cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
No description
41689 commits 47 branches 390 tags 440 MiB
Python 88.4%
PowerShell 7.5%
Shell 2%
C# 1.9%
Makefile 0.1%
Find a file
Toshio Kuratomi bd072fe83a
Make the timeout decorator raise an exception out of the function's scope (#49921) 
* Revert "allow caller to deal with timeout (#49449)"

This reverts commit 63279823a7.

Flawed on many levels

* Adds poor API to a public function
* Papers over the fact that the public function is doing something bad
  by catching exceptions it cannot handle in the first place
* Papers over the real cause of the issue which is a bug in the timeout
  decorator
* Doesn't reraise properly
* Catches the wrong exception

Fixes #49824
Fixes #49817

* Make the timeout decorator properly raise an exception outside of the function's scope

signal handlers which raise exceptions will never work well because the
exception can be raised anywhere in the called code.  This leads to
exception race conditions where the exceptions could end up being
hanlded by unintended pieces of the called code.

The timeout decorator was using just that idiom.  It was especially bad
because the decorator syntactically occurs outside of the called code
but because of the signal handler, the exception was being raised inside
of the called code.

This change uses a thread instead of a signal to manage the timeout in
parallel to the execution of the decorated function.  Since raising of
the exception happens inside of the decorator, now, instead of inside of
a signal handler, the timeout exception is raised from outside of the
called code as expected which makes reasoning about where exceptions are
to be expected intuitive again.

Fixes #43884

* Add a common case test.

Adding an integration test driven from our unittests.  Most of the time
we'll timeout in run_command which is running things in a subprocess.
Create a test for that specific case in case anything funky comes up
between threading and execve.

* Don't use OSError-based TimeoutError as a base class

Unlike most standard exceptions, OSError has a specific parameter list
with specific meanings.  Instead follow the example of other stdlib
functions, concurrent.futures and multiprocessing and define a separate
TimeoutException.

* Add comment and docstring to point out that this is not hte Python3 TimeoutError
2018-12-18 18:01:46 -08:00
.github Fix GitHub handle, use keachi (#50043) 2018-12-17 19:35:49 +00:00
bin Don't fail if a remote_addr with a '/' hits ansible_connection (#49781) 2018-12-17 12:53:32 -05:00
changelogs facts: detect FreeBSD KVM guests (#50030) 2018-12-19 06:57:53 +10:00
contrib Docker inventory service/stack groups for docker swarm (#48021) 2018-12-17 11:58:26 +00:00
docs plugin_formatter.py: Improve the output when processing docs (#46541) 2018-12-18 11:23:49 -06:00
examples inventory plugin order: update doc 2018-12-12 09:35:13 -08:00
hacking Port from plaform.dist to ansible.module_utils.distro.linux_distribution 2018-12-17 11:01:01 -08:00
lib/ansible Make the timeout decorator raise an exception out of the function's scope (#49921) 2018-12-18 18:01:46 -08:00
licenses Bundle a copy of github.com/nir0s/distro/distro.py 2018-12-17 11:01:01 -08:00
packaging fixes to ansible-doc (#47682) 2018-12-10 11:37:15 -05:00
test Make the timeout decorator raise an exception out of the function's scope (#49921) 2018-12-18 18:01:46 -08:00
.cherry_picker.toml 🚸 🐍 🍒 ⛏ Integrate cherry picker (#41403) 2018-07-12 19:34:02 +03:00
.coveragerc AnsiballZ improvements 2018-07-26 20:07:25 -07:00
.gitattributes
.gitignore added build artifact to .gitignore (#47518) 2018-10-23 10:52:36 -05:00
.mailmap
CODING_GUIDELINES.md Tidy up Contributors Docs (#47619) 2018-10-28 17:11:40 -05:00
COPYING
Makefile In the Makefile useful target list, mention "clean" and "webdocs". (#48843) 2018-11-19 14:44:26 -06:00
MANIFEST.in Update MANIFEST.in (#46502) 2018-10-08 12:55:24 -07:00
MODULE_GUIDELINES.md Tidy up Contributors Docs (#47619) 2018-10-28 17:11:40 -05:00
README.rst Upgrade README to have 4k+ contributors listed (#50093) 2018-12-18 15:50:19 +01:00
requirements.txt Remove runtime usage of pkg_resources. 2018-10-18 15:09:38 -07:00
setup.py win_exec: refactor PS exec runner (#45334) 2018-10-02 15:55:53 -07:00
shippable.yml ansible-test - swap Fedora 25 for 29 (#49634) 2018-12-07 12:00:23 +10:00
tox.ini Fix ansible-test unit test execution. (#45772) 2018-09-18 08:37:14 -07:00

README.rst

PyPI version Docs badge Chat badge Build Status Ansible Code of Conduct Ansible mailing lists Repository 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 for a variety of platforms.

Most users should probably install a released version of Ansible from pip, a package manager or our release repository. Officially supported 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 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
  • Development list: ansible-devel
  • Announcement list: ansible-announce -- read only
  • irc.freenode.net: #ansible
  • For the full list of Email Lists, IRC channels see the Communication page

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 page.
  • We'd love to have your contributions, read the Community Guide 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 details what is planned and how to influence the roadmap.

Authors

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

Ansible is sponsored by Red Hat, Inc.

License

GNU General Public License v3.0

See COPYING to see the full text.