@googleapis/container
Version:
1,193 lines (1,184 loc) • 717 kB
text/typescript
// Copyright 2020 Google LLC
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
/* eslint-disable @typescript-eslint/no-explicit-any */
/* eslint-disable @typescript-eslint/no-unused-vars */
/* eslint-disable @typescript-eslint/no-empty-interface */
/* eslint-disable @typescript-eslint/no-namespace */
/* eslint-disable no-irregular-whitespace */
import {
OAuth2Client,
JWT,
Compute,
UserRefreshClient,
BaseExternalAccountClient,
GaxiosResponseWithHTTP2,
GoogleConfigurable,
createAPIRequest,
MethodOptions,
StreamMethodOptions,
GlobalOptions,
GoogleAuth,
BodyResponseCallback,
APIRequestContext,
} from 'googleapis-common';
import {Readable} from 'stream';
export 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) {
this.context = {
_options: options || {},
google,
};
this.projects = new Resource$Projects(this.context);
}
}
/**
* 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://{$universe.dns_names.final_documentation_domain\}/compute/docs/gpus)
*/
acceleratorType?: string | null;
/**
* The configuration for auto installation of GPU driver.
*/
gpuDriverInstallationConfig?: Schema$GPUDriverInstallationConfig;
/**
* Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning).
*/
gpuPartitionSize?: string | null;
/**
* The configuration for GPU sharing options.
*/
gpuSharingConfig?: Schema$GPUSharingConfig;
/**
* The number of time-shared GPU resources to expose for each physical GPU.
*/
maxTimeSharedClientsPerGpu?: string | null;
}
/**
* AdditionalIPRangesConfig is the configuration for individual additional subnetwork attached to the cluster
*/
export interface Schema$AdditionalIPRangesConfig {
/**
* List of secondary ranges names within this subnetwork that can be used for pod IPs. Example1: gke-pod-range1 Example2: gke-pod-range1,gke-pod-range2
*/
podIpv4RangeNames?: string[] | null;
/**
* Name of the subnetwork. This can be the full path of the subnetwork or just the name. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet
*/
subnetwork?: string | null;
}
/**
* AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message
*/
export interface Schema$AdditionalNodeNetworkConfig {
/**
* Name of the VPC where the additional interface belongs
*/
network?: string | null;
/**
* Name of the subnetwork where the additional interface belongs
*/
subnetwork?: string | null;
}
/**
* AdditionalPodNetworkConfig is the configuration for additional pod networks within the NodeNetworkConfig message
*/
export interface Schema$AdditionalPodNetworkConfig {
/**
* The maximum number of pods per node which use this pod network.
*/
maxPodsPerNode?: Schema$MaxPodsConstraint;
/**
* The name of the network attachment for pods to communicate to; cannot be specified along with subnetwork or secondary_pod_range.
*/
networkAttachment?: string | null;
/**
* The name of the secondary range on the subnet which provides IP address for this pod range.
*/
secondaryPodRange?: string | null;
/**
* Name of the subnetwork where the additional pod network belongs.
*/
subnetwork?: string | null;
}
/**
* AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message.
*/
export interface Schema$AdditionalPodRangesConfig {
/**
* Output only. Information for additional pod range.
*/
podRangeInfo?: Schema$RangeInfo[];
/**
* Name for pod secondary ipv4 range which has the actual range defined ahead.
*/
podRangeNames?: 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 GCP Filestore CSI driver.
*/
gcpFilestoreCsiDriverConfig?: Schema$GcpFilestoreCsiDriverConfig;
/**
* Configuration for the Cloud Storage Fuse CSI driver.
*/
gcsFuseCsiDriverConfig?: Schema$GcsFuseCsiDriverConfig;
/**
* Configuration for the Backup for GKE agent addon.
*/
gkeBackupAgentConfig?: Schema$GkeBackupAgentConfig;
/**
* Configuration for the High Scale Checkpointing add-on.
*/
highScaleCheckpointingConfig?: Schema$HighScaleCheckpointingConfig;
/**
* 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://{$universe.dns_names.final_documentation_domain\}/kubernetes-engine/docs/concepts/dashboards
*/
kubernetesDashboard?: Schema$KubernetesDashboard;
/**
* Configuration for the Lustre CSI driver.
*/
lustreCsiDriverConfig?: Schema$LustreCsiDriverConfig;
/**
* 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 the Cloud Storage Parallelstore CSI driver.
*/
parallelstoreCsiDriverConfig?: Schema$ParallelstoreCsiDriverConfig;
/**
* Optional. Configuration for Ray Operator addon.
*/
rayOperatorConfig?: Schema$RayOperatorConfig;
/**
* Optional. Configuration for the StatefulHA add-on.
*/
statefulHaConfig?: Schema$StatefulHAConfig;
}
/**
* AdvancedDatapathObservabilityConfig specifies configuration of observability features of advanced datapath.
*/
export interface Schema$AdvancedDatapathObservabilityConfig {
/**
* Expose flow metrics on nodes
*/
enableMetrics?: boolean | null;
/**
* Enable Relay component
*/
enableRelay?: boolean | null;
/**
* Method used to make Relay available
*/
relayMode?: string | null;
}
/**
* Specifies options for controlling advanced machine features.
*/
export interface Schema$AdvancedMachineFeatures {
/**
* Whether or not to enable nested virtualization (defaults to false).
*/
enableNestedVirtualization?: boolean | null;
/**
* Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node.
*/
performanceMonitoringUnit?: string | null;
/**
* The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.
*/
threadsPerCore?: string | null;
}
/**
* AnonymousAuthenticationConfig defines the settings needed to limit endpoints that allow anonymous authentication.
*/
export interface Schema$AnonymousAuthenticationConfig {
/**
* Defines the mode of limiting anonymous access in the cluster.
*/
mode?: string | null;
}
/**
* 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;
}
/**
* AutoIpamConfig contains all information related to Auto IPAM
*/
export interface Schema$AutoIpamConfig {
/**
* The flag that enables Auto IPAM on this cluster
*/
enabled?: boolean | null;
}
/**
* AutoMonitoringConfig defines the configuration for GKE Workload Auto-Monitoring.
*/
export interface Schema$AutoMonitoringConfig {
/**
* Scope for GKE Workload Auto-Monitoring.
*/
scope?: string | null;
}
/**
* Autopilot is the configuration for Autopilot settings on the cluster.
*/
export interface Schema$Autopilot {
/**
* Output only. ConversionStatus shows conversion status.
*/
conversionStatus?: Schema$AutopilotConversionStatus;
/**
* Enable Autopilot
*/
enabled?: boolean | null;
/**
* PrivilegedAdmissionConfig is the configuration related to privileged admission control.
*/
privilegedAdmissionConfig?: Schema$PrivilegedAdmissionConfig;
/**
* WorkloadPolicyConfig is the configuration related to GCW workload policy
*/
workloadPolicyConfig?: Schema$WorkloadPolicyConfig;
}
/**
* AutopilotCompatibilityIssue contains information about a specific compatibility issue with Autopilot mode.
*/
export interface Schema$AutopilotCompatibilityIssue {
/**
* The constraint type of the issue.
*/
constraintType?: string | null;
/**
* The description of the issue.
*/
description?: string | null;
/**
* A URL to a public documentation, which addresses resolving this issue.
*/
documentationUrl?: string | null;
/**
* The incompatibility type of this issue.
*/
incompatibilityType?: string | null;
/**
* The last time when this issue was observed.
*/
lastObservation?: string | null;
/**
* The name of the resources which are subject to this issue.
*/
subjects?: string[] | null;
}
/**
* AutopilotConfig contains configuration of autopilot feature for this nodepool.
*/
export interface Schema$AutopilotConfig {
/**
* Denotes that nodes belonging to this node pool are Autopilot nodes.
*/
enabled?: boolean | null;
}
/**
* AutopilotConversionStatus represents conversion status.
*/
export interface Schema$AutopilotConversionStatus {
/**
* Output only. The current state of the conversion.
*/
state?: string | 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://{$universe.dns_names.final_documentation_domain\}/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;
/**
* The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain\}/kubernetes-engine/docs/concepts/node-images for available image types.
*/
imageType?: string | null;
/**
* DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead.
*/
insecureKubeletReadonlyPortEnabled?: boolean | null;
/**
* NodeManagement configuration for this NodePool.
*/
management?: Schema$NodeManagement;
/**
* Deprecated. Minimum CPU platform to be used for NAP created node pools. 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://{$universe.dns_names.final_documentation_domain\}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. 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://{$universe.dns_names.final_documentation_domain\}/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;
}
/**
* Best effort provisioning.
*/
export interface Schema$BestEffortProvisioning {
/**
* When this is enabled, cluster/node pool creations will ignore non-fatal errors like stockout to best provision as many nodes as possible right now and eventually bring up all target number of nodes
*/
enabled?: boolean | null;
/**
* Minimum number of nodes to be provisioned to be considered as succeeded, and the rest of nodes will be provisioned gradually and eventually when stockout issue has been resolved.
*/
minProvisionNodes?: number | 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 {
/**
* This field is deprecated. Leave this unset and instead configure BinaryAuthorization using evaluation_mode. If evaluation_mode is set to anything other than EVALUATION_MODE_UNSPECIFIED, this field is ignored.
*/
enabled?: boolean | null;
/**
* Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED.
*/
evaluationMode?: string | null;
/**
* Optional. Binauthz policies that apply to this cluster.
*/
policyBindings?: Schema$PolicyBinding[];
}
/**
* Information relevant to blue-green upgrade.
*/
export interface Schema$BlueGreenInfo {
/**
* The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool.
*/
blueInstanceGroupUrls?: string[] | null;
/**
* Time to start deleting blue pool to complete blue-green upgrade, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
*/
bluePoolDeletionStartTime?: string | null;
/**
* The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with green pool.
*/
greenInstanceGroupUrls?: string[] | null;
/**
* Version of green pool.
*/
greenPoolVersion?: string | null;
/**
* Current blue-green upgrade phase.
*/
phase?: string | null;
}
/**
* Settings for blue-green upgrade.
*/
export interface Schema$BlueGreenSettings {
/**
* Time needed after draining entire blue pool. After this period, blue pool will be cleaned up.
*/
nodePoolSoakDuration?: string | null;
/**
* Standard policy for the blue-green upgrade.
*/
standardRolloutPolicy?: Schema$StandardRolloutPolicy;
}
/**
* BootDisk specifies the boot disk configuration for nodepools.
*/
export interface Schema$BootDisk {
/**
* Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.)
*/
diskType?: string | null;
/**
* For Hyperdisk-Balanced only, the provisioned IOPS config value.
*/
provisionedIops?: string | null;
/**
* For Hyperdisk-Balanced only, the provisioned throughput config value.
*/
provisionedThroughput?: string | null;
/**
* Disk size in GB. Replaces NodeConfig.disk_size_gb
*/
sizeGb?: string | 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;
/**
* Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field.
*/
operationId?: string | null;
/**
* Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
*/
projectId?: string | null;
/**
* Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.
*/
zone?: string | null;
}
/**
* CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate.
*/
export interface Schema$CertificateAuthorityDomainConfig {
/**
* List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
*/
fqdns?: string[] | null;
/**
* Google Secret Manager (GCP) certificate configuration.
*/
gcpSecretManagerCertificateConfig?: Schema$GCPSecretManagerCertificateConfig;
}
/**
* CheckAutopilotCompatibilityResponse has a list of compatibility issues.
*/
export interface Schema$CheckAutopilotCompatibilityResponse {
/**
* The list of issues for the given operation.
*/
issues?: Schema$AutopilotCompatibilityIssue[];
/**
* The summary of the autopilot compatibility response.
*/
summary?: 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;
/**
* The list of user specified Kubernetes feature gates. Each string represents the activation status of a feature gate (e.g. "featureX=true" or "featureX=false")
*/
alphaClusterFeatureGates?: string[] | null;
/**
* Configuration for limiting anonymous access to all endpoints except the health checks.
*/
anonymousAuthenticationConfig?: Schema$AnonymousAuthenticationConfig;
/**
* 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;
/**
* Enable/Disable Compliance Posture features for the cluster.
*/
compliancePostureConfig?: Schema$CompliancePostureConfig;
/**
* Which conditions caused the current cluster state.
*/
conditions?: Schema$StatusCondition[];
/**
* Configuration of Confidential Nodes. All the nodes in the cluster will be Confidential VM once enabled.
*/
confidentialNodes?: Schema$ConfidentialNodes;
/**
* Configuration for all cluster's control plane endpoints.
*/
controlPlaneEndpointsConfig?: Schema$ControlPlaneEndpointsConfig;
/**
* Configuration for the fine-grained cost management feature.
*/
costManagementConfig?: Schema$CostManagementConfig;
/**
* 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://{$universe.dns_names.final_documentation_domain\}/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 open source beta apis enabled on the cluster. Only beta apis.
*/
enableK8sBetaApis?: Schema$K8sBetaAPIConfig;
/**
* 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. This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25.
*/
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;
/**
* GKE Enterprise Configuration.
*/
enterpriseConfig?: Schema$EnterpriseConfig;
/**
* This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
*/
etag?: 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;
/**
* Fleet information for the cluster.
*/
fleet?: Schema$Fleet;
/**
* Configuration for GKE auto upgrades.
*/
gkeAutoUpgradeConfig?: Schema$GkeAutoUpgradeConfig;
/**
* Output only. Unique id for the cluster.
*/
id?: string | null;
/**
* Configuration for Identity Service component.
*/
identityServiceConfig?: Schema$IdentityServiceConfig;
/**
* 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://{$universe.dns_names.final_documentation_domain\}/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;
/**
* Output only. 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://{$universe.dns_names.final_documentation_domain\}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
*/
location?: string | null;
/**
* The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain\}/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://{$universe.dns_names.final_documentation_domain\}/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;
/**
* Logging configuration for the cluster.
*/
loggingConfig?: Schema$LoggingConfig;
/**
* 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. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead.
*/
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;
/**
* Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
*/
meshCertificates?: Schema$MeshCertificates;
/**
* Monitoring configuration for the cluster.
*/
monitoringConfig?: Schema$MonitoringConfig;
/**
* 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://{$universe.dns_names.final_documentation_domain\}/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;
/**
* Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
*/
nodePoolAutoConfig?: Schema$NodePoolAutoConfig;
/**
* Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.
*/
nodePoolDefaults?: Schema$NodePoolDefaults;
/**
* 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;
/**
* The configuration of the parent product of the cluster. This field is used by Google internal products that are built on top of the GKE cluster and take the ownership of the cluster.
*/
parentProductConfig?: Schema$ParentProductConfig;
/**
* The config for pod autoscaling.
*/
podAutoscaling?: Schema$PodAutoscaling;
/**
* 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;
/**
* Deprecated: Use SecurityPostureConfig instead. Enable/Disable Protect API features for the cluster.
*/
protectConfig?: Schema$ProtectConfig;
/**
* RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created.
*/
rbacBindingConfig?: Schema$RBACBindingConfig;
/**
* Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version.
*/
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. Reserved for future use.
*/
satisfiesPzi?: boolean | null;
/**
* Output only. Reserved for future use.
*/
satisfiesPzs?: boolean | null;
/**
* Secret CSI driver configuration.
*/
secretManagerConfig?: Schema$SecretManagerConfig;
/**
* Enable/Disable Security Posture API features for the cluster.
*/
securityPostureConfig?: Schema$SecurityPostureConfig;
/**
* 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://{$universe.dns_names.final_documentation_domain\}/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; This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25.
*/
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`). This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25.
*/
tpuIpv4CidrBlock?: string | null;
/**
* The Custom keys configuration for the cluster.
*/
userManagedKeysConfig?: Schema$UserManagedKeysConfig;
/**
* Cluster-level Vertical Pod Autoscaling configuration.
*/
verticalPodAutoscaling?: Schema$VerticalPodAutoscaling;
/**
* Configuration for direct-path (via ALTS) with workload identity. This feature is not officially supported for external customers in Kubernetes Engine when using Workload Identity.
*/
workloadAltsConfig?: Schema$WorkloadALTSConfig;
/**
* Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
*/
workloadCertificates?: Schema$WorkloadCertificates;
/**
* 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://{$universe.dns_names.final_documentation_domain\}/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://{$universe.dns_names.final_documentation_domain\}/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;
/**
* Default compute class is a configuration for default compute class.
*/
defaultComputeClassConfig?: Schema$DefaultComputeClassConfig;
/**
* 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[];
}
/**
* Configuration of all network bandwidth tiers
*/
export interface Schema$ClusterNetworkPerformanceConfig {
/**
* Specifies the total network bandwidth tier for the NodePool.
*/
totalEgressBandwidthTier?: string | null;
}
/**
* 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 {
/**
* The additional pod ranges to be added to the cluster. These pod ranges can be used by node pools to allocate pod IPs.
*/
additionalPodRangesConfig?: Schema$AdditionalPodRangesConfig;
/**
* The desired config for additional subnetworks attached to the cluster.
*/
desiredAdditionalIpRangesConfig?: Schema$DesiredAdditionalIPRangesConfig;
/**
* Configurations for the various addons available to run in the cluster.
*/
desiredAddonsConfig?: Schema$AddonsConfig;
/**
* Configuration for limiting anonymous access to all endpoints except the health checks.
*/
desiredAnonymousAuthenticationConfig?: Schema$AnonymousAuthenticationConfig;
/**
* AuthenticatorGroupsConfig specifies the config for the cluster security groups settings.
*/
desiredAuthenticatorGroupsConfig?: Schema$AuthenticatorGroupsConfig;
/**
* AutoIpamConfig contains all information related to Auto IPAM
*/
desiredAutoIpamConfig?: Schema$AutoIpamConfig;
/**
* WorkloadPolicyConfig is the configuration related to GCW workload policy
*/
desiredAutopilotWorkloadPolicyConfig?: Schema$WorkloadPolicyConfig;
/**
* 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;
/**
* Enable/Disable Compliance Posture features for the cluster.
*/
desiredCompliancePostureConfig?: Schema$CompliancePostureConfig;
/**
* The desired containerd config for the cluster.
*/
desiredContainerdConfig?: Schema$ContainerdConfig;
/**
* Control plane endpoints configuration.
*/
desiredControlPlaneEndpointsConfig?: Schema$ControlPlaneEndpointsConfig;
/**
* The desired configuration for the fine-grained cost management feature.
*/
desiredCostManagementConfig?: Schema$CostManagementConfig;
/**
* Configuration of etcd encryption.
*/
desiredDatabaseEncryption?: Schema$DatabaseEncryption;
/**
* The desired datapath provider for the cluster.
*/
desiredDatapathProvider?: string | null;
/**
* Override the default setting of whether future created nodes have private IP addresses only, namely NetworkConfig.default_enable_private_nodes
*/
desiredDefaultEnablePrivateNodes?: boolean | null;
/**
* The desired status of whether to disable default sNAT for this cluster.
*/
desiredDefaultSnatStatus?: Schema$DefaultSnatStatus;
/**
* Enable/Disable L4 LB VPC firewall reconciliation for the cluster.
*/
desiredDisableL4LbFirewallReconciliation?: boolean | null;
/**
* DNSConfig contains clusterDNS config for this cluster.
*/
desiredDnsConfig?: Schema$DNSConfig;
/**
* Enable/Disable Cilium Clusterwide Network Policy for the cluster.
*/
desiredEnableCiliumClusterwideNetworkPolicy?: boolean | null;
/**
* Enable/Disable FQDN Network Policy for the cluster.
*/
desiredEnableFqdnNetworkPolicy?: boolean | null;
/**
* Enable/Disable Multi-Networking for the cluster
*/
desiredEnableMultiNetworking?: boolean | null;
/**
* Enable/Disable private endpoint for the cluster's master. Deprecated: Use desired_control_plane_endpoints_config.ip_endpoints_config.enable_public_endpoint instead. Note that the value of enable_public_endpoint is reversed: if enable_private_endpoint is false, then enable_public_endpoint will be true.
*/
desiredEna