Skip to Content
Menu

Ansible Manager

by
Odoo

173.61

v 17.0 Third Party
Availability
Odoo Online
Odoo.sh
On Premise
Lines of code 3483
Technical Name ansible_manager
LicenseOPL-1
Versions 16.0 17.0 18.0
You bought this module and need support? Click here!
Availability
Odoo Online
Odoo.sh
On Premise
Lines of code 3483
Technical Name ansible_manager
LicenseOPL-1
Versions 16.0 17.0 18.0

Create Credentials

Ansible Manager > Configuration > Credentials > New.

Start by configuring the authentication credentials for the target machines. The module supports two authentication methods: password and SSH key. Once configured, the machines linked to the selected credentials will be listed in the table below on the interface.

Browse / Create Variables

Ansible Manager > Configuration > Variables > (New).

Once the module is installed, some default variables will be available for use during Ansible execution. You can also create custom variables with unique names. When creating a variable, both its name and type are required. You can only modify the type of a variable if it is not in use, and it can only be deleted under the same condition. (At this point, variables have no values assigned on this interface.)

Create Labels

Ansible Manager > Configuration > Labels > New.

You can create labels and assign them to hosts or templates. Labels do not impact Ansible’s functionality; they are solely for better organization and easier navigation.

Create Host

Ansible Manager > Configuration > Host > New.

This interface allows you to create the hosts that Ansible will run on later. You can assign the authentication credentials set up earlier here. If any tags have been created, they can be linked to the host, and you can also configure the host-specific variables (with values).

In the list view, selecting one or more hosts reveals a 'Ping Check' option at the top of the interface. This feature allows you to deactivate hosts that fail to respond to a ping.

Create Group / Cluster

Ansible Manager > Configuration > Group > New.
Ansible Manager > Configuration > Cluster > New.

Under the 'Group' menu, you can group hosts together, eliminating the need to add them individually when running Ansible later. You can also configure variables at the group level. If a variable is set both at the host and group level, the value at the group level will override the host-level value.

The 'Cluster' section offers the same configuration options as the 'Group' section, but instead of grouping hosts, you can organize the previously created groups into larger clusters.

Create Files

Ansible Manager > Global Ansible Settings > Files > New.

You can upload files that will be available for use during Ansible execution. To use the uploaded file, reference it by its original filename, e.g., {{ example.txt }}. If you select the 'Use Custom Filename' option, you can assign a different name to the file, and you'll reference it by this custom name when running Ansible.

Create Templates

Ansible Manager > Global Ansible Settings > Templates > New.

You can create templates, such as configuration files, that include dynamic content, which can be made variable-driven. During Ansible execution, you can reference these templates by the name provided in the 'Output Filename' field, for example: {{ config.j2 }}.

Create Handlers

Ansible Manager > Global Ansible Settings > Handlers > New.

A 'Handler' is a task that can be triggered by another task if it causes a change during execution.

Browse Module Catalog

Ansible Manager > Module Catalog.

This interface displays the list of installed Ansible modules, which is updated weekly through a scheduled action. Click on a module to view its detailed information. Use the 'Add Task to Role' button to assign the selected task to an existing 'Role'.

Create Roles

Ansible Manager > Ansible > Roles > New.

This interface allows you to create tasks for later execution. You can define 'Defaults' variables, which will not override variables with the same name that were defined earlier. In contrast, variables added in the 'Variables' table will override existing ones with the same name. The meta section is a dedicated part of Ansible playbooks and roles for managing dependencies, documentation, and metadata. It is especially useful for roles, ensuring clear and efficient relationships between them. Click the 'Add Task' button to create tasks, and rearrange their order in the table as needed. If a task references a previously added file or handler, you must include those files or handlers in the respective tables to ensure they are generated during Ansible execution.

After creating a task, click on its row and scroll down in the pop-up window to access additional configuration options, such as assigning Handlers.

Create Job

Ansible Manager > Ansible > Job > New.

This interface allows you to define which hosts and roles should be executed. You can also define variables specific to the execution directly here. Ansible execution can be scheduled for a specified time or triggered manually. Optionally, you can configure email notifications to receive the results after the execution.
Before installing the module, you will need to install some Python packages to ensure the module runs properly.
(You can find the names of these packages in the requirements.txt file)

  • unidecode
  • PyYAML
  • ansible
  • ansible_runner
After installing this module, You need to enable user group named 'Ansible Manager User' for users, who you want to allow to run this app.

Settings --> Users --> than select the 'Ansible Manager User'
During the module installation, we create a scheduled action that runs immediately to start loading the installed Ansible modules into the 'Module Catalog' menuitem.

1.0.0

23th Nov, 2024
  • Initial Commit
Odoo Proprietary License v1.0

This software and associated files (the "Software") may only be used (executed,
modified, executed after modifications) if you have purchased a valid license
from the authors, typically via Odoo Apps, or if you have received a written
agreement from the authors of the Software (see the COPYRIGHT file).

You may develop Odoo modules that use the Software as a library (typically
by depending on it, importing it and using its resources), but without copying
any source code or material from the Software. You may distribute those
modules under the license of your choice, provided that this license is
compatible with the terms of the Odoo Proprietary License (For example:
LGPL, MIT, or proprietary licenses similar to this one).

It is forbidden to publish, distribute, sublicense, or sell copies of the Software
or modified copies of the Software.

The above copyright notice and this permission notice must be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

Please log in to comment on this module

  • The author can leave a single reply to each comment.
  • This section is meant to ask simple questions or leave a rating. Every report of a problem experienced while using the module should be addressed to the author directly (refer to the following point).
  • If you want to start a discussion with the author or have a question related to your purchase, please use the support page.