summaryrefslogtreecommitdiffstats
path: root/collections-debian-merged/ansible_collections/community/digitalocean/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-14 20:03:01 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-14 20:03:01 +0000
commita453ac31f3428614cceb99027f8efbdb9258a40b (patch)
treef61f87408f32a8511cbd91799f9cececb53e0374 /collections-debian-merged/ansible_collections/community/digitalocean/README.md
parentInitial commit. (diff)
downloadansible-upstream.tar.xz
ansible-upstream.zip
Adding upstream version 2.10.7+merged+base+2.10.8+dfsg.upstream/2.10.7+merged+base+2.10.8+dfsgupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'collections-debian-merged/ansible_collections/community/digitalocean/README.md')
-rw-r--r--collections-debian-merged/ansible_collections/community/digitalocean/README.md172
1 files changed, 172 insertions, 0 deletions
diff --git a/collections-debian-merged/ansible_collections/community/digitalocean/README.md b/collections-debian-merged/ansible_collections/community/digitalocean/README.md
new file mode 100644
index 00000000..b0361b5a
--- /dev/null
+++ b/collections-debian-merged/ansible_collections/community/digitalocean/README.md
@@ -0,0 +1,172 @@
+# DigitalOcean Community Collection
+[![CI](https://github.com/ansible-collections/community.digitalocean/workflows/CI/badge.svg?event=push)](https://github.com/ansible-collections/community.digitalocean/actions) [![Codecov](https://img.shields.io/codecov/c/github/ansible-collections/community.digitalocean)](https://codecov.io/gh/ansible-collections/community.digitalocean)
+
+This collection contains modules and plugins to assist in automating [DigitalOcean](https://www.digitalocean.com) infrastructure and API interactions with Ansible.
+
+## Tested 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.
+
+## Included content
+
+- [digital_ocean](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_module.html) – Create/delete a droplet/SSH_key in DigitalOcean
+- [digital_ocean_account_facts](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_account_facts_module.html) – Gather information about DigitalOcean User account
+- [digital_ocean_account_info](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_account_info_module.html) – Gather information about DigitalOcean User account
+- [digital_ocean_block_storage](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_block_storage_module.html) – Create/destroy or attach/detach Block Storage volumes in DigitalOcean
+- [digital_ocean_certificate](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_certificate_module.html) – Manage certificates in DigitalOcean.
+- [digital_ocean_certificate_facts](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_certificate_facts_module.html) – Gather information about DigitalOcean certificates
+- [digital_ocean_certificate_info](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_certificate_info_module.html) – Gather information about DigitalOcean certificates
+- [digital_ocean_domain](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_domain_module.html) – Create/delete a DNS domain in DigitalOcean
+- [digital_ocean_domain_facts](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_domain_facts_module.html) – Gather information about DigitalOcean Domains
+- [digital_ocean_domain_info](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_domain_info_module.html) – Gather information about DigitalOcean Domains
+- [digital_ocean_droplet](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_droplet_module.html) – Create and delete a DigitalOcean droplet
+- [digital_ocean_firewall_facts](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_firewall_facts_module.html) – Gather information about DigitalOcean firewalls
+- [digital_ocean_firewall_info](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_firewall_info_module.html) – Gather information about DigitalOcean firewalls
+- [digital_ocean_floating_ip](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_floating_ip_module.html) – Manage DigitalOcean Floating IPs
+- [digital_ocean_floating_ip_facts](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_floating_ip_facts_module.html) – DigitalOcean Floating IPs information
+- [digital_ocean_floating_ip_info](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_floating_ip_info_module.html) – DigitalOcean Floating IPs information
+- [digital_ocean_image_facts](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_image_facts_module.html) – Gather information about DigitalOcean images
+- [digital_ocean_image_info](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_image_info_module.html) – Gather information about DigitalOcean images
+- [digital_ocean_load_balancer_facts](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_load_balancer_facts_module.html) – Gather information about DigitalOcean load balancers
+- [digital_ocean_load_balancer_info](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_load_balancer_info_module.html) – Gather information about DigitalOcean load balancers
+- [digital_ocean_region_facts](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_region_facts_module.html) – Gather information about DigitalOcean regions
+- [digital_ocean_region_info](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_region_info_module.html) – Gather information about DigitalOcean regions
+- [digital_ocean_size_facts](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_size_facts_module.html) – Gather information about DigitalOcean Droplet sizes
+- [digital_ocean_size_info](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_size_info_module.html) – Gather information about DigitalOcean Droplet sizes
+- [digital_ocean_snapshot_facts](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_snapshot_facts_module.html) – Gather information about DigitalOcean Snapshot
+- [digital_ocean_snapshot_info](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_snapshot_info_module.html) – Gather information about DigitalOcean Snapshot
+- [digital_ocean_sshkey](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_sshkey_module.html) – Manage DigitalOcean SSH keys
+- [digital_ocean_sshkey_facts](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_sshkey_facts_module.html) – DigitalOcean SSH keys facts
+- [digital_ocean_sshkey_info](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_sshkey_info_module.html) – Gather information about DigitalOcean SSH keys
+- [digital_ocean_tag](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_tag_module.html) – Create and remove tag(s) to DigitalOcean resource.
+- [digital_ocean_tag_facts](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_tag_facts_module.html) – Gather information about DigitalOcean tags
+- [digital_ocean_tag_info](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_tag_info_module.html) – Gather information about DigitalOcean tags
+- [digital_ocean_volume_facts](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_volume_facts_module.html) – Gather information about DigitalOcean volumes
+- [digital_ocean_volume_info](https://docs.ansible.com/ansible/2.10/collections/community/digitalocean/digital_ocean_volume_info_module.html) – Gather information about DigitalOcean volumes
+
+## Installation and Usage
+
+### 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:
+
+```yaml
+---
+collections:
+ - name: community.digitalocean
+ version: 1.0.0
+```
+
+### 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`:
+
+```yaml
+---
+- 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:
+
+```yaml
+---
+- 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`](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#collections-paths), and work on it there.
+
+### Testing with `ansible-test`
+
+The `tests` directory contains configuration for running sanity and integration tests using [`ansible-test`](https://docs.ansible.com/ansible/latest/dev_guide/testing_integration.html).
+
+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`](https://docs.ansible.com/ansible/latest/dev_guide/testing_integration.html#integration-config-yml) file with a valid DigitalOcean API key (using variable `do_api_key`).
+
+## Release notes
+
+See the [changelog](https://github.com/ansible-collections/community.digitalocean/blob/main/CHANGELOG.rst).
+
+### 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.
+ 1. Update the CHANGELOG:
+ 1. Make sure you have [`antsibull-changelog`](https://pypi.org/project/antsibull-changelog/) installed.
+ 1. Make sure there are fragments for all known changes in `changelogs/fragments`.
+ 1. Run `antsibull-changelog release`.
+ 1. Commit the changes and create a PR with the changes. Wait for tests to pass, then merge it once they have.
+ 1. Tag the version in Git and push to GitHub.
+
+After the version is published, verify it exists on the [DigitalOcean Collection Galaxy page](https://galaxy.ansible.com/community/digitalocean).
+
+## More information
+
+ - [DigitalOcean Working Group](https://github.com/ansible/community/wiki/Digital-Ocean)
+ - [Ansible Collection overview](https://github.com/ansible-collections/overview)
+ - [Ansible User guide](https://docs.ansible.com/ansible/latest/user_guide/index.html)
+ - [Ansible Developer guide](https://docs.ansible.com/ansible/latest/dev_guide/index.html)
+ - [Ansible Community code of conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html)
+
+## Licensing
+
+GNU General Public License v3.0 or later.
+
+See [COPYING](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text.