For details on how to use orchestration, see Using OpenStack Orchestration
The orchestration high-level interface is available through the
orchestration
member of a Connection
object. The orchestration
member will only be added if the service
is detected.
openstack.orchestration.v1._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_stack
(preview=False, **attrs)Create a new stack from attributes
find_stack
(name_or_id, ignore_missing=True, resolve_outputs=True)Find a single stack
name_or_id – The name or ID of a stack.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the resource does not exist.
When set to True
, None will be returned when
attempting to find a nonexistent resource.
One Stack
or None
stacks
(**query)Return a generator of stacks
query (kwargs) – Optional query parameters to be sent to limit the resources being returned.
A generator of stack objects
get_stack
(stack, resolve_outputs=True)Get a single stack
update_stack
(stack, preview=False, **attrs)Update a stack
delete_stack
(stack, ignore_missing=True)Delete a stack
stack – The value can be either the ID of a stack or a
Stack
instance.
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the stack does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent stack.
None
check_stack
(stack)Check a stack’s status
Since this is an asynchronous action, the only way to check the result is to track the stack’s status.
stack – The value can be either the ID of a stack or an instance
of Stack
.
None
get_stack_template
(stack)Get template used by a stack
stack – The value can be the ID of a stack or an instance of
Stack
One object of
StackTemplate
ResourceNotFound
when no resource can be found.
get_stack_environment
(stack)Get environment used by a stack
stack – The value can be the ID of a stack or an instance of
Stack
One object of
StackEnvironment
ResourceNotFound
when no
resource can be found.
get_stack_files
(stack)Get files used by a stack
stack – The value can be the ID of a stack or an instance of
Stack
A dictionary containing the names and contents of all files used by the stack.
ResourceNotFound
when the stack cannot be found.
resources
(stack, **query)Return a generator of resources
stack – This can be a stack object, or the name of a stack for which the resources are to be listed.
query (kwargs) – Optional query parameters to be sent to limit the resources being returned.
A generator of resource objects if the stack exists and there are resources in it. If the stack cannot be found, an exception is thrown.
A generator of
Resource
ResourceNotFound
when the stack cannot be found.
validate_template
(template, environment=None, template_url=None, ignore_errors=None)Validates a template.
template – The stack template on which the validation is performed.
environment – A JSON environment for the stack, if provided.
template_url – A URI to the location containing the stack
template for validation. This parameter is only
required if the template
parameter is None.
This parameter is ignored if template
is
specified.
ignore_errors – A string containing comma separated error codes to ignore. Currently the only valid error code is ‘99001’.
The result of template validation.
InvalidRequest
if neither
template not template_url is provided.
HttpException
if the template
fails the validation.
openstack.orchestration.v1._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_software_config
(**attrs)Create a new software config from attributes
attrs (dict) – Keyword arguments which will be used to create a
SoftwareConfig
,
comprised of the properties on the SoftwareConfig class.
The results of software config creation
SoftwareConfig
software_configs
(**query)Returns a generator of software configs
query (dict) – Optional query parameters to be sent to limit the software configs returned.
A generator of software config objects.
SoftwareConfig
get_software_config
(software_config)Get details about a specific software config.
software_config – The value can be the ID of a software config
or a instace of
SoftwareConfig
,
An object of type
SoftwareConfig
delete_software_config
(software_config, ignore_missing=True)Delete a software config
software_config – The value can be either the ID of a software
config or an instance of
SoftwareConfig
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the software config does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent software config.
None
openstack.orchestration.v1._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)create_software_deployment
(**attrs)Create a new software deployment from attributes
attrs (dict) – Keyword arguments which will be used to create a
SoftwareDeployment
,
comprised of the properties on the SoftwareDeployment class.
The results of software deployment creation
SoftwareDeployment
software_deployments
(**query)Returns a generator of software deployments
query (dict) – Optional query parameters to be sent to limit the software deployments returned.
A generator of software deployment objects.
SoftwareDeployment
get_software_deployment
(software_deployment)Get details about a specific software deployment resource
software_deployment – The value can be the ID of a software
deployment or an instace of
SoftwareDeployment
,
An object of type
SoftwareDeployment
delete_software_deployment
(software_deployment, ignore_missing=True)Delete a software deployment
software_deployment – The value can be either the ID of a
software deployment or an instance of
SoftwareDeployment
ignore_missing (bool) – When set to False
ResourceNotFound
will be
raised when the software deployment does not exist.
When set to True
, no exception will be set when
attempting to delete a nonexistent software deployment.
None
update_software_deployment
(software_deployment, **attrs)Update a software deployment
server – Either the ID of a software deployment or an instance of
SoftwareDeployment
attrs (dict) – The attributes to update on the software deployment
represented by software_deployment
.
The updated software deployment
SoftwareDeployment
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.