Skip to content

Commit c4f7d93

Browse files
opensearch-trigger-bot[bot]opensearch-trigger-bot[bot]
authored
Updating helm commands to work with latest version (#10716) (#10724)
1 parent c3d06ae commit c4f7d93

File tree

2 files changed

+105
-51
lines changed
  • _install-and-configure

2 files changed

+105
-51
lines changed

‎_install-and-configure/install-dashboards/helm.md‎

Lines changed: 44 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -36,63 +36,74 @@ Make sure that you can send requests to your OpenSearch pod:
3636
```json
3737
$ curl -XGET https://localhost:9200 -u 'admin:<custom-admin-password>' --insecure
3838
{
39-
"name" : "opensearch-cluster-master-1",
39+
"name" : "opensearch-cluster-master-0",
4040
"cluster_name" : "opensearch-cluster",
41-
"cluster_uuid" : "hP2gq5bPS3SLp8Z7wXm8YQ",
41+
"cluster_uuid" : "72e_wDs1QdWHmwum_E2feA",
4242
"version" : {
4343
"distribution" : "opensearch",
44-
"number" : "1.0.0",
44+
"number" : "3.1.0",
4545
"build_type" : "tar",
46-
"build_hash" : "34550c5b17124ddc59458ef774f6b43a086522e3",
47-
"build_date" : "2021-07-02T23:22:21.383695Z",
46+
"build_hash" : "8ff7c6ee924a49f0f59f80a6e1c73073c8904214",
47+
"build_date" : "2025-06-21T08:05:50.445588571Z",
4848
"build_snapshot" : false,
49-
"lucene_version" : "8.8.2",
50-
"minimum_wire_compatibility_version" : "6.8.0",
51-
"minimum_index_compatibility_version" : "6.0.0-beta1"
49+
"lucene_version" : "10.2.1",
50+
"minimum_wire_compatibility_version" : "2.19.0",
51+
"minimum_index_compatibility_version" : "2.0.0"
5252
},
5353
"tagline" : "The OpenSearch Project: https://opensearch.org/"
5454
}
5555
```
5656

5757
## Install OpenSearch Dashboards using Helm
5858

59-
1. Change to the `opensearch-dashboards` directory:
59+
1. Clone the [helm-charts repo](https://github.com/opensearch-project/helm-charts/tree/main):
6060

6161
```bash
62-
cd opensearch-dashboards
62+
git clone https://github.com/opensearch-project/helm-charts.git
6363
```
64+
{% include copy.html %}
65+
66+
1. Navigate to the `opensearch-dashboards` directory:
67+
68+
```bash
69+
cd helm-charts/charts/opensearch-dashboards
70+
```
71+
{% include copy.html %}
6472

6573
1. Package the Helm chart:
6674

6775
```bash
6876
helm package .
6977
```
78+
{% include copy.html %}
7079

7180
1. Deploy OpenSearch Dashboards:
7281

7382
```bash
74-
helm install --generate-name opensearch-dashboards-1.0.0.tgz
83+
helm install --generate-name opensearch-dashboards-3.1.0.tgz
7584
```
85+
{% include copy.html %}
86+
7687
The output shows you the specifications instantiated from the install.
7788
To customize the deployment, pass in the values that you want to override with a custom YAML file:
7889

7990
```bash
80-
helm install --values=customvalues.yaml opensearch-dashboards-1.0.0.tgz
91+
helm install --values=customvalues.yaml opensearch-dashboards-3.1.0.tgz
8192
```
93+
{% include copy.html %}
8294

8395
#### Sample output
8496

8597
```yaml
8698
NAME: opensearch-dashboards-1-1629223356
87-
LAST DEPLOYED: Tue Aug 17 18:02:37 2021
99+
LAST DEPLOYED: Tue Aug 12 11:32:42 2025
88100
NAMESPACE: default
89101
STATUS: deployed
90102
REVISION: 1
91103
TEST SUITE: None
92104
NOTES:
93105
1. Get the application URL by running these commands:
94-
export POD_NAME=$(kubectl get pods --namespace default -l "app.kubernetes.io/name=opensearch-dashboards,app.kubernetes.io/instance=op
95-
ensearch-dashboards-1-1629223356" -o jsonpath="{.items[0].metadata.name}")
106+
export POD_NAME=$(kubectl get pods --namespace default -l "app.kubernetes.io/name=opensearch-dashboards,app.kubernetes.io/instance=dashboards" -o jsonpath="{.items[0].metadata.name}")
96107
export CONTAINER_PORT=$(kubectl get pod --namespace default $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
97108
echo "Visit http://127.0.0.1:8080 to use your application"
98109
kubectl --namespace default port-forward $POD_NAME 8080:$CONTAINER_PORT
@@ -102,6 +113,12 @@ To make sure your OpenSearch Dashboards pod is up and running, run the following
102113
103114
```bash
104115
$ kubectl get pods
116+
```
117+
{% include copy.html %}
118+
119+
The running containers are listed in the response:
120+
121+
```bash
105122
NAME READY STATUS RESTARTS AGE
106123
opensearch-cluster-master-0 1/1 Running 0 4m35s
107124
opensearch-cluster-master-1 1/1 Running 0 4m35s
@@ -112,8 +129,9 @@ opensearch-dashboards-1-1629223356-758bd8747f-8www5 1/1 Running 0
112129
To set up port forwarding to access OpenSearch Dashboards, exit the OpenSearch shell and run the following command:
113130

114131
```bash
115-
$ kubectl port-forward deployment/opensearch-dashboards-1-1629223356 5601
132+
$ k port-forward opensearch-dashboards-1-1629223356-758bd8747f-8www5 5601
116133
```
134+
{% include copy.html %}
117135

118136
You can now access OpenSearch Dashboards from your browser at: http://localhost:5601.
119137

@@ -124,14 +142,20 @@ To identify the OpenSearch Dashboards deployment that you want to delete:
124142

125143
```bash
126144
$ helm list
127-
NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
128-
opensearch-1-1629223146 default 1 2021-08-17 17:59:07.664498239 +0000 UTCdeployedopensearch-1.0.0 1.0.0
129-
opensearch-dashboards-1-1629223356 default 1 2021-08-17 18:02:37.600796946 +0000 UTCdepl
130-
oyedopensearch-dashboards-1.0.0 1.0.0
145+
```
146+
{% include copy.html %}
147+
148+
The existing Helm deployments are listed in the response:
149+
150+
```bash
151+
NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
152+
opensearch-dashboards-1-1629223356 default 1 2025-08-12 11:32:42.798313 +0100 IST deployed opensearch-dashboards-3.1.0 3.1.0
153+
opensearch-3-1754994664 default 1 2025-08-12 11:31:04.710386 +0100 IST deployed opensearch-3.1.0 3.1.0
131154
```
132155

133156
To delete or uninstall a deployment, run the following command:
134157

135158
```bash
136159
helm delete opensearch-dashboards-1-1629223356
137160
```
161+
{% include copy.html %}

‎_install-and-configure/install-opensearch/helm.md‎

Lines changed: 61 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,15 @@ The instructions here assume you have a Kubernetes cluster with Helm preinstalle
3131

3232
The default Helm chart deploys a three-node cluster. We recommend that you have at least 8 GiB of memory available for this deployment. You can expect the deployment to fail if, say, you have less than 4 GiB of memory available.
3333

34+
For OpenSearch 2.12 or later, you must provide `OPENSEARCH_INITIAL_ADMIN_PASSWORD` to start the cluster. Customize the admin password in `values.yaml` under `extraEnvs`, as shown in the following example:
35+
36+
```yaml
37+
extraEnvs:
38+
- name: OPENSEARCH_INITIAL_ADMIN_PASSWORD
39+
value: <custom-admin-password>
40+
```
41+
{% include copy.html %}
42+
3443
## Install OpenSearch using Helm
3544
3645
1. Add `opensearch` [helm-charts](https://github.com/opensearch-project/helm-charts) repository to Helm:
@@ -54,76 +63,91 @@ The default Helm chart deploys a three-node cluster. We recommend that you have
5463
```
5564
{% include copy.html %}
5665

66+
The available charts are provided in the response:
67+
5768
```bash
5869
NAME CHART VERSION APP VERSION DESCRIPTION
59-
opensearch/opensearch 1.0.7 1.0.0 A Helm chart for OpenSearch
60-
opensearch/opensearch-dashboards 1.0.4 1.0.0 A Helm chart for OpenSearch Dashboards
70+
opensearch/opensearch 3.1.0 3.1.0 A Helm chart for OpenSearch
71+
opensearch/opensearch-dashboards 3.1.0 3.1.0 A Helm chart for OpenSearch Dashboards
6172
```
6273

74+
1. Create a minimal `values.yaml` file:
75+
76+
```yaml
77+
config:
78+
opensearch.yml: |-
79+
cluster.name: opensearch-cluster
80+
network.host: 0.0.0.0
81+
extraEnvs:
82+
- name: OPENSEARCH_INITIAL_ADMIN_PASSWORD
83+
value: <strong_password>
84+
```
85+
{% include copy.html %}
86+
6387
1. Deploy OpenSearch:
6488

6589
```bash
66-
helm install my-deployment opensearch/opensearch
90+
helm install my-deployment opensearch/opensearch -f values.yaml
6791
```
6892
{% include copy.html %}
6993

70-
You can also build the `opensearch-1.0.0.tgz` file manually:
94+
You can also build the `opensearch-<VERSION>.tgz` file manually:
7195

72-
1. Change to the `opensearch` directory:
96+
1. Clone the [helm-charts repo](https://github.com/opensearch-project/helm-charts/tree/main):
7397

7498
```bash
75-
cd charts/opensearch
99+
git clone https://github.com/opensearch-project/helm-charts.git
76100
```
77101
{% include copy.html %}
78102

79-
1. Package the Helm chart:
103+
1. Navigate to the `opensearch` directory:
80104

81105
```bash
82-
helm package .
106+
cd helm-charts/charts/opensearch
83107
```
84108
{% include copy.html %}
85109

86-
1. Deploy OpenSearch:
110+
1. Package the Helm chart:
87111

88112
```bash
89-
helm install --generate-name opensearch-1.0.0.tgz
113+
helm package .
90114
```
91115
{% include copy.html %}
92116

93-
The output shows you the specifications instantiated from the install.
94-
To customize the deployment, pass in the values that you want to override with a custom YAML file:
117+
1. Deploy OpenSearch:
95118

96119
```bash
97-
helm install --values=customvalues.yaml opensearch-1.0.0.tgz
120+
helm install --generate-name opensearch-<VERSION>.tgz -f /path/to/values.yaml
98121
```
99122
{% include copy.html %}
100123

101-
For OpenSearch 2.12 or greater, customize the admin password in `values.yaml` under `extraEnvs`, as shown in the following example:
124+
The output shows you the specifications instantiated from the install.
102125

103-
```yaml
104-
extraEnvs:
105-
- name: OPENSEARCH_INITIAL_ADMIN_PASSWORD
106-
value: <custom-admin-password>
107-
```
108126

109127
#### Sample output
110128

111129
```yaml
112-
NAME: opensearch-1-1629223146
113-
LAST DEPLOYED: Tue Aug 17 17:59:07 2021
130+
NAME: opensearch-3-1754992026
131+
LAST DEPLOYED: Tue Aug 12 10:47:06 2025
114132
NAMESPACE: default
115133
STATUS: deployed
116134
REVISION: 1
117135
TEST SUITE: None
118136
NOTES:
119137
Watch all cluster members come up.
120-
$ kubectl get pods --namespace=default -l app=opensearch-cluster-master -w
138+
$ kubectl get pods --namespace=default -l app.kubernetes.io/component=opensearch-cluster-master -w
121139
```
122140

123141
To make sure your OpenSearch pod is up and running, run the following command:
124142

125143
```bash
126144
$ kubectl get pods
145+
```
146+
{% include copy.html %}
147+
148+
The response lists the running containers:
149+
150+
```bash
127151
NAME READY STATUS RESTARTS AGE
128152
opensearch-cluster-master-0 1/1 Running 0 3m56s
129153
opensearch-cluster-master-1 1/1 Running 0 3m56s
@@ -140,11 +164,11 @@ $ kubectl exec -it opensearch-cluster-master-0 -- /bin/bash
140164
You can send requests to the pod to verify that OpenSearch is up and running:
141165

142166
```json
143-
$ curl -XGET https://localhost:9200 -u 'admin:admin' --insecure
167+
$ curl -XGET https://localhost:9200 -u 'admin:<custom-admin-password>' --insecure
144168
{
145-
"name" : "opensearch-cluster-master-1",
169+
"name" : "opensearch-cluster-master-0",
146170
"cluster_name" : "opensearch-cluster",
147-
"cluster_uuid" : "hP2gq5bPS3SLp8Z7wXm8YQ",
171+
"cluster_uuid" : "72e_wDs1QdWHmwum_E2feA",
148172
"version" : {
149173
"distribution" : "opensearch",
150174
"number" : <version>,
@@ -153,8 +177,8 @@ $ curl -XGET https://localhost:9200 -u 'admin:admin' --insecure
153177
"build_date" : <build-date>,
154178
"build_snapshot" : false,
155179
"lucene_version" : <lucene-version>,
156-
"minimum_wire_compatibility_version" : "6.8.0",
157-
"minimum_index_compatibility_version" : "6.0.0-beta1"
180+
"minimum_wire_compatibility_version" : "2.19.0",
181+
"minimum_index_compatibility_version" : "2.0.0"
158182
},
159183
"tagline" : "The OpenSearch Project: https://opensearch.org/"
160184
}
@@ -166,15 +190,21 @@ To identify the OpenSearch deployment that you want to delete:
166190

167191
```bash
168192
$ helm list
169-
NAME NAMESPACEREVISIONUPDATED STATUS CHART APP VERSION
170-
opensearch-1-1629223146 default 1 2021-08-17 17:59:07.664498239 +0000 UTCdeployedopensearch-1.0.0 1.0.0
193+
```
194+
{% include copy.html %}
195+
196+
The reponse lists the current Helm deployments:
197+
198+
```
199+
NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
200+
opensearch-3-1754992026 default 1 2025-08-12 10:47:06.02703 +0100 IST deployed opensearch-3.1.0 3.1.0
171201
```
172202

173203
To delete or uninstall a deployment, run the following command:
174204

175205
```bash
176-
helm delete opensearch-1-1629223146
206+
helm delete opensearch-3-1754992026
177207
```
178208
{% include copy.html %}
179209

180-
For steps to install OpenSearch Dashboards, see [Helm to install OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/dashboards/install/helm/).
210+
For instructions on how to to install OpenSearch Dashboards, see [Helm to install OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/dashboards/install/helm/).

0 commit comments

Comments
 (0)