Skip to content

Add instructions to install OpenSearch K8s operator and enable tracing in multi cluster setup #139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nilushancosta merged 1 commit into from
Nov 28, 2025
Merged

Add instructions to install OpenSearch K8s operator and enable tracing in multi cluster setup #139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions docs/getting-started/multi-cluster.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,14 +242,26 @@ This will:

#### Install OpenChoreo Observability Plane

Install the OpenChoreo observability plane using Helm. This will create the `openchoreo-observability-plane` namespace automatically:
#### Prerequisites
Install the [OpenSearch Kubernetes operator](https://docs.opensearch.org/latest/install-and-configure/install-opensearch/operator/) as follows. This will create the `openchoreo-observability-plane` namespace automatically:

@chalindukodikara chalindukodikara Nov 28, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shall we add this to the code repository readmes as well?

@nilushancosta nilushancosta Nov 28, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure


<CodeBlock language="bash">
{`helm repo add opensearch-operator https://opensearch-project.github.io/opensearch-k8s-operator/
helm repo update
helm install opensearch-operator opensearch-operator/opensearch-operator \\
--create-namespace \\
--namespace openchoreo-observability-plane \\
--version 2.8.0`}
</CodeBlock>


Install the OpenChoreo observability plane using Helm.

<CodeBlock language="bash">
{`helm install openchoreo-observability-plane oci://ghcr.io/openchoreo/helm-charts/openchoreo-observability-plane \\
--version ${versions.helmChart} \\
--kube-context k3d-openchoreo-op \\
--namespace openchoreo-observability-plane \\
--create-namespace \\
--values https://raw.githubusercontent.com/openchoreo/openchoreo/${versions.githubRef}/install/k3d/multi-cluster/values-op.yaml`}
</CodeBlock>

Expand Down Expand Up @@ -301,6 +313,8 @@ helm upgrade data-plane oci://ghcr.io/openchoreo/helm-charts/openchoreo-data-pla
--set fluentBit.config.opensearch.port=30920 \\
--set cert-manager.enabled=false \\
--set cert-manager.crds.enabled=false \\
--set observability.observabilityPlaneUrl="openchoreo-op-control-plane" \\
--set opentelemetry-collector.enabled=true \\
--kube-context kind-openchoreo-dp`}
</CodeBlock>

Expand Down
15 changes: 13 additions & 2 deletions docs/getting-started/single-cluster.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,14 +192,25 @@ kubectl get buildplane -n default

### 5. Install OpenChoreo Observability Plane (Optional)

Install the OpenChoreo observability plane using the following helm install command for monitoring and logging capabilities. This will create the `openchoreo-observability-plane` namespace automatically:
#### Prerequisites
Install the [OpenSearch Kubernetes operator](https://docs.opensearch.org/latest/install-and-configure/install-opensearch/operator/) as follows. This will create the `openchoreo-observability-plane` namespace automatically:

<CodeBlock language="bash">
{`helm repo add opensearch-operator https://opensearch-project.github.io/opensearch-k8s-operator/
helm repo update
helm install opensearch-operator opensearch-operator/opensearch-operator \\
--create-namespace \\
--namespace openchoreo-observability-plane \\
--version 2.8.0`}
</CodeBlock>

Install the OpenChoreo observability plane using the following helm install command for monitoring and logging capabilities.

<CodeBlock language="bash">
{`helm install openchoreo-observability-plane oci://ghcr.io/openchoreo/helm-charts/openchoreo-observability-plane \\
--version ${versions.helmChart} \\
--kube-context k3d-openchoreo \\
--namespace openchoreo-observability-plane \\
--create-namespace \\
--values https://raw.githubusercontent.com/openchoreo/openchoreo/${versions.githubRef}/install/k3d/single-cluster/values-op.yaml`}
</CodeBlock>

Expand Down