Skip to content

Commit 6f21e3a

Browse files
authored
docs: fix on-your-env installation guide (#433)
Updated the configuration structure in the installation guide for clarity and consistency. Adjusted indentation and formatting for various components including openchoreoApi, backstage, security, and gateway sections. Added a note for single-node clusters regarding LoadBalancer services to prevent port conflicts. Signed-off-by: Akila-I <akila.99g@gmail.com>
1 parent 0d6fd41 commit 6f21e3a

File tree

1 file changed

+84
-76
lines changed

1 file changed

+84
-76
lines changed

docs/getting-started/try-it-out/on-your-environment.mdx

Lines changed: 84 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -227,21 +227,21 @@ First, install a minimal control plane to get a LoadBalancer address. The chart
227227
--create-namespace \\
228228
--values - <<'EOF'
229229
openchoreoApi:
230-
http:
231-
hostnames:
232-
- "api.placeholder.tld"
230+
http:
231+
hostnames:
232+
- "api.placeholder.tld"
233233
backstage:
234-
baseUrl: "https://console.placeholder.tld"
235-
secretName: backstage-secrets
236-
http:
237-
hostnames:
238-
- "console.placeholder.tld"
234+
baseUrl: "https://console.placeholder.tld"
235+
secretName: backstage-secrets
236+
http:
237+
hostnames:
238+
- "console.placeholder.tld"
239239
security:
240-
oidc:
241-
issuer: "https://thunder.placeholder.tld"
240+
oidc:
241+
issuer: "https://thunder.placeholder.tld"
242242
gateway:
243-
tls:
244-
enabled: false
243+
tls:
244+
enabled: false
245245
EOF`}
246246
</CodeBlock>
247247

@@ -388,41 +388,41 @@ Upgrade with real hostnames, TLS enabled, and JWKS skip-verify for self-signed c
388388
--reuse-values \\
389389
--values - <<EOF
390390
openchoreoApi:
391-
config:
392-
server:
393-
publicUrl: "https://api.\${CP_BASE_DOMAIN}"
394-
security:
395-
authentication:
396-
jwt:
397-
jwks:
398-
skip_tls_verify: true
399-
http:
400-
hostnames:
401-
- "api.\${CP_BASE_DOMAIN}"
391+
config:
392+
server:
393+
publicUrl: "https://api.\${CP_BASE_DOMAIN}"
394+
security:
395+
authentication:
396+
jwt:
397+
jwks:
398+
skip_tls_verify: true
399+
http:
400+
hostnames:
401+
- "api.\${CP_BASE_DOMAIN}"
402402
backstage:
403-
secretName: backstage-secrets
404-
baseUrl: "https://console.\${CP_BASE_DOMAIN}"
405-
http:
406-
hostnames:
407-
- "console.\${CP_BASE_DOMAIN}"
408-
auth:
409-
redirectUrls:
410-
- "https://console.\${CP_BASE_DOMAIN}/api/auth/openchoreo-auth/handler/frame"
411-
extraEnv:
412-
- name: NODE_TLS_REJECT_UNAUTHORIZED
413-
value: "0"
403+
secretName: backstage-secrets
404+
baseUrl: "https://console.\${CP_BASE_DOMAIN}"
405+
http:
406+
hostnames:
407+
- "console.\${CP_BASE_DOMAIN}"
408+
auth:
409+
redirectUrls:
410+
- "https://console.\${CP_BASE_DOMAIN}/api/auth/openchoreo-auth/handler/frame"
411+
extraEnv:
412+
- name: NODE_TLS_REJECT_UNAUTHORIZED
413+
value: "0"
414414
security:
415-
oidc:
416-
issuer: "https://thunder.\${CP_BASE_DOMAIN}"
417-
jwksUrl: "https://thunder.\${CP_BASE_DOMAIN}/oauth2/jwks"
418-
authorizationUrl: "https://thunder.\${CP_BASE_DOMAIN}/oauth2/authorize"
419-
tokenUrl: "https://thunder.\${CP_BASE_DOMAIN}/oauth2/token"
415+
oidc:
416+
issuer: "https://thunder.\${CP_BASE_DOMAIN}"
417+
jwksUrl: "https://thunder.\${CP_BASE_DOMAIN}/oauth2/jwks"
418+
authorizationUrl: "https://thunder.\${CP_BASE_DOMAIN}/oauth2/authorize"
419+
tokenUrl: "https://thunder.\${CP_BASE_DOMAIN}/oauth2/token"
420420
gateway:
421-
tls:
422-
enabled: true
423-
hostname: "*.\${CP_BASE_DOMAIN}"
424-
certificateRefs:
425-
- name: cp-gateway-tls
421+
tls:
422+
enabled: true
423+
hostname: "*.\${CP_BASE_DOMAIN}"
424+
certificateRefs:
425+
- name: cp-gateway-tls
426426
EOF`}
427427
</CodeBlock>
428428

