Add missing OPENSEARCH_INITIAL_ADMIN_PASSWORD for both apt/deb and yu…

…m/rpm (#7079) * Add missing OPENSEARCH_INITIAL_ADMIN_PASSWORD for apt install on debian.md This page's install command when installing via rep package is missing `OPENSEARCH_INITIAL_ADMIN_PASSWORD` Signed-off-by: Drew Miranda <[email protected]> * More update on deb and rpm installation steps on 2.12 security changes Signed-off-by: Peter Zhu <[email protected]> * Move 2.12 top Signed-off-by: Peter Zhu <[email protected]> * fix formatting Signed-off-by: Peter Zhu <[email protected]> * More tweaks Signed-off-by: Peter Zhu <[email protected]> * More tweaks 2 Signed-off-by: Peter Zhu <[email protected]> * Update _install-and-configure/install-opensearch/debian.md Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Peter Zhu <[email protected]> * Update _install-and-configure/install-opensearch/debian.md Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Peter Zhu <[email protected]> * Update _install-and-configure/install-opensearch/debian.md Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Peter Zhu <[email protected]> * Update _install-and-configure/install-opensearch/debian.md Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Peter Zhu <[email protected]> * Update _install-and-configure/install-opensearch/debian.md Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Peter Zhu <[email protected]> * Update _install-and-configure/install-opensearch/rpm.md Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Peter Zhu <[email protected]> * Update _install-and-configure/install-opensearch/rpm.md Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Peter Zhu <[email protected]> * Update _install-and-configure/install-opensearch/rpm.md Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Peter Zhu <[email protected]> * Update _install-and-configure/install-opensearch/rpm.md Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Peter Zhu <[email protected]> * Update _install-and-configure/install-opensearch/rpm.md Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Peter Zhu <[email protected]> * Update _install-and-configure/install-opensearch/rpm.md Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Peter Zhu <[email protected]> * Update _install-and-configure/install-opensearch/rpm.md Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Peter Zhu <[email protected]> * Add more things Signed-off-by: Peter Zhu <[email protected]> * Add more things Signed-off-by: Peter Zhu <[email protected]> * Update _install-and-configure/install-opensearch/debian.md Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Peter Zhu <[email protected]> --------- Signed-off-by: Drew Miranda <[email protected]> Signed-off-by: Peter Zhu <[email protected]> Co-authored-by: Peter Zhu <[email protected]> Co-authored-by: Nathan Bower <[email protected]> (cherry picked from commit 4f2a458) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-project · May 6, 2024 · 4e0fba9 · 4e0fba9
1 parent 42b1f15
commit 4e0fba9
Show file tree

Hide file tree

Showing 2 changed files with 51 additions and 23 deletions.
diff --git a/_install-and-configure/install-opensearch/debian.md b/_install-and-configure/install-opensearch/debian.md
@@ -37,21 +37,23 @@ This guide assumes that you are comfortable working from the Linux command line
 ### Install OpenSearch from a package
 
 1. Download the Debian package for the desired version directly from the [OpenSearch downloads page](https://opensearch.org/downloads.html){:target='\_blank'}. The Debian package can be downloaded for both **x64** and **arm64** architectures.
-1. From the CLI, install using `dpkg`.
+1. From the CLI, install the package using `dpkg`:
+
+   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:
    ```bash
    # x64
-   sudo dpkg -i opensearch-{{site.opensearch_version}}-linux-x64.deb
+   sudo env OPENSEARCH_INITIAL_ADMIN_PASSWORD=<custom-admin-password> dpkg -i opensearch-{{site.opensearch_version}}-linux-x64.deb
 
    # arm64
-   sudo dpkg -i opensearch-{{site.opensearch_version}}-linux-arm64.deb
+   sudo env OPENSEARCH_INITIAL_ADMIN_PASSWORD=<custom-admin-password> dpkg -i opensearch-{{site.opensearch_version}}-linux-arm64.deb
    ```
-   For OpenSearch 2.12 and greater, a custom admin password is required in order to set up a security demo configuration.  To set a custom admin password, use one the following commands:
+   Use the following command for OpenSearch versions 2.11 and earlier:
    ```bash
    # x64
-   sudo env OPENSEARCH_INITIAL_ADMIN_PASSWORD=<custom-admin-password> dpkg -i opensearch-{{site.opensearch_version}}-linux-x64.deb
+   sudo dpkg -i opensearch-{{site.opensearch_version}}-linux-x64.deb
 
    # arm64
-   sudo env OPENSEARCH_INITIAL_ADMIN_PASSWORD=<custom-admin-password> dpkg -i opensearch-{{site.opensearch_version}}-linux-arm64.deb
+   sudo dpkg -i opensearch-{{site.opensearch_version}}-linux-arm64.deb
    ```
 
 1. After the installation succeeds, enable OpenSearch as a service.
@@ -136,14 +138,27 @@ APT, the primary package management tool for Debian–based operating systems, a
 
 1. Choose the version of OpenSearch you want to install: 
    - Unless otherwise indicated, the latest available version of OpenSearch is installed.
+
    ```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:
+   sudo env OPENSEARCH_INITIAL_ADMIN_PASSWORD=<custom-admin-password> apt-get install opensearch
+
+   # Use the following command for OpenSearch versions 2.11 and earlier:
    sudo apt-get install opensearch
    ```
    {% include copy.html %}
 
    - To install a specific version of OpenSearch:
+
    ```bash
    # Specify the version manually using opensearch=<version>
+
+   # 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:
+   sudo env OPENSEARCH_INITIAL_ADMIN_PASSWORD=<custom-admin-password> apt-get install opensearch={{site.opensearch_version}}
+
+   # Use the following command for OpenSearch versions 2.11 and earlier:
    sudo apt-get install opensearch={{site.opensearch_version}}
    ```
 

diff --git a/_install-and-configure/install-opensearch/rpm.md b/_install-and-configure/install-opensearch/rpm.md
@@ -44,36 +44,37 @@ This guide assumes that you are comfortable working from the Linux command line
     ```
     {% include copy.html %}
 
-1. For OpenSearch 2.12 and greater, a custom admin password is required in order to set up a security demo configuration. To set a custom admin password, use one the following commands:
+1. From the CLI, you can install the package with `rpm` or `yum`:
 
    ```bash
-   # Install the x64 package using 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:
+
+   ## Install the x64 package using yum.
    sudo env OPENSEARCH_INITIAL_ADMIN_PASSWORD=<custom-admin-password> yum install opensearch-{{site.opensearch_version}}-linux-x64.rpm
    
-   # Install the x64 package using rpm.
+   ## Install the x64 package using rpm.
    sudo env OPENSEARCH_INITIAL_ADMIN_PASSWORD=<custom-admin-password> rpm -ivh opensearch-{{site.opensearch_version}}-linux-x64.rpm
    
-   # Install the arm64 package using yum.
-   sudo env OPENSEARCH_INITIAL_ADMIN_PASSWORD=<custom-admin-password> yum install opensearch-{{site.opensearch_version}}-linux-x64.rpm
+   ## Install the arm64 package using yum.
+   sudo env OPENSEARCH_INITIAL_ADMIN_PASSWORD=<custom-admin-password> yum install opensearch-{{site.opensearch_version}}-linux-arm64.rpm
    
-   # Install the arm64 package using rpm.
-   sudo env OPENSEARCH_INITIAL_ADMIN_PASSWORD=<custom-admin-password> rpm -ivh opensearch-{{site.opensearch_version}}-linux-x64.rpm
-   ```
+   ## Install the arm64 package using rpm.
+   sudo env OPENSEARCH_INITIAL_ADMIN_PASSWORD=<custom-admin-password> rpm -ivh opensearch-{{site.opensearch_version}}-linux-arm64.rpm
    
-1. From the CLI, you can install the package with `rpm` or `yum`.
+   # Use the following command for OpenSearch versions 2.11 and earlier:
 
-   ```bash
-   # Install the x64 package using yum.
+   ## Install the x64 package using yum.
    sudo yum install opensearch-{{site.opensearch_version}}-linux-x64.rpm
 
-   # Install the x64 package using rpm.
+   ## Install the x64 package using rpm.
    sudo rpm -ivh opensearch-{{site.opensearch_version}}-linux-x64.rpm
 
-   # Install the arm64 package using yum.
-   sudo yum install opensearch-{{site.opensearch_version}}-linux-x64.rpm
+   ## Install the arm64 package using yum.
+   sudo yum install opensearch-{{site.opensearch_version}}-linux-arm64.rpm
 
-   # Install the arm64 package using rpm.
-   sudo rpm -ivh opensearch-{{site.opensearch_version}}-linux-x64.rpm
+   ## Install the arm64 package using rpm.
+   sudo rpm -ivh opensearch-{{site.opensearch_version}}-linux-arm64.rpm
    ```
 
 1. After the installation succeeds, enable OpenSearch as a service.
@@ -125,15 +126,27 @@ YUM, the primary package management tool for Red Hat–based operating systems,
    ```
    {% include copy.html %}
 
-1. Choose the version of OpenSearch you want to install: 
+1. Choose the version of OpenSearch you want to install:
    - Unless otherwise indicated, the latest available version of OpenSearch is installed.
+
    ```bash
+   # For OpenSearch versions 2.12 and later, a custom admin password is required in order to set up a demo security configuration for a new installation.
+   # To set a custom admin password, use the following commands:
+   sudo env OPENSEARCH_INITIAL_ADMIN_PASSWORD=<custom-admin-password> yum install opensearch
+
+   # Use the following command for OpenSearch versions 2.11 and earlier:
    sudo yum install opensearch
    ```
    {% include copy.html %}
 
    - To install a specific version of OpenSearch:
+
    ```bash
+   # For OpenSearch versions 2.12 and later, a custom admin password is required in order to set up a demo security configuration for a new installation.
+   # To set a custom admin password, use the following commands:
+   sudo env OPENSEARCH_INITIAL_ADMIN_PASSWORD=<custom-admin-password> yum install 'opensearch-{{site.opensearch_version}}'
+
+   # Use the following command for OpenSearch versions 2.11 and earlier:
    sudo yum install 'opensearch-{{site.opensearch_version}}'
    ```
    {% include copy.html %}