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.
99 lines
4.5 KiB
ReStructuredText
99 lines
4.5 KiB
ReStructuredText
6 years ago
|
.. _developer_guide:
|
||
|
|
||
7 years ago
|
***************
|
||
|
Developer Guide
|
||
|
***************
|
||
8 years ago
|
|
||
4 years ago
|
.. note::
|
||
|
|
||
|
**Making Open Source More Inclusive**
|
||
|
|
||
|
Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with these four terms: master, slave, blacklist, and whitelist. We ask that you open an issue or pull request if you come upon a term that we have missed. For more details, see `our CTO Chris Wright's message <https://www.redhat.com/en/blog/making-open-source-more-inclusive-eradicating-problematic-language>`_.
|
||
|
|
||
8 years ago
|
Welcome to the Ansible Developer Guide!
|
||
|
|
||
6 years ago
|
**Who should use this guide?**
|
||
8 years ago
|
|
||
6 years ago
|
If you want to extend Ansible by using a custom module or plugin locally, creating a module or plugin, adding functionality to an existing module, or expanding test coverage, this guide is for you. We've included detailed information for developers on how to test and document modules, as well as the prerequisites for getting your module or plugin accepted into the main Ansible repository.
|
||
8 years ago
|
|
||
6 years ago
|
Find the task that best describes what you want to do:
|
||
|
|
||
|
* I'm looking for a way to address a use case:
|
||
|
|
||
|
* I want to :ref:`add a custom plugin or module locally <developing_locally>`.
|
||
|
* I want to figure out if :ref:`developing a module is the right approach <module_dev_should_you>` for my use case.
|
||
5 years ago
|
* I want to :ref:`develop a collection <developing_collections>`.
|
||
4 years ago
|
* I want to :ref:`contribute to an Ansible-maintained collection <contributing_maintained_collections>`.
|
||
4 years ago
|
* I want to :ref:`contribute to a community-maintained collection <hacking_collections>`.
|
||
4 years ago
|
* I want to :ref:`migrate a role to a collection <migrating_roles>`.
|
||
6 years ago
|
|
||
6 years ago
|
* I've read the info above, and I'm sure I want to develop a module:
|
||
6 years ago
|
|
||
6 years ago
|
* What do I need to know before I start coding?
|
||
6 years ago
|
* I want to :ref:`set up my Python development environment <environment_setup>`.
|
||
|
* I want to :ref:`get started writing a module <developing_modules_general>`.
|
||
5 years ago
|
* I want to write a specific kind of module:
|
||
|
* a :ref:`network module <developing_modules_network>`
|
||
|
* a :ref:`Windows module <developing_modules_general_windows>`.
|
||
|
* an :ref:`Amazon module <AWS_module_development>`.
|
||
|
* an :ref:`OpenStack module <OpenStack_module_development>`.
|
||
|
* an :ref:`oVirt/RHV module <oVirt_module_development>`.
|
||
5 years ago
|
* a :ref:`VMware module <VMware_module_development>`.
|
||
4 years ago
|
* I want to :ref:`write a series of related modules <developing_modules_in_groups>` that integrate Ansible with a new product (for example, a database, cloud provider, network platform, and so on).
|
||
6 years ago
|
|
||
|
* I want to refine my code:
|
||
|
|
||
4 years ago
|
* I want to :ref:`debug my module code <debugging_modules>`.
|
||
6 years ago
|
* I want to :ref:`add tests <developing_testing>`.
|
||
6 years ago
|
* I want to :ref:`document my module <module_documenting>`.
|
||
5 years ago
|
* I want to :ref:`document my set of modules for a network platform <documenting_modules_network>`.
|
||
6 years ago
|
* I want to follow :ref:`conventions and tips for clean, usable module code <developing_modules_best_practices>`.
|
||
6 years ago
|
* I want to :ref:`make sure my code runs on Python 2 and Python 3 <developing_python_3>`.
|
||
|
|
||
|
* I want to work on other development projects:
|
||
|
|
||
|
* I want to :ref:`write a plugin <developing_plugins>`.
|
||
|
* I want to :ref:`connect Ansible to a new source of inventory <developing_inventory>`.
|
||
|
* I want to :ref:`deprecate an outdated module <deprecating_modules>`.
|
||
|
|
||
6 years ago
|
* I want to contribute back to the Ansible project:
|
||
|
|
||
6 years ago
|
* I want to :ref:`understand how to contribute to Ansible <ansible_community_guide>`.
|
||
6 years ago
|
* I want to :ref:`contribute my module or plugin <developing_modules_checklist>`.
|
||
|
* I want to :ref:`understand the license agreement <contributor_license_agreement>` for contributions to Ansible.
|
||
6 years ago
|
|
||
|
If you prefer to read the entire guide, here's a list of the pages in order.
|
||
8 years ago
|
|
||
|
.. toctree::
|
||
7 years ago
|
:maxdepth: 2
|
||
8 years ago
|
|
||
6 years ago
|
developing_locally
|
||
8 years ago
|
developing_modules
|
||
6 years ago
|
developing_modules_general
|
||
|
developing_modules_checklist
|
||
|
developing_modules_best_practices
|
||
|
developing_python_3
|
||
|
debugging
|
||
|
developing_modules_documenting
|
||
|
developing_modules_general_windows
|
||
6 years ago
|
developing_modules_general_aci
|
||
5 years ago
|
platforms/aws_guidelines
|
||
|
platforms/openstack_guidelines
|
||
|
platforms/ovirt_dev_guide
|
||
5 years ago
|
platforms/vmware_guidelines
|
||
4 years ago
|
platforms/vmware_rest_guidelines
|
||
6 years ago
|
developing_modules_in_groups
|
||
|
testing
|
||
|
module_lifecycle
|
||
8 years ago
|
developing_plugins
|
||
|
developing_inventory
|
||
|
developing_core
|
||
6 years ago
|
developing_program_flow_modules
|
||
7 years ago
|
developing_api
|
||
8 years ago
|
developing_rebasing
|
||
6 years ago
|
developing_module_utilities
|
||
5 years ago
|
developing_collections
|
||
4 years ago
|
migrating_roles
|
||
5 years ago
|
collections_galaxy_meta
|
||
6 years ago
|
overview_architecture
|