ansible_project

Example: running an Ansible project

This example shows how to run an Ansible playbook using Concord.

Playbook's repository

Create a git repository of the following structure:

playbook/
  hello.yml

The hello.yml playbook consists of a simple debug task:

---
- hosts: local
  tasks:
  - debug:
      msg: "{{ greeting }}"
      verbosity: 0

Commit and push the repository to a remote server (e.g. GitHub). If you are using SSH, a new SSH key pair will created on the step 2 - you will need access to the repository settings to add a new public key.

Concord project

Before we create our own user, all requests are perfomed using the default admin API key. This example assumes that the ansible template is already uploaded to the server.

1. Create a new repository key

Use mySecret as a name of the key pair, it will be used on the next step.

2. Create a new Concord project

We are going to create a new project using the ansible project template. The ansible template will automatically add the necessary boilerplate - a workflow process definition to run our playbook and necessary runtime dependencies.

curl -v \
-H "Content-Type: application/json" \
-H "Authorization: API_TOKEN" \
-d '{ "name": "myProject", "cfg": { "template": "ansible" }, "repositories": { "myRepo": {"url": "[email protected]:my/repo.git", "secret": "mySecret" } } }' \
http://localhost:8001/api/v1/org/Default/project

The secret parameters is the name of the key created on the step 2.

{
  "ok": true
}

4. Add a new user (optional)

curl -v \
-H "Content-Type: application/json" \
-H "Authorization: API_TOKEN" \
-d '{ "username": "myUser" }' \
http://localhost:8001/api/v1/user

{
    "ok": true,
    "id": "9458c42e-db11-11e6-8356-07c51e4e3ef5"
}

5. Create an API key (optional)

Use the username value of the user created in the previous step.

curl -v \
-H "Content-Type: application/json" \
-H "Authorization: API_TOKEN" \
-d '{ "username": "myUser" }' \
http://localhost:8001/api/v1/apikey

{
    "ok": true,
    "key": "API_TOKEN"
}

The key value can be used for further access to the API, e.g. to start a process.

6. Start a process

Create the inventory.ini file:

[local]
127.0.0.1

[local:vars]
ansible_connection=local

Create the request.json file:

{
  "playbook": "playbook/hello.yml",
  "extraVars": {
    "greeting": "Hello, world"
  }
}

Make a call:

curl -v \
-H "Authorization: API_TOKEN" \
-F org=Default \
-F project=myProject \
-F repo=myRepo \
-F [email protected] \
-F [email protected] \
http://localhost:8001/api/v1/process

{
    "ok": true,
    "instanceId": "33c8f91e-db14-11e6-8d94-a3efec7ccd7b"
}

7. Check the logs (optional)

Use the instanceId value returned by the server in the previous step.

curl -v http://localhost:8001/logs/33c8f91e-db14-11e6-8d94-a3efec7ccd7b.log

8. Get Ansible's statistics (optional)

You can download Ansible play's statistics with this request:

curl -v \
-H "Authorization: API_TOKEN" \
http://localhost:8001/api/v1/process/33c8f91e-db14-11e6-8d94-a3efec7ccd7b/attachment/ansible_stats.json

Example of response:

{
  "failures": [], 
  "skipped": [], 
  "changed": [], 
  "ok": [
    "127.0.0.1"
  ], 
  "unreachable": []
}