a-c-m
/
community.general
mirror of https://github.com/ansible-collections/community.general.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
community.general/lib/ansible/modules/cloud/openstack
History
Monty Taylor c2b695390b Actually pass in is_public to create_image 
Fixes #2325
 		2016-12-08 11:23:43 -05:00
..
README.md Return resource objects from OpenStack modules 2016-12-08 11:23:09 -05:00
__init__.py
…
_glance_image.py Add OpenStack Image module 2016-12-08 11:23:05 -05:00
_keystone_user.py Add OpenStack Keystone User module 2016-12-08 11:23:42 -05:00
_nova_compute.py The nova_compute module create a list of un-use floating ip by value of fixed_ip. 2016-12-08 11:23:28 -05:00
_nova_keypair.py Add OpenStack Keypair module 2016-12-08 11:23:13 -05:00
_quantum_floating_ip.py Add OpenStack Floating IP Module 2016-12-08 11:23:17 -05:00
_quantum_floating_ip_associate.py Add OpenStack Floating IP Module 2016-12-08 11:23:17 -05:00
_quantum_network.py Add OpenStack Network module 2016-12-08 11:23:00 -05:00
_quantum_router.py Add OpenStack Router module 2016-12-08 11:23:28 -05:00
_quantum_router_gateway.py Deprecate older router modules. 2016-12-08 11:23:38 -05:00
_quantum_router_interface.py Deprecate older router modules. 2016-12-08 11:23:38 -05:00
os_auth.py Updating cloud modules with proper github author information 2016-12-08 11:23:07 -05:00
os_client_config.py removed hyphens in module name in examples 2016-12-08 11:23:33 -05:00
os_floating_ip.py Fix up docs 2016-12-08 11:23:18 -05:00
os_image.py Actually pass in is_public to create_image 2016-12-08 11:23:43 -05:00
os_image_facts.py doc fixes 2016-12-08 11:23:40 -05:00
os_ironic.py Update version added 2016-12-08 11:23:08 -05:00
os_ironic_node.py Updating os_ironic_node module 2016-12-08 11:23:08 -05:00
os_keypair.py Fix indentation levels in os_keypair 2016-12-08 11:23:16 -05:00
os_network.py Allow setting external attribute 2016-12-08 11:23:38 -05:00
os_networks_facts.py doc fixes 2016-12-08 11:23:40 -05:00
os_nova_flavor.py Add new os_nova_flavor module. 2016-12-08 11:23:22 -05:00
os_object.py Return resource objects from OpenStack modules 2016-12-08 11:23:09 -05:00
os_port.py Some docs fixes 2016-12-08 11:23:41 -05:00
os_router.py Fix os_router to accept internal interfaces 2016-12-08 11:23:41 -05:00
os_security_group.py Remove duplicate shade requirement 2016-12-08 11:23:10 -05:00
os_security_group_rule.py checking remote_group_id while comparing os_security_group_rule 2016-12-08 11:23:31 -05:00
os_server.py fix handling of nics argument 2016-12-08 11:23:41 -05:00
os_server_actions.py Adding start and stop actions to os_server_actions 2016-12-08 11:23:34 -05:00
os_server_facts.py Updating cloud modules with proper github author information 2016-12-08 11:23:07 -05:00
os_server_volume.py Updating cloud modules with proper github author information 2016-12-08 11:23:07 -05:00
os_subnet.py Fix yaml syntax 2016-12-08 11:23:39 -05:00
os_subnets_facts.py fixed results docs 2016-12-08 11:23:41 -05:00
os_user.py Clarify password requirement and add return docs. 2016-12-08 11:23:42 -05:00
os_user_group.py Add OpenStack Group content module 2016-12-08 11:23:29 -05:00
os_volume.py Return resource objects from OpenStack modules 2016-12-08 11:23:09 -05:00
quantum_subnet.py Revert "Add deprecated documentation for _quantum_subnet" cause it was already added 2016-12-08 11:23:03 -05: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.