History

Ricardo Carrillo Cruz 6e6817ce18 Fix is_public type on os_image Without this fix, the is_public value is a string and the shade call handling the module does not evaluate correctly when passing is_public: no		2016-03-29 11:37:49 +00: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	Fix glance_client module	2016-01-25 14:49:37 +02:00
_keystone_user.py	@lorin stepping down as maintainer	2015-10-28 14:38:11 -04:00
_nova_compute.py	The nova_compute module create a list of un-use floating ip by value of fixed_ip.	2015-07-14 13:48:42 +09:00
_nova_keypair.py	Add OpenStack Keypair module	2015-06-18 08:01:24 -04:00
_quantum_floating_ip.py	Add OpenStack Floating IP Module	2015-06-16 15:50:31 -07:00
_quantum_floating_ip_associate.py	Add OpenStack Floating IP Module	2015-06-16 15:50:31 -07:00
_quantum_network.py	fixed quantum_ modules to work with minimum access rights if greater access rights are not needed	2015-11-26 15:34:47 +02:00
_quantum_router.py	fixed quantum_ modules to work with minimum access rights if greater access rights are not needed	2015-11-26 15:34:47 +02:00
_quantum_router_gateway.py	Deprecate older router modules.	2015-10-02 09:24:03 -04:00
_quantum_router_interface.py	fixed quantum_ modules to work with minimum access rights if greater access rights are not needed	2015-11-26 15:34:47 +02:00
_quantum_subnet.py	fixed quantum_ modules to work with minimum access rights if greater access rights are not needed	2015-11-26 15:34:47 +02:00
os_auth.py	Fix OpenStack module failure output	2016-01-13 11:15:24 -05:00
os_client_config.py	Fix parameters where type is assumed.	2016-02-12 12:30:52 -05:00
os_floating_ip.py	added missing version_added	2016-01-25 23:43:46 -05:00
os_image.py	Fix is_public type on os_image	2016-03-29 11:37:49 +00:00
os_image_facts.py	s/plubic/public/in the doc	2016-03-26 14:17:26 +01:00
os_ironic.py	Fix OpenStack module failure output	2016-01-13 11:15:24 -05:00
os_ironic_node.py	Fix parameters where type is assumed.	2016-02-12 12:30:52 -05:00
os_keypair.py	Fix OpenStack module failure output	2016-01-13 11:15:24 -05:00
os_network.py	Fix OpenStack module failure output	2016-01-13 11:15:24 -05:00
os_networks_facts.py	Fix parameters where type is assumed.	2016-02-12 12:30:52 -05:00
os_nova_flavor.py	Fix OpenStack module failure output	2016-01-13 11:15:24 -05:00
os_object.py	Fix openstack module documentation	2016-03-04 09:32:40 -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 OpenStack module failure output	2016-01-13 11:15:24 -05:00
os_security_group.py	Fix OpenStack module failure output	2016-01-13 11:15:24 -05:00
os_security_group_rule.py	Fix OpenStack module failure output	2016-01-13 11:15:24 -05:00
os_server.py	openstack: os_server: add version_added for scheduler_hints	2016-03-18 23:45:48 +01: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 OpenStack module failure output	2016-01-13 11:15:24 -05:00
os_subnets_facts.py	Fix parameters where type is assumed.	2016-02-12 12:30:52 -05:00
os_user.py	Allow passing domain name on os_server	2016-03-22 17:56:46 +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

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.