Zen

Translation

English type: Title ==
Naming
10/100 · 6

Sign in to save the translation.

English Finnish Actions
Ansible Collection Packaging Guidelines
 
Forward
Seuraava
Ansible collections are packaged units of Ansible content, including modules and other types of plugins. Most Ansible Plugins are written in Python or Powershell.
 
Some collections are also included in Ansible Community's `+ansible+` collection bundle, which is packaged in Fedora. All collections, whether or not they are included in the `+ansible+` package, MAY be packaged in Fedora.
 
`+ansible+` depends on `+ansible-core+`, which contains the core engine and CLI programs (e.g. `+ansible+`, `+ansible-playbook+`). The `+ansible+` package has a different release cycle than individual collections, and it may contain older versions of the individual components. `+ansible+` installs collections in a different namespace and is parallel installable with individual collections. The Ansible engine searches for collections in the standalone collections directory first.
 
See https://fedoraproject.org/wiki/Changes/Ansible5[Changes/Ansible5] for more information about the split between `+ansible+` and `+ansible-core+`.
 
Naming
Nimeäminen
Collection packages MUST be named `+ansible-collection-NAMESPACE-NAME+`. For example, the `+community.general+` collection package is named `+ansible-collection-community-general+`.
 
Collection Source
 
Collection source code MUST be downloaded from the collection's respective Git forge/other SCM repository. While the tarballs published to Ansible Galaxy contain all of the collection's Python/Powershell source code as well as some development files, they do not include the `+galaxy.yml+` build configuration and development files (e.g. unit tests) that the author may choose to remove. Note that the Ansible Community collection requirements mandate that collections tag releases in a public SCM repository.
 
Collection packages SHOULD use `+%{ansible_collection_url NAMESPACE NAME}+` as the package's `+URL:+`. This points to the collection's homepage on Ansible Galaxy.
 
Dependencies
Riippuvuudet
Buildtime
Koostamisaika
Collections MUST have `+BuildRequires: ansible-packaging+`. `+ansible-packaging+` provides macros and a dependency generator for packaging Ansible Collections. It also pulls in `+ansible-core+`, so `+BuildRequires: ansible-core+` SHOULD NOT be added manually.
 
Runtime
Ajonaikainen
The dependency generator will generate the appropriate dependency on the Ansible engine. This ensures compatibility with Fedora 35 which contains the classic `+ansible+` 2.9 package (instead of the collections bundle) and `+ansible-core+`. Both versions of the Ansible engine support collections, but they are not parallel installable. Packages MUST NOT manually `+Require+` `+ansible-core+` or `+ansible+`, unless they are known to require a specific version, in which case the appropriate version constraints should be used.
 
The dependency generator also handles inter-collection dependencies.
 
External dependencies of plugins
 
Ansible collections may contain various plugins that have various external dependencies. The Ansible dev guide https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_best_practices.html#importing-and-using-shared-code[mandates] that plugins fail cleanly if these dependencies are not installed. Many times, external dependencies are only needed for a small subset of the collection which may or may not be widely used. Therefore, collection packages SHOULD weakly depend on these external libraries, i.e. use Recommends instead of Requires.
 
Module dependencies are only needed on the target node not the controller node. Therefore, collection packages SHOULD NOT depend on these dependencies at all, weakly or strongly. Users are responsible for installing these dependencies on the target host. Modules that are intended to be used with `+delegate_to: localhost+` are an exception to this rule.
 
The situation is a bit different for controller plugins, such as filter plugins, lookup plugins, connection plugins, or inventory plugins. Collections MAY add `+Recommends+` for dependencies of controller plugins. However, packagers should use discretion when adding any type of dependency and only do so when it is required for the central functionality of the collection. For instance, it makes sense for `+ansible-collection-community-docker+` to Recommend `+python3-docker+`, but it doesn't make sense for the larger, more general ansible-collection-community-general collection to Recommend `+python3-redis+` for the `+redis+` lookup plugin. This guideline seeks to prevent ballooning collection packages. `+ansible-core+` and `+ansible+` follow this same principle.
 
Build and Installation
 

Loading…

User avatar copperi

Suggestion accepted
Naming
Nimeäminen
a year ago
User avatar anonymous

Suggestion added
Naming
Nimeäminen
a year ago
User avatar None

String updated in the repository
Naming
 
2 years ago
Browse all string changes

Things to check

Inconsistent

This string has more than one translation in this project or is untranslated in some components.

Reset

Glossary

English Finnish
No related strings found in the glossary.

12194373 String information

Source string description
type: Title ==
Flags
no-wrap
Source string location
pages/Ansible_collections.adoc:27
String age
2 years ago
Last updated
a year ago
Source string age
2 years ago
Translation file
po/fi/master/pages/Ansible_collections.po, string 7