You need to install ansible on the control machine
MacOS
sudo pip install ansible
Ubuntu
sudo apt-get install software-properties-common
sudo apt-add-repository ppa:ansible/ansible
sudo apt-get update
sudo apt-get install ansible
The code is available on github
git clone git@github.com:ongair/ansible.git && cd ansible
To securely store the secret data this software uses to configure Ongair-whatsapp servers, we use ansible vault to encrypt the data.
The first thing we do here is to setup the encryption password that ansible will be using to encrypt and decrypt these variables.
echo 'strong password' >> ~/.vault_pass.txtOnce the encryption password is setup, we can now use it to encyrpt files in this folder. The secret variables are stored in the file roles/whatsapp/vars/variables.yml.
To encrypt this file, we pass the encryption password we created above to ansible-vault as below.
ansible-vault encrypt roles/whatsapp/vars/variables.yml --vault-password-file ~/.vault_pass.txtOnce encrypted the file cannot be read. If you want to edit the file you can decrypt it as follows
ansible-vault decrypt roles/whatsapp/vars/variables.yml --vault-password-file ~/.vault_pass.txtThis software configures Ubuntu servers to run Ongair whatsapp agents. To setup a new server, you will need to supply the following:
- ssh login credentials
- Hostname/IP address,
- Accounts running on the server
- The names of upstart services for each account running on the server
Each host's credentials are added inside the production file which carries inventory for all production servers.
Each host is assumed to have 1 or more whatsapp accounts and they are registered in a file named after the hostname inside the group_vars directory.
For example let's assume we want to add a new host whose IP address is 56.4.5.232 , hostname ongair-56.4.5.23 with username deploy and 3 whatsapp accounts 93939393, 83838833 and 6272644
The first thing we do is add the host to the inventory as follow
[ongair-56.4.5.232]
56.4.5.232 ansible_ssh_user=deployYou should be able to ssh to the server without requiring a password by simply typing ssh deploy@56.4.5.232.
Then we add the host to the whatsapp group (in the same inventory file) as a child
[whatsapp:children]
....
ongair-56.4.5.232Test if you can connect to the now host
ansible all -i prodution -m ping --limit ongair-56.4.5.232If the above fails, check your login credentials and make sure you have entered the host details correctly in the inventory.
We now need to add the host's account variables inside the group_vars folder.
In this case we create a file named after the hostname inside group_vars touch group_vars/ongair-56.4.5.232.
Inside that file we add the hosts variables (based on the account numbers above) as follows
agents:
- { account_number: 93939393, agent_name: ongair-93939393 }
- { account_number: 83838833, agent_name: ongair-83838833 }
- { account_number: 6272644, agent_name: ongair-6272644 }With the above setup, the new host is now part of the ongair-whatsapp inventory and we can configure it, deploy the whatsapp code to it and restart services using this ansible software.
New hosts need to be configured to run the whatsapp code. So the initial command on a new host should be to setup the server before attempting to deploy the code. To configure the above host to run the whatsapp code, you can type the following
ansible-playbook -i production setup.yml --limit ongair-56.4.5.232 --vault-password-file ~/.vault_pass.txtTo deploy the latest whatsapp code and restart all services in the new host,
ansible-playbook -i production deploy.yml --limit ongair-56.4.5.232 --vault-password-file ~/.vault_pass.txtTo run both setup and deployment procedures on the new host,
ansible-playbook -i production site.yml --limit ongair-56.4.5.232 --vault-password-file ~/.vault_pass.txt ansible-playbook -i production deploy.yml --vault-password-file ~/.vault_pass.txtansible-playbook -i trial updatetrial.yml --vault-password-file ~/.vault_pass.txtThe Ongair ansible allows you to carry out the above tasks and more but via a http API instead of just the command line. The API at the moment has five endpoints:
/trial?number=<number>Allows you to automatically add a new number to the trial server/production?number=<number>Allows to automatically spin up a new production instance and add a new number to it./list- Lists all available Ongair Production Servers/restart?instanceid=<instanceid>- Allows you to reload an instance/stop?insanceid=<instanceid>Allows you to terminate a production instance
To add a number to the trial server, just call the trial endpoint with the number as a paramater. For example to add 0123456789 to trial we just make a GET request to the trial endpoint as follows http://54.229.156.41/trial?number=0123456789
This adds the number to the trial server and returns with a response in this format
{
status: 200,
agent_name: "ongair-0123456789",
number: "0123456789",
message: "successfully added 0123456789 to trial",
data: {
52.18.43.161: {
unreachable: 0,
skipped: 0,
ok: 4,
changed: 2,
failures: 0
}
},
time_taken: "3.14 seconds"
}
To add a number to the production, the API initiates a process of launching a new Ongair server based on the ongair whatsapp image then runs the playbook to install the latest version of whatsapp code and ads the number to the server. To do this you simply send a request to the production endpoint with the number as a paramater. For example to add 0123456789 to production we just make a GET request as follows http://54.229.156.41/production?number=0123456789
This request takes longer at the moment which causes the browser to timeout but optimization is on the way.
If all goes well you should get a response in this format
{
"data": {
"54.229.156.41": {
"changed": 2,
"failures": 0,
"ok": 6,
"skipped": 0,
"unreachable": 0
},
"host": "54.229.156.41",
"message": "success",
"number": "0123456789",
"status": 200,
"time_taken": 119.52
}
To list all production servers, send a request to the endpoint http://54.229.156.41/list This list all available servers in this format.
{
count: 3,
instances: [
{
image_id: "ami-1a8b0b69",
instance_id: "i-9496e61c",
instance_name: "Ongair-8383938338",
instance_type: "t2.micro",
key_name: "ongair-shared",
launch_time: "Tue, 05 Apr 2016 14:10:31 GMT",
private_ip: "172.31.9.199",
public_dns_name: "ec2-52-49-214-14.eu-west-1.compute.amazonaws.com",
public_ip: "52.49.214.14",
state: "running"
},
{
image_id: "ami-b0c379c3",
instance_id: "i-af7b0e27",
instance_name: "Ongair-trial-test",
instance_type: "t2.micro",
key_name: "ongair-shared",
launch_time: "Fri, 01 Apr 2016 14:30:50 GMT",
private_ip: "172.31.6.17",
public_dns_name: "ec2-52-18-43-161.eu-west-1.compute.amazonaws.com",
public_ip: "52.18.43.161",
state: "running"
},
......
To stop an instance, send a request with the instanceid as follows;
http://54.229.156.41/stop?instanceid=i-9496e61c. This initiates the instance shutdown and sends back this response
{
InstanceId: "i-9496e61c",
CurrentState: {
Code: 64,
Name: "stopping"
},
PreviousState: {
Code: 16,
Name: "running"
}
}
To reboot an instance, send a request with the instanceid as follows;
http://54.229.156.41/restart?instanceid=i-9496e61c. This initiates the instance reboot and sends back this response
{
status: 200,
instanceid: "i-cc99e944",
message: "Rebooting Instance",
response: {
ResponseMetadata: {
HTTPStatusCode: 200,
RequestId: "ed3d77dd-ab37-4270-a334-9e449e49bf95"
}
}
}