cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
No description
29329 commits 47 branches 390 tags 440 MiB
Python 88.4%
PowerShell 7.5%
Shell 2%
C# 1.9%
Makefile 0.1%
Find a file
John R Barker 04e816e13b Stricter module documentation validation (#22353) 
Raise the bar for module `DOCUMENTAION`
This validator update was used to find the issues in https://github.com/ansible/ansible/pull/22297/files

**Validation**
* Updated Validation and docs to enforce more (items fixed in https://github.com/ansible/ansible/pull/22297/files)
* Use `suboptions` to document complex options 
* Validate module name
* Validate deprecated modules have correct ANSIBLE_METADATA

**Module Documentation Generation**
* Document `suboptions:` Example https://gist.github.com/gundalow/4bdc3669d696268328ccc18528cc6718
* Tidy up HTML generation (valid HTML, no empty lists, etc)
 
**Documentation**
* Clarify the steps for deprecating a module
* Use correct RST headings
* Document `suboptions:` (options)
* Document `contains:` (returns)


**Details**
The aim is to get this (and corresponding module updates) complete by the time `devel` becomes `2.4`, as this allows us to raise the bar for new modules

Example `suboptions` https://gist.github.com/gundalow/4bdc3669d696268328ccc18528cc6718

The aim is to get this PR integrated into `devel` *before* we branch `stable-2.3`, this will allows us to:
* Raise the bar for new modules in 2.4
* Ensure the generated module documentation for 2.3 and higher is improved, important as we will be doing versioned docs moving forward.
2017-03-13 19:49:27 +00:00
.github Move summary to be next to where github places the commit message. (#22368) 2017-03-07 18:00:22 +01:00
bin Handle downstream version additions (#22428) 2017-03-10 12:01:11 -08:00
contrib Fix Elasticcache issue where ec2 script would fail on finding lack of primary endpoint address on Redis cluster (#20190) 2017-03-10 13:08:54 -05:00
docs Stricter module documentation validation (#22353) 2017-03-13 19:49:27 +00:00
examples moved network module magic from hardcoded to conf 2017-03-09 21:49:02 -05:00
hacking Stricter module documentation validation (#22353) 2017-03-13 19:49:27 +00:00
lib/ansible Add no_log to all network module_utils provider argument (#22566) 2017-03-13 13:21:46 -06:00
packaging Use HTTPS instead of legacy HTTP for ansible.com (#16870) 2017-02-15 16:09:33 -08:00
test Stricter module documentation validation (#22353) 2017-03-13 19:49:27 +00:00
ticket_stubs
.coveragerc Run unit tests in isolation w/ coverage support. 2017-02-27 17:16:45 -08:00
.gitattributes
.gitignore Create bot friendly sanity output. (#22381) 2017-03-07 14:59:50 -08:00
.gitmodules
.mailmap
.yamllint
ansible-core-sitemap.xml
CHANGELOG.md added stuff to changelog 2017-03-09 15:46:45 -05:00
CODING_GUIDELINES.md
CONTRIBUTING.md
COPYING
Makefile clean tests results 2017-03-12 12:30:24 -04:00
MANIFEST.in Move to using a requirements.txt to install the python packages. (#21430) 2017-02-15 06:58:09 -08:00
MODULE_GUIDELINES.md
README.md
RELEASES.txt
requirements.txt Move to using a requirements.txt to install the python packages. (#21430) 2017-02-15 06:58:09 -08:00
ROADMAP.rst Update ROADMAP (#20002) 2017-01-16 11:36:53 +00:00
setup.py Use HTTPS instead of legacy HTTP for ansible.com (#16870) 2017-02-15 16:09:33 -08:00
shippable.yml Split up unit tests on Shippable. (#21931) 2017-02-24 16:58:56 -08:00
tox.ini Pass TEST_FLAGS environment variable to tests run with Tox (#21611) 2017-02-20 15:24:39 -08:00
VERSION

README.md

PyPI version Build Status

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/

Many users run straight from the development branch (it's generally fine to do so), but you might also wish to consume a release.

You can find instructions here for a variety of platforms.

If you want to download a tarball of a release, go to releases.ansible.com, though most users use yum (using the EPEL instructions linked above), apt (using the PPA instructions linked above), or pip install ansible.

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 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. Take care to make sure no merge commits are in the submission, and use git rebase vs git merge for this reason. If submitting a large code change (other than modules), it's probably a good idea to join ansible-devel and talk about what you would like to do or add first and 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
  • Development list: ansible-devel
  • Announcement list: ansible-announce - read only
  • irc.freenode.net: #ansible

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.
  • For releases 1.8 - 2.2, modules are kept in different repos, you'll want to follow core and extras
  • Various release-X.Y branches exist for previous releases.
  • We'd love to have your contributions, read Community Information for notes on how to get started.

Authors

Ansible was created by Michael DeHaan (michael.dehaan/gmail/com) and has contributions from over 1000 users (and growing). Thanks everyone!

Ansible is sponsored by Ansible, Inc

Licence

GNU Click on the Link to see the full text.