Skip to content

Commit 066af34

Browse files
akila-iLakshanSS
authored andcommitted
docs: add kubernetes events collection setup instructions
Signed-off-by: Akila-I <akila.99g@gmail.com>
1 parent bc5d1cd commit 066af34

3 files changed

Lines changed: 124 additions & 7 deletions

File tree

docs/getting-started/try-it-out/on-k3d-locally.mdx

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -793,7 +793,7 @@ helm upgrade --install observability-logs-opensearch \
793793
oci://ghcr.io/openchoreo/helm-charts/observability-logs-opensearch \
794794
--create-namespace \
795795
--namespace openchoreo-observability-plane \
796-
--version 0.4.1 \
796+
--version 0.5.1 \
797797
--set openSearchSetup.openSearchSecretName="opensearch-admin-credentials" \
798798
--set adapter.openSearchSecretName="opensearch-admin-credentials"
799799
```
@@ -826,11 +826,51 @@ helm upgrade --install observability-metrics-prometheus \
826826
helm upgrade observability-logs-opensearch \
827827
oci://ghcr.io/openchoreo/helm-charts/observability-logs-opensearch \
828828
--namespace openchoreo-observability-plane \
829-
--version 0.4.1 \
829+
--version 0.5.1 \
830830
--reuse-values \
831831
--set fluent-bit.enabled=true
832832
```
833833

834+
#### Enable kubernetes events collection and exporting to logs module
835+
836+
```bash
837+
helm upgrade --install observability-events-otel-collector \
838+
oci://ghcr.io/openchoreo/helm-charts/observability-events-otel-collector \
839+
--namespace openchoreo-observability-plane \
840+
--version 0.1.1 \
841+
-f - <<'EOF'
842+
collector:
843+
extraEnv:
844+
- name: OPENSEARCH_USERNAME
845+
valueFrom:
846+
secretKeyRef:
847+
name: opensearch-admin-credentials
848+
key: username
849+
- name: OPENSEARCH_PASSWORD
850+
valueFrom:
851+
secretKeyRef:
852+
name: opensearch-admin-credentials
853+
key: password
854+
extraExtensions:
855+
basicauth/opensearch:
856+
client_auth:
857+
username: ${env:OPENSEARCH_USERNAME}
858+
password: ${env:OPENSEARCH_PASSWORD}
859+
exporters:
860+
opensearch:
861+
logs_index: "k8s-events"
862+
logs_index_time_format: "yyyy-MM-dd"
863+
http:
864+
endpoint: "https://opensearch:9200"
865+
tls:
866+
insecure_skip_verify: true
867+
auth:
868+
authenticator: basicauth/opensearch
869+
pipelineExporters:
870+
- opensearch
871+
EOF
872+
```
873+
834874
</TabItem>
835875
</Tabs>
836876

docs/getting-started/try-it-out/on-k3d-locally/k3d-observability-plane.sh

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ helm upgrade --install observability-logs-opensearch \
2121
oci://ghcr.io/openchoreo/helm-charts/observability-logs-opensearch \
2222
--create-namespace \
2323
--namespace openchoreo-observability-plane \
24-
--version 0.4.1 \
24+
--version 0.5.1 \
2525
--set openSearchSetup.openSearchSecretName="opensearch-admin-credentials"
2626

2727
step "Installing OpenSearch-based traces module..."
@@ -44,9 +44,46 @@ step "Enabling logs collection in the configured logs module..."
4444
helm upgrade observability-logs-opensearch \
4545
oci://ghcr.io/openchoreo/helm-charts/observability-logs-opensearch \
4646
--namespace openchoreo-observability-plane \
47-
--version 0.4.1 \
47+
--version 0.5.1 \
4848
--reuse-values \
4949
--set fluent-bit.enabled=true
5050

