Cluster(mapping=None, *, ignore_unknown_fields=False, **kwargs)A Google Distributed Cloud Edge Kubernetes cluster.
Attributes | |
|---|---|
| Name | Description |
name |
str
Required. The resource name of the cluster. |
create_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The time when the cluster was created. |
update_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The time when the cluster was last updated. |
labels |
MutableMapping[str, str]
Labels associated with this resource. |
fleet |
google.cloud.edgecontainer_v1.types.Fleet
Required. Fleet configuration. |
networking |
google.cloud.edgecontainer_v1.types.ClusterNetworking
Required. Cluster-wide networking configuration. |
authorization |
google.cloud.edgecontainer_v1.types.Authorization
Required. Immutable. RBAC policy that will be applied and managed by GEC. |
default_max_pods_per_node |
int
Optional. The default maximum number of pods per node used if a maximum value is not specified explicitly for a node pool in this cluster. If unspecified, the Kubernetes default value will be used. |
endpoint |
str
Output only. The IP address of the Kubernetes API server. |
port |
int
Output only. The port number of the Kubernetes API server. |
cluster_ca_certificate |
str
Output only. The PEM-encoded public certificate of the cluster's CA. |
maintenance_policy |
google.cloud.edgecontainer_v1.types.MaintenancePolicy
Optional. Cluster-wide maintenance policy configuration. |
control_plane_version |
str
Output only. The control plane release version |
node_version |
str
Output only. The lowest release version among all worker nodes. This field can be empty if the cluster does not have any worker nodes. |
control_plane |
google.cloud.edgecontainer_v1.types.Cluster.ControlPlane
Optional. The configuration of the cluster control plane. |
system_addons_config |
google.cloud.edgecontainer_v1.types.Cluster.SystemAddonsConfig
Optional. The configuration of the system add-ons. |
external_load_balancer_ipv4_address_pools |
MutableSequence[str]
Optional. IPv4 address pools for cluster data plane external load balancing. |
control_plane_encryption |
google.cloud.edgecontainer_v1.types.Cluster.ControlPlaneEncryption
Optional. Remote control plane disk encryption options. This field is only used when enabling CMEK support. |
status |
google.cloud.edgecontainer_v1.types.Cluster.Status
Output only. The current status of the cluster. |
maintenance_events |
MutableSequence[google.cloud.edgecontainer_v1.types.Cluster.MaintenanceEvent]
Output only. All the maintenance events scheduled for the cluster, including the ones ongoing, planned for the future and done in the past (up to 90 days). |
target_version |
str
Optional. The target cluster version. For example: "1.5.0". |
release_channel |
google.cloud.edgecontainer_v1.types.Cluster.ReleaseChannel
Optional. The release channel a cluster is subscribed to. |
survivability_config |
google.cloud.edgecontainer_v1.types.Cluster.SurvivabilityConfig
Optional. Configuration of the cluster survivability, e.g., for the case when network connectivity is lost. Note: This only applies to local control plane clusters. |
external_load_balancer_ipv6_address_pools |
MutableSequence[str]
Optional. IPv6 address pools for cluster data plane external load balancing. |
Classes
ControlPlane
ControlPlane(mapping=None, *, ignore_unknown_fields=False, **kwargs)Configuration of the cluster control plane.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ControlPlaneEncryption
ControlPlaneEncryption(mapping=None, *, ignore_unknown_fields=False, **kwargs)Configuration for Customer-managed KMS key support for remote control plane cluster disk encryption.
LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)The abstract base class for a message.
| Parameters | |
|---|---|
| Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |
MaintenanceEvent
MaintenanceEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)A Maintenance Event is an operation that could cause temporary disruptions to the cluster workloads, including Google-driven or user-initiated cluster upgrades, user-initiated cluster configuration changes that require restarting nodes, etc.
ReleaseChannel
ReleaseChannel(value)The release channel a cluster is subscribed to.
Values: RELEASE_CHANNEL_UNSPECIFIED (0): Unspecified release channel. This will default to the REGULAR channel. NONE (1): No release channel. REGULAR (2): Regular release channel.
Status
Status(value)Indicates the status of the cluster.
Values: STATUS_UNSPECIFIED (0): Status unknown. PROVISIONING (1): The cluster is being created. RUNNING (2): The cluster is created and fully usable. DELETING (3): The cluster is being deleted. ERROR (4): The status indicates that some errors occurred while reconciling/deleting the cluster. RECONCILING (5): The cluster is undergoing some work such as version upgrades, etc.
SurvivabilityConfig
SurvivabilityConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)Configuration of the cluster survivability, e.g., for the case when network connectivity is lost.
SystemAddonsConfig
SystemAddonsConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)Config that customers are allowed to define for GDCE system add-ons.