v1

google.container. v1

Source:

Members

(static) Action :number

Operation type: what type update to perform.

Properties:
Name Type Description
UNKNOWN number

Operation is unknown and will error out.

SET_PASSWORD number

Set the password to a user generated value.

GENERATE_PASSWORD number

Generate a new password and set it to that.

SET_USERNAME number

Set the username. If an empty username is provided, basic authentication is disabled for the cluster. If a non-empty username is provided, basic authentication is enabled, with either a provided password or a generated one.

Source:

(static) Code :number

Code for each condition

Properties:
Name Type Description
UNKNOWN number

UNKNOWN indicates a generic condition.

GCE_STOCKOUT number

GCE_STOCKOUT indicates a Google Compute Engine stockout.

GKE_SERVICE_ACCOUNT_DELETED number

GKE_SERVICE_ACCOUNT_DELETED indicates that the user deleted their robot service account.

GCE_QUOTA_EXCEEDED number

Google Compute Engine quota was exceeded.

SET_BY_OPERATOR number

Cluster state was manually changed by an SRE due to a system logic error.

CLOUD_KMS_KEY_ERROR number

Unable to perform an encrypt operation against the CloudKMS key used for etcd level encryption. More codes TBA

Source:

(static) Effect :number

Possible values for Effect in taint.

Properties:
Name Type Description
EFFECT_UNSPECIFIED number

Not set

NO_SCHEDULE number

NoSchedule

PREFER_NO_SCHEDULE number

PreferNoSchedule

NO_EXECUTE number

NoExecute

Source:

(static) Provider :number

Allowed Network Policy providers.

Properties:
Name Type Description
PROVIDER_UNSPECIFIED number

Not set

CALICO number

Tigera (Calico Felix).

Source:

(static) State :number

State of etcd encryption.

Properties:
Name Type Description
UNKNOWN number

Should never be set

ENCRYPTED number

Secrets in etcd are encrypted.

DECRYPTED number

Secrets in etcd are stored in plain text (at etcd level) - this is unrelated to GCE level full disk encryption.

Source:

(static) Status :number

The current status of the node pool instance.

Properties:
Name Type Description
STATUS_UNSPECIFIED number

Not set.

PROVISIONING number

The PROVISIONING state indicates the node pool is being created.

RUNNING number

The RUNNING state indicates the node pool has been created and is fully usable.

RUNNING_WITH_ERROR number

The RUNNING_WITH_ERROR state indicates the node pool has been created and is partially usable. Some error state has occurred and some functionality may be impaired. Customer may need to reissue a request or trigger a new update.

RECONCILING number

The RECONCILING state indicates that some work is actively being done on the node pool, such as upgrading node software. Details can be found in the statusMessage field.

STOPPING number

The STOPPING state indicates the node pool is being deleted.

ERROR number

The ERROR state indicates the node pool may be unusable. Details can be found in the statusMessage field.

Source:

(static) Status :number

The current status of the cluster.

Properties:
Name Type Description
STATUS_UNSPECIFIED number

Not set.

PROVISIONING number

The PROVISIONING state indicates the cluster is being created.

RUNNING number

The RUNNING state indicates the cluster has been created and is fully usable.

RECONCILING number

The RECONCILING state indicates that some work is actively being done on the cluster, such as upgrading the master or node software. Details can be found in the statusMessage field.

STOPPING number

The STOPPING state indicates the cluster is being deleted.

ERROR number

The ERROR state indicates the cluster may be unusable. Details can be found in the statusMessage field.

DEGRADED number

The DEGRADED state indicates the cluster requires user action to restore full functionality. Details can be found in the statusMessage field.

Source:

(static) Status :number

Current status of the operation.

Properties:
Name Type Description
STATUS_UNSPECIFIED number

Not set.

PENDING number

The operation has been created.

RUNNING number

The operation is currently running.

DONE number

The operation is done, either cancelled or completed.

ABORTING number

The operation is aborting.

Source:

(static) Status :number

Status shows the current usage of a secondary IP range.

Properties:
Name Type Description
UNKNOWN number

UNKNOWN is the zero value of the Status enum. It's not a valid status.

UNUSED number

UNUSED denotes that this range is unclaimed by any cluster.

IN_USE_SERVICE number

IN_USE_SERVICE denotes that this range is claimed by a cluster for services. It cannot be used for other clusters.

IN_USE_SHAREABLE_POD number

IN_USE_SHAREABLE_POD denotes this range was created by the network admin and is currently claimed by a cluster for pods. It can only be used by other clusters as a pod range.

IN_USE_MANAGED_POD number

IN_USE_MANAGED_POD denotes this range was created by GKE and is claimed for pods. It cannot be used for other clusters.

Source:

(static) Type :number

Operation type.

Properties:
Name Type Description
TYPE_UNSPECIFIED number

Not set.

CREATE_CLUSTER number

Cluster create.

DELETE_CLUSTER number

Cluster delete.

UPGRADE_MASTER number

A master upgrade.

UPGRADE_NODES number

A node upgrade.

REPAIR_CLUSTER number

Cluster repair.

UPDATE_CLUSTER number

Cluster update.

CREATE_NODE_POOL number

Node pool create.

DELETE_NODE_POOL number

Node pool delete.

SET_NODE_POOL_MANAGEMENT number

Set node pool management.

AUTO_REPAIR_NODES number

Automatic node pool repair.

AUTO_UPGRADE_NODES number

Automatic node upgrade.

SET_LABELS number

Set labels.

SET_MASTER_AUTH number

Set/generate master auth materials

SET_NODE_POOL_SIZE number

Set node pool size.

SET_NETWORK_POLICY number

Updates network policy for a cluster.

SET_MAINTENANCE_POLICY number

Set the maintenance policy.

Source:

Type Definitions

AcceleratorConfig

AcceleratorConfig represents a Hardware Accelerator request.

Properties:
Name Type Description
acceleratorCount number

The number of the accelerator cards exposed to an instance.

acceleratorType string