51+
step "Enabling kubernetes events collection and exporting to logs module..."
52+
helm upgrade --install observability-events-otel-collector \
53+
oci://ghcr.io/openchoreo/helm-charts/observability-events-otel-collector \
54+
--namespace openchoreo-observability-plane \
55+
--version 0.1.1 \
56+
-f - <<'EOF'
57+
collector:
58+
extraEnv:
59+
- name: OPENSEARCH_USERNAME
60+
valueFrom:
61+
secretKeyRef:
62+
name: opensearch-admin-credentials
63+
key: username
64+
- name: OPENSEARCH_PASSWORD
65+
valueFrom:
66+
secretKeyRef:
67+
name: opensearch-admin-credentials
68+
key: password
69+
extraExtensions:
70+
basicauth/opensearch:
71+
client_auth:
72+
username: ${env:OPENSEARCH_USERNAME}
73+
password: ${env:OPENSEARCH_PASSWORD}
74+
exporters:
75+
opensearch:
76+
logs_index: "k8s-events"
77+
logs_index_time_format: "yyyy-MM-dd"
78+
http:
79+
endpoint: "https://opensearch:9200"
80+
tls:
81+
insecure_skip_verify: true
82+
auth:
83+
authenticator: basicauth/opensearch
84+
pipelineExporters:
85+
- opensearch
86+
EOF
87+
5188
echo ""
5289
echo "==> Observability plane and default modules installed successfully."

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

Lines changed: 43 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -962,7 +962,7 @@ helm upgrade --install observability-logs-opensearch \
962962
oci://ghcr.io/openchoreo/helm-charts/observability-logs-opensearch \
963963
--create-namespace \
964964
--namespace openchoreo-observability-plane \
965-
--version 0.4.1 \
965+
--version 0.5.1 \
966966
--set openSearchSetup.openSearchSecretName="opensearch-admin-credentials" \
967967
--set adapter.openSearchSecretName="opensearch-admin-credentials"
968968
```
@@ -1108,16 +1108,56 @@ kubectl patch clusterworkflowplane default --type merge \
11081108
-p '{"spec":{"observabilityPlaneRef":{"kind":"ClusterObservabilityPlane","name":"default"}}}'
11091109
```
11101110

1111-
Enable Fluent Bit for log collection
1111+
#### Enable Fluent Bit for log collection
11121112

11131113
<CodeBlock language="bash">
11141114
{`helm upgrade -n openchoreo-observability-plane observability-logs-opensearch \\
11151115
oci://ghcr.io/openchoreo/helm-charts/observability-logs-opensearch \\
1116-
--version 0.4.1 \\
1116+
--version 0.5.1 \\
11171117
--reuse-values \\
11181118
--set fluent-bit.enabled=true`}
11191119
</CodeBlock>
11201120

1121+
#### Enable kubernetes events collection and exporting to logs module
1122+
1123+
<CodeBlock language="bash">
1124+
{`helm upgrade --install observability-events-otel-collector \\
1125+
oci://ghcr.io/openchoreo/helm-charts/observability-events-otel-collector \\
1126+
--namespace openchoreo-observability-plane \\
1127+
--version 0.1.1 \\
1128+
-f - <<'EOF'
1129+
collector:
1130+
extraEnv:
1131+
- name: OPENSEARCH_USERNAME
1132+
valueFrom:
1133+
secretKeyRef:
1134+
name: opensearch-admin-credentials
1135+
key: username
1136+
- name: OPENSEARCH_PASSWORD
1137+
valueFrom:
1138+
secretKeyRef:
1139+
name: opensearch-admin-credentials
1140+
key: password
1141+
extraExtensions:
1142+
basicauth/opensearch:
1143+
client_auth:
1144+
username: \${env:OPENSEARCH_USERNAME}
1145+
password: \${env:OPENSEARCH_PASSWORD}
1146+
exporters:
1147+
opensearch:
1148+
logs_index: "k8s-events"
1149+
logs_index_time_format: "yyyy-MM-dd"
1150+
http:
1151+
endpoint: "https://opensearch:9200"
1152+
tls:
1153+
insecure_skip_verify: true
1154+
auth:
1155+
authenticator: basicauth/opensearch
1156+
pipelineExporters:
1157+
- opensearch
1158+
EOF`}
1159+
</CodeBlock>
1160+
11211161
Verify the observer is reachable:
11221162

11231163
```bash

0 commit comments

Comments
 (0)