# Introduction

## Introduction

### 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

The module is also available on [Ansible Galaxy](https://galaxy.ansible.com/ionoscloudsdk/ionoscloud).

The IONOS module for Ansible requires the following:

* IONOS Cloud account
* Python >= 3.5
* [Ansible](https://www.ansible.com/)
* [IONOS Cloud **Compute Engine** Python SDK](https://pypi.org/project/ionoscloud/) >= 6.1.6
* [IONOS Cloud **DBaaS PostgreSQL** Python SDK](https://pypi.org/project/ionoscloud-dbaas-postgres/) >= 1.1.1
* [IONOS Cloud **DBaaS MongoDB** Python SDK](https://pypi.org/project/ionoscloud-dbaas-mongo/) >= 1.2.2
* [IONOS Cloud **Container Registry** Python SDK](https://pypi.org/project/ionoscloud-container-registry/) >= 1.0.0
* [IONOS Cloud **Certificate Manager** Python SDK](https://pypi.org/project/ionoscloud-cert-manager/) >= 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](http://docs.ansible.com/ansible/intro_installation.html) for more information on installing Ansible.

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

```bash
pip install ionoscloud
pip install ionoscloud-dbaas-postgres
pip install ionoscloud-dbaas-mongo
pip install ionoscloud-container-registry
pip install ionoscloud-cert-manager
```

## Installation

### I. Using Ansible galaxy *(recommended)*

Run the following command:

```bash
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`:

```bash
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:

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

2. Install the collection with ansible-galaxy.

```bash
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>

2. 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.