# Ansible Variables

### Overview <a href="#overview" id="overview"></a>

Ansible is the configuration management system used in Sunbird. The infrastructure setup, deployment of services and other configurations is handled primarily through ansible.

#### Updating the Private Repository with Hosts and Variables <a href="#updating-the-private-repository-with-hosts-and-variables" id="updating-the-private-repository-with-hosts-and-variables"></a>

Execute the following commands in your local to clone the private repo template and update your private GitHub repository -

```bash
git clone https://github.com/project-sunbird/sunbird-devops
cd sunbird-devops
git checkout tags/release-5.1.0 -b release-5.1.0
```

* Copy the directory `sunbird-devops/private_repo/ansible` to your private repo local workspace
* Run the `key-generate.sh` script located under `ansible/inventory/dev` folder. The script will ask for the ansible vault password. Enter the same vault password that you used in the Jenkins setup stage. The script will generate many private key files and they will be encrypted with the vault password. Deployments will fail if keys are not encrypted.
* Update the files **common.yml**, **hosts**, and **secrets.yml** under **Core**, **KnowledgePlatform** and **DataPipeline** directories. After updating, push them to your private repo branch
* Your private repo structure starting from the root path should be as shown below

```bash
  ansible
└── inventory
    └── dev
        ├── Core
        │   ├── common.yml
        │   ├── hosts
        │   └── secrets.yml
        ├── Kubernetes
        │   ├── common.yml   (soft link to Core directory files)
        │   ├── hosts.       (soft link to Core directory files)
        │   └── secrets.yml  (soft link to Core directory files)
        ├── DataPipeline
        │   ├── common.yml
        │   ├── hosts
        │   └── secrets.yml
        └── KnowledgePlatform
            ├── common.yml
            ├── hosts
            └── secrets.yml
```

**Neo4j download and upload to object storage**

* Neo4j community artifact needs to be downloaded from neo4j official website <http://dist.neo4j.org/neo4j-community-3.3.9-unix.tar.gz> (only Neo4j 3.4 and below is supported)
* Upload downloaded artifact to `cloud_storage_artifacts_bucketname`
* Update `neo4j_zip` variable with artifact name `Eg: neo4j-community-3.3.9-unix.tar.gz`

> Note:
>
> * The ansible inventory setup is a must before we can start to run jobs from the **Provision**, **ArtifactUpload** and **Deploy** directory in Jenkins. The **Build** directory on Jenkins does not depend on the ansible variables
> * It is highly recommended that you complete the ansible inventory updates before proceeding further

#### List of Servers with their Ansible Group Names <a href="#list-of-servers-with-their-ansible-group-names" id="list-of-servers-with-their-ansible-group-names"></a>

<table><thead><tr><th width="178">Module</th><th width="139">Servers</th><th width="151">Service</th><th>Ansible Group Names</th></tr></thead><tbody><tr><td>Build and Deploy</td><td>Server-1</td><td>Jenkins Master</td><td></td></tr><tr><td>Databases</td><td>Server-2</td><td>Cassandra</td><td>cassandra-1, lp-cassandra, dp-cassandra, core-cassandra, report-cassandra, cassandra-node-1, cassandra</td></tr><tr><td></td><td></td><td>Postgres</td><td>postgresql-master-1, postgresql-master, postgres</td></tr><tr><td></td><td></td><td>Application Elasticsearch</td><td>es-1, composite-search-cluster, core-es-1, core-es, es-backup, es</td></tr><tr><td></td><td></td><td>Neo4j</td><td>learning-neo4j-node1, learning-neo4j-cluster</td></tr><tr><td></td><td></td><td>Mongo</td><td>mongo_master, mongo</td></tr><tr><td>Knowledge Platform</td><td>Server-3</td><td>Redis</td><td>redis1, redis, redis-ps, redisall, lp-redis, lp-redis-ps, dp-redis, lms-redis, redis-exporter-targets</td></tr><tr><td></td><td></td><td>Zookeeper</td><td>processing-cluster-zookeepers, ingestion-cluster-zookeeper, raw-zookeeper, zookeeper</td></tr><tr><td></td><td></td><td>Kafka</td><td>processing-cluster-kafka, ingestion-cluster-kafka, kafka-1, kafka</td></tr><tr><td>Data Pipeline</td><td>Server-4</td><td>Spark</td><td>spark</td></tr><tr><td></td><td></td><td>Kafka Indexer (Logstash)</td><td>kafka-indexer</td></tr><tr><td></td><td></td><td>InfluxDB</td><td>influxdb</td></tr><tr><td></td><td></td><td>Keycloak</td><td>keycloak-1, keycloak</td></tr><tr><td>Learning</td><td>Server-5</td><td>Learning</td><td>learning1, learning, learningall</td></tr><tr><td></td><td></td><td>Graylog</td><td>graylog-1, graylog</td></tr><tr><td>Druid</td><td>Server-6</td><td>Druid</td><td>druid-postgres, raw-coordinator, raw-overlord, raw-broker, raw-historical, raw-middlemanager, raw-graphite, rollup-coordinator, dp-druid-broker, broker, coordinator, druid-raw</td></tr><tr><td></td><td></td><td>Logs Elasticsearch</td><td>log-es-1, log-es-backup, log-es</td></tr><tr><td></td><td></td><td></td><td></td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://ed.sunbird.org/older-versions/use/installing-ed-platform/release-5.1.0/ansible-variables.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.