googleapis
Version:
Google APIs Client Library for Node.js
998 lines • 456 kB
TypeScript
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace container_v1beta1 {
export interface Options extends GlobalOptions {
version: 'v1beta1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Kubernetes Engine API
*
* Builds and manages container-based applications, powered by the open source Kubernetes technology.
*
* @example
* ```js
* const {google} = require('googleapis');
* const container = google.container('v1beta1');
* ```
*/
export class Container {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* AcceleratorConfig represents a Hardware Accelerator request.
*/
export interface Schema$AcceleratorConfig {
/**
* The number of the accelerator cards exposed to an instance.
*/
acceleratorCount?: string | null;
/**
* The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
*/
acceleratorType?: string | null;
}
/**
* Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality.
*/
export interface Schema$AddonsConfig {
/**
* Configuration for the Cloud Run addon. The `IstioConfig` addon must be enabled in order to enable Cloud Run addon. This option can only be enabled at cluster creation time.
*/
cloudRunConfig?: Schema$CloudRunConfig;
/**
* Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API
*/
configConnectorConfig?: Schema$ConfigConnectorConfig;
/**
* Configuration for NodeLocalDNS, a dns cache running on cluster nodes
*/
dnsCacheConfig?: Schema$DnsCacheConfig;
/**
* Configuration for the Compute Engine Persistent Disk CSI driver.
*/
gcePersistentDiskCsiDriverConfig?: Schema$GcePersistentDiskCsiDriverConfig;
/**
* 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.
*/
horizontalPodAutoscaling?: Schema$HorizontalPodAutoscaling;
/**
* Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
*/
httpLoadBalancing?: Schema$HttpLoadBalancing;
/**
* Configuration for Istio, an open platform to connect, manage, and secure microservices.
*/
istioConfig?: Schema$IstioConfig;
/**
* Configuration for the KALM addon, which manages the lifecycle of k8s applications.
*/
kalmConfig?: Schema$KalmConfig;
/**
* 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
*/
kubernetesDashboard?: Schema$KubernetesDashboard;
/**
* 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.
*/
networkPolicyConfig?: Schema$NetworkPolicyConfig;
}
/**
* Configuration for returning group information from authenticators.
*/
export interface Schema$AuthenticatorGroupsConfig {
/**
* Whether this cluster should return group membership lookups during authentication using a group of security groups.
*/
enabled?: boolean | null;
/**
* The name of the security group-of-groups to be used. Only relevant if enabled = true.
*/
securityGroup?: string | null;
}
/**
* Autopilot is the configuration for Autopilot settings on the cluster.
*/
export interface Schema$Autopilot {
/**
* Enable Autopilot
*/
enabled?: boolean | null;
}
/**
* AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
*/
export interface Schema$AutoprovisioningNodePoolDefaults {
/**
* The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
*/
bootDiskKmsKey?: string | null;
/**
* 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.
*/
diskSizeGb?: number | null;
/**
* Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'
*/
diskType?: string | null;
/**
* NodeManagement configuration for this NodePool.
*/
management?: Schema$NodeManagement;
/**
* 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](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) To unset the min cpu platform field pass "automatic" as field value.
*/
minCpuPlatform?: string | null;
/**
* 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](https://cloud.google.com/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.
*/
oauthScopes?: string[] | null;
/**
* The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used.
*/
serviceAccount?: string | null;
/**
* Shielded Instance options.
*/
shieldedInstanceConfig?: Schema$ShieldedInstanceConfig;
/**
* Upgrade settings control disruption and speed of the upgrade.
*/
upgradeSettings?: Schema$UpgradeSettings;
}
/**
* AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed.
*/
export interface Schema$AutoUpgradeOptions {
/**
* [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
*/
autoUpgradeStartTime?: string | null;
/**
* [Output only] This field is set when upgrades are about to commence with the description of the upgrade.
*/
description?: string | null;
}
/**
* Deprecated.
*/
export interface Schema$AvailableVersion {
/**
* Reason for availability.
*/
reason?: string | null;
/**
* Kubernetes version.
*/
version?: string | null;
}
/**
* Parameters for using BigQuery as the destination of resource usage export.
*/
export interface Schema$BigQueryDestination {
/**
* The ID of a BigQuery Dataset.
*/
datasetId?: string | null;
}
/**
* Configuration for Binary Authorization.
*/
export interface Schema$BinaryAuthorization {
/**
* Enable Binary Authorization for this cluster. If enabled, all container images will be validated by Google Binauthz.
*/
enabled?: boolean | null;
}
/**
* CancelOperationRequest cancels a single operation.
*/
export interface Schema$CancelOperationRequest {
/**
* The name (project, location, operation id) of the operation to cancel. Specified in the format `projects/x/locations/x/operations/x`.
*/
name?: string | null;
/**
* Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field.
*/
operationId?: string | null;
/**
* Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.
*/
projectId?: string | null;
/**
* Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.
*/
zone?: string | null;
}
/**
* CidrBlock contains an optional name and one CIDR block.
*/
export interface Schema$CidrBlock {
/**
* cidr_block must be specified in CIDR notation.
*/
cidrBlock?: string | null;
/**
* display_name is an optional field for users to identify CIDR blocks.
*/
displayName?: string | null;
}
/**
* Configuration for client certificates on the cluster.
*/
export interface Schema$ClientCertificateConfig {
/**
* Issue a client certificate.
*/
issueClientCertificate?: boolean | null;
}
/**
* Configuration options for the Cloud Run feature.
*/
export interface Schema$CloudRunConfig {
/**
* Whether Cloud Run addon is enabled for this cluster.
*/
disabled?: boolean | null;
/**
* Which load balancer type is installed for Cloud Run.
*/
loadBalancerType?: string | null;
}
/**
* A Google Kubernetes Engine cluster.
*/
export interface Schema$Cluster {
/**
* Configurations for the various addons available to run in the cluster.
*/
addonsConfig?: Schema$AddonsConfig;
/**
* Configuration controlling RBAC group membership information.
*/
authenticatorGroupsConfig?: Schema$AuthenticatorGroupsConfig;
/**
* Autopilot configuration for the cluster.
*/
autopilot?: Schema$Autopilot;
/**
* Cluster-level autoscaling configuration.
*/
autoscaling?: Schema$ClusterAutoscaling;
/**
* Configuration for Binary Authorization.
*/
binaryAuthorization?: Schema$BinaryAuthorization;
/**
* The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) 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`.
*/
clusterIpv4Cidr?: string | null;
/**
* Telemetry integration for the cluster.
*/
clusterTelemetry?: Schema$ClusterTelemetry;
/**
* Which conditions caused the current cluster state.
*/
conditions?: Schema$StatusCondition[];
/**
* Configuration of Confidential Nodes
*/
confidentialNodes?: Schema$ConfidentialNodes;
/**
* [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
*/
createTime?: string | null;
/**
* [Output only] The current software version of the master endpoint.
*/
currentMasterVersion?: string | null;
/**
* [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
*/
currentNodeCount?: number | null;
/**
* [Output only] Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) 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.
*/
currentNodeVersion?: string | null;
/**
* Configuration of etcd encryption.
*/
databaseEncryption?: Schema$DatabaseEncryption;
/**
* 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.
*/
defaultMaxPodsConstraint?: Schema$MaxPodsConstraint;
/**
* An optional description of this cluster.
*/
description?: string | null;
/**
* Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) 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.
*/
enableKubernetesAlpha?: boolean | null;
/**
* Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead.
*/
enableTpu?: boolean | null;
/**
* [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.
*/
endpoint?: string | null;
/**
* [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
*/
expireTime?: string | null;
/**
* 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
*/
initialClusterVersion?: string | null;
/**
* The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) 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.
*/
initialNodeCount?: number | null;
/**
* Deprecated. Use node_pools.instance_group_urls.
*/
instanceGroupUrls?: string[] | null;
/**
* Configuration for cluster IP allocation.
*/
ipAllocationPolicy?: Schema$IPAllocationPolicy;
/**
* The fingerprint of the set of labels for this cluster.
*/
labelFingerprint?: string | null;
/**
* Configuration for the legacy ABAC authorization mode.
*/
legacyAbac?: Schema$LegacyAbac;
/**
* [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
*/
location?: string | null;
/**
* The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
*/
locations?: string[] | null;
/**
* The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.
*/
loggingService?: string | null;
/**
* Configure the maintenance policy for this cluster.
*/
maintenancePolicy?: Schema$MaintenancePolicy;
/**
* Configuration for master components.
*/
master?: Schema$Master;
/**
* 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.
*/
masterAuth?: Schema$MasterAuth;
/**
* The configuration options for master authorized networks feature.
*/
masterAuthorizedNetworksConfig?: Schema$MasterAuthorizedNetworksConfig;
/**
* The IP prefix in CIDR notation to use for the hosted master network. This prefix will be used for assigning private IP addresses to the master or set of masters, as well as the ILB VIP. This field is deprecated, use private_cluster_config.master_ipv4_cidr_block instead.
*/
masterIpv4CidrBlock?: string | null;
/**
* The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.
*/
monitoringService?: string | null;
/**
* 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.
*/
name?: string | null;
/**
* The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name.
*/
network?: string | null;
/**
* Configuration for cluster networking.
*/
networkConfig?: Schema$NetworkConfig;
/**
* Configuration options for the NetworkPolicy feature.
*/
networkPolicy?: Schema$NetworkPolicy;
/**
* 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.
*/
nodeConfig?: Schema$NodeConfig;
/**
* [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.
*/
nodeIpv4CidrSize?: number | null;
/**
* The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.
*/
nodePools?: Schema$NodePool[];
/**
* Notification configuration of the cluster.
*/
notificationConfig?: Schema$NotificationConfig;
/**
* Configuration for the PodSecurityPolicy feature.
*/
podSecurityPolicyConfig?: Schema$PodSecurityPolicyConfig;
/**
* If this is a private cluster setup. Private clusters are clusters that, by default have no external IP addresses on the nodes and where nodes and the master communicate over private IP addresses. This field is deprecated, use private_cluster_config.enable_private_nodes instead.
*/
privateCluster?: boolean | null;
/**
* Configuration for private cluster.
*/
privateClusterConfig?: Schema$PrivateClusterConfig;
/**
* Release channel configuration.
*/
releaseChannel?: Schema$ReleaseChannel;
/**
* The resource labels for the cluster to use to annotate any related Google Compute Engine resources.
*/
resourceLabels?: {
[key: string]: string;
} | null;
/**
* Configuration for exporting resource usages. Resource usage export is disabled when this config unspecified.
*/
resourceUsageExportConfig?: Schema$ResourceUsageExportConfig;
/**
* [Output only] Server-defined URL for the resource.
*/
selfLink?: string | null;
/**
* [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.
*/
servicesIpv4Cidr?: string | null;
/**
* Shielded Nodes configuration.
*/
shieldedNodes?: Schema$ShieldedNodes;
/**
* [Output only] The current status of this cluster.
*/
status?: string | null;
/**
* [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
*/
statusMessage?: string | null;
/**
* The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name.
*/
subnetwork?: string | null;
/**
* Configuration for Cloud TPU support;
*/
tpuConfig?: Schema$TpuConfig;
/**
* [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`).
*/
tpuIpv4CidrBlock?: string | null;
/**
* Cluster-level Vertical Pod Autoscaling configuration.
*/
verticalPodAutoscaling?: Schema$VerticalPodAutoscaling;
/**
* Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.
*/
workloadIdentityConfig?: Schema$WorkloadIdentityConfig;
/**
* [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
*/
zone?: string | null;
}
/**
* 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.
*/
export interface Schema$ClusterAutoscaling {
/**
* The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.
*/
autoprovisioningLocations?: string[] | null;
/**
* AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
*/
autoprovisioningNodePoolDefaults?: Schema$AutoprovisioningNodePoolDefaults;
/**
* Defines autoscaling behaviour.
*/
autoscalingProfile?: string | null;
/**
* Enables automatic node pool creation and deletion.
*/
enableNodeAutoprovisioning?: boolean | null;
/**
* Contains global constraints regarding minimum and maximum amount of resources in the cluster.
*/
resourceLimits?: Schema$ResourceLimit[];
}
/**
* Telemetry integration for the cluster.
*/
export interface Schema$ClusterTelemetry {
/**
* Type of the integration.
*/
type?: string | null;
}
/**
* 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.
*/
export interface Schema$ClusterUpdate {
/**
* Configurations for the various addons available to run in the cluster.
*/
desiredAddonsConfig?: Schema$AddonsConfig;
/**
* The desired configuration options for the Binary Authorization feature.
*/
desiredBinaryAuthorization?: Schema$BinaryAuthorization;
/**
* Cluster-level autoscaling configuration.
*/
desiredClusterAutoscaling?: Schema$ClusterAutoscaling;
/**
* The desired telemetry integration for the cluster.
*/
desiredClusterTelemetry?: Schema$ClusterTelemetry;
/**
* Configuration of etcd encryption.
*/
desiredDatabaseEncryption?: Schema$DatabaseEncryption;
/**
* The desired datapath provider for the cluster.
*/
desiredDatapathProvider?: string | null;
/**
* The desired status of whether to disable default sNAT for this cluster.
*/
desiredDefaultSnatStatus?: Schema$DefaultSnatStatus;
/**
* The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well.
*/
desiredImageType?: string | null;
/**
* The desired config of Intra-node visibility.
*/
desiredIntraNodeVisibilityConfig?: Schema$IntraNodeVisibilityConfig;
/**
* The desired L4 Internal Load Balancer Subsetting configuration.
*/
desiredL4ilbSubsettingConfig?: Schema$ILBSubsettingConfig;
/**
* The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.
*/
desiredLocations?: string[] | null;
/**
* The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.
*/
desiredLoggingService?: string | null;
/**
* Configuration for master components.
*/
desiredMaster?: Schema$Master;
/**
* The desired configuration options for master authorized networks feature.
*/
desiredMasterAuthorizedNetworksConfig?: Schema$MasterAuthorizedNetworksConfig;
/**
* The Kubernetes version to change the master to. The only valid value is the latest supported version. 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
*/
desiredMasterVersion?: string | null;
/**
* The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.
*/
desiredMonitoringService?: string | null;
/**
* 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.
*/
desiredNodePoolAutoscaling?: Schema$NodePoolAutoscaling;
/**
* The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family", "desired_node_pool_autoscaling", or "desired_workload_metadata_config" is specified and there is more than one node pool on the cluster.
*/
desiredNodePoolId?: string | null;
/**
* 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
*/
desiredNodeVersion?: string | null;
/**
* The desired notification configuration.
*/
desiredNotificationConfig?: Schema$NotificationConfig;
/**
* The desired configuration options for the PodSecurityPolicy feature.
*/
desiredPodSecurityPolicyConfig?: Schema$PodSecurityPolicyConfig;
/**
* The desired private cluster configuration.
*/
desiredPrivateClusterConfig?: Schema$PrivateClusterConfig;
/**
* The desired state of IPv6 connectivity to Google Services.
*/
desiredPrivateIpv6GoogleAccess?: string | null;
/**
* The desired release channel configuration.
*/
desiredReleaseChannel?: Schema$ReleaseChannel;
/**
* The desired configuration for exporting resource usage.
*/
desiredResourceUsageExportConfig?: Schema$ResourceUsageExportConfig;
/**
* Configuration for Shielded Nodes.
*/
desiredShieldedNodes?: Schema$ShieldedNodes;
/**
* The desired Cloud TPU configuration.
*/
desiredTpuConfig?: Schema$TpuConfig;
/**
* Cluster-level Vertical Pod Autoscaling configuration.
*/
desiredVerticalPodAutoscaling?: Schema$VerticalPodAutoscaling;
/**
* Configuration for Workload Identity.
*/
desiredWorkloadIdentityConfig?: Schema$WorkloadIdentityConfig;
}
/**
* CompleteIPRotationRequest moves the cluster master back into single-IP mode.
*/
export interface Schema$CompleteIPRotationRequest {
/**
* Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
*/
clusterId?: string | null;
/**
* The name (project, location, cluster id) of the cluster to complete IP rotation. Specified in the format `projects/x/locations/x/clusters/x`.
*/
name?: string | null;
/**
* Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the name field.
*/
projectId?: string | null;
/**
* Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
*/
zone?: string | null;
}
/**
* ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs.
*/
export interface Schema$ConfidentialNodes {
/**
* Whether Confidential Nodes feature is enabled for all nodes in this cluster.
*/
enabled?: boolean | null;
}
/**
* Configuration options for the Config Connector add-on.
*/
export interface Schema$ConfigConnectorConfig {
/**
* Whether Cloud Connector is enabled for this cluster.
*/
enabled?: boolean | null;
}
/**
* Parameters for controlling consumption metering.
*/
export interface Schema$ConsumptionMeteringConfig {
/**
* Whether to enable consumption metering for this cluster. If enabled, a second BigQuery table will be created to hold resource consumption records.
*/
enabled?: boolean | null;
}
/**
* CreateClusterRequest creates a cluster.
*/
export interface Schema$CreateClusterRequest {
/**
* Required. A [cluster resource](https://cloud.google.com/container-engine/reference/rest/v1beta1/projects.locations.clusters)
*/
cluster?: Schema$Cluster;
/**
* The parent (project and location) where the cluster will be created. Specified in the format `projects/x/locations/x`.
*/
parent?: string | null;
/**
* Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field.
*/
projectId?: string | null;
/**
* Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.
*/
zone?: string | null;
}
/**
* CreateNodePoolRequest creates a node pool for a cluster.
*/
export interface Schema$CreateNodePoolRequest {
/**
* Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.
*/
clusterId?: string | null;
/**
* Required. The node pool to create.
*/
nodePool?: Schema$NodePool;
/**
* The parent (project, location, cluster id) where the node pool will be created. Specified in the format `projects/x/locations/x/clusters/x`.
*/
parent?: string | null;
/**
* Required. Deprecated. The Google Developers Console [project ID or project number](https://developers.google.com/console/help/new/#projectnumber). This field has been deprecated and replaced by the parent field.
*/
projectId?: string | null;
/**
* Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.
*/
zone?: string | null;
}
/**
* Time window specified for daily maintenance operations.
*/
export interface Schema$DailyMaintenanceWindow {
/**
* [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.
*/
duration?: string | null;
/**
* Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.
*/
startTime?: string | null;
}
/**
* Configuration of etcd encryption.
*/
export interface Schema$DatabaseEncryption {
/**
* 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
*/
keyName?: string | null;
/**
* Denotes the state of etcd encryption.
*/
state?: string | null;
}
/**
* DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster.
*/
export interface Schema$DefaultSnatStatus {
/**
* Disables cluster default sNAT rules.
*/
disabled?: boolean | null;
}
/**
* Configuration for NodeLocal DNSCache
*/
export interface Schema$DnsCacheConfig {
/**
* Whether NodeLocal DNSCache is enabled for this cluster.
*/
enabled?: boolean | null;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} The JSON representation for `Empty` is empty JSON object `{\}`.
*/
export interface Schema$Empty {
}
/**
* EphemeralStorageConfig contains configuration for the ephemeral storage filesystem.
*/
export interface Schema$EphemeralStorageConfig {
/**
* Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. Each local SSD is 375 GB in size. If zero, it means to disable using local SSDs as ephemeral storage.
*/
localSsdCount?: number | null;
}
/**
* Configuration for the Compute Engine PD CSI driver.
*/
export interface Schema$GcePersistentDiskCsiDriverConfig {
/**
* Whether the Compute Engine PD CSI driver is enabled for this cluster.
*/
enabled?: boolean | null;
}
/**
* GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517
*/
export interface Schema$GetJSONWebKeysResponse {
/**
* OnePlatform automatically extracts this field and uses it to set the HTTP Cache-Control header.
*/
cacheHeader?: Schema$HttpCacheControlResponseHeader;
/**
* The public component of the keys used by the cluster to sign token requests.
*/
keys?: Schema$Jwk[];
}
/**
* GetOpenIDConfigResponse is an OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.
*/
export interface Schema$GetOpenIDConfigResponse {
/**
* OnePlatform automatically extracts this field and uses it to set the HTTP Cache-Control header.
*/
cacheHeader?: Schema$HttpCacheControlResponseHeader;
/**
* Supported claims.
*/
claims_supported?: string[] | null;
/**
* Supported grant types.
*/
grant_types?: string[] | null;
/**
* supported ID Token signing Algorithms.
*/
id_token_signing_alg_values_supported?: string[] | null;
/**
* OIDC Issuer.
*/
issuer?: string | null;
/**
* JSON Web Key uri.
*/
jwks_uri?: string | null;
/**
* Supported response types.
*/
response_types_supported?: string[] | null;
/**
* Supported subject types.
*/
subject_types_supported?: string[] | null;
}
/**
* 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.
*/
export interface Schema$HorizontalPodAutoscaling {
/**
* Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that metrics are collected into Stackdriver Monitoring.
*/
disabled?: boolean | null;
}
/**
* RFC-2616: cache control support
*/
export interface Schema$HttpCacheControlResponseHeader {
/**
* 14.6 response cache age, in seconds since the response is generated
*/
age?: string | null;
/**
* 14.9 request and response directives
*/
directive?: string | null;
/**
* 14.21 response cache expires, in RFC 1123 date format
*/
expires?: string | null;
}
/**
* 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.
*/
export interface Schema$HttpLoadBalancing {
/**
* 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.
*/
disabled?: boolean | null;
}
/**
* ILBSubsettingConfig contains the desired config of L4 Internal LoadBalancer subsetting on this cluster.
*/
export interface Schema$ILBSubsettingConfig {
/**
* Enables l4 ILB subsetting for this cluster
*/
enabled?: boolean | null;
}
/**
* IntraNodeVisibilityConfig contains the desired config of the intra-node visibility on this cluster.
*/
export interface Schema$IntraNodeVisibilityConfig {
/**
* Enables intra node visibility for this cluster.
*/
enabled?: boolean | null;
}
/**
* Configuration for controlling how IPs are allocated in the cluster.
*/
export interface Schema$IPAllocationPolicy {
/**
* If true, allow allocation of cluster CIDR ranges that overlap with certain kinds of network routes. By default we do not allow cluster CIDR ranges to intersect with any user declared routes. With allow_route_overlap == true, we allow overlapping with CIDR ranges that are larger than the cluster CIDR range. If this field is set to true, then cluster and services CIDRs must be fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means: 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and `services_ipv4_cidr_block` must be fully-specified. 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be fully-specified.
*/
allowRouteOverlap?: boolean | null;
/**
* This field is deprecated, use cluster_ipv4_cidr_block.
*/
clusterIpv4Cidr?: string | null;
/**
* 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](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) 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.
*/
clusterIpv4CidrBlock?: string | null;
/**
* 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 and create_subnetwork is false.
*/
clusterSecondaryRangeName?: string | null;
/**
* Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true.
*/
createSubnetwork?: boolean | null;
/**
* This field is deprecated, use node_ipv4_cidr_block.
*/
nodeIpv4Cidr?: string | null;
/**
* 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](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) 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 | null;
/**
* This field is deprecated, use services_ipv4_cidr_block.
*/
servicesIpv4Cidr?: string | null;
/**
* 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](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) 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 speci