Add missing servers.create parameter documentation
The min_count, max_count, and security_groups parameters for servers.create are missing documentation. The security_groups parameter was documented in the servers._boot function but that private function isn't published to the docs. This change adds the missing documentation for the aforementioned parameters and removes the duplicate docs in the servers._boot function. Change-Id: Ib0dcc7e8f7f4d0b83b6caeddd1ace66add4e0003
This commit is contained in:
parent
1940093621
commit
7b1734d44e
@ -423,40 +423,6 @@ class ServerManager(base.BootingManagerWithFind):
|
|||||||
config_drive=None, admin_pass=None, disk_config=None, **kwargs):
|
config_drive=None, admin_pass=None, disk_config=None, **kwargs):
|
||||||
"""
|
"""
|
||||||
Create (boot) a new server.
|
Create (boot) a new server.
|
||||||
|
|
||||||
:param name: Something to name the server.
|
|
||||||
:param image: The :class:`Image` to boot with.
|
|
||||||
:param flavor: The :class:`Flavor` to boot onto.
|
|
||||||
:param meta: A dict of arbitrary key/value metadata to store for this
|
|
||||||
server. A maximum of five entries is allowed, and both
|
|
||||||
keys and values must be 255 characters or less.
|
|
||||||
:param files: A dict of files to overwrite on the server upon boot.
|
|
||||||
Keys are file names (i.e. ``/etc/passwd``) and values
|
|
||||||
are the file contents (either as a string or as a
|
|
||||||
file-like object). A maximum of five entries is allowed,
|
|
||||||
and each file must be 10k or less.
|
|
||||||
:param reservation_id: a UUID for the set of servers being requested.
|
|
||||||
:param return_raw: If True, don't try to coerce the result into
|
|
||||||
a Resource object.
|
|
||||||
:param security_groups: list of security group names
|
|
||||||
:param key_name: (optional extension) name of keypair to inject into
|
|
||||||
the instance
|
|
||||||
:param availability_zone: Name of the availability zone for instance
|
|
||||||
placement.
|
|
||||||
:param block_device_mapping: A dict of block device mappings for this
|
|
||||||
server.
|
|
||||||
:param block_device_mapping_v2: A dict of block device mappings V2 for
|
|
||||||
this server.
|
|
||||||
:param nics: (optional extension) an ordered list of nics to be
|
|
||||||
added to this server, with information about
|
|
||||||
connected networks, fixed IPs, etc.
|
|
||||||
:param scheduler_hints: (optional extension) arbitrary key-value pairs
|
|
||||||
specified by the client to help boot an instance.
|
|
||||||
:param config_drive: (optional extension) If True, enable config drive
|
|
||||||
on the server.
|
|
||||||
:param admin_pass: admin password for the server.
|
|
||||||
:param disk_config: (optional extension) control how the disk is
|
|
||||||
partitioned when the server is created.
|
|
||||||
"""
|
"""
|
||||||
body = {"server": {
|
body = {"server": {
|
||||||
"name": name,
|
"name": name,
|
||||||
@ -873,10 +839,15 @@ class ServerManager(base.BootingManagerWithFind):
|
|||||||
are the file contents (either as a string or as a
|
are the file contents (either as a string or as a
|
||||||
file-like object). A maximum of five entries is allowed,
|
file-like object). A maximum of five entries is allowed,
|
||||||
and each file must be 10k or less.
|
and each file must be 10k or less.
|
||||||
|
:param reservation_id: a UUID for the set of servers being requested.
|
||||||
|
:param min_count: (optional extension) The minimum number of
|
||||||
|
servers to launch.
|
||||||
|
:param max_count: (optional extension) The maximum number of
|
||||||
|
servers to launch.
|
||||||
|
:param security_groups: A list of security group names
|
||||||
:param userdata: user data to pass to be exposed by the metadata
|
:param userdata: user data to pass to be exposed by the metadata
|
||||||
server this can be a file type object as well or a
|
server this can be a file type object as well or a
|
||||||
string.
|
string.
|
||||||
:param reservation_id: a UUID for the set of servers being requested.
|
|
||||||
:param key_name: (optional extension) name of previously created
|
:param key_name: (optional extension) name of previously created
|
||||||
keypair to inject into the instance.
|
keypair to inject into the instance.
|
||||||
:param availability_zone: Name of the availability zone for instance
|
:param availability_zone: Name of the availability zone for instance
|
||||||
|
Loading…
x
Reference in New Issue
Block a user