• Stars
    star
    141
  • Rank 259,971 (Top 6 %)
  • Language
    Python
  • License
    GNU General Publi...
  • Created over 4 years ago
  • Updated 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

This Ansible collection contains modules for assisting in the automation of the DigitalOcean cloud.

DigitalOcean Community Collection

coverage black integration sanity unit

This collection contains modules and plugins to assist in automating DigitalOcean infrastructure and API interactions with Ansible.

Included content

Installation and Usage

Requirements

The collection is tested and supported with:

  • ansible >= 2.9.10 or ansible-core >= 2.11 (as well as the devel branch)
  • python >= 3.6

Installing the Collection from Ansible Galaxy

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

Using modules from the DigitalOcean Collection in your playbooks

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

  vars:
    oauth_token: "{{ lookup('ansible.builtin.env', 'DO_API_TOKEN') }}"

  # You can also default the value of a variable for every DO module using module_defaults
  # module_defaults:
  #   group/community.digitalocean.all:
  #     oauth_token: "{{ lookup('ansible.builtin.env', 'DO_API_TOKEN') }}"

  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: my_ssh_key

    - name: Create a new Droplet
      community.digitalocean.digital_ocean_droplet:
        oauth_token: "{{ oauth_token }}"
        state: present
        name: mydroplet
        unique_name: true
        size: s-1vcpu-1gb
        region: sfo3
        image: ubuntu-20-04-x64
        wait_timeout: 500
        ssh_keys:
          - "{{ my_ssh_key.data.ssh_key.id }}"
      register: my_droplet

    - name: Show Droplet info
      ansible.builtin.debug:
        msg: |
          Droplet ID is {{ my_droplet.data.droplet.id }}
          First Public IPv4 is {{ (my_droplet.data.droplet.networks.v4 | selectattr('type', 'equalto', 'public')).0.ip_address | default('<none>', true) }}
          First Private IPv4 is {{ (my_droplet.data.droplet.networks.v4 | selectattr('type', 'equalto', 'private')).0.ip_address | default('<none>', true) }}

    - name: Tag a resource; creating the tag if it does not exist
      community.digitalocean.digital_ocean_tag:
        oauth_token: "{{ oauth_token }}"
        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 }}"
        ...

Testing and Development

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.

Alternatively, to develop completely out of ~/src/ansible-dev, one could:

mkdir -p ~/src/ansible-dev
cd ~/src/ansible-dev
python3 -m venv venv
source venv/bin/activate
git clone https://github.com/ansible/ansible.git
pip install --requirement ansible/requirements.txt
pip install kubernetes
source ansible/hacking/env-setup
export ANSIBLE_COLLECTIONS_PATHS="~/src/ansible-dev/ansible_collections"
ansible-galaxy collection install community.digitalocean community.general

This gives us a self-contained environment in ~/src/ansible-dev consisting of Python, Ansible, and this collection (located in ~/src/ansible-dev/ansible_collections/community/digitalocean). This collection requires functionality from community.general, and as such, we install it as well.

If you would like to contribute any changes which you have made to the collection, you will have to push them to your fork. If you do not have a fork yet, you can create one here. Once you have a fork:

cd ~/src/ansible-dev/ansible_collections/community/digitalocean
git remote add origin [email protected]:{your fork organization}/community.digitalocean.git
git checkout -b my-awesome-fixes
git commit -am "My awesome fixes"
git push -u origin my-awesome-fixes

Now, you should be ready to create a Pull Request.

Testing with ansible-test

The tests directory inside the collection root contains configuration for running unit, sanity, and integration tests using ansible-test.

You can run the collection's test suites with the commands:

ansible-test units --venv --python 3.9
ansible-test sanity --venv --python 3.9
ansible-test integration --venv --python 3.9

Replace --venv with --docker if you'd like to use Docker for the testing runtime environment.

Note: To run integration tests, you must add an tests/integration/integration_config.yml file with a valid DigitalOcean API Key (variable do_api_key), AWS Access ID and Secret Key (variables aws_access_key_id and aws_secret_access_key, respectively). The AWS variables are used for the DigitalOcean Spaces and CDN Endpoints integration tests.

Release notes

See the changelog.

Release process

Releases are automatically built and pushed to Ansible Galaxy for any new tag. Before tagging a release, make sure to do the following:

  1. Update galaxy.yml and this README's requirements.yml example with the new version for the collection. Make sure all new modules have references above.
  2. Update the CHANGELOG:
    1. Make sure you have antsibull-changelog installed.
    2. Make sure there are fragments for all known changes in changelogs/fragments.
    3. Run antsibull-changelog release.
    4. Don't forget to add new folks to galaxy.yml.
  3. Commit the changes and create a PR with the changes. Wait for tests to pass, then merge it once they have.
  4. Tag the version in Git and push to GitHub.
    1. Determine the next version (collections follow semver semantics) by listing tags or looking at the releases.
    2. List tags with git tag --list
    3. Create a new tag with git tag 1.2.3
    4. Push tags upstream with git push upstream --tags