@@ -573,11 +573,11 @@ kubectl wait --for=condition=Ready certificate/dp-gateway-tls \
573573
--reuse-values \\
574574
--values - <<EOF
575575
gateway:
576-
tls:
577-
enabled: true
578-
hostname: "*.\${DP_DOMAIN}"
579-
certificateRefs:
580-
- name: dp-gateway-tls
576+
tls:
577+
enabled: true
578+
hostname: "*.\${DP_DOMAIN}"
579+
certificateRefs:
580+
- name: dp-gateway-tls
581581
EOF`}
582582
</CodeBlock>
583583

@@ -871,9 +871,21 @@ OpenChoreo uses a modular observability plane. In this step you will:
871871
--version ${versions.helmChart} \\
872872
--namespace openchoreo-observability-plane \\
873873
--create-namespace \\
874-
--timeout 25m`}
874+
--timeout 25m \\
875+
--values - <<EOF
876+
observer:
877+
openSearchSecretName: opensearch-admin-credentials
878+
secretName: observer-secret
879+
gateway:
880+
tls:
881+
enabled: false
882+
EOF`}
875883
</CodeBlock>
876884

885+
:::note[Single-node clusters (k3s, Rancher Desktop, minikube)]
886+
On single-node clusters all LoadBalancer services share the same IP. Add `--set gateway.httpPort=9080 --set gateway.httpsPort=9443` to avoid port conflicts with the control plane and data plane gateways.
887+
:::
888+
877889
#### Install the logs module (OpenSearch)
878890

879891
```bash
@@ -907,10 +919,6 @@ helm upgrade --install observability-traces-opensearch \
907919
--set openSearchSetup.openSearchSecretName="opensearch-admin-credentials"
908920
```
909921

910-
:::note[Single-node clusters (k3s, Rancher Desktop, minikube)]
911-
On single-node clusters all LoadBalancer services share the same IP. Add `--set gateway.httpPort=9080 --set gateway.httpsPort=9443` to avoid port conflicts with the control plane and data plane gateways.
912-
:::
913-
914922
#### Create the Observability Plane TLS Certificate
915923

916924
Get the observer gateway IP and create a certificate:
@@ -950,7 +958,7 @@ kubectl wait --for=condition=Ready certificate/obs-gateway-tls \
950958
-n openchoreo-observability-plane --timeout=60s
951959
```
952960

953-
Configure the observability plane to use the newly created certificate
961+
#### Configure the Observability Plane to use the newly created certificate
954962

955963
<CodeBlock language="bash">
956964
{`helm upgrade openchoreo-observability-plane ${versions.helmSource}/openchoreo-observability-plane \\
@@ -960,29 +968,29 @@ Configure the observability plane to use the newly created certificate
960968
--timeout 10m \\
961969
--values - <<EOF
962970
observer:
963-
openSearchSecretName: opensearch-admin-credentials
964-
secretName: observer-secret
965-
controlPlaneApiUrl: "https://api.\${CP_BASE_DOMAIN}"
966-
http:
967-
hostnames:
968-
- "observer.\${OBS_BASE_DOMAIN}"
969-
cors:
970-
allowedOrigins:
971-
- "https://console.\${CP_BASE_DOMAIN}"
971+
openSearchSecretName: opensearch-admin-credentials
972+
secretName: observer-secret
973+
controlPlaneApiUrl: "https://api.\${CP_BASE_DOMAIN}"
974+
http:
975+
hostnames:
976+
- "observer.\${OBS_BASE_DOMAIN}"
977+
cors:
978+
allowedOrigins:
979+
- "https://console.\${CP_BASE_DOMAIN}"
980+
authzTlsInsecureSkipVerify: true
972981
security:
973-
oidc:
974-
issuer: "https://thunder.\${CP_BASE_DOMAIN}"
975-
jwksUrl: "https://thunder.\${CP_BASE_DOMAIN}/oauth2/jwks"
976-
tokenUrl: "https://thunder.\${CP_BASE_DOMAIN}/oauth2/token"
977-
jwksUrlTlsInsecureSkipVerify: "true"
978-
authzTlsInsecureSkipVerify: "true"
979-
uidResolverTlsInsecureSkipVerify: "true"
982+
oidc:
983+
issuer: "https://thunder.\${CP_BASE_DOMAIN}"
984+
jwksUrl: "https://thunder.\${CP_BASE_DOMAIN}/oauth2/jwks"
985+
tokenUrl: "https://thunder.\${CP_BASE_DOMAIN}/oauth2/token"
986+
jwksUrlTlsInsecureSkipVerify: "true"
987+
uidResolverTlsInsecureSkipVerify: "true"
980988
gateway:
981-
tls:
982-
enabled: true
983-
hostname: "*.\${OBS_BASE_DOMAIN}"
984-
certificateRefs:
985-
- name: obs-gateway-tls
989+
tls:
990+
enabled: true
991+
hostname: "*.\${OBS_BASE_DOMAIN}"
992+
certificateRefs:
993+
- name: obs-gateway-tls
986994
EOF`}
987995
</CodeBlock>
988996

0 commit comments

Comments
 (0)