Ansible Module for IONOS Cloud

Warning: API Basic Authentication Deprecation Notice

Effective March 15, 2024, IONOS account holders using 2-Factor Authentication will no longer be able to utilize Basic Authentication for accessing our APIs, SDKs, and all related tools. Token creation and deletion via APIs and ionosCTL will also be restricted.

Affected users are required to switch to token-based authorization. These tokens will be accessible through our new Token Manager in the Data Center Designer, launching at the beginning of February 2024. More information can be found here.

Overview

Ansible is an IT automation tool that allows you to configure, deploy, and orchestrate advanced tasks, such as continuous deployments or zero downtime rolling updates. The IONOS module for Ansible leverages the IONOS Cloud API.

Getting Started

Source code and in-depth documentation about installation and use are available here. The module is also available on Ansible Galaxy.

The IONOS module for Ansible requires the following:

• IONOS Cloud account
• Python >= 3.5
• Ansible
• IONOS Cloud Compute Engine Python SDK >= 6.1.6
• IONOS Cloud DBaaS PostgreSQL Python SDK >= 1.1.1
• IONOS Cloud DBaaS MongoDB Python SDK >= 1.2.2
• IONOS Cloud Container Registry Python SDK >= 1.0.0
• IONOS Cloud Data Platform Python SDK >= 1.0.0
• IONOS Cloud Certificate Manager Python SDK >= 1.0.0

NOTE: The Ansible module does not support Python 2. It only supports Python >= 3.5.

Before you begin you will need an IONOS account. The credentials from your registration will be used to authenticate against the IONOS Cloud API.

Ansible must also be installed before the IONOS module can be used. Please review the official Ansible Documentation for more information on installing Ansible.

The IONOS module requires some IONOS SDKs for Python to be installed. This can easily be accomplished with Python PyPI:

pip install ionoscloud
pip install ionoscloud-dbaas-postgres
pip install ionoscloud-dbaas-mongo
pip install ionoscloud-container-registry
pip install ionoscloud-dataplatform
pip install ionoscloud-cert-manager

Installation

I. Using Ansible galaxy (recommended)

Run the following command:

  ansible-galaxy collection install ionoscloudsdk.ionoscloud

II. Downloading the module from GitHub

1. The IONOS module for Ansible must first be downloaded from GitHub. This can be accomplished a few different ways such as downloading and extracting the archive using curl or cloning the GitHub repository locally.

   Download and extract with curl:

   mkdir -p ionos-module-ansible && curl -L https://github.com/ionos-cloud/module-ansible/tarball/master | tar zx -C ionos-module-ansible/ --strip-components=1

   Clone the GitHub repository locally:

   git clone https://github.com/ionos-cloud/module-ansible

2. Install the collection with ansible-galaxy.

   ansible-galaxy collection build .
   ansible-galaxy collection install ionoscloudsdk-ionoscloud-<module_version>.tar.gz

FAQ

1. How can I open a bug/feature request?

Bugs & feature requests can be open on the repository issues: https://github.com/ionos-cloud/module-ansible/issues/new/choose

1. Can I contribute to the Ansible Module?

Sure! Our repository is public, feel free to fork it and file a PR for one of the issues opened in the issues list. We will review it and work together to get it released.