After the version is published, verify it exists on the DigitalOcean Collection Galaxy page.

More information

Licensing

GNU General Public License v3.0 or later.

See COPYING to see the full text.

More Repositories

1

community.general

Ansible Community General Collection
Python
821
star
2

community.vmware

Ansible Collection for VMware
Python
348
star
3

community.zabbix

Zabbix Ansible modules
Python
320
star
4

amazon.aws

Ansible Collection for Amazon AWS
Python
304
star
5

cisco.ios

Ansible Network Collection for Cisco IOS
Python
277
star
6

community.kubernetes

Kubernetes Collection for Ansible
Makefile
264
star
7

overview

Collections overview, how to request a namespace
249
star
8

ansible.windows

Windows core collection for Ansible
PowerShell
246
star
9

azure

Development area for Azure Collections
Python
246
star
10

kubernetes.core

The collection includes a variety of Ansible content to help automate the management of applications in Kubernetes and OpenShift clusters, as well as the provisioning and maintenance of clusters themselves.
Python
215
star
11

community.windows

Windows community collection for Ansible
PowerShell
200
star
12

community.docker

Community Docker Collection for Ansible: modules and plugins for working with Docker
Python
200
star
13

community.aws

Ansible Collection for Community AWS
Python
187
star
14

ansible.posix

Ansible Collection for Posix
Python
152
star
15

ansible.netcommon

Ansible Network Collection for Common Code
Python
141
star
16

vmware.vmware_rest

Ansible Collection for VMWare (REST modules)
Python
131
star
17

community.grafana

Grafana Collection for Ansible
Python
129
star
18

community.network

Ansible Community Network Collection
Python
124
star
19

cisco.nxos

Ansible Network Collection for Cisco NXOS
Python
115
star
20

community.postgresql

Manage PostgreSQL with Ansible
Python
108
star
21

community.mongodb

MongoDB Ansible Collection
Python
106
star
22

hetzner.hcloud

A collection to manage resources on Hetzner Cloud
Python
105
star
23

community.mysql

MySQL Ansible Collection
Python
99
star
24

google.cloud

GCP Ansible Collection https://galaxy.ansible.com/google/cloud
Python
99
star
25

community.routeros

Ansible modules for managing MikroTik RouterOS instances.
Python
97
star
26

community.crypto

The community.crypto collection for Ansible.
Python
96
star
27

collection_template

A GitHub Template repo to use as the basis for future repos
91
star
28

arista.eos

Ansible Network Collection for Arista EOS
Python
82
star
29

junipernetworks.junos

Ansible Network Collection for Juniper JunOS
Python
80
star
30

ibm_zos_core

Red Hat Ansible Certified Content for IBM Z
Python
77
star
31

community.sops

Simple and flexible tool for managing secrets
Python
76
star
32

ansible.utils

A collection of ansible utilities for the content creator.
Python
73
star
33

servicenow.itsm

Ansible Collection for ServiceNow ITSM
Python
71
star
34

community.hashi_vault

Ansible collection for managing and working with HashiCorp Vault.
Python
69
star
35

cloud.terraform

The collection automates the management and provisioning of infrastructure as code (IaC) using the Terraform CLI tool within Ansible playbooks and Execution Environment runtimes.
Python
67
star
36

cisco.iosxr

Ansible Network Collection for Cisco IOSXR
Python
65
star
37

community.libvirt

Manage libvirt with Ansible
Python
61
star
38

netapp.ontap

Ansible collection to support NetApp ONTAP configuration.
Python
56
star
39

netapp

Development area for Netapp collections
Python
49
star
40

cisco.asa

Ansible Security Collection for Cisco ASA
Python
49
star
41

dellemc.enterprise_sonic

Ansible Network Collection for Enterprise SONiC Distribution by Dell Technologies
Python
42
star
42

microsoft.ad

Ansible collection for Active Directory management
Python
40
star
43

dellemc.os10

Jinja
37
star
44

community.rabbitmq

Manage RabbitMQ with Ansible
Python
31
star
45

community.dns

Ansible modules and plugins for working with DNS
Python
27
star
46

community.cassandra

Cassandra Ansible Collection
Python
25
star
47

ibm.qradar

IBM QRadar Ansible Collection
Python
24
star
48

