Added Ansible playbook docs
This commit is contained in:
parent
380a209ffa
commit
95dc1be29c
|
@ -9,14 +9,14 @@ nav_order: 60
|
||||||
|
|
||||||
You can use an Ansible playbook to install and configure a production-ready OpenSearch cluster along with OpenSearch Dashboards.
|
You can use an Ansible playbook to install and configure a production-ready OpenSearch cluster along with OpenSearch Dashboards.
|
||||||
|
|
||||||
The Ansible playbook only supports deployment of OpenSearch / OpenSearch Dashboards to CentOS7 hosts.
|
The Ansible playbook only supports deployment of OpenSearch and OpenSearch Dashboards to CentOS7 hosts.
|
||||||
{: .note }
|
{: .note }
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
Make sure you have [Ansible](https://www.ansible.com/) and [Java 8](https://www.java.com/en/download/manual.jsp) installed.
|
Make sure you have [Ansible](https://www.ansible.com/) and [Java 8](https://www.java.com/en/download/manual.jsp) installed.
|
||||||
|
|
||||||
## Run OpenSearch and OpenSearch Dashboards using Ansible playbook
|
## Configuration
|
||||||
|
|
||||||
1. Clone the OpenSearch [ansible-playbook](https://github.com/opensearch-project/ansible-playbook) repository:
|
1. Clone the OpenSearch [ansible-playbook](https://github.com/opensearch-project/ansible-playbook) repository:
|
||||||
|
|
||||||
|
@ -24,32 +24,39 @@ Make sure you have [Ansible](https://www.ansible.com/) and [Java 8](https://www.
|
||||||
git clone https://github.com/opensearch-project/ansible-playbook
|
git clone https://github.com/opensearch-project/ansible-playbook
|
||||||
```
|
```
|
||||||
|
|
||||||
|
2. Configure the node properties in the `inventories/opensearch/hosts` file:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ansible_host=<Public IP address> ansible_user=root ip=<Private IP address / 0.0.0.0>
|
||||||
|
```
|
||||||
|
|
||||||
|
where:
|
||||||
|
|
||||||
|
- `ansible_host` is the IP address of the target node that you want the Ansible playbook to install OpenSearch and OpenSearch DashBoards on.
|
||||||
|
- `ip` is the IP address that you want OpenSearch and OpenSearch DashBoards to bind to. You can specify the private IP of the target node, or localhost, or 0.0.0.0.
|
||||||
|
|
||||||
|
3. You can modify the default configuration values in the `inventories/opensearch/group_vars/all/all.yml` file. For example, you can increase the Java memory heap size:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
xms_value: 8
|
||||||
|
xmx_value: 8
|
||||||
|
```
|
||||||
|
|
||||||
|
Make sure you have direct SSH access into the root user of the target node.
|
||||||
|
{: .note }
|
||||||
|
|
||||||
|
## Run OpenSearch and OpenSearch Dashboards using Ansible playbook
|
||||||
|
|
||||||
1. Run the Ansible playbook with root privileges:
|
1. Run the Ansible playbook with root privileges:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
ansible-playbook -i inventories/opensearch/hosts opensearch.yml --extra-vars "admin_password=Test@123 opensearch-dashboards-server_password=Test@6789"
|
ansible-playbook -i inventories/opensearch/hosts opensearch.yml --extra-vars "admin_password=Test@123 kibanaserver_password=Test@6789"
|
||||||
```
|
```
|
||||||
|
|
||||||
You can set the passwords for the reserved users (`admin` and `opensearch-dashboards-server`) using the `admin_password` and `opensearch-dashboards-server_password` variables.
|
You can set the passwords for reserved users (`admin` and `kibanaserver`) using the `admin_password` and `kibanaserver_password` variables.
|
||||||
|
|
||||||
1. After the deployment process is complete, you can access OpenSearch / OpenSearch Dashboards with username `admin` and the password that you set for the `admin_password` variable.
|
2. After the deployment process is complete, you can access OpenSearch and OpenSearch Dashboards with the username `admin` and the password that you set for the `admin_password` variable:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
curl -XGET https://localhost:9200 -u 'admin:Test@123' --insecure
|
curl https://localhost:9200 -u 'admin:Test@123' --insecure
|
||||||
```
|
```
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
You can modify the default configuration values in the `inventories/opensearch/group_vars/all/all.yml` file.
|
|
||||||
For example, you can increase the Java memory heap size:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
xms_value: 8
|
|
||||||
xmx_value: 8
|
|
||||||
```
|
|
||||||
|
|
||||||
You can configure node properties in the `inventories/opensearch/hosts` file. Specify the IP addresses of the nodes that you want the Ansible playbook to connect to with the `ansible_host` property:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
ansible_host=<Public IP address> ansible_user=root ip=<Private IP address / 0.0.0.0>
|
|
||||||
```
|
|
||||||
|
|
Loading…
Reference in New Issue