Skip to content

Commit

Permalink
Updates README to reflect strong password requirements for admin user (
Browse files Browse the repository at this point in the history
…#151)

* Updates README to reflect strong password requirements for admin user

Signed-off-by: Darshit Chanpura <[email protected]>

* Applies PR feedback

Signed-off-by: Darshit Chanpura <[email protected]>

---------

Signed-off-by: Darshit Chanpura <[email protected]>
  • Loading branch information
DarshitChanpura authored Feb 2, 2024
1 parent 7134a8c commit d1a1af0
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
<img src="https://opensearch.org/assets/brand/SVG/Logo/opensearch_logo_default.svg" height="64px"/>

- [OpenSearch Project Ansible-Playbook](#helm-charts)
- [OpenSearch Installation with Dashboards](opensearch-installation-with-dashboards)
- [OpenSearch Project Ansible-Playbook](#opensearch-project-ansible-playbook)
- [Version and Branching](#version-and-branching)
- [OpenSearch Installation with Dashboards](#opensearch-installation-with-dashboards)
- [Prerequisite](#prerequisite)
- [Configure](#configure)
- [Multi-node Installation](#multi-node-installation)
- [Single Node Installation](#single-node-installation)
- [Install](#install)
- [OpenID authentification](#openid-authentification)
- [Custom configuration files](#custom-configuration-files)
- [IaC (Infrastructure-as-Code)](#iac-infrastructure-as-code)
- [Contributing](#contributing)
- [Getting Help](#getting-help)
- [Code of Conduct](#code-of-conduct)
Expand Down Expand Up @@ -95,17 +104,19 @@ cluster_type: single-node


# Deploy with ansible playbook - run the playbook as root
ansible-playbook -i inventories/opensearch/hosts opensearch.yml --extra-vars "admin_password=Test@123 kibanaserver_password=Test@6789 logstash_password=Test@456"
ansible-playbook -i inventories/opensearch/hosts opensearch.yml --extra-vars "admin_password=myStrongPassword@123! kibanaserver_password=Test@6789 logstash_password=Test@456"

You should set the reserved users(`admin`, `kibanaserver`, and `logstash`) password using `admin_password`, `kibanaserver_password`, and `logstash_password` variables.

**Note**: Starting OpenSearch 2.12, a strong password is required for `admin` user, i.e. `myStrongPassword123!`. The cluster will fail to start with a weak password (i.e. admin) or no password.

If you define your own internal users (in addition to the reserved `admin`, `kibanaserver`, and `logstash`) in custom configuration
files, then passwords to them should be set via variables on the principle of `<username>_password`

It will install and configure the opensearch. Once the deployment completed, you can access the opensearch Dashboards with user `admin` and password which you provided for variable `admin_password`.

# Deploy with ansible playbook - run the playbook as non-root user which have sudo privileges,
ansible-playbook -i inventories/opensearch/hosts opensearch.yml --extra-vars "admin_password=Test@123 kibanaserver_password=Test@6789 logstash_password=Test@456" --become
ansible-playbook -i inventories/opensearch/hosts opensearch.yml --extra-vars "admin_password=myStrongPassword@123! kibanaserver_password=Test@6789 logstash_password=Test@456" --become

**Note**: Change the user details in `ansible_user` parameter in `inventories/opensearch/hosts` inventory file.

Expand Down

0 comments on commit d1a1af0

Please sign in to comment.