Enumerations

Action

static

number

Operation type: what type update to perform.

Value

UNKNOWN

Operation is unknown and will error out.

SET_PASSWORD

Set the password to a user generated value.

GENERATE_PASSWORD

Generate a new password and set it to that.

SET_USERNAME

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.

Provider

static

number

Allowed Network Policy providers.

Value

PROVIDER_UNSPECIFIED

Not set

CALICO

Tigera (Calico Felix).

Status

static

number

The current status of the cluster.

Value

STATUS_UNSPECIFIED

Not set.

PROVISIONING

The PROVISIONING state indicates the cluster is being created.

RUNNING

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

RECONCILING

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

The STOPPING state indicates the cluster is being deleted.

ERROR

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

DEGRADED

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

Status

static

number

The current status of the node pool instance.

Value

STATUS_UNSPECIFIED

Not set.

PROVISIONING

The PROVISIONING state indicates the node pool is being created.

RUNNING

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

RUNNING_WITH_ERROR

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

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

The STOPPING state indicates the node pool is being deleted.

ERROR

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

Status

static

number

Current status of the operation.

Value

STATUS_UNSPECIFIED

Not set.

PENDING

The operation has been created.

RUNNING

The operation is currently running.

DONE

The operation is done, either cancelled or completed.

ABORTING

The operation is aborting.

Type

static

number

Operation type.

Value

TYPE_UNSPECIFIED

Not set.

CREATE_CLUSTER

Cluster create.

DELETE_CLUSTER

Cluster delete.

UPGRADE_MASTER

A master upgrade.

UPGRADE_NODES

A node upgrade.

REPAIR_CLUSTER

Cluster repair.

UPDATE_CLUSTER

Cluster update.

CREATE_NODE_POOL

Node pool create.

DELETE_NODE_POOL

Node pool delete.

SET_NODE_POOL_MANAGEMENT

Set node pool management.

AUTO_REPAIR_NODES

Automatic node pool repair.

AUTO_UPGRADE_NODES

Automatic node upgrade.

SET_LABELS

Set labels.

SET_MASTER_AUTH

Set/generate master auth materials

SET_NODE_POOL_SIZE

Set node pool size.

SET_NETWORK_POLICY

Updates network policy for a cluster.

SET_MAINTENANCE_POLICY

Set the maintenance policy.

Properties

Action

static

number

Operation type: what type update to perform.

Value

UNKNOWN

Operation is unknown and will error out.

SET_PASSWORD

Set the password to a user generated value.

GENERATE_PASSWORD

Generate a new password and set it to that.

SET_USERNAME

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.

Provider

static

number

Allowed Network Policy providers.

Value

PROVIDER_UNSPECIFIED

Not set

CALICO

Tigera (Calico Felix).

Status

static

number

The current status of the cluster.

Value

STATUS_UNSPECIFIED

Not set.

PROVISIONING

The PROVISIONING state indicates the cluster is being created.

RUNNING

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

RECONCILING

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

The STOPPING state indicates the cluster is being deleted.

ERROR

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

DEGRADED

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

Status

static

number

The current status of the node pool instance.

Value

STATUS_UNSPECIFIED

Not set.

PROVISIONING

The PROVISIONING state indicates the node pool is being created.

RUNNING

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

RUNNING_WITH_ERROR

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

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

The STOPPING state indicates the node pool is being deleted.

ERROR

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

Status

static

number

Current status of the operation.

Value

STATUS_UNSPECIFIED

Not set.

PENDING

The operation has been created.

RUNNING

The operation is currently running.

DONE

The operation is done, either cancelled or completed.

ABORTING

The operation is aborting.

Type

static

number

Operation type.

Value

TYPE_UNSPECIFIED

Not set.

CREATE_CLUSTER

Cluster create.

DELETE_CLUSTER

Cluster delete.

UPGRADE_MASTER

A master upgrade.

UPGRADE_NODES

A node upgrade.

REPAIR_CLUSTER

Cluster repair.

UPDATE_CLUSTER

Cluster update.

CREATE_NODE_POOL

Node pool create.

DELETE_NODE_POOL

Node pool delete.

SET_NODE_POOL_MANAGEMENT

Set node pool management.

AUTO_REPAIR_NODES

Automatic node pool repair.

AUTO_UPGRADE_NODES

Automatic node upgrade.

SET_LABELS

Set labels.

SET_MASTER_AUTH

Set/generate master auth materials

SET_NODE_POOL_SIZE

Set node pool size.

SET_NETWORK_POLICY

Updates network policy for a cluster.

SET_MAINTENANCE_POLICY

Set the maintenance policy.

Abstract types

AcceleratorConfig

static

AcceleratorConfig represents a Hardware Accelerator request.

Properties

Parameter

acceleratorCount

number

The number of the accelerator cards exposed to an instance.

acceleratorType

string

The accelerator type resource name. List of supported accelerators here

See also

google.container.v1.AcceleratorConfig definition in proto format

AddonsConfig

static

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

Properties

Parameter

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 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

See also

google.container.v1.AddonsConfig definition in proto format

AutoUpgradeOptions

static

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

Properties

Parameter

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.

See also

google.container.v1.AutoUpgradeOptions definition in proto format

CancelOperationRequest

static

CancelOperationRequest cancels a single operation.

Properties

Parameter

projectId

string

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

zone

string

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

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/*'.

See also

google.container.v1.CancelOperationRequest definition in proto format

CidrBlock

static

CidrBlock contains an optional name and one CIDR block.

Properties

Parameter

displayName

string

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

cidrBlock

string

cidr_block must be specified in CIDR notation.

See also

google.container.v1.MasterAuthorizedNetworksConfig.CidrBlock definition in proto format

ClientCertificateConfig

static

Configuration for client certificates on the cluster.

Property

Parameter

issueClientCertificate

boolean

Issue a client certificate.

See also

google.container.v1.ClientCertificateConfig definition in proto format

Cluster

static

A Google Kubernetes Engine cluster.

Properties

Parameter

name

string

The name of this cluster. The name must be unique within this project and zone, 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.

nodeConfig

Object

Parameters used in creating the cluster's nodes. See nodeConfig for the description of its properties. 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.

If unspecified, the defaults are used.

This object should have the same structure as NodeConfig

masterAuth

Object

The authentication information for accessing the master endpoint.

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 - 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 of 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 of string

The list of Google Compute Engine locations 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 with string properties

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

networkConfig

Object

Configuration for cluster networking.

This object should have the same structure as NetworkConfig

privateClusterConfig

Object

Configuration for private cluster.

This object should have the same structure as PrivateClusterConfig

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 NodePool.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.

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 of string

Deprecated. Use node_pools.instance_group_urls.

currentNodeCount

number

[Output only] The number of nodes currently in the cluster.

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.

See also

google.container.v1.Cluster definition in proto format

ClusterUpdate

static

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

Parameter

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" - 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.

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 of string

The desired list of Google Compute Engine locations 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

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
See also

google.container.v1.ClusterUpdate definition in proto format

CompleteIPRotationRequest

static

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

Properties

Parameter

projectId

string

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

zone

string

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

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/*'.

See also

google.container.v1.CompleteIPRotationRequest definition in proto format

CreateClusterRequest

static

CreateClusterRequest creates a cluster.

Properties

Parameter

projectId

string

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

zone

string

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

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/'.

See also

google.container.v1.CreateClusterRequest definition in proto format

CreateNodePoolRequest

static

CreateNodePoolRequest creates a node pool for a cluster.

Properties

Parameter

projectId

string

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

zone

string

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

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

nodePool

Object

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/*'.

See also

google.container.v1.CreateNodePoolRequest definition in proto format

DailyMaintenanceWindow

static

Time window specified for daily maintenance operations.

Properties

Parameter

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".

See also

google.container.v1.DailyMaintenanceWindow definition in proto format

DeleteClusterRequest

static

DeleteClusterRequest deletes a cluster.

Properties

Parameter

projectId

string

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

zone

string

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

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/*'.

See also

google.container.v1.DeleteClusterRequest definition in proto format

DeleteNodePoolRequest

static

DeleteNodePoolRequest deletes a node pool for a cluster.

Properties

Parameter

projectId

string

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

zone

string

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

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

nodePoolId

string

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/'.

See also

google.container.v1.DeleteNodePoolRequest definition in proto format

GetClusterRequest

static

GetClusterRequest gets the settings of a cluster.

Properties

Parameter

projectId

string

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

zone

string

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

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/*'.

See also

google.container.v1.GetClusterRequest definition in proto format

GetNodePoolRequest

static

GetNodePoolRequest retrieves a node pool for a cluster.

Properties

Parameter

projectId

string

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

zone

string

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

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

nodePoolId

string

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/'.

See also

google.container.v1.GetNodePoolRequest definition in proto format

GetOperationRequest

static

GetOperationRequest gets a single operation.

Properties

Parameter

projectId

string

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

zone

string

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

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/*'.

See also

google.container.v1.GetOperationRequest definition in proto format

GetServerConfigRequest

static

Gets the current Kubernetes Engine service configuration.

Properties

Parameter

projectId

string

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

zone

string

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/'.

See also

google.container.v1.GetServerConfigRequest definition in proto format

HorizontalPodAutoscaling

static

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.

Property

Parameter

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.

See also

google.container.v1.HorizontalPodAutoscaling definition in proto format

HttpLoadBalancing

static

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.

Property

Parameter

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.

See also

google.container.v1.HttpLoadBalancing definition in proto format

IPAllocationPolicy

static

Configuration for controlling how IPs are allocated in the cluster.

Properties

Parameter

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.

See also

google.container.v1.IPAllocationPolicy definition in proto format

KubernetesDashboard

static

Configuration for the Kubernetes Dashboard.

Property

Parameter

disabled

boolean

Whether the Kubernetes Dashboard is enabled for this cluster.

See also

google.container.v1.KubernetesDashboard definition in proto format

LegacyAbac

static

Configuration for the legacy Attribute Based Access Control authorization mode.

Property

Parameter

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.

See also

google.container.v1.LegacyAbac definition in proto format

ListClustersRequest

static

ListClustersRequest lists clusters.

Properties

Parameter

projectId

string

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

zone

string

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.

See also

google.container.v1.ListClustersRequest definition in proto format

ListClustersResponse

static

ListClustersResponse is the result of ListClustersRequest.

Properties

Parameter

clusters

Array of 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 of string

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

See also

google.container.v1.ListClustersResponse definition in proto format

ListNodePoolsRequest

static

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

Properties

Parameter

projectId

string

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

zone

string

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

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/*'.

See also

google.container.v1.ListNodePoolsRequest definition in proto format

ListNodePoolsResponse

static

ListNodePoolsResponse is the result of ListNodePoolsRequest.

Property

Parameter

nodePools

Array of Object

A list of node pools for a cluster.

This object should have the same structure as NodePool

See also

google.container.v1.ListNodePoolsResponse definition in proto format

ListOperationsRequest

static

ListOperationsRequest lists operations.

Properties

Parameter

projectId

string

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

zone

string

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.

See also

google.container.v1.ListOperationsRequest definition in proto format

ListOperationsResponse

static

ListOperationsResponse is the result of ListOperationsRequest.

Properties

Parameter

operations

Array of Object

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

This object should have the same structure as Operation

missingZones

Array of string

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

See also

google.container.v1.ListOperationsResponse definition in proto format

MaintenancePolicy

static

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

Property

Parameter

window

Object

Specifies the maintenance window in which maintenance may be performed.

This object should have the same structure as MaintenanceWindow

See also

google.container.v1.MaintenancePolicy definition in proto format

MaintenanceWindow

static

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

Property

Parameter

dailyMaintenanceWindow

Object

DailyMaintenanceWindow specifies a daily maintenance operation window.

This object should have the same structure as DailyMaintenanceWindow

See also

google.container.v1.MaintenanceWindow definition in proto format

MasterAuth

static

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

Properties

Parameter

username

string

The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, you can disable basic authentication by providing an empty username.

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.

See also

google.container.v1.MasterAuth definition in proto format

MasterAuthorizedNetworksConfig

static

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

Parameter

enabled

boolean

Whether or not master authorized networks is enabled.

cidrBlocks

Array of Object

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

This object should have the same structure as CidrBlock

See also

google.container.v1.MasterAuthorizedNetworksConfig definition in proto format

NetworkConfig

static

NetworkConfig reports the relative names of network & subnetwork.

Properties

Parameter

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

See also

google.container.v1.NetworkConfig definition in proto format

NetworkPolicy

static

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

Properties

Parameter

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.

See also

google.container.v1.NetworkPolicy definition in proto format

NetworkPolicyConfig

static

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.

Property

Parameter

disabled

boolean

Whether NetworkPolicy is enabled for this cluster.

See also

google.container.v1.NetworkPolicyConfig definition in proto format

NodeConfig

static

Parameters that describe the nodes in a cluster.

Properties

Parameter

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 of 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:

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 with string properties

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" "enable-os-login" "gci-update-strategy" "gci-ensure-gke-docker" "instance-template" "kube-env" "startup-script" "user-data"

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 with string properties

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 dependant upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits for more information.

tags

Array of 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 of 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

See also

google.container.v1.NodeConfig definition in proto format

NodeManagement

static

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

Properties

Parameter

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

See also

google.container.v1.NodeManagement definition in proto format

NodePool

static

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

Parameter

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 of 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

See also

google.container.v1.NodePool definition in proto format

NodePoolAutoscaling

static

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

Properties

Parameter

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.

See also

google.container.v1.NodePoolAutoscaling definition in proto format

Operation

static

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

Properties

Parameter

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.

See also

google.container.v1.Operation definition in proto format

PrivateClusterConfig

static

Configuration options for private clusters.

Properties

Parameter

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.

See also

google.container.v1.PrivateClusterConfig definition in proto format

RollbackNodePoolUpgradeRequest

static

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

Properties

Parameter

projectId

string

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

zone

string

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

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

nodePoolId

string

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/'.

See also

google.container.v1.RollbackNodePoolUpgradeRequest definition in proto format

ServerConfig

static

Kubernetes Engine service configuration.

Properties

Parameter

defaultClusterVersion

string

Version of Kubernetes the service deploys by default.

validNodeVersions

Array of string

List of valid node upgrade target versions.

defaultImageType

string

Default image type.

validImageTypes

Array of string

List of valid image types.

validMasterVersions

Array of string

List of valid master versions.

See also

google.container.v1.ServerConfig definition in proto format

SetAddonsConfigRequest

static

SetAddonsConfigRequest sets the addons associated with the cluster.

Properties

Parameter

projectId

string

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

zone

string

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

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

addonsConfig

Object

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/*'.

See also

google.container.v1.SetAddonsConfigRequest definition in proto format

SetLabelsRequest

static

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

Parameter

projectId

string

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

zone

string

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

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

resourceLabels

Object with string properties

The labels to set for that cluster.

labelFingerprint

string

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/*'.

See also

google.container.v1.SetLabelsRequest definition in proto format

SetLegacyAbacRequest

static

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

Properties

Parameter

projectId

string

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

zone

string

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

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

enabled

boolean

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/*'.

See also

google.container.v1.SetLegacyAbacRequest definition in proto format

SetLocationsRequest

static

SetLocationsRequest sets the locations of the cluster.

Properties

Parameter

projectId

string

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

zone

string

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

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

locations

Array of string

The desired list of Google Compute Engine locations 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/*'.

See also

google.container.v1.SetLocationsRequest definition in proto format

SetLoggingServiceRequest

static

SetLoggingServiceRequest sets the logging service of a cluster.

Properties

Parameter

projectId

string

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

zone

string

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

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

loggingService

string

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/*'.

See also

google.container.v1.SetLoggingServiceRequest definition in proto format

SetMaintenancePolicyRequest

static

SetMaintenancePolicyRequest sets the maintenance policy for a cluster.

Properties

Parameter

projectId

string

The Google Developers Console project ID or project number.

zone

string

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

clusterId

string

The name of the cluster to update.

maintenancePolicy

Object

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/*'.

See also

google.container.v1.SetMaintenancePolicyRequest definition in proto format

SetMasterAuthRequest

static

SetMasterAuthRequest updates the admin password of a cluster.

Properties

Parameter

projectId

string

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

zone

string

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

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

action

number

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

The number should be among the values of Action

update

Object

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/*'.

See also

google.container.v1.SetMasterAuthRequest definition in proto format

SetMonitoringServiceRequest

static

SetMonitoringServiceRequest sets the monitoring service of a cluster.

Properties

Parameter

projectId

string

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

zone

string

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

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

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

name

string

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

See also

google.container.v1.SetMonitoringServiceRequest definition in proto format

SetNetworkPolicyRequest

static

SetNetworkPolicyRequest enables/disables network policy for a cluster.

Properties

Parameter

projectId

string

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

zone

string

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

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

networkPolicy

Object

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/*'.

See also

google.container.v1.SetNetworkPolicyRequest definition in proto format

SetNodePoolAutoscalingRequest

static

SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.

Properties

Parameter

projectId

string

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

zone

string

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

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

nodePoolId

string

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

autoscaling

Object

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/'.

See also

google.container.v1.SetNodePoolAutoscalingRequest definition in proto format

SetNodePoolManagementRequest

static

SetNodePoolManagementRequest sets the node management properties of a node pool.

Properties

Parameter

projectId

string

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

zone

string

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

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

nodePoolId

string

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

management

Object

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/'.

See also

google.container.v1.SetNodePoolManagementRequest definition in proto format

SetNodePoolSizeRequest

static

SetNodePoolSizeRequest sets the size a node pool.

Properties

Parameter

projectId

string

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

zone

string

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

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

nodePoolId

string

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

nodeCount

number

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/'.

See also

google.container.v1.SetNodePoolSizeRequest definition in proto format

StartIPRotationRequest

static

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

Parameter

projectId

string

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

zone

string

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

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.

See also

google.container.v1.StartIPRotationRequest definition in proto format

UpdateClusterRequest

static

UpdateClusterRequest updates the settings of a cluster.

Properties

Parameter

projectId

string

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

zone

string

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

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

update

Object

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/*'.

See also

google.container.v1.UpdateClusterRequest definition in proto format

UpdateMasterRequest

static

UpdateMasterRequest updates the master of the cluster.

Properties

Parameter

projectId

string

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

zone

string

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

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

masterVersion

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

name

string

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

See also

google.container.v1.UpdateMasterRequest definition in proto format

UpdateNodePoolRequest

static

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

Properties

Parameter

projectId

string

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

zone

string

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

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

nodePoolId

string

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

nodeVersion

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

imageType

string

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/'.

See also

google.container.v1.UpdateNodePoolRequest definition in proto format