Skip to content

Commit ad17d19

Browse files
docs: Fix clippy warnings
1 parent a823c57 commit ad17d19

3 files changed

Lines changed: 21 additions & 15 deletions

File tree

docs/modules/opensearch/examples/getting_started/getting_started.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ curl \
8989
--user $CREDENTIALS \
9090
--request PUT \
9191
--json '{"name": "Stackable"}' \
92-
$OPENSEARCH_HOST/sample_index/_doc/1
92+
"$OPENSEARCH_HOST/sample_index/_doc/1"
9393

9494
# Output:
9595
# {"_index":"sample_index","_id":"1","_version":1,"result":"created","_shards":{"total":2,"successful":1,"failed":0},"_seq_no":0,"_primary_term":1}
@@ -98,7 +98,7 @@ curl \
9898
--insecure \
9999
--user $CREDENTIALS \
100100
--request GET \
101-
$OPENSEARCH_HOST/sample_index/_doc/1
101+
"$OPENSEARCH_HOST/sample_index/_doc/1"
102102

103103
# Output:
104104
# {"_index":"sample_index","_id":"1","_version":1,"_seq_no":0,"_primary_term":1,"found":true,"_source":{"name": "Stackable"}}

docs/modules/opensearch/examples/getting_started/getting_started.sh.j2

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ curl \
8989
--user $CREDENTIALS \
9090
--request PUT \
9191
--json '{"name": "Stackable"}' \
92-
$OPENSEARCH_HOST/sample_index/_doc/1
92+
"$OPENSEARCH_HOST/sample_index/_doc/1"
9393

9494
# Output:
9595
# {"_index":"sample_index","_id":"1","_version":1,"result":"created","_shards":{"total":2,"successful":1,"failed":0},"_seq_no":0,"_primary_term":1}
@@ -98,7 +98,7 @@ curl \
9898
--insecure \
9999
--user $CREDENTIALS \
100100
--request GET \
101-
$OPENSEARCH_HOST/sample_index/_doc/1
101+
"$OPENSEARCH_HOST/sample_index/_doc/1"
102102

103103
# Output:
104104
# {"_index":"sample_index","_id":"1","_version":1,"_seq_no":0,"_primary_term":1,"found":true,"_source":{"name": "Stackable"}}

docs/modules/opensearch/pages/usage-guide/opensearch-dashboards.adoc.j2

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ A basic `values.yaml` file to deploy OpenSearch Dashboards with this chart might
1010

1111
[source,yaml]
1212
----
13-
opensearchHosts: https://opensearch-nodes-default.<opensearch-namespace>.svc.cluster.local:9200 # <1>
13+
opensearchHosts: null # <1>
1414
image: # <2>
1515
repository: oci.stackable.tech/sdp/opensearch-dashboards
1616
tag: 3.1.0-stackable{{ versions.opensearch }}
@@ -34,13 +34,18 @@ config:
3434
cookie:
3535
secure: true # <10>
3636
extraEnvs:
37+
- name: OPENSEARCH_HOSTS
38+
valueFrom:
39+
configMapKeyRef:
40+
name: opensearch # <11>
41+
key: OPENSEARCH_HOSTS
3742
- name: OPENSEARCH_PASSWORD
3843
valueFrom:
3944
secretKeyRef:
4045
name: opensearch-credentials
41-
key: kibanaserver # <11>
46+
key: kibanaserver # <12>
4247
extraVolumes:
43-
- name: tls # <12>
48+
- name: tls # <13>
4449
ephemeral:
4550
volumeClaimTemplate:
4651
metadata:
@@ -58,13 +63,12 @@ extraVolumeMounts:
5863
- mountPath: /stackable/opensearch-dashboards/config/tls
5964
name: tls
6065
- mountPath: /stackable/opensearch-dashboards/config/opensearch_dashboards.yml
61-
name: config # <13>
66+
name: config # <14>
6267
subPath: opensearch_dashboards.yml
6368
podSecurityContext:
64-
fsGroup: 1000 # <14>
69+
fsGroup: 1000 # <15>
6570
----
66-
<1> Address of the OpenSearch Service deployed by the operator;
67-
This address must be adapted according to your deployment.
71+
<1> The address of the OpenSearch cluster is provided in `extraEnvs` in the `OPENSEARCH_HOSTS` variable.
6872
<2> Use the OCI image provided by the Stackable Data Platform
6973
<3> If running on OpenShift, use the ServiceAccount of OpenSearch because its permissions are already configured to work on OpenShift.
7074
This ServiceAccount name must probably adapted according to your deployment.
@@ -75,10 +79,12 @@ podSecurityContext:
7579
<8> OpenSearch Dashboards verifies the certificate of OpenSearch. This is disabled by default.
7680
<9> The CA certificate which is used to verify the OpenSearch certificate
7781
<10> Ensure that cookies are not sent via an insecure connection.
78-
<11> The password for the `kibanaserver` user
79-
<12> This example uses the secret operator to provide a TLS certificate.
80-
<13> The Helm chart only adds a volume mount at `/usr/share/opensearch-dashboards/config`, but in the image provided by Stackable, OpenSearch Dashboards is located in `/stackable/opensearch-dashboards`.
81-
<14> Mount the volumes with the `stackable` group so that the files are accessible by OpenSearch Dashboards.
82+
<11> Address of the OpenSearch Service taken from the xref:opensearch:reference/discovery.adoc[discovery ConfigMap]
83+
The name of the discovery ConfigMap corresponds to the name of the OpenSearch cluster and must be adapted according to your deployment.
84+
<12> The password for the `kibanaserver` user
85+
<13> This example uses the secret operator to provide a TLS certificate.
86+
<14> The Helm chart only adds a volume mount at `/usr/share/opensearch-dashboards/config`, but in the image provided by Stackable, OpenSearch Dashboards is located in `/stackable/opensearch-dashboards`.
87+
<15> Mount the volumes with the `stackable` group so that the files are accessible by OpenSearch Dashboards.
8288

8389
After the values are adjusted according to your deployment, especially `opensearchHosts` and `serviceAccount.name`, you can deploy the Helm chart as follows:
8490

0 commit comments

Comments
 (0)