Skip to content

Latest commit

 

History

History
111 lines (76 loc) · 4.72 KB

README.md

File metadata and controls

111 lines (76 loc) · 4.72 KB
Raw

TransIP Collection

CI

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

Tested with Ansible

Tested with the current Ansible 2.15 release and the current development version of Ansible. Ansible versions before 2.13 are not supported.

Included content

  • transip_sshkey – Manage TransIP SSH keys
  • transip_vps – Create and delete a TransIP VPS
  • transip_vps_os – Install a new OS on a TransIP VPS
  • transip_domain – Create and delete a TransIP DNS entries
  • transip_network – Create and delete a TransIP Private Networks

Installation and Usage

Installing the Collection from Ansible Galaxy

Before using the TransIP collection, you need to install it with the Ansible Galaxy CLI:

ansible-galaxy collection install yo_han.transip

You can also include it in a requirements.yml file and install it via ansible-galaxy collection install -r requirements.yaml, using the format:

---
collections:
  - name: yo_han.transip
    version: 0.4.2

Using modules from the TransIP Collection in your playbooks

It's preferable to use content in this collection using their Fully Qualified Collection Namespace (FQCN), for example: yo_han.transip.transip_vps:

---
- hosts: localhost
  gather_facts: false
  connection: local

  task:
    - name: Create a new VPS
      yo_han.transip.transip_vps:
        state: present
        description: "example vps description"
        unique_description: true
        product_name: vps-bladevps-x2
        operating_system: ubuntu-22.04
        availability_zone: ams0
        access_token: REDACTED
      register: result

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. All modules support the test_mode argument which if true will add the ?test-1 query parameter to every transip request to perform the request in test mode.

Testing with ansible-test

The tests directory contains configuration for running sanity and integeration tests using ansible-test.

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

ansible-test sanity -v --color
ansible-test integration -v --color

Note: To run integration tests, you must add an integration_config.yml file with a valid TransIP API key (using variable transip_api_key). You can use integration_config.yml.tpl as a start.

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.
  2. Update the CHANGELOG:
    1. Make sure you you have antsibull-changelog installed.
    2. Make sure there are fragments for all known changes in changelogs/fragments.
    3. Run antsibull-changelog release.
  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.

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

More information

Licensing

GNU General Public License v3.0 or later.

See COPYING to see the full text.