The accelerator type resource name. List of supported accelerators here

Source:
See:

AddonsConfig

Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality.

Properties:
Name Type Description
httpLoadBalancing Object

Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.

This object should have the same structure as HttpLoadBalancing

horizontalPodAutoscaling Object

Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.

This object should have the same structure as HorizontalPodAutoscaling

kubernetesDashboard Object

Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards

This object should have the same structure as KubernetesDashboard

networkPolicyConfig Object

Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes.

This object should have the same structure as NetworkPolicyConfig

cloudRunConfig Object

Configuration for the Cloud Run addon, which allows the user to use a managed Knative service.

This object should have the same structure as CloudRunConfig

Source:
See:

AuthenticatorGroupsConfig

Configuration for returning group information from authenticators.

Properties:
Name Type Description
enabled boolean

Whether this cluster should return group membership lookups during authentication using a group of security groups.

securityGroup string

The name of the security group-of-groups to be used. Only relevant if enabled = true.

Source:
See:

AutoprovisioningNodePoolDefaults

AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.

Properties:
Name Type Description
oauthScopes Array.<string>

Scopes that are used by NAP when creating node pools. If oauth_scopes are specified, service_account should be empty.

serviceAccount string

The Google Cloud Platform Service Account to be used by the node VMs. If service_account is specified, scopes should be empty.

Source:
See:

AutoUpgradeOptions

AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed.

Properties:
Name Type Description
autoUpgradeStartTime string

[Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in RFC3339 text format.

description string

[Output only] This field is set when upgrades are about to commence with the description of the upgrade.

Source:
See:

BigQueryDestination

Parameters for using BigQuery as the destination of resource usage export.

Properties:
Name Type Description
datasetId string

The ID of a BigQuery Dataset.

Source:
See:

BinaryAuthorization

Configuration for Binary Authorization.

Properties:
Name Type Description
enabled boolean

Enable Binary Authorization for this cluster. If enabled, all container images will be validated by Binary Authorization.

Source:
See:

CancelOperationRequest

CancelOperationRequest cancels a single operation.

Properties:
Name Type Description
projectId string

Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone string

Required. Deprecated. The name of the Google Compute Engine zone in which the operation resides. This field has been deprecated and replaced by the name field.

operationId string

Required. Deprecated. The server-assigned name of the operation. This field has been deprecated and replaced by the name field.

name string

The name (project, location, operation id) of the operation to cancel. Specified in the format 'projects/* /locations/* /operations/*'.

Source:
See:

CidrBlock

CidrBlock contains an optional name and one CIDR block.

Properties:
Name Type Description
displayName string

display_name is an optional field for users to identify CIDR blocks.

cidrBlock string

cidr_block must be specified in CIDR notation.

Source:
See:

ClientCertificateConfig

Configuration for client certificates on the cluster.

Properties:
Name Type Description
issueClientCertificate boolean

Issue a client certificate.

Source:
See:

CloudRunConfig

Configuration options for the Cloud Run feature.

Properties:
Name Type Description
disabled boolean

Whether Cloud Run addon is enabled for this cluster.

Source:
See:

Cluster

A Google Kubernetes Engine cluster.

Properties:
Name Type Description
name string

The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions:

  • Lowercase letters, numbers, and hyphens only.
  • Must start with a letter.
  • Must end with a number or a letter.
description string

An optional description of this cluster.

initialNodeCount number

The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time.

This field is deprecated, use node_pool.initial_node_count instead.

nodeConfig Object

Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see node_pool.config)

If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.

This object should have the same structure as NodeConfig

masterAuth Object

The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, username will be set to "admin", a random password will be generated, and a client certificate will be issued.

This object should have the same structure as MasterAuth

loggingService string

The logging service the cluster should use to write logs. Currently available options:

  • "logging.googleapis.com/kubernetes" - the Google Cloud Logging service with Kubernetes-native resource model
  • logging.googleapis.com - the Google Cloud Logging service.
  • none - no logs will be exported from the cluster.
  • if left as an empty string,logging.googleapis.com will be used.
monitoringService string

The monitoring service the cluster should use to write metrics. Currently available options:

  • monitoring.googleapis.com - the Google Cloud Monitoring service.
  • none - no metrics will be exported from the cluster.
  • if left as an empty string, monitoring.googleapis.com will be used.
network string

The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used.

clusterIpv4Cidr string

The IP address range of the container pods in this cluster, in CIDR notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8.

addonsConfig Object

Configurations for the various addons available to run in the cluster.

This object should have the same structure as AddonsConfig

subnetwork string

The name of the Google Compute Engine subnetwork to which the cluster is connected.

nodePools Array.<Object>

The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.

This object should have the same structure as NodePool

locations Array.<string>

The list of Google Compute Engine zones in which the cluster's nodes should be located.

enableKubernetesAlpha boolean

Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.

resourceLabels Object.<string, string>

The resource labels for the cluster to use to annotate any related Google Compute Engine resources.

labelFingerprint string

The fingerprint of the set of labels for this cluster.

legacyAbac Object

Configuration for the legacy ABAC authorization mode.

This object should have the same structure as LegacyAbac

networkPolicy Object

Configuration options for the NetworkPolicy feature.

This object should have the same structure as NetworkPolicy

ipAllocationPolicy Object

Configuration for cluster IP allocation.

This object should have the same structure as IPAllocationPolicy

masterAuthorizedNetworksConfig Object

The configuration options for master authorized networks feature.

This object should have the same structure as MasterAuthorizedNetworksConfig

maintenancePolicy Object

Configure the maintenance policy for this cluster.

This object should have the same structure as MaintenancePolicy

binaryAuthorization Object

Configuration for Binary Authorization.

This object should have the same structure as BinaryAuthorization

autoscaling Object

Cluster-level autoscaling configuration.

This object should have the same structure as ClusterAutoscaling

networkConfig Object

Configuration for cluster networking.

This object should have the same structure as NetworkConfig

defaultMaxPodsConstraint Object

The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.

