Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updates README to reflect strong password requirements for admin user #151

Merged
merged 2 commits into from
Feb 2, 2024
Merged

Updates README to reflect strong password requirements for admin user #151

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
31c66b5
Updates README to reflect strong password requirements for admin user
DarshitChanpura Feb 2, 2024
bfb5578
Applies PR feedback
DarshitChanpura Feb 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions README.md
View file
Open in desktop
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