diff --git a/docs/getting-started/multi-cluster.mdx b/docs/getting-started/multi-cluster.mdx index 95ea6ea..865e251 100644 --- a/docs/getting-started/multi-cluster.mdx +++ b/docs/getting-started/multi-cluster.mdx @@ -16,9 +16,10 @@ This guide walks you through step-by-step instructions for deploying OpenChoreo - **Docker** – Just have it installed on your machine, and you're good to go. - We recommend using [Docker Engine version 26.0+](https://docs.docker.com/engine/release-notes/26.0/). - Allocate at least **8 GB RAM** and **4 CPU** cores to Docker (or the VM running Docker). + - **Important**: Ensure your Docker VM has sufficient inotify limits. Set `fs.inotify.max_user_watches=524288` and `fs.inotify.max_user_instances=512` to prevent k3d cluster creation from hanging. - **[k3d](https://k3d.io/stable/#installation)** v5.8+ installed - **[kubectl](https://kubernetes.io/docs/tasks/tools/)** v1.32+ installed -- **[Helm](https://helm.sh/docs/intro/install/)** v3.12+ installed +- **[Helm](https://helm.sh/docs/intro/install/)** v3.12+ installed (helm v4 is not supported yet) ### Verify Prerequisites @@ -288,28 +289,53 @@ If the indices exist and the count is greater than 0, FluentBit is successfully ## Verification +### Switch to Control Plane Context + +Set your default kubectl context to the control plane for easier management: + +```bash +kubectl config use-context k3d-openchoreo-cp +``` + ### Check that default OpenChoreo resources were created: ```bash # Check default organization and project (on control plane) -kubectl get organizations,projects,environments -A --context k3d-openchoreo-cp +kubectl get organizations,projects,environments -A # Check default component types (on control plane) -kubectl get componenttypes -n default --context k3d-openchoreo-cp +kubectl get componenttypes -n default # Check all OpenChoreo CRDs (on control plane) -kubectl get crds --context k3d-openchoreo-cp | grep openchoreo +kubectl get crds | grep openchoreo # Check gateway resources (on data plane) kubectl get gateway,httproute -n openchoreo-data-plane --context k3d-openchoreo-dp ``` +### Verify Data Plane and Build Plane Registration + +```bash +# Verify DataPlane is registered and ready +kubectl get dataplane -n default +kubectl describe dataplane -n default | grep -A 5 "Status:" + +# Verify BuildPlane is registered and ready (if installed) +if kubectl get buildplane -n default &>/dev/null; then + echo "BuildPlane found:" + kubectl get buildplane -n default + kubectl describe buildplane -n default | grep -A 5 "Status:" +else + echo "BuildPlane not installed - skipping verification" +fi +``` + #### Check that all components are running: ```bash # Check control plane cluster -kubectl cluster-info --context k3d-openchoreo-cp -kubectl get pods -n openchoreo-control-plane --context k3d-openchoreo-cp +kubectl cluster-info +kubectl get pods -n openchoreo-control-plane # Check data plane cluster kubectl cluster-info --context k3d-openchoreo-dp diff --git a/docs/getting-started/qsg-backstage-ui.png b/docs/getting-started/qsg-backstage-ui.png new file mode 100644 index 0000000..8d4a1c5 Binary files /dev/null and b/docs/getting-started/qsg-backstage-ui.png differ diff --git a/docs/getting-started/quick-start-guide.mdx b/docs/getting-started/quick-start-guide.mdx index 3ad705d..eb3dc3d 100644 --- a/docs/getting-started/quick-start-guide.mdx +++ b/docs/getting-started/quick-start-guide.mdx @@ -56,7 +56,7 @@ The setup uses a preconfigured Dev Container that includes all required dependen Inside the container, run the installation command: - {`./install.sh --version ${versions.helmChart}`} + {`./install.sh --version ${versions.dockerTag}`} This command performs the following: @@ -110,6 +110,42 @@ The setup uses a preconfigured Dev Container that includes all required dependen ``` +
+
+
4
+
Access the Backstage UI
+
+ + Now that your web application is deployed, access the OpenChoreo Backstage UI to explore and manage your components: + + Access the UI at: http://openchoreo.localhost:8080/ + + Default login credentials: + - Username: `admin@openchoreo.dev` + - Password: `Admin@123` + + Backstage UI Screenshot + + + Take some time to explore the interface where you can: + - View your deployed components + - Monitor application status + - Access component catalogs + - Manage deployment pipelines + + :::note + To access advanced features like **CI/CD pipelines** (Build Plane) and **Observability** (Observability Plane) within the UI, you can enable them by including the following flags during installation: + + {`./install.sh --version ${versions.dockerTag} --with-build --with-observability`} + + ::: + +
+
### Understanding the Setup @@ -167,6 +203,10 @@ The setup uses a preconfigured Dev Container that includes all required dependen kubectl get components ``` + #### 3. UI Architecture + + The Backstage UI is powered by the OpenChoreo Backstage plugin, providing a unified interface for managing your components and deployments. The authentication and user management is handled by Asgardio, a lightweight identity management platform that secures access to your OpenChoreo environment. + :::tip Explore more examples in the Samples directory or in @@ -207,7 +247,7 @@ The setup uses a preconfigured Dev Container that includes all required dependen This example requires the Build Plane. If you didn't install it initially, reinstall with: - {`./install.sh --version ${versions.helmChart} --with-build`} + {`./install.sh --version ${versions.dockerTag} --with-build`} ::: @@ -220,7 +260,7 @@ The setup uses a preconfigured Dev Container that includes all required dependen
-
4
+
5
Cleaning up
diff --git a/docs/getting-started/single-cluster.mdx b/docs/getting-started/single-cluster.mdx index 4c3a886..cd0bc7e 100644 --- a/docs/getting-started/single-cluster.mdx +++ b/docs/getting-started/single-cluster.mdx @@ -18,7 +18,7 @@ This guide provides step-by-step instructions for setting up a local development - Allocate at least **8 GB RAM** and **4 CPU** cores to Docker (or the VM running Docker). - **[k3d](https://k3d.io/stable/#installation)** v5.8+ installed - **[kubectl](https://kubernetes.io/docs/tasks/tools/)** v1.32+ installed -- **[Helm](https://helm.sh/docs/intro/install/)** v3.12+ installed +- **[Helm](https://helm.sh/docs/intro/install/)** v3.12+ installed (helm v4 is not supported yet) ### Verify Prerequisites