This object should have the same structure as MaxPodsConstraint

resourceUsageExportConfig Object

Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.

This object should have the same structure as ResourceUsageExportConfig

authenticatorGroupsConfig Object

Configuration controlling RBAC group membership information.

This object should have the same structure as AuthenticatorGroupsConfig

privateClusterConfig Object

Configuration for private cluster.

This object should have the same structure as PrivateClusterConfig

databaseEncryption Object

Configuration of etcd encryption.

This object should have the same structure as DatabaseEncryption

verticalPodAutoscaling Object

Cluster-level Vertical Pod Autoscaling configuration.

This object should have the same structure as VerticalPodAutoscaling

selfLink string

[Output only] Server-defined URL for the resource.

zone string

[Output only] The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.

endpoint string

[Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at https://username:password@endpoint/.

See the masterAuth property of this resource for username and password information.

initialClusterVersion string

The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion.

Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior:

  • "latest": picks the highest valid Kubernetes version
  • "1.X": picks the highest valid patch+gke.N patch in the 1.X version
  • "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
  • "1.X.Y-gke.N": picks an explicit Kubernetes version
  • "","-": picks the default Kubernetes version
currentMasterVersion string

[Output only] The current software version of the master endpoint.

currentNodeVersion string

[Output only] Deprecated, use NodePools.version instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.

createTime string

[Output only] The time the cluster was created, in RFC3339 text format.

status number

[Output only] The current status of this cluster.

The number should be among the values of Status

statusMessage string

[Output only] Additional information about the current status of this cluster, if available.

nodeIpv4CidrSize number

[Output only] The size of the address space on each node for hosting containers. This is provisioned from within the container_ipv4_cidr range. This field will only be set when cluster is in route-based network mode.

servicesIpv4Cidr string

[Output only] The IP address range of the Kubernetes services in this cluster, in CIDR notation (e.g. 1.2.3.4/29). Service addresses are typically put in the last /16 from the container CIDR.

instanceGroupUrls Array.<string>

Deprecated. Use node_pools.instance_group_urls.

currentNodeCount number

[Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.

expireTime string

[Output only] The time the cluster will be automatically deleted in RFC3339 text format.

location string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.

enableTpu boolean

Enable the ability to use Cloud TPUs in this cluster.

tpuIpv4CidrBlock string

[Output only] The IP address range of the Cloud TPUs in this cluster, in CIDR notation (e.g. 1.2.3.4/29).

conditions Array.<Object>

Which conditions caused the current cluster state.

This object should have the same structure as StatusCondition

Source:
See:

ClusterAutoscaling

ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs.

Properties:
Name Type Description
enableNodeAutoprovisioning boolean

Enables automatic node pool creation and deletion.

resourceLimits Array.<Object>

Contains global constraints regarding minimum and maximum amount of resources in the cluster.

This object should have the same structure as ResourceLimit

autoprovisioningNodePoolDefaults Object

AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.

This object should have the same structure as AutoprovisioningNodePoolDefaults

autoprovisioningLocations Array.<string>

The list of Google Compute Engine zones in which the NodePool's nodes can be created by NAP.

Source:
See:

ClusterUpdate

ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided.

Properties:
Name Type Description
desiredNodeVersion string

The Kubernetes version to change the nodes to (typically an upgrade).

Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior:

  • "latest": picks the highest valid Kubernetes version
  • "1.X": picks the highest valid patch+gke.N patch in the 1.X version
  • "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
  • "1.X.Y-gke.N": picks an explicit Kubernetes version
  • "-": picks the Kubernetes master version
desiredMonitoringService string

The monitoring service the cluster should use to write metrics. Currently available options:

  • "monitoring.googleapis.com/kubernetes" - the Google Cloud Monitoring service with Kubernetes-native resource model
  • "monitoring.googleapis.com" - the Google Cloud Monitoring service
  • "none" - no metrics will be exported from the cluster
desiredAddonsConfig Object

Configurations for the various addons available to run in the cluster.

This object should have the same structure as AddonsConfig

desiredNodePoolId string

The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family" or "desired_node_pool_autoscaling" is specified and there is more than one node pool on the cluster.

desiredImageType string

The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well.

desiredDatabaseEncryption Object

Configuration of etcd encryption.

This object should have the same structure as DatabaseEncryption

desiredNodePoolAutoscaling Object

Autoscaler configuration for the node pool specified in desired_node_pool_id. If there is only one pool in the cluster and desired_node_pool_id is not provided then the change applies to that single node pool.

This object should have the same structure as NodePoolAutoscaling

desiredLocations Array.<string>

The desired list of Google Compute Engine zones in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed.

This list must always include the cluster's primary zone.

desiredMasterAuthorizedNetworksConfig Object

The desired configuration options for master authorized networks feature.

This object should have the same structure as MasterAuthorizedNetworksConfig

desiredClusterAutoscaling Object

Cluster-level autoscaling configuration.

This object should have the same structure as ClusterAutoscaling

desiredBinaryAuthorization Object

The desired configuration options for the Binary Authorization feature.

This object should have the same structure as BinaryAuthorization

desiredLoggingService string

The logging service the cluster should use to write logs. Currently available options:

  • "logging.googleapis.com/kubernetes" - the Google Cloud Logging service with Kubernetes-native resource model
  • "logging.googleapis.com" - the Google Cloud Logging service
  • "none" - no logs will be exported from the cluster
desiredResourceUsageExportConfig Object

The desired configuration for exporting resource usage.

This object should have the same structure as ResourceUsageExportConfig

desiredVerticalPodAutoscaling Object

Cluster-level Vertical Pod Autoscaling configuration.

This object should have the same structure as VerticalPodAutoscaling

desiredIntraNodeVisibilityConfig Object

The desired config of Intra-node visibility.

This object should have the same structure as IntraNodeVisibilityConfig

desiredMasterVersion string

The Kubernetes version to change the master to.

Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior:

  • "latest": picks the highest valid Kubernetes version
  • "1.X": picks the highest valid patch+gke.N patch in the 1.X version
  • "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
  • "1.X.Y-gke.N": picks an explicit Kubernetes version
  • "-": picks the default Kubernetes version
Source:
See:

CompleteIPRotationRequest

CompleteIPRotationRequest moves the cluster master back into single-IP mode.

Properties:
Name Type Description
projectId string

Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone string

Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

clusterId string

Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

name string

The name (project, location, cluster id) of the cluster to complete IP rotation. Specified in the format 'projects/* /locations/* /clusters/*'.

Source:
See:

ConsumptionMeteringConfig

Parameters for controlling consumption metering.

Properties:
Name Type Description
enabled boolean

Whether to enable consumption metering for this cluster. If enabled, a second BigQuery table will be created to hold resource consumption records.

Source:
See:

CreateClusterRequest

CreateClusterRequest creates a cluster.

Properties:
Name Type Description
projectId string

Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.

zone string

Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the parent field.

cluster Object

Required. A cluster resource

This object should have the same structure as Cluster

parent string

The parent (project and location) where the cluster will be created. Specified in the format 'projects/* /locations/*'.

Source:
See:

CreateNodePoolRequest

CreateNodePoolRequest creates a node pool for a cluster.

Properties:
Name Type Description
projectId string

Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.

zone string

Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the parent field.

clusterId string

Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.

nodePool Object

Required. The node pool to create.

This object should have the same structure as NodePool

parent string

The parent (project, location, cluster id) where the node pool will be created. Specified in the format 'projects/* /locations/* /clusters/*'.

Source:
See:

DailyMaintenanceWindow

Time window specified for daily maintenance operations.

Properties:
Name Type Description
startTime string

Time within the maintenance window to start the maintenance operations. Time format should be in RFC3339 format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.

duration string

[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in RFC3339 format "PTnHnMnS".

Source:
See:

DatabaseEncryption

Configuration of etcd encryption.

Properties:
Name Type Description
state number

Denotes the state of etcd encryption.

The number should be among the values of State

keyName string

Name of CloudKMS key to use for the encryption of secrets in etcd. Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key

Source:
See:

DeleteClusterRequest

DeleteClusterRequest deletes a cluster.

Properties:
Name Type Description
projectId string

Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone string

Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

clusterId string

Required. Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field.

name string

The name (project, location, cluster) of the cluster to delete. Specified in the format 'projects/* /locations/* /clusters/*'.

Source:
See:

DeleteNodePoolRequest

DeleteNodePoolRequest deletes a node pool for a cluster.

Properties:
Name Type Description
projectId string

Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone string

Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

clusterId string

Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

nodePoolId string

Required. Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field.

name string

The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format 'projects/* /locations/* /clusters/* /nodePools/*'.

Source:
See:

GetClusterRequest

GetClusterRequest gets the settings of a cluster.

Properties:
Name Type Description
projectId string

Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone string

Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

clusterId string

Required. Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field.

name string

The name (project, location, cluster) of the cluster to retrieve. Specified in the format 'projects/* /locations/* /clusters/*'.

Source:
See:

GetNodePoolRequest

GetNodePoolRequest retrieves a node pool for a cluster.

Properties:
Name Type Description
projectId string

Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone string

Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

clusterId string

Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

nodePoolId string

Required. Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field.

name string

The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format 'projects/* /locations/* /clusters/* /nodePools/*'.

Source:
See:

GetOperationRequest

GetOperationRequest gets a single operation.

Properties:
Name Type Description
projectId string

Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone string

Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

operationId string

Required. Deprecated. The server-assigned name of the operation. This field has been deprecated and replaced by the name field.

name string

The name (project, location, operation id) of the operation to get. Specified in the format 'projects/* /locations/* /operations/*'.

Source:
See:

GetServerConfigRequest

Gets the current Kubernetes Engine service configuration.

Properties:
Name Type Description
projectId string

Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone string

Required. Deprecated. The name of the Google Compute Engine zone to return operations for. This field has been deprecated and replaced by the name field.

name string

The name (project and location) of the server config to get, specified in the format 'projects/* /locations/*'.

Source:
See:

HorizontalPodAutoscaling

Configuration options for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.

Properties:
Name Type Description
disabled boolean

Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that a Heapster pod is running in the cluster, which is also used by the Cloud Monitoring service.

Source:
See:

HttpLoadBalancing

Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.

Properties:
Name Type Description
disabled boolean

Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.

Source:
See:

IntraNodeVisibilityConfig

IntraNodeVisibilityConfig contains the desired config of the intra-node visibility on this cluster.

Properties:
Name Type Description
enabled boolean

Enables intra node visibility for this cluster.

Source:
See:

IPAllocationPolicy

Configuration for controlling how IPs are allocated in the cluster.

Properties:
Name Type Description
useIpAliases boolean

Whether alias IPs will be used for pod IPs in the cluster.

createSubnetwork boolean

Whether a new subnetwork will be created automatically for the cluster.

This field is only applicable when use_ip_aliases is true.

subnetworkName string

A custom subnetwork name to be used if create_subnetwork is true. If this field is empty, then an automatic name will be chosen for the new subnetwork.

clusterIpv4Cidr string

This field is deprecated, use cluster_ipv4_cidr_block.

nodeIpv4Cidr string

This field is deprecated, use node_ipv4_cidr_block.

servicesIpv4Cidr string

This field is deprecated, use services_ipv4_cidr_block.

clusterSecondaryRangeName string

The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork.

This field is only applicable with use_ip_aliases is true and create_subnetwork is false.

servicesSecondaryRangeName string

The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork.

This field is only applicable with use_ip_aliases is true and create_subnetwork is false.

clusterIpv4CidrBlock string

The IP address range for the cluster pod IPs. If this field is set, then cluster.cluster_ipv4_cidr must be left blank.

This field is only applicable when use_ip_aliases is true.

Set to blank to have a range chosen with the default size.

Set to /netmask (e.g. /14) to have a range chosen with a specific netmask.

Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use.

nodeIpv4CidrBlock string

The IP address range of the instance IPs in this cluster.

This is applicable only if create_subnetwork is true.

Set to blank to have a range chosen with the default size.

Set to /netmask (e.g. /14) to have a range chosen with a specific netmask.

Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use.

servicesIpv4CidrBlock string

The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size.

This field is only applicable when use_ip_aliases is true.

Set to blank to have a range chosen with the default size.

Set to /netmask (e.g. /14) to have a range chosen with a specific netmask.

Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use.

tpuIpv4CidrBlock string

The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size.

This field is only applicable when use_ip_aliases is true.

If unspecified, the range will use the default size.

Set to /netmask (e.g. /14) to have a range chosen with a specific netmask.

Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use.

Source:
See:

KubernetesDashboard

Configuration for the Kubernetes Dashboard.

Properties:
Name Type Description
disabled boolean

Whether the Kubernetes Dashboard is enabled for this cluster.

Source:
See:

LegacyAbac

Configuration for the legacy Attribute Based Access Control authorization mode.

Properties:
Name Type Description
enabled boolean

Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM.

Source:
See:

ListClustersRequest

ListClustersRequest lists clusters.

Properties:
Name Type Description
projectId string

Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.

zone string

Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field.

parent string

The parent (project and location) where the clusters will be listed. Specified in the format 'projects/* /locations/*'. Location "-" matches all zones and all regions.

Source:
See:

ListClustersResponse

ListClustersResponse is the result of ListClustersRequest.

Properties:
Name Type Description
clusters Array.<Object>

A list of clusters in the project in the specified zone, or across all ones.

This object should have the same structure as Cluster

missingZones Array.<string>

If any zones are listed here, the list of clusters returned may be missing those zones.

Source:
See:

ListNodePoolsRequest

ListNodePoolsRequest lists the node pool(s) for a cluster.

Properties:
Name Type Description
projectId string

Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.

zone string

Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the parent field.

clusterId string

Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.

parent string

The parent (project, location, cluster id) where the node pools will be listed. Specified in the format 'projects/* /locations/* /clusters/*'.

Source:
See:

ListNodePoolsResponse

ListNodePoolsResponse is the result of ListNodePoolsRequest.

Properties:
Name Type Description
nodePools Array.<Object>

A list of node pools for a cluster.

This object should have the same structure as NodePool

Source:
See:

ListOperationsRequest

ListOperationsRequest lists operations.

Properties:
Name Type Description
projectId string

Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.

zone string

Required. Deprecated. The name of the Google Compute Engine zone to return operations for, or - for all zones. This field has been deprecated and replaced by the parent field.

parent string

The parent (project and location) where the operations will be listed. Specified in the format 'projects/* /locations/*'. Location "-" matches all zones and all regions.

Source:
See:

ListOperationsResponse

ListOperationsResponse is the result of ListOperationsRequest.

Properties:
Name Type Description
operations Array.<Object>

A list of operations in the project in the specified zone.

This object should have the same structure as Operation

missingZones Array.<string>

If any zones are listed here, the list of operations returned may be missing the operations from those zones.

Source:
See:

ListUsableSubnetworksRequest

ListUsableSubnetworksRequest requests the list of usable subnetworks available to a user for creating clusters.

Properties:
Name Type Description
parent string

The parent project where subnetworks are usable. Specified in the format 'projects/*'.

filter string

Filtering currently only supports equality on the networkProjectId and must be in the form: "networkProjectId=[PROJECTID]", where networkProjectId is the project which owns the listed subnetworks. This defaults to the parent project ID.

pageSize number

The max number of results per page that should be returned. If the number of available results is larger than page_size, a next_page_token is returned which can be used to get the next page of results in subsequent requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

pageToken string

Specifies a page token to use. Set this to the nextPageToken returned by previous list requests to get the next page of results.

Source:
See:

ListUsableSubnetworksResponse

ListUsableSubnetworksResponse is the response of ListUsableSubnetworksRequest.

Properties:
Name Type Description
subnetworks Array.<Object>

A list of usable subnetworks in the specified network project.

This object should have the same structure as UsableSubnetwork

nextPageToken string

This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter page_token in the next request. The value will become empty when there are no more pages.

Source:
See:

MaintenancePolicy

MaintenancePolicy defines the maintenance policy to be used for the cluster.

Properties:
Name Type Description
window Object

Specifies the maintenance window in which maintenance may be performed.

This object should have the same structure as MaintenanceWindow

resourceVersion string

A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a get() request to the cluster to get the current resource version and include it with requests to set the policy.

Source:
See:

MaintenanceWindow

MaintenanceWindow defines the maintenance window to be used for the cluster.

Properties:
Name Type Description
dailyMaintenanceWindow Object

DailyMaintenanceWindow specifies a daily maintenance operation window.

This object should have the same structure as DailyMaintenanceWindow

recurringWindow Object

RecurringWindow specifies some number of recurring time periods for maintenance to occur. The time windows may be overlapping. If no maintenance windows are set, maintenance can occur at any time.

This object should have the same structure as RecurringTimeWindow

maintenanceExclusions Object.<string, Object>

Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows.

Source:
See:

MasterAuth

The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates.

Properties:
Name Type Description
username string

The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string).

password string

The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty.

clientCertificateConfig Object

Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.

This object should have the same structure as ClientCertificateConfig

clusterCaCertificate string

[Output only] Base64-encoded public certificate that is the root of trust for the cluster.

clientCertificate string

[Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.

clientKey string

[Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.

Source:
See:

MasterAuthorizedNetworksConfig

Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs.

Properties:
Name Type Description
enabled boolean

Whether or not master authorized networks is enabled.

cidrBlocks Array.<Object>

cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.

This object should have the same structure as CidrBlock

Source:
See:

MaxPodsConstraint

Constraints applied to pods.

Properties:
Name Type Description
maxPodsPerNode number

Constraint enforced on the max num of pods per node.

Source:
See:

NetworkConfig

NetworkConfig reports the relative names of network & subnetwork.

Properties:
Name Type Description
network string

Output only. The relative name of the Google Compute Engine network(/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network

subnetwork string

Output only. The relative name of the Google Compute Engine subnetwork to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet

enableIntraNodeVisibility boolean

Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network.

Source:
See:

NetworkPolicy

Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/

Properties:
Name Type Description
provider number

The selected network policy provider.

The number should be among the values of Provider

enabled boolean

Whether network policy is enabled on the cluster.

Source:
See:

NetworkPolicyConfig

Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes.

Properties:
Name Type Description
disabled boolean

Whether NetworkPolicy is enabled for this cluster.

Source:
See:

NodeConfig

Parameters that describe the nodes in a cluster.

Properties:
Name Type Description
machineType string

The name of a Google Compute Engine machine type (e.g. n1-standard-1).

If unspecified, the default machine type is n1-standard-1.

diskSizeGb number

Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB.

If unspecified, the default disk size is 100GB.

oauthScopes Array.<string>

The set of Google API scopes to be made available on all of the node VMs under the "default" service account.

The following scopes are recommended, but not required, and by default are not included:

  • https://www.googleapis.com/auth/compute is required for mounting persistent storage on your nodes.
  • https://www.googleapis.com/auth/devstorage.read_only is required for communicating with gcr.io (the Google Container Registry).

If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.

serviceAccount string

The Google Cloud Platform Service Account to be used by the node VMs. If no Service Account is specified, the "default" service account is used.

metadata Object.<string, string>

The metadata key/value pairs assigned to instances in the cluster.

Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: "cluster-location" "cluster-name" "cluster-uid" "configure-sh" "containerd-configure-sh" "enable-os-login" "gci-update-strategy" "gci-ensure-gke-docker" "instance-template" "kube-env" "startup-script" "user-data" "disable-address-manager" "windows-startup-script-ps1" "common-psm1" "k8s-node-setup-psm1" "install-ssh-psm1" "user-profile-psm1" "serial-port-logging-enable"

Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB.

The total size of all keys and values must be less than 512 KB.

imageType string

The image type to use for this node. Note that for a given image type, the latest version of it will be used.

labels Object.<string, string>

The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

localSsdCount number

The number of local SSD disks to be attached to the node.

The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.

tags Array.<string>

The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.

preemptible boolean

Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.

accelerators Array.<Object>

A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.

This object should have the same structure as AcceleratorConfig

diskType string

Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

If unspecified, the default disk type is 'pd-standard'

minCpuPlatform string

Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read how to specify min CPU platform

taints Array.<Object>

List of kubernetes taints to be applied to each node.

For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

This object should have the same structure as NodeTaint

shieldedInstanceConfig Object

Shielded Instance options.

This object should have the same structure as ShieldedInstanceConfig

Source:
See:

NodeManagement

NodeManagement defines the set of node management services turned on for the node pool.

Properties:
Name Type Description
autoUpgrade boolean

A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.

autoRepair boolean

A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.

upgradeOptions Object

Specifies the Auto Upgrade knobs for the node pool.

This object should have the same structure as AutoUpgradeOptions

Source:
See:

NodePool

NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.

Properties:
Name Type Description
name string

The name of the node pool.

config Object

The node configuration of the pool.

This object should have the same structure as NodeConfig

initialNodeCount number

The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.

selfLink string

[Output only] Server-defined URL for the resource.

version string

The version of the Kubernetes of this node.

instanceGroupUrls Array.<string>

[Output only] The resource URLs of the managed instance groups associated with this node pool.

status number

[Output only] The status of the nodes in this pool instance.

The number should be among the values of Status

statusMessage string

[Output only] Additional information about the current status of this node pool instance, if available.

autoscaling Object

Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.

This object should have the same structure as NodePoolAutoscaling

management Object

NodeManagement configuration for this NodePool.

This object should have the same structure as NodeManagement

maxPodsConstraint Object

The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.

This object should have the same structure as MaxPodsConstraint

conditions Array.<Object>

Which conditions caused the current node pool state.

This object should have the same structure as StatusCondition

podIpv4CidrSize number

[Output only] The pod CIDR block size per node in this node pool.

Source:
See:

NodePoolAutoscaling

NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage.

Properties:
Name Type Description
enabled boolean

Is autoscaling enabled for this node pool.

minNodeCount number

Minimum number of nodes in the NodePool. Must be >= 1 and <= max_node_count.

maxNodeCount number

Maximum number of nodes in the NodePool. Must be >= min_node_count. There has to enough quota to scale up the cluster.

autoprovisioned boolean

Can this node pool be deleted automatically.

Source:
See:

NodeTaint

Kubernetes taint is comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

Properties:
Name Type Description
key string

Key for taint.

value string

Value for taint.

effect number

Effect for taint.

The number should be among the values of Effect

Source:
See:

Operation

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Properties:
Name Type Description
name string

The server-assigned ID for the operation.

zone string

The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.

operationType number

The operation type.

The number should be among the values of Type

status number

The current status of the operation.

The number should be among the values of Status

detail string

Detailed operation progress, if available.

statusMessage string

If an error has occurred, a textual description of the error.

selfLink string

Server-defined URL for the resource.

targetLink string

Server-defined URL for the target of the operation.

location string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.

startTime string

[Output only] The time the operation started, in RFC3339 text format.

endTime string

[Output only] The time the operation completed, in RFC3339 text format.

clusterConditions Array.<Object>

Which conditions caused the current cluster state.

This object should have the same structure as StatusCondition

nodepoolConditions Array.<Object>

Which conditions caused the current node pool state.

This object should have the same structure as StatusCondition

Source:
See:

PrivateClusterConfig

Configuration options for private clusters.

Properties:
Name Type Description
enablePrivateNodes boolean

Whether nodes have internal IP addresses only. If enabled, all nodes are given only RFC 1918 private addresses and communicate with the master via private networking.

enablePrivateEndpoint boolean

Whether the master's internal IP address is used as the cluster endpoint.

masterIpv4CidrBlock string

The IP range in CIDR notation to use for the hosted master network. This range will be used for assigning internal IP addresses to the master or set of masters, as well as the ILB VIP. This range must not overlap with any other ranges in use within the cluster's network.

privateEndpoint string

Output only. The internal IP address of this cluster's master endpoint.

publicEndpoint string

Output only. The external IP address of this cluster's master endpoint.

Source:
See:

RecurringTimeWindow

Represents an arbitrary window of time that recurs.

Properties:
Name Type Description
window Object

The window of the first recurrence.

This object should have the same structure as TimeWindow

recurrence string

An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time.

For example, to have something repeat every weekday, you'd use: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR To repeat some window daily (equivalent to the DailyMaintenanceWindow): FREQ=DAILY For the first weekend of every month: FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you'd use something like: start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA Note the start and end time's specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

Source:
See:

ResourceLimit

Contains information about amount of some resource in the cluster. For memory, value should be in GB.

Properties:
Name Type Description
resourceType string

Resource name "cpu", "memory" or gpu-specific string.

minimum number

Minimum amount of the resource in the cluster.

maximum number

Maximum amount of the resource in the cluster.

Source:
See:

ResourceUsageExportConfig

Configuration for exporting cluster resource usages.

Properties:
Name Type Description
bigqueryDestination Object

Configuration to use BigQuery as usage export destination.

This object should have the same structure as BigQueryDestination

enableNetworkEgressMetering boolean

Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic.

consumptionMeteringConfig Object

Configuration to enable resource consumption metering.

This object should have the same structure as ConsumptionMeteringConfig

Source:
See:

RollbackNodePoolUpgradeRequest

RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed.

Properties:
Name Type Description
projectId string

Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone string

Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

clusterId string

Required. Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field.

nodePoolId string

Required. Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field.

name string

The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format 'projects/* /locations/* /clusters/* /nodePools/*'.

Source:
See:

ServerConfig

Kubernetes Engine service configuration.

Properties:
Name Type Description
defaultClusterVersion string

Version of Kubernetes the service deploys by default.

validNodeVersions Array.<string>

List of valid node upgrade target versions.

defaultImageType string

Default image type.

validImageTypes Array.<string>

List of valid image types.

validMasterVersions Array.<string>

List of valid master versions.

Source:
See:

SetAddonsConfigRequest

SetAddonsConfigRequest sets the addons associated with the cluster.

Properties:
Name Type Description
projectId string

Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone string

Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

clusterId string

Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

addonsConfig Object

Required. The desired configurations for the various addons available to run in the cluster.

This object should have the same structure as AddonsConfig

name string

The name (project, location, cluster) of the cluster to set addons. Specified in the format 'projects/* /locations/* /clusters/*'.

Source:
See:

SetLabelsRequest

SetLabelsRequest sets the Google Cloud Platform labels on a Google Container Engine cluster, which will in turn set them for Google Compute Engine resources used by that cluster

Properties:
Name Type Description
projectId string

Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone string

Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

clusterId string

Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

resourceLabels Object.<string, string>

Required. The labels to set for that cluster.

labelFingerprint string

Required. The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a get() request to the resource to get the latest fingerprint.

name string

The name (project, location, cluster id) of the cluster to set labels. Specified in the format 'projects/* /locations/* /clusters/*'.

Source:
See:

SetLegacyAbacRequest

SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster.

Properties:
Name Type Description
projectId string

Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone string

Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

clusterId string

Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.

enabled boolean

Required. Whether ABAC authorization will be enabled in the cluster.

name string

The name (project, location, cluster id) of the cluster to set legacy abac. Specified in the format 'projects/* /locations/* /clusters/*'.

Source:
See:

SetLocationsRequest

SetLocationsRequest sets the locations of the cluster.

Properties:
Name Type Description
projectId string

Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone string

Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

clusterId string

Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

locations Array.<string>

Required. The desired list of Google Compute Engine zones in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed.

This list must always include the cluster's primary zone.

name string

The name (project, location, cluster) of the cluster to set locations. Specified in the format 'projects/* /locations/* /clusters/*'.

Source:
See:

SetLoggingServiceRequest

SetLoggingServiceRequest sets the logging service of a cluster.

Properties:
Name Type Description
projectId string

Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone string

Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

clusterId string

Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

loggingService string

Required. The logging service the cluster should use to write metrics. Currently available options:

  • "logging.googleapis.com" - the Google Cloud Logging service
  • "none" - no metrics will be exported from the cluster
name string

The name (project, location, cluster) of the cluster to set logging. Specified in the format 'projects/* /locations/* /clusters/*'.

Source:
See:

SetMaintenancePolicyRequest

SetMaintenancePolicyRequest sets the maintenance policy for a cluster.

Properties:
Name Type Description
projectId string

Required. The Google Developers Console project ID or project number.

zone string

Required. The name of the Google Compute Engine zone in which the cluster resides.

clusterId string

Required. The name of the cluster to update.

maintenancePolicy Object

Required. The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy.

This object should have the same structure as MaintenancePolicy

name string

The name (project, location, cluster id) of the cluster to set maintenance policy. Specified in the format 'projects/* /locations/* /clusters/*'.

Source:
See:

SetMasterAuthRequest

SetMasterAuthRequest updates the admin password of a cluster.

Properties:
Name Type Description
projectId string

Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone string

Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

clusterId string

Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

action number

Required. The exact form of action to be taken on the master auth.

The number should be among the values of Action

update Object

Required. A description of the update.

This object should have the same structure as MasterAuth

name string

The name (project, location, cluster) of the cluster to set auth. Specified in the format 'projects/* /locations/* /clusters/*'.

Source:
See:

SetMonitoringServiceRequest

SetMonitoringServiceRequest sets the monitoring service of a cluster.

Properties:
Name Type Description
projectId string

Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone string

Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

clusterId string

Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

monitoringService string

Required. The monitoring service the cluster should use to write metrics. Currently available options:

  • "monitoring.googleapis.com/kubernetes" - the Google Cloud Monitoring service with Kubernetes-native resource model
  • "monitoring.googleapis.com" - the Google Cloud Monitoring service
  • "none" - no metrics will be exported from the cluster
name string

The name (project, location, cluster) of the cluster to set monitoring. Specified in the format 'projects/* /locations/* /clusters/*'.

Source:
See:

SetNetworkPolicyRequest

SetNetworkPolicyRequest enables/disables network policy for a cluster.

Properties:
Name Type Description
projectId string

Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone string

Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

clusterId string

Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

networkPolicy Object

Required. Configuration options for the NetworkPolicy feature.

This object should have the same structure as NetworkPolicy

name string

The name (project, location, cluster id) of the cluster to set networking policy. Specified in the format 'projects/* /locations/* /clusters/*'.

Source:
See:

SetNodePoolAutoscalingRequest

SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.

Properties:
Name Type Description
projectId string

Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone string

Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

clusterId string

Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

nodePoolId string

Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.

autoscaling Object

Required. Autoscaling configuration for the node pool.

This object should have the same structure as NodePoolAutoscaling

name string

The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format 'projects/* /locations/* /clusters/* /nodePools/*'.

Source:
See:

SetNodePoolManagementRequest

SetNodePoolManagementRequest sets the node management properties of a node pool.

Properties:
Name Type Description
projectId string

Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone string

Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

clusterId string

Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.

nodePoolId string

Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.

management Object

Required. NodeManagement configuration for the node pool.

This object should have the same structure as NodeManagement

name string

The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format 'projects/* /locations/* /clusters/* /nodePools/*'.

Source:
See:

SetNodePoolSizeRequest

SetNodePoolSizeRequest sets the size a node pool.

Properties:
Name Type Description
projectId string

Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone string

Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

clusterId string

Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.

nodePoolId string

Required. Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.

nodeCount number

Required. The desired node count for the pool.

name string

The name (project, location, cluster, node pool id) of the node pool to set size. Specified in the format 'projects/* /locations/* /clusters/* /nodePools/*'.

Source:
See:

ShieldedInstanceConfig

A set of Shielded Instance options.

Properties:
Name Type Description
enableSecureBoot boolean

Defines whether the instance has Secure Boot enabled.

Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.

enableIntegrityMonitoring boolean

Defines whether the instance has integrity monitoring enabled.

Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.

Source:
See:

StartIPRotationRequest

StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP.

Properties:
Name Type Description
projectId string

Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone string

Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

clusterId string

Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

name string

The name (project, location, cluster id) of the cluster to start IP rotation. Specified in the format 'projects/* /locations/* /clusters/*'.

rotateCredentials boolean

Whether to rotate credentials during IP rotation.

Source:
See:

StatusCondition

StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

Properties:
Name Type Description
code number

Machine-friendly representation of the condition

The number should be among the values of Code

message string

Human-friendly representation of the condition

Source:
See:

TimeWindow

Represents an arbitrary window of time.

Properties:
Name Type Description
startTime Object

The time that the window first starts.

This object should have the same structure as Timestamp

endTime Object

The time that the window ends. The end time should take place after the start time.

This object should have the same structure as Timestamp

Source:
See:

UpdateClusterRequest

UpdateClusterRequest updates the settings of a cluster.

Properties:
Name Type Description
projectId string

Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone string

Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

clusterId string

Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

update Object

Required. A description of the update.

This object should have the same structure as ClusterUpdate

name string

The name (project, location, cluster) of the cluster to update. Specified in the format 'projects/* /locations/* /clusters/*'.

Source:
See:

UpdateMasterRequest

UpdateMasterRequest updates the master of the cluster.

Properties:
Name Type Description
projectId string

Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone string

Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

clusterId string

Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

masterVersion string

Required. The Kubernetes version to change the master to.

Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior:

  • "latest": picks the highest valid Kubernetes version
  • "1.X": picks the highest valid patch+gke.N patch in the 1.X version
  • "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
  • "1.X.Y-gke.N": picks an explicit Kubernetes version
  • "-": picks the default Kubernetes version
name string

The name (project, location, cluster) of the cluster to update. Specified in the format 'projects/* /locations/* /clusters/*'.

Source:
See:

UpdateNodePoolRequest

UpdateNodePoolRequests update a node pool's image and/or version.

Properties:
Name Type Description
projectId string

Required. Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone string

Required. Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

clusterId string

Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

nodePoolId string

Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.

nodeVersion string

Required. The Kubernetes version to change the nodes to (typically an upgrade).

Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior:

  • "latest": picks the highest valid Kubernetes version
  • "1.X": picks the highest valid patch+gke.N patch in the 1.X version
  • "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
  • "1.X.Y-gke.N": picks an explicit Kubernetes version
  • "-": picks the Kubernetes master version
imageType string

Required. The desired image type for the node pool.

name string

The name (project, location, cluster, node pool) of the node pool to update. Specified in the format 'projects/* /locations/* /clusters/* /nodePools/*'.

Source:
See:

UsableSubnetwork

UsableSubnetwork resource returns the subnetwork name, its associated network and the primary CIDR range.

Properties:
Name Type Description
subnetwork string

Subnetwork Name. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet

network string

Network Name. Example: projects/my-project/global/networks/my-network

ipCidrRange string

The range of internal addresses that are owned by this subnetwork.

secondaryIpRanges Array.<Object>

Secondary IP ranges.

This object should have the same structure as UsableSubnetworkSecondaryRange

statusMessage string

A human readable status message representing the reasons for cases where the caller cannot use the secondary ranges under the subnet. For example if the secondary_ip_ranges is empty due to a permission issue, an insufficient permission message will be given by status_message.

Source:
See:

UsableSubnetworkSecondaryRange

Secondary IP range of a usable subnetwork.

Properties:
Name Type Description
rangeName string

The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance.

ipCidrRange string

The range of IP addresses belonging to this subnetwork secondary range.

status number

This field is to determine the status of the secondary range programmably.

The number should be among the values of Status

Source:
See:

VerticalPodAutoscaling

VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it.

Properties:
Name Type Description
enabled boolean

Enables vertical pod autoscaling.

Source:
See: