mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
38c0769abb
* Change example syntax on supervisorctl module * Change example syntax or _ec2_ami_search module * Change example syntax on cloudformation module * Change example syntax on ec2 module * Change example syntax on ec2_facts module * Change example syntax on ec2_eip module * Change example syntax on rds module * Change example syntax on route53 module * Change example syntax on s3 module * Change example syntax on digital_ocean module * Change example syntax on docker_service module * Change example syntax on cloudformation module * Change example syntax on gc_storage module * Change example syntax on gce module * Change example syntax on gce_mig module * Change example syntax on _glance_image module * Change example syntax on _keystone_user module * Change example syntax on _nova_keypair module * Change example syntax on _quantum_floating module * Change example syntax on _quantum_floating_ip_associate module * Change example syntax on _quantum_network module * Change example syntax on _quantum_router module * Change example syntax on _quantum_router_gateway module * Change example syntax on _quantum_router_interface module * Change example syntax on _quantum_subnet module * SQUASH _quantum_subnet * Add missing quotes |
||
|---|---|---|
| .. | ||
| __init__.py | ||
| _glance_image.py | ||
| _keystone_user.py | ||
| _nova_compute.py | ||
| _nova_keypair.py | ||
| _quantum_floating_ip.py | ||
| _quantum_floating_ip_associate.py | ||
| _quantum_network.py | ||
| _quantum_router.py | ||
| _quantum_router_gateway.py | ||
| _quantum_router_interface.py | ||
| os_auth.py | ||
| os_client_config.py | ||
| os_floating_ip.py | ||
| os_image.py | ||
| os_image_facts.py | ||
| os_ironic.py | ||
| os_ironic_node.py | ||
| os_keypair.py | ||
| os_network.py | ||
| os_networks_facts.py | ||
| os_nova_flavor.py | ||
| os_object.py | ||
| os_port.py | ||
| os_router.py | ||
| os_security_group.py | ||
| os_security_group_rule.py | ||
| os_server.py | ||
| os_server_actions.py | ||
| os_server_facts.py | ||
| os_server_volume.py | ||
| os_subnet.py | ||
| os_subnets_facts.py | ||
| os_user.py | ||
| os_user_group.py | ||
| os_volume.py | ||
| quantum_subnet.py | ||
| README.md | ||
OpenStack Ansible Modules
These are a set of modules for interacting with OpenStack as either an admin or an end user. If the module does not begin with os_, it's either deprecated or soon to be. This document serves as developer coding guidelines for modules intended to be here.
Naming
- All modules should start with os_
- If the module is one that a cloud consumer would expect to use, it should be named after the logical resource it manages. Thus, os_server not os_nova. The reasoning for this is that there are more than one resource that are managed by more than one service and which one manages it is a deployment detail. A good example of this are floating IPs, which can come from either Nova or Neutron, but which one they come from is immaterial to an end user.
- If the module is one that a cloud admin would expect to use, it should be be named with the service and the resouce, such as os_keystone_domain.
- If the module is one that a cloud admin and a cloud consumer could both use, the cloud consumer rules apply.
Interface
- If the resource being managed has an id, it should be returned.
- If the resource being managed has an associated object more complex than an id, it should also be returned.
Interoperability
- It should be assumed that the cloud consumer does not know a bazillion details about the deployment choices their cloud provider made, and a best effort should be made to present one sane interface to the ansible user regardless of deployer insanity.
- All modules should work appropriately against all existing known public OpenStack clouds.
- It should be assumed that a user may have more than one cloud account that they wish to combine as part of a single ansible managed infrastructure.
Libraries
- All modules should use openstack_full_argument_spec to pick up the standard input such as auth and ssl support.
- All modules should extends_documentation_fragment: openstack to go along with openstack_full_argument_spec.
- All complex cloud interaction or interoperability code should be housed in the shade library.
- All OpenStack API interactions should happen via shade and not via OpenStack Client libraries. The OpenStack Client libraries do no have end users as a primary audience, they are for intra-server communication. The python-openstacksdk is the future there, and shade will migrate to it when its ready in a manner that is not noticable to ansible users.