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.

History

Toshio Kuratomi 55e6703209 Remove version-added on name field. This parameter was actually added in 2.0. It's just that the documentation in previous versions of the module were wrong (it said the name was "network" rather than "name.) I've renamed the parameter in the documentation of prior versions so ansible-module-validate should no longer think that this is a new parameter.		8 years ago
..
README.md	Return resource objects from OpenStack modules	10 years ago
__init__.py	added __init__.py to new cloud subcategories so builds work again	10 years ago
_glance_image.py	Fixing open stack compile time errors irt exception handling for Python 3 (#3848 )	9 years ago
_keystone_user.py	Fixing open stack compile time errors irt exception handling for Python 3 (#3848 )	9 years ago
_nova_compute.py	nova_compute: indicate argument type (#4070 )	8 years ago
_nova_keypair.py	Fixing open stack compile time errors irt exception handling for Python 3 (#3848 )	9 years ago
_quantum_floating_ip.py	Fixing open stack compile time errors irt exception handling for Python 3 (#3848 )	9 years ago
_quantum_floating_ip_associate.py	Fixing open stack compile time errors irt exception handling for Python 3 (#3848 )	9 years ago
_quantum_network.py	Fixing open stack compile time errors irt exception handling for Python 3 (#3848 )	9 years ago
_quantum_router.py	Fixing open stack compile time errors irt exception handling for Python 3 (#3848 )	9 years ago
_quantum_router_gateway.py	Fixing open stack compile time errors irt exception handling for Python 3 (#3848 )	9 years ago
_quantum_router_interface.py	Fixing open stack compile time errors irt exception handling for Python 3 (#3848 )	9 years ago
_quantum_subnet.py	Fixing open stack compile time errors irt exception handling for Python 3 (#3848 )	9 years ago
os_auth.py	Fix OpenStack module failure output	9 years ago
os_client_config.py	Wrap calls to main() with if check	9 years ago
os_floating_ip.py	Make add ip_floating_ip idempotent	9 years ago
os_image.py	Wrap calls to main() with if check	9 years ago
os_image_facts.py	s/plubic/public/in the doc	9 years ago
os_ironic.py	Wrap calls to main() with if check	9 years ago
os_ironic_node.py	Wrap calls to main() with if check	9 years ago
os_keypair.py	Fix OpenStack module failure output	9 years ago
os_network.py	ansible-validate-modules part 4: Enable check on ansible-modules-core (#3526 )	9 years ago
os_networks_facts.py	Remove version-added on name field.	8 years ago
os_nova_flavor.py	Fix OpenStack module failure output	9 years ago
os_object.py	Wrap calls to main() with if check	9 years ago
os_port.py	Fix allowed_address_pairs and extra_dhcp_opts in os_port	9 years ago
os_router.py	Fix bug in os_router.py when router is not actually updated. (#4107 )	8 years ago
os_security_group.py	Wrap calls to main() with if check	9 years ago
os_security_group_rule.py	Make remote_group handle name and id in cloud/openstack/os_security_group_rule.py	9 years ago
os_server.py	os_server, doc: add version added for delete_fip	8 years ago
os_server_actions.py	Fix OpenStack module failure output	9 years ago
os_server_facts.py	Fix OpenStack module failure output	9 years ago
os_server_volume.py	Fix OpenStack module failure output	9 years ago
os_subnet.py	Fix can_update test in os_subnet (#3664 )	9 years ago
os_subnets_facts.py	Fix parameters where type is assumed.	9 years ago
os_user.py	Only check default_project on resource creation	9 years ago
os_user_group.py	Fix OpenStack module failure output	9 years ago
os_volume.py	Fix size parameter documentation	9 years ago

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.