otcextensions.sdk.cce.v3.cluster¶
The CCE Cluster Class¶
The Cluster
class inherits from
Resource
.
- class otcextensions.sdk.cce.v3.cluster.Cluster(_synchronized=False, connection=None, **attrs)¶
The base resource
- Parameters:
_synchronized (bool) – This is not intended to be used directly. See
new()
andexisting()
.connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of
self._connection
in Resource code should protect itself with a check for None.
- base_path: str = '/clusters'¶
The base part of the URI for this resource.
- resources_key: ty.Optional[str] = ''¶
Plural form of key for resource.
- resource_key: ty.Optional[str] = ''¶
Singular form of key for resource.
- allow_create = True¶
Allow create operation for this resource.
- allow_fetch = True¶
Allow get operation for this resource.
- allow_commit = True¶
Allow update operation for this resource.
- allow_delete = True¶
Allow delete operation for this resource.
- allow_list = True¶
Allow list operation for this resource.
- spec¶
specification
- status¶
Cluster status
- classmethod new(**kwargs)¶
Create a new instance of this resource.
When creating the instance set the
_synchronized
parameter ofResource
toFalse
to indicate that the resource does not yet exist on the server side. This marks all attributes passed in**kwargs
as “dirty” on the resource, and thusly tracked as necessary in subsequent calls such asupdate()
.- Parameters:
kwargs (dict) – Each of the named arguments will be set as attributes on the resulting Resource object.
- class otcextensions.sdk.cce.v3.cluster.ClusterSpec(_synchronized=False, connection=None, **attrs)¶
The base resource
- Parameters:
_synchronized (bool) – This is not intended to be used directly. See
new()
andexisting()
.connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of
self._connection
in Resource code should protect itself with a check for None.
- authentication¶
Authentication
- billing¶
Billing mode of the cluster. Currently, only pay-per-use is supported.
- container_network¶
Container network parameters.
- description¶
Cluster description.
- extended_param¶
Extended parameters.
- flavor¶
Cluster flavors.
- host_network¶
Node network parameters.
- kube_proxy_mode¶
Service forwarding mode
- service_ip_range¶
Service CIDR block or the IP address range which the kubernetes clusterIp must fall within
- type¶
Cluster type.
- version¶
Cluster version [‘v1.11.7-r2’, ‘v1.13.10-r0’].
- eni_network¶
Eni network parameters.
- class otcextensions.sdk.cce.v3.cluster.HostNetworkSpec(_synchronized=False, connection=None, **attrs)¶
The base resource
- Parameters:
_synchronized (bool) – This is not intended to be used directly. See
new()
andexisting()
.connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of
self._connection
in Resource code should protect itself with a check for None.
- highway_subnet¶
ID of the high-speed network that is used to create a bare metal node.
- security_group¶
Security group.
- network_id¶
ID of the subnet that is used to create a node.
- router_id¶
ID of the VPC that is used to create a node.
- class otcextensions.sdk.cce.v3.cluster.EniNetworkSpec(_synchronized=False, connection=None, **attrs)¶
The base resource
- Parameters:
_synchronized (bool) – This is not intended to be used directly. See
new()
andexisting()
.connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of
self._connection
in Resource code should protect itself with a check for None.
- eni_subnet_id¶
IPv4 Subnet ID of the ENI container subnet.
- eni_subnet_cidr¶
ENI subnet CIDR block.
- class otcextensions.sdk.cce.v3.cluster.StatusSpec(_synchronized=False, connection=None, **attrs)¶
The base resource
- Parameters:
_synchronized (bool) – This is not intended to be used directly. See
new()
andexisting()
.connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of
self._connection
in Resource code should protect itself with a check for None.
- endpoints¶
Access address of the kube-apiserver in the cluster.