minor doc fixes
This commit is contained in:
parent
d393df4bce
commit
898e338318
5 changed files with 25 additions and 23 deletions
|
@ -244,9 +244,9 @@ options:
|
|||
requirements:
|
||||
- "python >= 2.6"
|
||||
- "boto"
|
||||
author:
|
||||
author:
|
||||
- "Bruce Pennypacker (@bpennypacker)"
|
||||
- "Will Thames (@willthames")
|
||||
- "Will Thames (@willthames)"
|
||||
|
||||
'''
|
||||
|
||||
|
|
|
@ -28,6 +28,7 @@ DOCUMENTATION = '''
|
|||
module: os_ironic
|
||||
short_description: Create/Delete Bare Metal Resources from OpenStack
|
||||
extends_documentation_fragment: openstack
|
||||
author: "Monty Taylor (@emonty)"
|
||||
version_added: "2.0"
|
||||
description:
|
||||
- Create or Remove Ironic nodes from OpenStack.
|
||||
|
@ -71,28 +72,30 @@ options:
|
|||
- Information for this server's driver. Will vary based on which
|
||||
driver is in use. Any sub-field which is populated will be validated
|
||||
during creation.
|
||||
suboptions:
|
||||
power:
|
||||
- Information necessary to turn this server on / off. This often
|
||||
includes such things as IPMI username, password, and IP address.
|
||||
required: true
|
||||
description:
|
||||
- Information necessary to turn this server on / off.
|
||||
This often includes such things as IPMI username, password, and IP address.
|
||||
required: true
|
||||
deploy:
|
||||
- Information necessary to deploy this server directly, without
|
||||
using Nova. THIS IS NOT RECOMMENDED.
|
||||
description:
|
||||
- Information necessary to deploy this server directly, without using Nova. THIS IS NOT RECOMMENDED.
|
||||
console:
|
||||
- Information necessary to connect to this server's serial console.
|
||||
Not all drivers support this.
|
||||
description:
|
||||
- Information necessary to connect to this server's serial console. Not all drivers support this.
|
||||
management:
|
||||
- Information necessary to interact with this server's management
|
||||
interface. May be shared by power_info in some cases.
|
||||
required: true
|
||||
description:
|
||||
- Information necessary to interact with this server's management interface. May be shared by power_info in some cases.
|
||||
required: true
|
||||
nics:
|
||||
description:
|
||||
- A list of network interface cards, eg, " - mac: aa:bb:cc:aa:bb:cc"
|
||||
- 'A list of network interface cards, eg, " - mac: aa:bb:cc:aa:bb:cc"'
|
||||
required: true
|
||||
properties:
|
||||
description:
|
||||
- Definition of the physical characteristics of this server, used for
|
||||
scheduling purposes
|
||||
- Definition of the physical characteristics of this server, used for scheduling purposes
|
||||
suboptions:
|
||||
cpu_arch:
|
||||
description:
|
||||
- CPU architecture (x86_64, i686, ...)
|
||||
|
@ -107,8 +110,7 @@ options:
|
|||
default: 1
|
||||
disk_size:
|
||||
description:
|
||||
- size of first storage device in this machine (typically
|
||||
/dev/sda), in GB
|
||||
- size of first storage device in this machine (typically /dev/sda), in GB
|
||||
default: 1
|
||||
skip_update_of_driver_password:
|
||||
description:
|
||||
|
|
|
@ -26,7 +26,9 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: os_ironic_node
|
||||
short_description: Activate/Deactivate Bare Metal Resources from OpenStack
|
||||
author: "Monty Taylor (@emonty)"
|
||||
extends_documentation_fragment: openstack
|
||||
version_added: "2.0"
|
||||
description:
|
||||
- Deploy to nodes controlled by Ironic.
|
||||
options:
|
||||
|
@ -65,6 +67,7 @@ options:
|
|||
- Definition of the instance information which is used to deploy
|
||||
the node. This information is only required when an instance is
|
||||
set to present.
|
||||
suboptions:
|
||||
image_source:
|
||||
description:
|
||||
- An HTTP(S) URL where the image can be retrieved from.
|
||||
|
@ -93,8 +96,6 @@ options:
|
|||
maintenance mode.
|
||||
required: false
|
||||
default: None
|
||||
|
||||
requirements: ["shade"]
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
|
|
|
@ -27,7 +27,8 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: os_object
|
||||
short_description: Create or Delete objects and containers from OpenStack
|
||||
version_added: "1.10"
|
||||
version_added: "2.0"
|
||||
author: "Monty Taylor (@emonty)"
|
||||
extends_documentation_fragment: openstack
|
||||
description:
|
||||
- Create or Delete objects and containers from OpenStack
|
||||
|
@ -56,7 +57,6 @@ options:
|
|||
- Should the resource be present or absent.
|
||||
choices: [present, absent]
|
||||
default: present
|
||||
requirements: ["shade"]
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
|
|
|
@ -28,6 +28,7 @@ DOCUMENTATION = '''
|
|||
module: os_security_group
|
||||
short_description: Add/Delete security groups from an OpenStack cloud.
|
||||
extends_documentation_fragment: openstack
|
||||
author: "Monty Taylor (@emonty)"
|
||||
version_added: "2.0"
|
||||
description:
|
||||
- Add or Remove security groups from an OpenStack cloud.
|
||||
|
@ -47,8 +48,6 @@ options:
|
|||
- Should the resource be present or absent.
|
||||
choices: [present, absent]
|
||||
default: present
|
||||
|
||||
requirements: ["shade"]
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
|
|
Loading…
Reference in a new issue