This collection contains modules and plugins to assist in automating DigitalOcean infrastructure and API interactions with Ansible.
Tested with the current Ansible 2.9 and 2.10 releases and the current development version of Ansible. Ansible versions before 2.9.10 are not supported.
- digital_ocean – Create/delete a droplet/SSH_key in DigitalOcean
- digital_ocean_account_facts – Gather information about DigitalOcean User account
- digital_ocean_account_info – Gather information about DigitalOcean User account
- digital_ocean_balance_info – Display DigitalOcean customer balance
- digital_ocean_block_storage – Create/destroy or attach/detach Block Storage volumes in DigitalOcean
- digital_ocean_certificate – Manage certificates in DigitalOcean.
- digital_ocean_certificate_facts – Gather information about DigitalOcean certificates
- digital_ocean_certificate_info – Gather information about DigitalOcean certificates
- digital_ocean_domain – Create/delete a DNS domain in DigitalOcean
- digital_ocean_domain_facts – Gather information about DigitalOcean Domains
- digital_ocean_domain_info – Gather information about DigitalOcean Domains
- digital_ocean_domain_record – Create and delete DigitalOcean Domain Records
- digital_ocean_droplet – Create and delete a DigitalOcean droplet
- digital_ocean_firewall – Create and delete DigitalOcean firewalls
- digital_ocean_firewall_facts – Gather information about DigitalOcean firewalls
- digital_ocean_firewall_info – Gather information about DigitalOcean firewalls
- digital_ocean_floating_ip – Manage DigitalOcean Floating IPs
- digital_ocean_floating_ip_facts – DigitalOcean Floating IPs information
- digital_ocean_floating_ip_info – DigitalOcean Floating IPs information
- digital_ocean_image_facts – Gather information about DigitalOcean images
- digital_ocean_image_info – Gather information about DigitalOcean images
- digital_ocean_load_balancer_facts – Gather information about DigitalOcean load balancers
- digital_ocean_load_balancer_info – Gather information about DigitalOcean load balancers
- digital_ocean_region_facts – Gather information about DigitalOcean regions
- digital_ocean_region_info – Gather information about DigitalOcean regions
- digital_ocean_size_facts – Gather information about DigitalOcean Droplet sizes
- digital_ocean_size_info – Gather information about DigitalOcean Droplet sizes
- digital_ocean_snapshot_facts – Gather information about DigitalOcean Snapshot
- digital_ocean_snapshot_info – Gather information about DigitalOcean Snapshot
- digital_ocean_sshkey – Manage DigitalOcean SSH keys
- digital_ocean_sshkey_facts – DigitalOcean SSH keys facts
- digital_ocean_sshkey_info – Gather information about DigitalOcean SSH keys
- digital_ocean_tag – Create and remove tag(s) to DigitalOcean resource.
- digital_ocean_tag_facts – Gather information about DigitalOcean tags
- digital_ocean_tag_info – Gather information about DigitalOcean tags
- digital_ocean_volume_facts – Gather information about DigitalOcean volumes
- digital_ocean_volume_info – Gather information about DigitalOcean volumes
- digitalocean – DigitalOcean Inventory Plugin
Before using the DigitalOcean collection, you need to install it with the Ansible Galaxy CLI:
ansible-galaxy collection install community.digitalocean
You can also include it in a requirements.yml
file and install it via ansible-galaxy collection install -r requirements.yml
, using the format:
---
collections:
- name: community.digitalocean
It's preferable to use content in this collection using their Fully Qualified Collection Namespace (FQCN), for example community.digitalocean.digital_ocean_droplet
:
---
- hosts: localhost
gather_facts: false
connection: local
tasks:
- name: Create ssh key
community.digitalocean.digital_ocean_sshkey:
oauth_token: "{{ oauth_token }}"
name: mykey
ssh_pub_key: "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAQQDDHr/jh2Jy4yALcK4JyWbVkPRaWmhck3IgCoeOO3z1e2dBowLh64QAM+Qb72pxekALga2oi4GvT+TlWNhzPH4V example"
state: present
register: result
- name: Create a new droplet
community.digitalocean.digital_ocean_droplet:
state: present
name: mydroplet
oauth_token: "{{ oauth_token }}"
size: 2gb
region: sfo1
image: ubuntu-20-04-x64
wait_timeout: 500
ssh_keys:
- mykey
register: my_droplet
- debug:
msg: "ID is {{ my_droplet.data.droplet.id }}, IP is {{ my_droplet.data.ip_address }}"
- name: Tag a resource; creating the tag if it does not exist
digital_ocean_tag:
name: "{{ item }}"
resource_id: "{{ my_droplet.data.droplet.id }}"
state: present
loop:
- staging
- dbserver
If upgrading older playbooks which were built prior to Ansible 2.10 and this collection's existence, you can also define collections
in your play and refer to this collection's modules as you did in Ansible 2.9 and below, as in this example:
---
- hosts: localhost
gather_facts: false
connection: local
collections:
- community.digitalocean
tasks:
- name: Create ssh key
digital_ocean_sshkey:
oauth_token: "{{ oauth_token }}"
...
If you want to develop new content for this collection or improve what's already here, the easiest way to work on the collection is to clone it into one of the configured COLLECTIONS_PATHS
, and work on it there.
The tests
directory contains configuration for running sanity and integration tests using ansible-test
.
You can run the collection's test suites with the commands:
ansible-test sanity --docker -v --color
ansible-test integration --docker -v --color
Note: To run integration tests, you must add an integration_config.yml
file with a valid DigitalOcean API key (using variable do_api_key
).
See the changelog.
Releases are automatically built and pushed to Ansible Galaxy for any new tag. Before tagging a release, make sure to do the following:
- Update
galaxy.yml
and this README'srequirements.yml
example with the newversion
for the collection. - Update the CHANGELOG:
- Make sure you have
antsibull-changelog
installed. - Make sure there are fragments for all known changes in
changelogs/fragments
. - Run
antsibull-changelog release
.
- Make sure you have
- Commit the changes and create a PR with the changes. Wait for tests to pass, then merge it once they have.
- Tag the version in Git and push to GitHub.
After the version is published, verify it exists on the DigitalOcean Collection Galaxy page.
- DigitalOcean Working Group
- Ansible Collection overview
- Ansible User guide
- Ansible Developer guide
- Ansible Community code of conduct
GNU General Public License v3.0 or later.
See COPYING to see the full text.