Skip to content

Latest commit

 

History

History
271 lines (234 loc) · 7.54 KB

README.md

File metadata and controls

271 lines (234 loc) · 7.54 KB
Raw

Sanity Units License

Ansible Inventory Plugin for Arvan Cloud

This collection provides a inventory plugin for Arvan Iaas servers .

Installation

ansible-galaxy collection install git+https://github.com/arvancloud/ar-iaas-ansible.git

Requirements

  • ansible version >= 2.9

Usage

You need a inventory file which its name ends with 'arvan.yml' or 'arvan.yaml' and this file must at least contains plugin option :

# use namespace.collection-name.plugin-name
plugin: arvancloud.iaas.arvan

Also you need enable this plugin in ansible.cfg

[inventory]
enable_plugins=arvancloud.iaas.arvan

And you need to add API key from your arvan account to inventory file:

plugin: arvancloud.iaas.arvan
api_key: Apikey 01234567-9abc-def0-1234-56789abcdef0

Or in ini file:

[default]
key=Apikey 01234567-9abc-def0-1234-56789abcdef0

This plugin will look for ini file in this order:

  • File specified by api_account module parameter or environment variable ARVAN_API_CONFIG
  • arvan.ini file located in current working directory
  • $HOME/.arvan.ini

A example of ini file:

[default]
key=Apikey 01234567-9abc-def0-1234-56789abcdef0
timeout=20
max_tries=2
retry_max_delay=1

[account1]
key=Apikey 01234567-9abc-def0-1234-56789abcdef1
timeout=5

If ARVAN_API_ACCOUNT environment variable or api_account module parameter is not specified, this plugin will look for the section named "default"

Plugin options

Host variables

Here is an example of host variables which this plugin returns

New host variables can be composed by compose option in inventory file

An Example

Assuming you already installed ansible, Download collection :

$ ansible-galaxy collection install git+https://github.com/arvancloud/ar-iaas-ansible.git -p collections

Create ansible.cfg:

$ cat <<EOF > ansible.cfg
[defaults]
host_key_checking=false

[inventory]
enable_plugins=arvancloud.iaas.arvan

EOF
$

Create inventory file ( file name must be ended with arvan.yaml or arvan.yml ) :

$ cat <<EOF > inventory_arvan.yml
---
# plugin must be arvancloud.iaas.arvan
plugin: arvancloud.iaas.arvan
# add your API key 
api_key: Apikey 01234567-9abc-def0-1234-56789abcdef0

compose:
# set ansible_ssh_private_key_file variable based on key_name host variable
  ansible_ssh_private_key_file: '["~/.ssh/",key_name]|join("")'
# set ansible_user with default_username host variable
  ansible_user: default_username
# create groups based on dc_name host variable with parent group arvan
keyed_groups:
  - prefix: ''
    key: 'dc_name|lower'
    parent_group: arvan
    separator: ''

EOF
$

Get list of hosts and groups in inventory:

$ ansible-inventory -i inventory_arvan.yml --playbook-dir ./ --list
{
    "_meta": {
        "hostvars": {
            "ubuntu-foroogh": {
                "ansible_host": "185.226.119.88",
                "ansible_ssh_private_key_file": "~/.ssh/ir-thr-c2X",
                "ansible_user": "ubuntu",
                "city": "Tehran",
                "city_code": "thr",
                "country": "Iran",
                "created": "2022-05-18T13:46:19Z",
                "dc_beta": false,
                "dc_code": "fr",
                "dc_default": true,
                "dc_flag": "ir",
                "dc_full_code": "ir-thr-c2",
                "dc_name": "Foroogh",
                "dc_new": true,
                "dc_soon": false,
                "dc_visible": true,
                "dc_volume_backed": true,
                "default_username": "ubuntu",
                "disk": 25,
                "flavor_name": "g1-1-1-0",
                "id": "9febd501-0d20-4acd-9ef6-1f9db4b1415d",
                "image_name": "Ubuntu-20.04",
                "key_name": "ir-thr-c2X",
                "name": "ubuntu-foroogh",
                "os": "ubuntu",
                "os_type": "linux",
                "ram": 1024,
                "region": "ir-thr",
                "status": "ACTIVE",
                "swap": 0,
                "tags": [],
                "task_state": null,
                "v4_public_ip": "185.226.119.88",
                "vcpus": 1
            },
            "ubuntu-shahriar": {
                "ansible_host": "188.121.111.160",
                "ansible_ssh_private_key_file": "~/.ssh/ir-tbz-dc1X",
                "ansible_user": "ubuntu",
                "city": "Tabriz",
                "city_code": "tbz",
                "country": "Iran",
                "created": "2022-05-18T13:45:00Z",
                "dc_beta": false,
                "dc_code": "sh",
                "dc_default": false,
                "dc_flag": "ir",
                "dc_full_code": "ir-tbz-dc1",
                "dc_name": "Shahriar",
                "dc_new": true,
                "dc_soon": false,
                "dc_visible": true,
                "dc_volume_backed": true,
                "default_username": "ubuntu",
                "disk": 25,
                "flavor_name": "g2-1-1-0",
                "id": "8c3d2362-fc86-40de-b22c-c8dbf3b37d03",
                "image_name": "Ubuntu-20.04",
                "key_name": "ir-tbz-dc1X",
                "name": "ubuntu-shahriar",
                "os": "ubuntu",
                "os_type": "linux",
                "ram": 1024,
                "region": "ir-tbz",
                "status": "ACTIVE",
                "swap": 0,
                "tags": [],
                "task_state": null,
                "v4_public_ip": "188.121.111.160",
                "vcpus": 1
            }
        }
    },
    "all": {
        "children": [
            "arvan",
            "ungrouped"
        ]
    },
    "arvan": {
        "children": [
            "foroogh",
            "shahriar"
        ],
        "hosts": [
            "ubuntu-foroogh",
            "ubuntu-shahriar"
        ]
    },
    "foroogh": {
        "hosts": [
            "ubuntu-foroogh"
        ]
    },
    "shahriar": {
        "hosts": [
            "ubuntu-shahriar"
        ]
    }
}

Use inventory in Ad-hoc command :

$ ansible -i inventory_arvan.yml  -m ping shahriar --playbook-dir ./ 
ubuntu-shahriar | SUCCESS => {
    "ansible_facts": {
        "discovered_interpreter_python": "/usr/bin/python3"
    },
    "changed": false,
    "ping": "pong"
}

or with playbook :

$ cat <<EOF > playbook.yml
---
  - name: Playbook
    hosts: foroogh:shahriar
    gather_facts: false
    tasks:
      - name: "Execute multiple commands"
        shell: |
           whoami
           uptime & uname -a
EOF
$ ansible-playbook -i inventory_arvan.yml playbook.yml

PLAY [Playbook] ****************************************************************

TASK [Execute multiple commands] ***********************************************
changed: [ubuntu-foroogh]
changed: [ubuntu-shahriar]

PLAY RECAP *********************************************************************
ubuntu-foroogh             : ok=1    changed=1    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   
ubuntu-shahriar            : ok=1    changed=1    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

License

GNU General Public License v3.0

See COPYING to see the full text.