ansible

Mirror of https://github.com/ansible/ansible.git

You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Go to file

Dag Wieers cd9471ef17 Introduce new 'required_by' argument_spec option (#28662 ) * Introduce new "required_by' argument_spec option This PR introduces a new required_by argument_spec option which allows you to say "if parameter A is set, parameter B and C are required as well". - The difference with required_if is that it can only add dependencies if a parameter is set to a specific value, not when it is just defined. - The difference with required_together is that it has a commutative property, so: "Parameter A and B are required together, if one of them has been defined". As an example, we need this for the complex options that the xml module provides. One of the issues we often see is that users are not using the correct combination of options, and then are surprised that the module does not perform the requested action(s). This would be solved by adding the correct dependencies, and mutual exclusives. For us this is important to get this shipped together with the new xml module in Ansible v2.4. (This is related to bugfix https://github.com/ansible/ansible/pull/28657) ```python module = AnsibleModule( argument_spec=dict( path=dict(type='path', aliases=['dest', 'file']), xmlstring=dict(type='str'), xpath=dict(type='str'), namespaces=dict(type='dict', default={}), state=dict(type='str', default='present', choices=['absent', 'present'], aliases=['ensure']), value=dict(type='raw'), attribute=dict(type='raw'), add_children=dict(type='list'), set_children=dict(type='list'), count=dict(type='bool', default=False), print_match=dict(type='bool', default=False), pretty_print=dict(type='bool', default=False), content=dict(type='str', choices=['attribute', 'text']), input_type=dict(type='str', default='yaml', choices=['xml', 'yaml']), backup=dict(type='bool', default=False), ), supports_check_mode=True, required_by=dict( add_children=['xpath'], attribute=['value', 'xpath'], content=['xpath'], set_children=['xpath'], value=['xpath'], ), required_if=[ ['count', True, ['xpath']], ['print_match', True, ['xpath']], ], required_one_of=[ ['path', 'xmlstring'], ['add_children', 'content', 'count', 'pretty_print', 'print_match', 'set_children', 'value'], ], mutually_exclusive=[ ['add_children', 'content', 'count', 'print_match','set_children', 'value'], ['path', 'xmlstring'], ], ) ``` * Rebase and fix conflict * Add modules that use required_by functionality * Update required_by schema * Fix rebase issue		6 years ago
.github	Add new WG members	6 years ago
bin	Save the command line arguments into a global context	6 years ago
changelogs	yum always return changes dict, not only in check mode (#51987 )	6 years ago
contrib	Fix pycodestyle E117 issues.	6 years ago
docs	Ansible.Basic: make module options case insensitive with dep warning (#51583 )	6 years ago
examples	examples: fix Ansible API example (#51863 )	6 years ago
hacking	aws_kms enhancements (#31960 )	6 years ago
lib/ansible	Introduce new 'required_by' argument_spec option (#28662 )	6 years ago
licenses	Bundle a copy of github.com/nir0s/distro/distro.py	6 years ago
packaging	Change some file listings to try and figure out which rpm macro is undefined	6 years ago
test	Introduce new 'required_by' argument_spec option (#28662 )	6 years ago
.cherry_picker.toml	🚸 🐍 🍒 ⛏ Integrate cherry picker (#41403 )	6 years ago
.coveragerc	AnsiballZ improvements	6 years ago
.gitattributes	2.6 changelog gen/version/root dir cleanup (#40421 )	7 years ago
.gitignore	aws_kms enhancements (#31960 )	6 years ago
.mailmap	Fix syntax typo	7 years ago
CODING_GUIDELINES.md	Tidy up Contributors Docs (#47619 )	6 years ago
COPYING	license file should be in source tree	13 years ago
MANIFEST.in	Update MANIFEST.in (#46502 )	6 years ago
MODULE_GUIDELINES.md	Tidy up Contributors Docs (#47619 )	6 years ago
Makefile	In the Makefile useful target list, mention "clean" and "webdocs". (#48843 )	6 years ago
README.rst	Upgrade README to have 4k+ contributors listed (#50093 )	6 years ago
requirements.txt	Remove runtime usage of pkg_resources.	6 years ago
setup.py	win_exec: refactor PS exec runner (#45334 )	6 years ago
shippable.yml	Add FreeBSD 12.0 to CI. (#52195 )	6 years ago
tox.ini	Updated test constraints for mock assert_called() and assert_called_once()	6 years ago

README.rst

|PyPI version| |Docs badge| |Chat badge| |Build Status| |Code Of Conduct| |Mailing Lists| |License|

*******
Ansible
*******

Ansible is a radically simple IT automation system. It handles
configuration-management, application deployment, cloud provisioning,
ad-hoc task-execution, and multinode orchestration -- including
trivializing things like zero-downtime rolling updates with load
balancers.

Read the documentation and more at https://ansible.com/

You can find installation instructions
`here <https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html>`_ for a
variety of platforms.

Most users should probably install a released version of Ansible from ``pip``, a package manager or
our `release repository <https://releases.ansible.com/ansible/>`_. `Officially supported
<https://www.ansible.com/ansible-engine>`_ builds of Ansible are also available. Some power users
run directly from the development branch - while significant efforts are made to ensure that
``devel`` is reasonably stable, you're more likely to encounter breaking changes when running
Ansible this way.

Design Principles
=================

*  Have a dead simple setup process and a minimal learning curve.
*  Manage machines very quickly and in parallel.
*  Avoid custom-agents and additional open ports, be agentless by
   leveraging the existing SSH daemon.
*  Describe infrastructure in a language that is both machine and human
   friendly.
*  Focus on security and easy auditability/review/rewriting of content.
*  Manage new remote machines instantly, without bootstrapping any
   software.
*  Allow module development in any dynamic language, not just Python.
*  Be usable as non-root.
*  Be the easiest IT automation system to use, ever.

Get Involved
============

*  Read `Community
   Information <https://docs.ansible.com/ansible/latest/community>`_ for all
   kinds of ways to contribute to and interact with the project,
   including mailing list information and how to submit bug reports and
   code to Ansible.
*  All code submissions are done through pull requests to the ``devel`` branch.
*  Feel free to talk to us before making larger changes
   to avoid duplicate efforts. This not only helps everyone
   know what's going on, it also helps save time and effort if we decide
   some changes are needed.
*  Users list:
   `ansible-project <https://groups.google.com/group/ansible-project>`_
*  Development list:
   `ansible-devel <https://groups.google.com/group/ansible-devel>`_
*  Announcement list:
   `ansible-announce <https://groups.google.com/group/ansible-announce>`_
   -- read only
*  irc.freenode.net: #ansible
*  For the full list of Email Lists, IRC channels see the
   `Communication page <https://docs.ansible.com/ansible/latest/community/communication.html>`_

Branch Info
===========

*  Releases are named after Led Zeppelin songs. (Releases prior to 2.0
   were named after Van Halen songs.)
*  The ``devel`` branch corresponds to the release actively under
   development.
*  The ``stable-2.x`` branches exist for current releases.
*  Various release-X.Y branches exist for previous releases.
*  For information about the active branches see the
   `Ansible release and maintenance <https://docs.ansible.com/ansible/latest/reference_appendices/release_and_maintenance.html>`_ page.
*  We'd love to have your contributions, read the `Community
   Guide <https://docs.ansible.com/ansible/latest/community>`_ for notes on
   how to get started.

Roadmap
=======

Based on team and community feedback, an initial roadmap will be published for a major or minor version (ex: 2.0, 2.1).
Subminor versions will generally not have roadmaps published.

The `Ansible Roadmap page <https://docs.ansible.com/ansible/devel/roadmap/>`_ details what is planned and how to influence the roadmap.

Authors
=======

Ansible was created by `Michael DeHaan <https://github.com/mpdehaan>`_
(michael.dehaan/gmail/com) and has contributions from over 4000 users
(and growing). Thanks everyone!

`Ansible <https://www.ansible.com>`_ is sponsored by `Red Hat, Inc.
<https://www.redhat.com>`_

License
=======

GNU General Public License v3.0

See `COPYING <COPYING>`_ to see the full text.

.. |PyPI version| image:: https://img.shields.io/pypi/v/ansible.svg
   :target: https://pypi.org/project/ansible
.. |Docs badge| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg
   :target: https://docs.ansible.com/ansible/latest/
.. |Build Status| image:: https://api.shippable.com/projects/573f79d02a8192902e20e34b/badge?branch=devel
   :target: https://app.shippable.com/projects/573f79d02a8192902e20e34b
.. |Chat badge| image:: https://img.shields.io/badge/chat-IRC-brightgreen.svg
   :target: https://docs.ansible.com/ansible/latest/community/communication.html
.. |Code Of Conduct| image:: https://img.shields.io/badge/code%20of%20conduct-Ansible-silver.svg
   :target: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html
   :alt: Ansible Code of Conduct
.. |Mailing Lists| image:: https://img.shields.io/badge/mailing%20lists-Ansible-orange.svg
   :target: https://docs.ansible.com/ansible/latest/community/communication.html#mailing-list-information
   :alt: Ansible mailing lists
.. |License| image:: https://img.shields.io/badge/license-GPL%20v3.0-brightgreen.svg
   :target: COPYING
   :alt: Repository License