Page Comparison

Ansible is a tool used to automate software provisioning, configuration management, and application deployment. It offers several advantages over other IT automation tools similar to it; It's minimal in nature, you don't need to install anything on the servers you're deploying to (except Python 2).

...

To easily manage (deploy new instances of or update) your OpenSRP, Keycloak, OpenMRS, and DHIS2 servers you would require Ansible to automate the deployment process.  Therefore the opensrp-playbooks provided here are meant to facilitate the process. All you need to do is clone the opensrp-playboks repository and then define your inventories based on your DevOps clients and development environments(staging, production or preview) and then run the playbooks to install the servers. The repository uses Ansible's recommended alternative directory layout.

For local "dev" deployments, you will need to install Virtualbox. You'll as well need the vault password used to encrypt sensitive info inside the sample inventory available in the repo. You will also need to create host_vars and group_vars to match your setup.

...

1. Create an sudo user (user with admin rights) called ubuntu and ensure that the user has NOPASSWDconfig on the `/etc/sudoers` (you can refer to the command used below on Vagrant #3).

2. On the host you have to install openssh-server to enable ssh connections and make it possible to ssh using the root account otherwise you will need an account with administrative privileges to run the playbooks.

   On Ubuntu or any debian disto you can install it using this command

   Code Block
   $ sudo apt install openssh-server

3. Finally ensure you can access the server though ssh ubuntu@vm-ip-address (You can get the vm-ip-address of the VM by running ifconfig on the host terminal). If it requests for password kindly disable it by

   Code Block
   $ sudo sed -i 's/prohibit-password/yes/' /etc/ssh/sshd_config $ sudo service ssh restart

• Vagrant: 

    Vagrant is a tool for building and managing virtual machine environments in a single workflow. You can download it from here. Below is a Vagrantfile that can get you up and running.

# -*- mode: ruby -*-
# vi: set ft=ruby :
# All Vagrant configuration is done below. The "2" in Vagrant.configure
# configures the configuration version (we support older styles for
# backwards compatibility). Please don't change it unless you know what
# you're doing.
Vagrant.configure("2") do |config|  
	config.vm.box = "hashicorp/bionic64"  
	config.vm.network "private_network", ip: "192.168.33.13" #replace with any private ip available 
  	config.vm.provision "shell", inline: <<-SHELL
		apt-get update    
		apt-get install -y cloud-init python3 python3-psycopg2    
		useradd -s /bin/bash -m -p $(openssl passwd -1 <specify-password-for-ubuntu-user>) ubuntu  #1    
		usermod -s /bin/bash -aG sudo ubuntu                             #2
		sudo sed -i -e '$a\\ubuntu  ALL=(ALL) NOPASSWD:ALL' /etc/sudoers #3
    	SHELL
end

...

$ ssh-copy-id -i ~/.ssh/id_rsa.pub ubuntu@vm-ip-address

or login to the server add and add your ssh key.

If you do not have the ssh keys you can generate one by running the below first:

...

1. Git clone the opensrp-playbooks from this link OpenSrp playbooks. Then switch directory to opensrp-playbooks you just cloned.

   Code Block
   $ git clone --recursive git@github.com:opensrp/playbooks.git && cd playbooks

2. Setup a python virtual environment:

   1. Kindly follow the steps here. 

   2. Create a virtual environment called opensrp.

   3. Switch to opensrp environment by typing:

      1. Code Block
         $ workon opensrp

      2. Add the following line to the end of ~/.bashrc of your machine ... Ensure you update <python-version> with version of python running on you machine.

         1. Code Block
            export ANSIBLE_STRATEGY_PLUGINS=~/.virtualenvs/opensrp/lib/python<python-version>/site-packages/ansible_mitogen/plugins/strategy #Update <python-version>

      3. Run the following command while on the virtual environment

         1. Code Block
            $ python --version

            confirm that your active python version is 3

         2. Code Block
            $ pip install -r requirements/base.pip

         3. Code Block
            $ ansible-galaxy role install -r requirements/ansible-galaxy.yml -p ~/.ansible/roles/opensrp

         4. Code Block
            $ ansible-galaxy collection install -r requirements/ansible-galaxy.yml -p ~/.ansible/collections/opensrp

            Opensrp-playbooks requires some modules from ansible-galaxy. The modules are specified in the requirements.yml file. Refer to this link for more information on ansible-galaxy : ansible-galaxy documentation

            You need to run the two commands above before running any playbooks to install the required modules..

3. If you have not created the inventory yet kindly execute the commands below on the root of opensrp-playbooks directory.

   1. $ ./scripts/new_inventory.sh opensrp-app-servers demo staging

      Code Block
      $ ./scripts/new_inventory.sh opensrp-app-servers demo staging

   2. $ ./scripts/new_inventory.sh openmrs-app-servers demo staging (optional  if keycloak is used)

      Code Block
      $ ./scripts/new_inventory.sh openmrs-app-servers demo staging

   3. $ ./scripts/new_inventory.sh mysql demo staging

      Code Block
      $ ./scripts/new_inventory.sh mysql demo staging

   4. $ ./scripts/new_inventory.sh all demo staging

      Code Block
      $ ./scripts/new_inventory.sh all demo staging

   5. $ ./scripts/new_inventory.sh opensrp-redis-servers demo staging

      Code Block
      $ ./scripts/new_inventory.sh opensrp-redis-servers demo staging

   6. $ ./scripts/new_inventory.sh opensrp-postgresql-servers demo staging

      Code Block
      $ ./scripts/new_inventory.sh opensrp-postgresql-servers demo staging

   7. $ ./scripts/new_inventory.sh keycloak-app-servers demo staging (optional if openmrs is used)

      Code Block
      $ ./scripts/new_inventory.sh keycloak-app-servers demo staging

4. Add the host_vars directory and hosts file from the following directory: sample-inventories/inventory-a

5. Update the host_varsvars.yml file with your  VMs ip, as below:

   1. ansible_host: "<vm-ip-address>"

6. Finally add files directory with a pgp directory containing gpg keys like so:

...