upcloud-ansible

DEPRECATION NOTICE

This repo has been deprecated and won't receive more fixes, features or version updates. We suggest using UpCloud Terraform Provider for creating infrastructure and UpCloud Ansible Collection for provisioning and modification.

Dynamic inventory and modules for managing servers via UpCloud's API

The inventory script and modules contain documentation and examples as per Ansible's developer guidelines.

Dependencies and supported versions

• upcloud-api>=2.0.0 must be installed, pip install upcloud-api or get the sources from Github
• python 3.6 and higher versions are supported by upcloud-api
• tested with ansible 2.10.9
• It should work with whatever is the newest version of ansible, if not, please create an issue about it.

Note for OS X users:

• install ansible with homebrew can make it hard to know what Python ansible is using, using pip install ansible is recommended

Inventory script

Installation

• move to any location you wish, point to the script with ansible -i /path/to/script/upcloud.py
• note that upcloud.ini and upcloud.py must be in the same folder; see .ini for settings
• you may wish to use return_ip_addresses = True in .ini to ensure that SSH works (hostnames may not be in DNS)
• information on configuring the inventory without specifying -i every time: http://stackoverflow.com/questions/21958727/where-to-store-ansible-host-file-on-osx
• Define upcloud api user and password in the .ini file or in env variables.
• Default timeout is defined either in the .ini file or as env variable. (default is 300s)

Usage

# match all servers
ansible all -m ping -i /path/to/upcloud.py

# match all servers from upcloud inventory script
ansible uc_all -m ping -i /path/to/upcloud.py

# inventory group servers by upcloud Tags
ansible <any-upcloud-tag> -m <module> -i <path-to-upcloud-inventory>

UpCloud modules

Installation

• move the modules to a location of your choice
• make sure to add the location of your choice into library path:
  • ansible.cfg
  • environment variable or CLI option
• ...or provide module path when invoking ansible:
  • ansible-playbook -M /path/to/modules/dir playbook.yml

Usage

# you can specify inventory and Modules pathes via cli
ansible-playbook create-servers.yml -i /path/to/upcloud.py -M /path/to/upcloud/modules

See the source files for documentation and examples. You may also want to refer to UpCloud's API documentation

The following example shows off some of the features of upcloud, upcloud_tag and upcloud_firewall modules:

---
- hosts: localhost
  connection: local
  serial: 1
  gather_facts: no

  tasks:
    - name: Create upcloud server
      upcloud:
        state: present
        hostname: web1.example.com
        title: web1.example.com
        zone: uk-lon1
        plan: 1xCPU-1GB
        storage_devices:
          - { size: 30, os: 01000000-0000-4000-8000-000030200200 } # Note this is Ubuntu server 20.04 template UUID
          - { size: 100 }
        api_user: <YOUR UPCLOUD USERNAME>
        api_passwd: <YOUR UPCLOUD PASSWORD>
        ssh_keys:
          - ssh-rsa AAAAB3NzaC1yc2EAA[...]ptshi44x [email protected]
          - ssh-dss AAAAB3NzaC1kc3MAA[...]VHRzAA== [email protected]
      register: upcloud_server # upcloud_server.server will contain the API response body

    # upcloud_server.public_ip shortcut will contain a public IPv4 (preferred) or IPv6 address
    # this task is not needed if host_key_checking=False in ansible
    - name: remove new server from known_hosts in case of IP collision
      known_hosts:
        state: absent
        host: "{{ upcloud_server.public_ip }}"

    - name: Wait for SSH to come up
      wait_for: host={{ upcloud_server.public_ip }} port=22 delay=5 timeout=320 state=started

    - name: tag the created server
      upcloud_tag:
        state: present
        uuid: "{{ upcloud_server.server.uuid }}"
        tags: [webservers, london]

    - name: configure firewall
      upcloud_firewall:
        state: present
        uuid: "{{ upcloud_server.server.uuid }}"
        firewall_rules:
          - direction: in
            family: IPv4
            protocol: udp
            destination_port_start: 53
            destination_port_end: 53
            action: accept

          - direction: in
            family: IPv4
            protocol: tcp
            destination_port_start: 22
            destination_port_end: 22
            action: accept

          - direction: in
            family: IPv4
            protocol: tcp
            destination_port_start: 80
            destination_port_end: 80
            action: accept

          - direction: in
            family: IPv4
            protocol: tcp
            destination_port_start: 443
            destination_port_end: 443
            action: accept

          # default rule last:
          - direction: in
            action: drop

Testing

Tests located in project_root/test/ directory. Run with:

pytest test/

To test against all supported python versions, run (will also run flake8 checks):

tox

To check for possible vulnerabilities in python packages, run:

safety check

To check for flake8 errors, run:

flake8

For tests, flake8 and safety check to work - additional dependencies need to be installed:

pip install -r requirements-dev.txt

Bugs, Issues, Problems, Ideas

Please report issues and features requests through the issues page.