Skip to content

Latest commit

 

History

History
218 lines (133 loc) · 10 KB

README.md

File metadata and controls

218 lines (133 loc) · 10 KB
Raw

cloud.common collection

This collection is a library for the cloud modules.

Description:

cloud.common is the home of the following component:

  • ansible_turbo.module: a cache sharing solution to to enhance the performance and efficiency of your cloud automation tasks. Users can achieve significant performance improvements in their cloud automation workflows by using this module.

More content may be included later.

Communication

For more information about communication, see the Ansible communication guide.

Requirements

  • ansible_turbo.module requires Python 3.9 and Ansible 2.15.0 or greater.

Ansible Turbo Module

Current situation

The traditional execution flow of an Ansible module includes the following steps:

  • Upload of a ZIP archive with the module and its dependencies
  • Execution of the module, which is just a Python script
  • Ansible collects the results once the script is finished

These steps happen for each task of a playbook, and on every host.

Most of the time, the execution of a module is fast enough for the user. However, sometime the module requires an important amount of time, just to initialize itself. This is a common situation with the API based modules. A classic initialization involves the following steps:

  • Load a Python library to access the remote resource (via SDK)
  • Open a client
    • Load a bunch of Python modules.
    • Request a new TCP connection.
    • Create a session.
    • Authenticate the client.

All these steps are time consuming and the same operations will be running again and again.

For instance, here:

  • import openstack: takes 0.569s
  • client = openstack.connect(): takes 0.065s
  • client.authorize(): takes 1.360s

These numbers are from test ran against VexxHost public cloud.

In this case, it's a 2s-ish overhead per task. If the playbook comes with 10 tasks, the execution time cannot go below 20s.

How Ansible Turbo Module improve the situation

AnsibleTurboModule is actually a class that inherites from the standard AnsibleModule class that your modules probably already use. The big difference is that when an module starts, it also spawns a little Python daemon. If a daemon already exists, it will just reuse it. All the module logic is run inside this Python daemon. This means:

  • Python modules are actually loaded one time
  • Ansible module can reuse an existing authenticated session.

How can I enable AnsibleTurboModule?

If you are a collection maintainer and want to enable AnsibleTurboModule, you can follow these steps. Your module should inherit from AnsibleTurboModule, instead of AnsibleModule.

  from ansible_module.turbo.module import AnsibleTurboModule as AnsibleModule

You can also use the functools.lru_cache() decorator to ask Python to cache the result of an operation, like a network session creation.

Finally, if some of the dependeded libraries are large, it may be nice to defer your module imports, and do the loading AFTER the AnsibleTurboModule instance creation.

The background service

The daemon kills itself after 15s, and communication are done through an Unix socket. It runs in one single process and uses asyncio internally. Consequently you can use the async keyword in your Ansible module. This will be handy if you interact with a lot of remote systems at the same time.

Security impact

ansible_module.turbo open an Unix socket to interact with the background service. We use this service to open the connection toward the different target systems. This is similar to what SSH does with the sockets.

Things to note:

  • All the modules can access the same cache. Soon an isolation will be done at the collection level (#17)
  • A task can loaded a different version of a library and impact the next tasks.
  • If the same user runs two ansible-playbook at the same time, they will have access to the same cache.

When a module stores a session in a cache, it's a good idea to use a hash of the authentication information to identify the session.

You may want to isolate your Ansible environemt in a container, in this case you can consider https://github.com/ansible/ansible-builder

Error handling

ansible_module.turbo uses exception to communicate a result back to the module.

  • EmbeddedModuleFailure is raised when json_fail() is called.
  • EmbeddedModuleSuccess is raised in case of success and return the result to the origin module processthe origin.

These exceptions are defined in ansible_collections.cloud.common.plugins.module_utils.turbo.exceptions. You can raise EmbeddedModuleFailure exception yourself, for instance from a module in module_utils.

Be careful with the catch all exception (except Exception:). Not only they are bad practice, but also may interface with this mechanism.

Troubleshooting

You may want to manually start the server. This can be done with the following command:

.. code-block:: shell

PYTHONPATH=$HOME/.ansible/collections python -m ansible_collections.cloud.common.plugins.module_utils.turbo.server --socket-path $HOME/.ansible/tmp/turbo_mode.foo.bar.socket

Replace foo.bar with the name of the collection.

You can use the --help argument to get a list of the optional parameters.

Use Case

The Ansible module is slightly different while using AnsibleTurboModule. Here are some examples with OpenStack and VMware.

These examples use functools.lru_cache that is the Python core since 3.3. lru_cache() decorator will managed the cache. It uses the function parameters as unicity criteria.

Related Information

Demo

In this demo, we run one playbook that do several os_keypair calls. For the first time, we run the regular Ansible module. The second time, we run the same playbook, but with the modified version.

asciicast

More information

Testing

This collection is tested using GitHub Actions. To know more about CI, refer to CI.md.

Versioning

This collection follows Semantic Versioning. More details on versioning can be found in the Ansible docs.

Releasing

We plan to regularly release new minor or bugfix versions once new features or bugfixes have been implemented.

Releasing happens by tagging the main branch.

Contributing to this collection

We welcome community contributions to this collection. If you find problems, please open an issue or create a PR against the Cloud.Common collection repository.

Support

For the latest supported versions, refer to the release notes below.

If you encounter issues or have questions, you can submit a support request through the following channels:

  • GitHub Issues: Report bugs, request features, or ask questions by opening an issue in the GitHub repository.
  • Ansible Community: Engage with the Ansible community on the Ansible Project Mailing List or Ansible Forum.

Release notes

See CHANGELOG.rst.

Code of Conduct

We follow Ansible Code of Conduct in all our interactions within this project.

If you encounter abusive behavior violating the Ansible Code of Conduct, please refer to the policy violations section of the Code of Conduct for information on how to raise a complaint.

License Information

GNU General Public License v3.0 or later.

See LICENSE to see the full text.

The files in plugins/module_utils and plugins/plugin_utils directories are also licensed with a BSD license.