ansible/cloud/openstack
Karthik Suresh 64ded1bb5e Removing duplicate name: parameter possible typo (#4525)
Removed name:parameter in documentation. Possible typo.
2016-08-24 11:04:59 -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 Fixing open stack compile time errors irt exception handling for Python 3 (#3848) 2016-06-03 06:37:09 -07:00
_keystone_user.py Fixing open stack compile time errors irt exception handling for Python 3 (#3848) 2016-06-03 06:37:09 -07:00
_nova_compute.py nova_compute: indicate argument type (#4070) 2016-07-02 00:06:44 +02:00
_nova_keypair.py Fixing open stack compile time errors irt exception handling for Python 3 (#3848) 2016-06-03 06:37:09 -07:00
_quantum_floating_ip.py Fixing open stack compile time errors irt exception handling for Python 3 (#3848) 2016-06-03 06:37:09 -07:00
_quantum_floating_ip_associate.py Fixing open stack compile time errors irt exception handling for Python 3 (#3848) 2016-06-03 06:37:09 -07:00
_quantum_network.py Fixing open stack compile time errors irt exception handling for Python 3 (#3848) 2016-06-03 06:37:09 -07:00
_quantum_router.py Fixing open stack compile time errors irt exception handling for Python 3 (#3848) 2016-06-03 06:37:09 -07:00
_quantum_router_gateway.py Fixing open stack compile time errors irt exception handling for Python 3 (#3848) 2016-06-03 06:37:09 -07:00
_quantum_router_interface.py Fixing open stack compile time errors irt exception handling for Python 3 (#3848) 2016-06-03 06:37:09 -07:00
_quantum_subnet.py Fixing open stack compile time errors irt exception handling for Python 3 (#3848) 2016-06-03 06:37:09 -07:00
os_auth.py Fix OpenStack module failure output 2016-01-13 11:15:24 -05:00
os_client_config.py Wrap calls to main() with if check 2016-04-06 12:18:35 -07:00
os_floating_ip.py Rename a confusing variable 2016-08-01 08:33:09 -05:00
os_image.py Wrap calls to main() with if check 2016-04-06 12:18:35 -07:00
os_image_facts.py s/plubic/public/in the doc 2016-03-26 14:17:26 +01:00
os_ironic.py Wrap calls to main() with if check 2016-04-06 12:18:35 -07:00
os_ironic_node.py Wrap calls to main() with if check 2016-04-06 12:18:35 -07:00
os_keypair.py Fix OpenStack module failure output 2016-01-13 11:15:24 -05:00
os_network.py ansible-validate-modules part 4: Enable check on ansible-modules-core (#3526) 2016-05-03 07:51:12 -07:00
os_networks_facts.py Remove version-added on name field. 2016-07-15 06:40:50 -07:00
os_nova_flavor.py Fix OpenStack module failure output 2016-01-13 11:15:24 -05:00
os_object.py Wrap calls to main() with if check 2016-04-06 12:18:35 -07:00
os_port.py Fix allowed_address_pairs and extra_dhcp_opts in os_port 2016-03-22 08:26:07 -04:00
os_router.py Fix bug in os_router.py when router is not actually updated. (#4107) 2016-07-11 16:01:20 +02:00
os_security_group.py Wrap calls to main() with if check 2016-04-06 12:18:35 -07:00
os_security_group_rule.py Make remote_group handle name and id in cloud/openstack/os_security_group_rule.py 2016-04-14 20:03:13 +02:00
os_server.py Removing duplicate name: parameter possible typo (#4525) 2016-08-24 11:04:59 -04:00
os_server_actions.py Fix OpenStack module failure output 2016-01-13 11:15:24 -05:00
os_server_facts.py Fix OpenStack module failure output 2016-01-13 11:15:24 -05:00
os_server_volume.py Fix OpenStack module failure output 2016-01-13 11:15:24 -05:00
os_subnet.py Fix can_update test in os_subnet (#3664) 2016-05-25 08:52:51 +02:00
os_subnets_facts.py Fix parameters where type is assumed. 2016-02-12 12:30:52 -05:00
os_user.py Only check default_project on resource creation 2016-04-04 13:20:00 +00:00
os_user_group.py Fix OpenStack module failure output 2016-01-13 11:15:24 -05:00
os_volume.py Fix size parameter documentation 2016-03-21 16:13:29 -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.