Collection Galaxy metadata structure — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# Collection Galaxy metadata structure

A key component of an Ansible collection is the `galaxy.yml` file placed in the root directory of a collection. This file contains the metadata of the collection that is used to generate a collection artifact.

## Structure

The `galaxy.yml` file must contain the following keys in valid YAML:

## Examples

    namespace: "namespace_name"
    name: "collection_name"
    version: "1.0.12"
    readme: "README.md"
    authors:
        - "Author1"
        - "Author2 (https://author2.example.com)"
        - "Author3 <author3@example.com>"
    dependencies:
        "other_namespace.collection1": ">=1.0.0"
        "other_namespace.collection2": ">=2.0.0,<3.0.0"
        "anderson55.my_collection": "*"    # note: "*" selects the highest version available
    license:
        - "MIT"
    tags:
        - demo
        - collection
    repository: "https://www.github.com/my_org/my_collection"

See also

Developing collections
  Develop or modify a collection.
Ansible module development: getting started
  Learn about how to write Ansible modules
Using collections
  Learn how to install and use collections.
Mailing List
  The development mailing list
irc.freenode.net
  #ansible IRC chat channel