ansible/cloud/openstack
2015-07-06 18:53:31 -04:00
..
__init__.py added __init__.py to new cloud subcategories so builds work again 2014-11-05 11:07:19 -05:00
_glance_image.py Add OpenStack Image module 2015-06-05 15:58:10 -04:00
_nova_compute.py Finish up cleanups to modules: 2015-05-11 13:21:17 -07:00
_nova_keypair.py Add OpenStack Keypair module 2015-06-18 08:01:24 -04:00
_quantum_network.py Add OpenStack Network module 2015-05-20 11:41:24 -07:00
_quantum_subnet.py Revert "Add deprecated documentation for _quantum_subnet" 2015-06-01 15:24:15 -07:00
keystone_user.py Updating cloud modules with proper github author information 2015-06-15 14:41:22 -04:00
os_auth.py Updating cloud modules with proper github author information 2015-06-15 14:41:22 -04:00
os_client_config.py Fix dict syntax typo 2015-06-29 10:34:24 -04:00
os_image.py Return resource objects from OpenStack modules 2015-06-17 05:24:08 -04:00
os_ironic.py minor doc fixes 2015-06-16 18:56:24 -04:00
os_ironic_node.py minor doc fixes 2015-06-16 18:56:24 -04:00
os_keypair.py Fix indentation levels in os_keypair 2015-07-01 05:00:39 -07:00
os_network.py Return resource objects from OpenStack modules 2015-06-17 05:24:08 -04:00
os_object.py Return resource objects from OpenStack modules 2015-06-17 05:24:08 -04:00
os_security_group.py Remove duplicate shade requirement 2015-06-19 17:39:57 -04:00
os_security_group_rule.py Update docstring to show port ranges as optional 2015-07-06 18:53:31 -04:00
os_server.py Document auto_floating_ip argument 2015-06-29 14:06:50 -07:00
os_server_actions.py Updating cloud modules with proper github author information 2015-06-15 14:41:22 -04:00
os_server_facts.py Updating cloud modules with proper github author information 2015-06-15 14:41:22 -04:00
os_server_volume.py Updating cloud modules with proper github author information 2015-06-15 14:41:22 -04:00
os_subnet.py Return resource objects from OpenStack modules 2015-06-17 05:24:08 -04:00
os_volume.py Return resource objects from OpenStack modules 2015-06-17 05:24:08 -04:00
quantum_floating_ip.py Updating cloud modules with proper github author information 2015-06-15 14:41:22 -04:00
quantum_floating_ip_associate.py Updating cloud modules with proper github author information 2015-06-15 14:41:22 -04:00
quantum_router.py Updating cloud modules with proper github author information 2015-06-15 14:41:22 -04:00
quantum_router_gateway.py Updating cloud modules with proper github author information 2015-06-15 14:41:22 -04:00
quantum_router_interface.py Updating cloud modules with proper github author information 2015-06-15 14:41:22 -04:00
README.md Return resource objects from OpenStack modules 2015-06-17 05:24:08 -04:00

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.