openstack/tempest
Code Issues Proposed changes

Update docstring for create_test_server

Browse Source 
Several paramters are missing in the docstring of the helper to
create test servers, so fixing that.

Change-Id: I408de7b98ad60b98c86a776912951d9e04491b7e
This commit is contained in:
Andrea Frittoli (andreaf) 2016-07-06 14:09:48 +01:00
parent c4b0e0091b
commit 9df3a52d77
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
tempest/common/compute.py
View File

@ -40,11 +40,20 @@ def create_test_server(clients, validatable=False, validation_resources=None,
:param clients: Client manager which provides OpenStack Tempest clients.
:param validatable: Whether the server will be pingable or sshable.
:param validation_resources: Resources created for the connection to the
server. Include a keypair, a security group and an IP.
server. Include a keypair, a security group and an IP.
:param tenant_network: Tenant network to be used for creating a server.
:param wait_until: Server status to wait for the server to reach after
its creation.
its creation.
:param volume_backed: Whether the instance is volume backed or not.
:param name: Name of the server to be provisioned. If not defined a random
string ending with '-instance' will be generated.
:param flavor: Flavor of the server to be provisioned. If not defined,
CONF.compute.flavor_ref will be used instead.
:param image_id: ID of the image to be used to provision the server. If not
defined, CONF.compute.image_ref will be used instead.
:param delete_vol_on_termination: Controls whether the backing volume
should be deleted when the server is deleted. Only applies to volume
backed servers.
:returns: a tuple
"""