From 977b282484e96b929223bf5eb3168002de1e8476 Mon Sep 17 00:00:00 2001 From: Anton Rubin Date: Fri, 26 Sep 2025 10:44:09 +0100 Subject: [PATCH 1/3] adding links for password requirements Signed-off-by: Anton Rubin --- _install-and-configure/install-opensearch/debian.md | 3 +++ _install-and-configure/install-opensearch/helm.md | 2 +- _install-and-configure/install-opensearch/rpm.md | 13 +++++++------ _install-and-configure/install-opensearch/tar.md | 2 +- .../install-opensearch/windows.md | 2 +- _security/configuration/demo-configuration.md | 2 +- 6 files changed, 14 insertions(+), 10 deletions(-) diff --git a/_install-and-configure/install-opensearch/debian.md b/_install-and-configure/install-opensearch/debian.md index 25b91a0450f..d2ce9e986eb 100644 --- a/_install-and-configure/install-opensearch/debian.md +++ b/_install-and-configure/install-opensearch/debian.md @@ -146,6 +146,9 @@ APT, the primary package management tool for Debian–based operating systems, a ``` {% include copy.html %} + See [password requirements]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/docker/#password-requirements) for further details. + {: .note} + - To install a specific version of OpenSearch: ```bash diff --git a/_install-and-configure/install-opensearch/helm.md b/_install-and-configure/install-opensearch/helm.md index e9f4ac63447..4e144b91f7a 100644 --- a/_install-and-configure/install-opensearch/helm.md +++ b/_install-and-configure/install-opensearch/helm.md @@ -31,7 +31,7 @@ The instructions here assume you have a Kubernetes cluster with Helm preinstalle 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. -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: +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`, following the [password requirements]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/docker/#password-requirements), as shown in the following example: ```yaml extraEnvs: diff --git a/_install-and-configure/install-opensearch/rpm.md b/_install-and-configure/install-opensearch/rpm.md index b92195dfe79..f36093416e4 100644 --- a/_install-and-configure/install-opensearch/rpm.md +++ b/_install-and-configure/install-opensearch/rpm.md @@ -44,12 +44,11 @@ This guide assumes that you are comfortable working from the Linux command line ``` {% include copy.html %} -1. From the CLI, you can install the package with `rpm` or `yum`: +1. From the CLI, you can install the package with `rpm` or `yum` + + For new installations of OpenSearch 2.12 and later, you must define a custom admin password in order to set up a demo security configuration. Use one of the following commands to define a custom admin password, following the [password requirements]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/docker/#password-requirements): ```bash - # For new installations of OpenSearch 2.12 and later, you must define a custom admin password in order to set up a demo security configuration. - # Use one of the following commands to define a custom admin password: - ## Install the x64 package using yum. sudo env OPENSEARCH_INITIAL_ADMIN_PASSWORD= yum install opensearch-{{site.opensearch_version}}-linux-x64.rpm @@ -61,9 +60,11 @@ This guide assumes that you are comfortable working from the Linux command line ## Install the arm64 package using rpm. sudo env OPENSEARCH_INITIAL_ADMIN_PASSWORD= rpm -ivh opensearch-{{site.opensearch_version}}-linux-arm64.rpm + ``` - # Use the following command for OpenSearch versions 2.11 and earlier: - + Use the following command for OpenSearch versions 2.11 and earlier: + + ```bash ## Install the x64 package using yum. sudo yum install opensearch--linux-x64.rpm diff --git a/_install-and-configure/install-opensearch/tar.md b/_install-and-configure/install-opensearch/tar.md index 1e5fe47a12d..557f4647623 100644 --- a/_install-and-configure/install-opensearch/tar.md +++ b/_install-and-configure/install-opensearch/tar.md @@ -100,7 +100,7 @@ An OpenSearch node configured by the demo security script is not suitable for a ``` {% include copy.html %} - For OpenSearch 2.12 or greater, set a new custom admin password before installation using the following command: + For OpenSearch 2.12 or greater, set a new custom admin password before installation using the following command, following the [password requirements]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/docker/#password-requirements): ```bash $ export OPENSEARCH_INITIAL_ADMIN_PASSWORD= ``` diff --git a/_install-and-configure/install-opensearch/windows.md b/_install-and-configure/install-opensearch/windows.md index ed450b4d46e..2c5f651f2ff 100644 --- a/_install-and-configure/install-opensearch/windows.md +++ b/_install-and-configure/install-opensearch/windows.md @@ -60,7 +60,7 @@ An OpenSearch node in its default configuration (with demo certificates and user {% include copy.html %} 1. Run the batch script. - For OpenSearch 2.12 or later, use the following command to specify a custom admin password: + For OpenSearch 2.12 or later, use the following command to specify a custom admin password, following the [password requirements]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/docker/#password-requirements): ```bat > set OPENSEARCH_INITIAL_ADMIN_PASSWORD= ``` diff --git a/_security/configuration/demo-configuration.md b/_security/configuration/demo-configuration.md index 98fd8c0273a..438310eafad 100644 --- a/_security/configuration/demo-configuration.md +++ b/_security/configuration/demo-configuration.md @@ -85,7 +85,7 @@ For OpenSearch 2.12 or later, set a new custom admin password before installatio ### Helm -For Helm charts, the demo configuration is automatically installed during the OpenSearch installation. For OpenSearch 2.12 or later, customize the admin password in `values.yaml` under `extraEnvs`: +For Helm charts, the demo configuration is automatically installed during the OpenSearch installation. For OpenSearch 2.12 or later, customize the admin password in `values.yaml` under `extraEnvs`, following the [password requirements]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/docker/#password-requirements): ```yaml extraEnvs: From 21a3b7b4258f9f6d97bb095b0b833b4f9020e1c6 Mon Sep 17 00:00:00 2001 From: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Date: Mon, 29 Sep 2025 14:42:04 -0400 Subject: [PATCH 2/3] Update _install-and-configure/install-opensearch/debian.md Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --- _install-and-configure/install-opensearch/debian.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_install-and-configure/install-opensearch/debian.md b/_install-and-configure/install-opensearch/debian.md index d2ce9e986eb..d88f5817cf2 100644 --- a/_install-and-configure/install-opensearch/debian.md +++ b/_install-and-configure/install-opensearch/debian.md @@ -146,7 +146,7 @@ APT, the primary package management tool for Debian–based operating systems, a ``` {% include copy.html %} - See [password requirements]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/docker/#password-requirements) for further details. + For more information, see [password requirements]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/docker/#password-requirements). {: .note} - To install a specific version of OpenSearch: From 12c641bb0a6b532540af019051a74832653af92a Mon Sep 17 00:00:00 2001 From: Nathan Bower Date: Mon, 29 Sep 2025 14:48:18 -0400 Subject: [PATCH 3/3] Apply suggestions from code review Signed-off-by: Nathan Bower --- _install-and-configure/install-opensearch/debian.md | 2 +- _install-and-configure/install-opensearch/rpm.md | 2 +- _install-and-configure/install-opensearch/tar.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/_install-and-configure/install-opensearch/debian.md b/_install-and-configure/install-opensearch/debian.md index d88f5817cf2..04a6bfc9c5d 100644 --- a/_install-and-configure/install-opensearch/debian.md +++ b/_install-and-configure/install-opensearch/debian.md @@ -146,7 +146,7 @@ APT, the primary package management tool for Debian–based operating systems, a ``` {% include copy.html %} - For more information, see [password requirements]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/docker/#password-requirements). + For more information, see the [password requirements]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/docker/#password-requirements). {: .note} - To install a specific version of OpenSearch: diff --git a/_install-and-configure/install-opensearch/rpm.md b/_install-and-configure/install-opensearch/rpm.md index f36093416e4..fe7428a5421 100644 --- a/_install-and-configure/install-opensearch/rpm.md +++ b/_install-and-configure/install-opensearch/rpm.md @@ -44,7 +44,7 @@ This guide assumes that you are comfortable working from the Linux command line ``` {% include copy.html %} -1. From the CLI, you can install the package with `rpm` or `yum` +1. From the CLI, you can install the package with `rpm` or `yum`. For new installations of OpenSearch 2.12 and later, you must define a custom admin password in order to set up a demo security configuration. Use one of the following commands to define a custom admin password, following the [password requirements]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/docker/#password-requirements): diff --git a/_install-and-configure/install-opensearch/tar.md b/_install-and-configure/install-opensearch/tar.md index 557f4647623..e6814713462 100644 --- a/_install-and-configure/install-opensearch/tar.md +++ b/_install-and-configure/install-opensearch/tar.md @@ -100,7 +100,7 @@ An OpenSearch node configured by the demo security script is not suitable for a ``` {% include copy.html %} - For OpenSearch 2.12 or greater, set a new custom admin password before installation using the following command, following the [password requirements]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/docker/#password-requirements): + For OpenSearch 2.12 or later, set a new custom admin password before installation using the following command, following the [password requirements]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/docker/#password-requirements): ```bash $ export OPENSEARCH_INITIAL_ADMIN_PASSWORD= ```