Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

Ansible content manager

Project description

Mazer

Ansible content manager

A new command-line tool for managing Ansible content.

Expect breaking changes!

Mazer is experimental, and currently only available for tech-preview. Use with lots of caution! It is not intended for use in production environments, nor is it currently intended to replace the ansible-galaxy command-line tool.

If you’re installing Ansible content in a production environment, or need assistance with Ansible, please visit the Ansible Project, or the Ansible docs site.

Docs

For additional documentation on mazer, view the Mazer topic on Ansible Galaxy Docs. Also see the more detailed README at github.

Examples

Installing roles

To install geerlingguy.nginx via galaxy:

$ mazer install geerlingguy.nginx

See mazer github repo for more examples.

Installing Mazer

From source

The source code for mazer lives at https://github.com/ansible/mazer

$ git clone https://github.com/ansible/mazer.git $ cd mazer $ python setup.py install

Or install the requirements via pip:

$ pip install -r requirements.txt

Via pip (from git)

pip install -v git+ssh://git@github.com/ansible/mazer.git

Testing

unit testing

mazer uses pytest for unit tests.

test requirements

To install test requirements, use pip to install the requirements in requirements_test.txt:

pip install -r requirements_test.txt

To run unit tests via tox for default platforms (python 2.6, 2.7, 3.6):

$ tox

via ‘pytest’ directly:

$ pytest tests/

Prerequisites

When installing content from an Ansible Galaxy server, requires Galaxy v3.0+.

Roadmap

To see what we’re working on, and where we’re headed, view the roadmap.

Getting help

Issues welcome! If you find a bug, or have a feature idea, please let us know by opening an issue.

You can also reach out to us on irc.freenode.net in the #ansible-galaxy channel.

Origin of “Mazer”

The name Mazer comes from a character from Ender’s Game, Mazer Rackham, that Wikipedia describes as “the half-Māori captain who singlehandedly stopped the Second Invasion by realizing that the Buggers are a hive mind. Due to his inability to pass on his knowledge, he was forced to spend fifty years at relativistic speeds (eight years to Rackham) so that he could train the next commander — Ender Wiggin.”

A mazer is also a hardwood drinking vessel.

Changelog

0.5.0 (2019-04-15)

  • WARNING: Mazer now requires a Ansible Galaxy server that provides the ‘v2’ style REST API. At time of release, that includes galaxy-dev.ansible.com and galaxy-qa.ansible.com
  • WARNING: Support for directly installing ‘traditional’ style roles from Ansible Galaxy is no longer supported. ie, ‘mazer install geerlingguy.ntp’ will no longer work. However, roles can still be installed if they are included in a collection
  • WARNING: The config file items and cli options for specifying install paths
    have changed and may break existing configs and scripts.
  • The cli option ‘–content-root’ is now ‘–collections-path’
  • The short cli option ‘-C’ is now shorthand for ‘–collections-path’ instead of ‘–content-root’
  • The config item ‘content_root’ has been replaced with ‘collections_path’
  • The config item ‘global_content_root’ has been replaced with ‘global_collections_path’
  • The new ‘collections_path’ value no longer needs to end with ‘ansible_collections’
  • The new ‘global_collections_path’ value no longer needs to end with ‘ansible_collections’
  • The new ‘collections_path’ defaults to ‘~/.ansible/collections’. Note that this replaces the previous ‘content_root’ config item that defaulted to ‘~/.ansible/collections/ansible_collections’
  • The new ‘global_collections_path’ defaults to ‘/usr/share/ansible/collections’. Note that this replaces the previous ‘global_content_root’ config item that defaulted to ‘/usr/share/ansible/collections/ansible_collections’
  • ‘mazer install’ with default ‘collections_path’ (‘~/.ansible/collections’) will still install to ‘~/.ansible/collections/ansible_collections’, but install will add the require trailing ‘ansible_collections’ automatically.
  • ‘mazer install –global’ with default ‘globale_collections_path’ (‘/usr/share/ansible/collections’) will still install to ‘/usr/share/ansible/collections/ansible_collections’, but ‘install –global’ will add the require trailing ‘ansible_collections’ automatically.
  • The REST API client now uses ‘requests’ python module instead of the ‘url’ module bundle from ansible.
  • Add cli ‘–config’ option to specify a path to an alternative config file.
  • Add support for ‘MAZER_HOME’ environment variable. MAZER_HOME defaults to ~/.ansible and specifies where mazer looks for it’s config (mazer.yml and mazer-logging.yml)
  • 216 Use Galaxy REST API v2.
  • 239 Rename content-root to collections-path to be consistent with ansible.
  • 228 For envs w/no LANG/locale/text encoding, assume utf8.
  • 236 Partial fix for scm_url installs.

0.4.0 (2019-03-28)

  • The default path for collections to be installed is now ‘~/.ansible/collections/ansible_collections’ which is also the default place ansible 2.8 or higher will search for collections.
  • Add the ‘mazer publish’ for publishing a collection artifact to Ansible Galaxy
  • 186 Implement ‘migrate_role’ command to convert traditional roles to collections.
  • galaxy.yml ‘authors’ field is now a list
  • galaxy.yml ‘dependencies’ field is now a dict where the key is the collection and the value is a https://github.com/rbarrois/python-semanticversion version spec
  • galaxy.yml ‘tags’ field (a list of tags) added
  • galaxy.yml ‘readme’ field added. The value is the path to the README file.
  • galaxy.yml optional new fields ‘repository’, ‘documentation’, ‘homepage’, ‘issues’
  • galaxy.yml optional field ‘license_file’ added. It’s value is a path to a file containing additional license information
  • collection artifacts file manifest info is now in the generated FILES.json
  • MANIFEST.json now includes path and sha256sum of new generated FILES.json
  • Dependency solving version matching now supports the python-semanticversion style version specs
  • Fixes and improvements for install of local collection artifacts. ie. mazer install my_namespace-my_collection-1.2.3.tar.gz
  • Updates to the use Galaxy REST v2 API
  • Updates to how SPDX data is loaded and used.
  • SPDX data updated to 3.4-59-ga68ef3c

0.2.1 (2018-08-08)

0.2.0 (2018-07-26)

  • Support new ~/.ansible/content/namespace/reponame/content_type/content_name layout
  • Create install receipts (.galaxy_install_info) on install of repos and roles.
  • ‘list’ and ‘info’ commands updated.
  • Now requires and uses ‘attrs’ python module >=18.1.0

0.1.0 (2018-04-18)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
mazer-0.5.0-py2.py3-none-any.whl (116.7 kB) Copy SHA256 hash SHA256 Wheel py2.py3
mazer-0.5.0.tar.gz (139.3 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page