Container Infrastructure Management¶
Cluster Operations¶
-
class
openstack.container_infrastructure_management.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_cluster
(**attrs) Create a new cluster from attributes
-
delete_cluster
(cluster, ignore_missing=True) Delete a cluster
- Parameters
cluster – The value can be either the ID of a cluster or a
Cluster
instance.ignore_missing (bool) – When set to
False
ResourceNotFound
will be raised when the cluster does not exist. When set toTrue
, no exception will be set when attempting to delete a nonexistent cluster.
- Returns
None
-
find_cluster
(name_or_id, ignore_missing=True) Find a single cluster
- Parameters
name_or_id – The name or ID of a cluster.
ignore_missing (bool) – When set to
False
ResourceNotFound
will be raised when the resource does not exist. When set toTrue
, None will be returned when attempting to find a nonexistent resource.
- Returns
One
Cluster
or None
-
get_cluster
(cluster) Get a single cluster
-
clusters
(**query) Return a generator of clusters
- Parameters
query (kwargs) – Optional query parameters to be sent to limit the resources being returned.
- Returns
A generator of cluster objects
- Return type
-
Cluster Certificates Operations¶
-
class
openstack.container_infrastructure_management.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_cluster_certificate
(**attrs) Create a new cluster_certificate from CSR
- Parameters
attrs (dict) – Keyword arguments which will be used to create a
ClusterCertificate
, comprised of the properties on the ClusterCertificate class.- Returns
The results of cluster_certificate creation
- Return type
-
get_cluster_certificate
(cluster_certificate) Get a single cluster_certificate
- Parameters
cluster_certificate – The value can be the ID of a cluster_certificate or a
ClusterCertificate
instance.- Returns
- Raises
ResourceNotFound
when no resource can be found.
-
Cluster Templates Operations¶
-
class
openstack.container_infrastructure_management.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_cluster_template
(**attrs) Create a new cluster_template from attributes
- Parameters
attrs (dict) – Keyword arguments which will be used to create a
ClusterTemplate
, comprised of the properties on the ClusterTemplate class.- Returns
The results of cluster_template creation
- Return type
-
delete_cluster_template
(cluster_template, ignore_missing=True) Delete a cluster_template
- Parameters
cluster_template – The value can be either the ID of a cluster_template or a
ClusterTemplate
instance.ignore_missing (bool) – When set to
False
ResourceNotFound
will be raised when the cluster_template does not exist. When set toTrue
, no exception will be set when attempting to delete a nonexistent cluster_template.
- Returns
None
-
find_cluster_template
(name_or_id, ignore_missing=True) Find a single cluster_template
- Parameters
name_or_id – The name or ID of a cluster_template.
ignore_missing (bool) – When set to
False
ResourceNotFound
will be raised when the resource does not exist. When set toTrue
, None will be returned when attempting to find a nonexistent resource.
- Returns
One
ClusterTemplate
or None
-
get_cluster_template
(cluster_template) Get a single cluster_template
- Parameters
cluster_template – The value can be the ID of a cluster_template or a
ClusterTemplate
instance.- Returns
One
ClusterTemplate
- Raises
ResourceNotFound
when no resource can be found.
-
cluster_templates
(**query) Return a generator of cluster_templates
- Parameters
query (kwargs) – Optional query parameters to be sent to limit the resources being returned.
- Returns
A generator of cluster_template objects
- Return type
-
update_cluster_template
(cluster_template, **attrs) Update a cluster_template
- Parameters
cluster_template – Either the id of a cluster_template or a
ClusterTemplate
instance.attrs – The attributes to update on the cluster_template represented by
cluster_template
.
- Returns
The updated cluster_template
- Return type
-
Service Operations¶
-
class
openstack.container_infrastructure_management.v1._proxy.
Proxy
(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs) -
services
() Return a generator of services
- Returns
A generator of service objects
- Return type
-