news-for-maintainers

Announcements of changes impacting collection contributors and maintainers
24
star
49

community.elastic

Python
24
star
50

ibm.spectrum_virtualize

IBM Spectrum Virtualize
21
star
51

community.proxysql

ProxySQL Ansible Collection
Python
21
star
52

community.healthchecksio

This Ansible collection contains modules for assisting in the automation of the Healthchecks.io monitoring service.
Python
18
star
53

community.hrobot

Hetzner Robot Collection
Python
17
star
54

community.cip

Ansible Collection to automate Programmable Logic Controllers over Common Industrial Protocol (CIP)
Python
17
star
55

ansible.scm

An ansible collection for prescriptive retrieval and publish using git
Python
16
star
56

ansible.network

Ansible Network Collection for network and IP utilities that are not specific to any platform or OS.
16
star
57

openvswitch.openvswitch

Ansible Network Collection for Open vSwitch
Python
15
star
58

ibm_zos_cics

The IBM z/OS CICS collection supports management of CICS resources and definitions in Ansible via the CMCI REST API provided by CICS.
Python
15
star
59

cloud.common

Common files for the Cloud collections
Python
14
star
60

frr.frr

Ansible Collection for Free Range Routing (FRR)
Python
13
star
61

amazon.cloud

Ansible Collection for Amazon AWS' Cloud Control API
Python
12
star
62

splunk.es

Ansible Collection for Splunk Enterprise
Python
11
star
63

community.internal_test_tools

Internal only, not for end users
Python
11
star
64

ibm_zos_ims

IBM z/OS IMS Collection
Python
11
star
65

mellanox.onyx

onyx
Python
10
star
66

ansible-inclusion

Requests to include new collections into the ansible package
10
star
67

community.yang

Ansible Community Collection to support Yang in network devices.
Python
10
star
68

ansible.snmp

Python
10
star
69

dellemc.os9

Jinja
9
star
70

vmware_rest_code_generator

Tooling ued to generate the vmware.vmware_rest collection
Python
9
star
71

community.ciscosmb

Ansible Galaxy module for Cisco SMB switches - SG300, SG500, SG350, SG550
Python
8
star
72

dellemc.os6

Python
8
star
73

community.molecule

Ansible community.molecule is a very small collection that hosts filters used by molecule playbooks.
Python
8
star
74

splunk.enterprise_security

Ansible Collection for Splunk Enterprise
7
star
75

community.sonic

Ansible Galaxy community module for SONiC NOS
Python
7
star
76

community.kubevirt

KubeVirt Collection of Ansible.
Python
7
star
77

vmware.vmware

Ansible VMWare Collection
Python
7
star
78

ansible.security

Ansible Security Collection for security and are not specific to any security vendor.
7
star
79

pravic

An experimental project intended to explore how Ansible could be used to manage cloud-based resources in a more declarative way.
Python
7
star
80

community.google

Python
6
star
81

amazon_cloud_code_generator

Tooling used to generate the amazon.cloud collection
Python
6
star
82

community.sap

Python
6
star
83

logicmonitor

Repo to house LogicMonitor Collection
Python
6
star
84

ansible.yang

Ansible Supported Collection to support YANG in network devices.
Python
5
star
85

community.fqcn_migration

5
star
86

community.clickhouse

Ansible Community ClickHouse Collection
Python
5
star
87

cloud.roles

Collection of roles to help get started using Ansible with public clouds
4
star
88

trendmicro.deepsec

Ansible Collection for managing TrendMicro DeepSecurity Endpoint Security solutions.
Python
4
star
89

ibm.cloud

Code and relative documentation for the IBM Cloud Collection
Python
4
star
90

community.vagrant

community.vagrant collection (to adopt the module from molecule-vagrant)
4
star
91

community.azure

Manage Azure with Ansible
4
star
92

netapp.storagegrid

Ansible collection to support NetApp StorageGrid configuration.
Python
3
star
93

ibm.ds8000

IBM DS8000
Python
3
star
94

netapp.aws

Ansible collection to support NetApp CVS configuration in AWS.
Python
3
star
95

checkpoint

Ansible Security Collection for Check Point devices
3
star
96

skydive

Ansible Collection for Skydive network / protocols analyzer
Python
3
star
97

Datadog

Datadog Collection
Jinja
3
star
98

consoledot.edgemanagement

PoC Ansible Collection for Red Hat Edge Fleet Manager
Python
3
star
99

netapp.cloudmanager

Ansible collection to support NetApp Cloud Manager configuration, including CVO deployments.
Python
3
star
100

pureport

An Ansible Collection for interacting with the Pureport Fabric ReST API
Python
3
star