Skip to content

Latest commit

 

History

History
89 lines (65 loc) · 2.17 KB

README.md

File metadata and controls

89 lines (65 loc) · 2.17 KB
Raw

Collection for using Mitogen strategy

This collection allows for using Mitogen strategy without the need to mess with paths. It also performs live patching for Mitogen restrictions in Ansible versions, making it possible to use Mitogen with the current Ansible version.

Tested versions of ansible-core:

  • 2.14
  • 2.15

It patches ansible_mitogen code and unpatches it back right after module import, so the original files are kept intact.

Install

To use this collection, you need to install Mitogen. Up to a moment you've have to use master from mitogen repo (pip install git+https://github.com/mitogen-hq/mitogen@master), but there was a release of version 0.3.4 on 2023-07-03 which made it unnecessary.

Mitogen installation:

pip install mitogen==0.3.4

Then, you need to install this collection:

ansible-galaxy collection install serverscom.mitogen

Usage

There are three ways to use this collection, and you need to choose only one option.

ansible.cfg

Add the following to your ansible.cfg file:

strategy = serverscom.mitogen.mitogen_linear

Environment variable

You can set ANSIBLE_STRATEGY environment variable:

ANSIBLE_STRATEGY=serverscom.mitogen.mitogen_linear ansible-playbook ...

strategy stanza

You can use strategy stanza in a play:

- hosts: all
  strategy: serverscom.mitogen.mitogen_linear
  tasks:
   - debug:

Dealing with mitogen bugs

Some code may not run under Mitogen. The easiest way to opt-out of Mitogen for problematic plays is to use the linear strategy:

- hosts: all
  strategy: linear
  tasks:
    - debug:

Acknowledgements

based on @ITD27M01 idea: mitogen-hq/mitogen#961 (comment)

Disclamer

Servers.com is not responsible for any problems that may arise during the use of this collection. Mitogen is a separate project (https://github.com/mitogen-hq/mitogen) that is well-known for speeding up Ansible in exchange for multiple stability issues. Servers.com does not provide support for Mitogen-specific issues and may only address issues related to imports and/or patching of Mitogen.

If you want to make Mitogen better, please help upstream.