Definitions for @turbot/gcp-kubernetesengine

AcceleratorConfig

{
"description": "AcceleratorConfig represents a Hardware Accelerator request.",
"properties": {
"acceleratorCount": {
"description": "The number of the accelerator cards exposed to an instance.",
"type": "string"
},
"acceleratorType": {
"description": "The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)",
"type": "string"
},
"gpuDriverInstallationConfig": {
"$ref": "#/definitions/GPUDriverInstallationConfig",
"description": "The configuration for auto installation of GPU driver."
},
"gpuPartitionSize": {
"description": "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).",
"type": "string"
},
"gpuSharingConfig": {
"$ref": "#/definitions/GPUSharingConfig",
"description": "The configuration for GPU sharing options."
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/AcceleratorConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

AdditionalNodeNetworkConfig

{
"description": "AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message",
"properties": {
"network": {
"description": "Name of the VPC where the additional interface belongs",
"type": "string"
},
"subnetwork": {
"description": "Name of the subnetwork where the additional interface belongs",
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/AdditionalNodeNetworkConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

AdditionalPodNetworkConfig

{
"description": "AdditionalPodNetworkConfig is the configuration for additional pod networks within the NodeNetworkConfig message",
"properties": {
"maxPodsPerNode": {
"$ref": "#/definitions/MaxPodsConstraint",
"description": "The maximum number of pods per node which use this pod network"
},
"secondaryPodRange": {
"description": "The name of the secondary range on the subnet which provides IP address for this pod range",
"type": "string"
},
"subnetwork": {
"description": "Name of the subnetwork where the additional pod network belongs",
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/AdditionalPodNetworkConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

AdditionalPodRangesConfig

{
"description": "AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message.",
"properties": {
"podRangeInfo": {
"description": "Output only. [Output only] Information for additional pod range.",
"items": {
"$ref": "#/definitions/RangeInfo"
},
"readOnly": true,
"type": "array"
},
"podRangeNames": {
"description": "Name for pod secondary ipv4 range which has the actual range defined ahead.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/AdditionalPodRangesConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

addonsConfig

{
"type": "object",
"properties": {
"kubernetesDashboard": {
"$ref": "#/definitions/kubernetesDashboard"
}
},
"tests": [
{
"input": {
"kubernetesDashboard": {
"disabled": true
}
}
},
{
"input": {
"kubernetesDashboard": {}
}
}
],
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/addonsConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

AddonsConfig

{
"description": "Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality.",
"properties": {
"cloudRunConfig": {
"$ref": "#/definitions/CloudRunConfig",
"description": "Configuration for the Cloud Run addon, which allows the user to use a managed Knative service."
},
"configConnectorConfig": {
"$ref": "#/definitions/ConfigConnectorConfig",
"description": "Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API"
},
"dnsCacheConfig": {
"$ref": "#/definitions/DnsCacheConfig",
"description": "Configuration for NodeLocalDNS, a dns cache running on cluster nodes"
},
"gcePersistentDiskCsiDriverConfig": {
"$ref": "#/definitions/GcePersistentDiskCsiDriverConfig",
"description": "Configuration for the Compute Engine Persistent Disk CSI driver."
},
"gcpFilestoreCsiDriverConfig": {
"$ref": "#/definitions/GcpFilestoreCsiDriverConfig",
"description": "Configuration for the GCP Filestore CSI driver."
},
"gcsFuseCsiDriverConfig": {
"$ref": "#/definitions/GcsFuseCsiDriverConfig",
"description": "Configuration for the Cloud Storage Fuse CSI driver."
},
"gkeBackupAgentConfig": {
"$ref": "#/definitions/GkeBackupAgentConfig",
"description": "Configuration for the Backup for GKE agent addon."
},
"horizontalPodAutoscaling": {
"$ref": "#/definitions/HorizontalPodAutoscaling",
"description": "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."
},
"httpLoadBalancing": {
"$ref": "#/definitions/HttpLoadBalancing",
"description": "Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster."
},
"kubernetesDashboard": {
"$ref": "#/definitions/KubernetesDashboard",
"deprecated": true,
"description": "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"
},
"networkPolicyConfig": {
"$ref": "#/definitions/NetworkPolicyConfig",
"description": "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."
},
"statefulHaConfig": {
"$ref": "#/definitions/StatefulHAConfig",
"description": "Optional. Configuration for the StatefulHA add-on."
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/AddonsConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

AdvancedDatapathObservabilityConfig

{
"description": "AdvancedDatapathObservabilityConfig specifies configuration of observability features of advanced datapath.",
"properties": {
"enableMetrics": {
"description": "Expose flow metrics on nodes",
"type": "boolean"
},
"enableRelay": {
"description": "Enable Relay component",
"type": "boolean"
},
"relayMode": {
"description": "Method used to make Relay available",
"enum": [
"RELAY_MODE_UNSPECIFIED",
"DISABLED",
"INTERNAL_VPC_LB",
"EXTERNAL_LB"
],
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/AdvancedDatapathObservabilityConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

AdvancedMachineFeatures

{
"description": "Specifies options for controlling advanced machine features.",
"properties": {
"threadsPerCore": {
"description": "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.",
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/AdvancedMachineFeatures",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

AuthenticatorGroupsConfig

{
"description": "Configuration for returning group information from authenticators.",
"properties": {
"enabled": {
"description": "Whether this cluster should return group membership lookups during authentication using a group of security groups.",
"type": "boolean"
},
"securityGroup": {
"description": "The name of the security group-of-groups to be used. Only relevant if enabled = true.",
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/AuthenticatorGroupsConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

Autopilot

{
"description": "Autopilot is the configuration for Autopilot settings on the cluster.",
"properties": {
"enabled": {
"description": "Enable Autopilot",
"type": "boolean"
},
"workloadPolicyConfig": {
"$ref": "#/definitions/WorkloadPolicyConfig",
"description": "Workload policy configuration for Autopilot."
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/Autopilot",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

AutoprovisioningNodePoolDefaults

{
"description": "AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.",
"properties": {
"bootDiskKmsKey": {
"description": "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",
"type": "string"
},
"diskSizeGb": {
"description": "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.",
"type": "integer"
},
"diskType": {
"description": "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'",
"type": "string"
},
"imageType": {
"description": "The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.",
"type": "string"
},
"insecureKubeletReadonlyPortEnabled": {
"description": "Enable or disable Kubelet read only port.",
"type": "boolean"
},
"management": {
"$ref": "#/definitions/NodeManagement",
"description": "Specifies the node management options for NAP created node-pools."
},
"minCpuPlatform": {
"deprecated": true,
"description": "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://cloud.google.com/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.",
"type": "string"
},
"oauthScopes": {
"description": "Scopes that are used by NAP when creating node pools.",
"items": {
"type": "string"
},
"type": "array"
},
"serviceAccount": {
"description": "The Google Cloud Platform Service Account to be used by the node VMs.",
"type": "string"
},
"shieldedInstanceConfig": {
"$ref": "#/definitions/ShieldedInstanceConfig",
"description": "Shielded Instance options."
},
"upgradeSettings": {
"$ref": "#/definitions/UpgradeSettings",
"description": "Specifies the upgrade settings for NAP created node pools"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/AutoprovisioningNodePoolDefaults",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

AutoUpgradeOptions

{
"description": "AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed.",
"properties": {
"autoUpgradeStartTime": {
"description": "[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.",
"type": "string"
},
"description": {
"description": "[Output only] This field is set when upgrades are about to commence with the description of the upgrade.",
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/AutoUpgradeOptions",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

BestEffortProvisioning

{
"description": "Best effort provisioning.",
"properties": {
"enabled": {
"description": "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",
"type": "boolean"
},
"minProvisionNodes": {
"description": "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.",
"type": "integer"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/BestEffortProvisioning",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

BigQueryDestination

{
"description": "Parameters for using BigQuery as the destination of resource usage export.",
"properties": {
"datasetId": {
"description": "The ID of a BigQuery Dataset.",
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/BigQueryDestination",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

BinaryAuthorization

{
"description": "Configuration for Binary Authorization.",
"properties": {
"enabled": {
"deprecated": true,
"description": "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.",
"type": "boolean"
},
"evaluationMode": {
"description": "Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED.",
"enum": [
"EVALUATION_MODE_UNSPECIFIED",
"DISABLED",
"PROJECT_SINGLETON_POLICY_ENFORCE"
],
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/BinaryAuthorization",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

BlueGreenInfo

{
"description": "Information relevant to blue-green upgrade.",
"properties": {
"blueInstanceGroupUrls": {
"description": "The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool.",
"items": {
"type": "string"
},
"type": "array"
},
"bluePoolDeletionStartTime": {
"description": "Time to start deleting blue pool to complete blue-green upgrade, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
"type": "string"
},
"greenInstanceGroupUrls": {
"description": "The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with green pool.",
"items": {
"type": "string"
},
"type": "array"
},
"greenPoolVersion": {
"description": "Version of green pool.",
"type": "string"
},
"phase": {
"description": "Current blue-green upgrade phase.",
"enum": [
"PHASE_UNSPECIFIED",
"UPDATE_STARTED",
"CREATING_GREEN_POOL",
"CORDONING_BLUE_POOL",
"DRAINING_BLUE_POOL",
"NODE_POOL_SOAKING",
"DELETING_BLUE_POOL",
"ROLLBACK_STARTED"
],
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/BlueGreenInfo",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

BlueGreenSettings

{
"description": "Settings for blue-green upgrade.",
"properties": {
"nodePoolSoakDuration": {
"description": "Time needed after draining entire blue pool. After this period, blue pool will be cleaned up.",
"type": "string"
},
"standardRolloutPolicy": {
"$ref": "#/definitions/StandardRolloutPolicy",
"description": "Standard policy for the blue-green upgrade."
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/BlueGreenSettings",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

CidrBlock

{
"description": "CidrBlock contains an optional name and one CIDR block.",
"properties": {
"cidrBlock": {
"description": "cidr_block must be specified in CIDR notation.",
"type": "string"
},
"displayName": {
"description": "display_name is an optional field for users to identify CIDR blocks.",
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/CidrBlock",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

ClientCertificateConfig

{
"description": "Configuration for client certificates on the cluster.",
"properties": {
"issueClientCertificate": {
"description": "Issue a client certificate.",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/ClientCertificateConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

CloudRunConfig

{
"description": "Configuration options for the Cloud Run feature.",
"properties": {
"disabled": {
"description": "Whether Cloud Run addon is enabled for this cluster.",
"type": "boolean"
},
"loadBalancerType": {
"description": "Which load balancer type is installed for Cloud Run.",
"enum": [
"LOAD_BALANCER_TYPE_UNSPECIFIED",
"LOAD_BALANCER_TYPE_EXTERNAL",
"LOAD_BALANCER_TYPE_INTERNAL"
],
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/CloudRunConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

Cluster

{
"description": "A Google Kubernetes Engine cluster.",
"properties": {
"addonsConfig": {
"$ref": "#/definitions/AddonsConfig",
"description": "Configurations for the various addons available to run in the cluster."
},
"authenticatorGroupsConfig": {
"$ref": "#/definitions/AuthenticatorGroupsConfig",
"description": "Configuration controlling RBAC group membership information."
},
"autopilot": {
"$ref": "#/definitions/Autopilot",
"description": "Autopilot configuration for the cluster."
},
"autoscaling": {
"$ref": "#/definitions/ClusterAutoscaling",
"description": "Cluster-level autoscaling configuration."
},
"binaryAuthorization": {
"$ref": "#/definitions/BinaryAuthorization",
"description": "Configuration for Binary Authorization."
},
"clusterIpv4Cidr": {
"description": "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`.",
"type": "string"
},
"conditions": {
"description": "Which conditions caused the current cluster state.",
"items": {
"$ref": "#/definitions/StatusCondition"
},
"type": "array"
},
"confidentialNodes": {
"$ref": "#/definitions/ConfidentialNodes",
"description": "Configuration of Confidential Nodes. All the nodes in the cluster will be Confidential VM once enabled."
},
"costManagementConfig": {
"$ref": "#/definitions/CostManagementConfig",
"description": "Configuration for the fine-grained cost management feature."
},
"createTime": {
"description": "[Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
"type": "string"
},
"currentMasterVersion": {
"description": "[Output only] The current software version of the master endpoint.",
"type": "string"
},
"currentNodeCount": {
"deprecated": true,
"description": "[Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.",
"type": "integer"
},
"currentNodeVersion": {
"deprecated": true,
"description": "[Output only] Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/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.",
"type": "string"
},
"databaseEncryption": {
"$ref": "#/definitions/DatabaseEncryption",
"description": "Configuration of etcd encryption."
},
"defaultMaxPodsConstraint": {
"$ref": "#/definitions/MaxPodsConstraint",
"description": "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."
},
"description": {
"description": "An optional description of this cluster.",
"type": "string"
},
"enableK8sBetaApis": {
"$ref": "#/definitions/K8sBetaAPIConfig",
"description": "Beta APIs Config"
},
"enableKubernetesAlpha": {
"description": "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.",
"type": "boolean"
},
"enableTpu": {
"description": "Enable the ability to use Cloud TPUs in this cluster.",
"type": "boolean"
},
"endpoint": {
"description": "[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.",
"type": "string"
},
"enterpriseConfig": {
"$ref": "#/definitions/EnterpriseConfig",
"description": "GKE Enterprise Configuration."
},
"etag": {
"description": "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.",
"type": "string"
},
"expireTime": {
"description": "[Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
"type": "string"
},
"fleet": {
"$ref": "#/definitions/Fleet",
"description": "Fleet information for the cluster."
},
"id": {
"description": "Output only. Unique id for the cluster.",
"readOnly": true,
"type": "string"
},
"identityServiceConfig": {
"$ref": "#/definitions/IdentityServiceConfig",
"description": "Configuration for Identity Service component."
},
"initialClusterVersion": {
"description": "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",
"type": "string"
},
"initialNodeCount": {
"deprecated": true,
"description": "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.",
"type": "integer"
},
"instanceGroupUrls": {
"deprecated": true,
"description": "Deprecated. Use node_pools.instance_group_urls.",
"items": {
"type": "string"
},
"type": "array"
},
"ipAllocationPolicy": {
"$ref": "#/definitions/IPAllocationPolicy",
"description": "Configuration for cluster IP allocation."
},
"labelFingerprint": {
"description": "The fingerprint of the set of labels for this cluster.",
"type": "string"
},
"legacyAbac": {
"$ref": "#/definitions/LegacyAbac",
"description": "Configuration for the legacy ABAC authorization mode."
},
"location": {
"description": "[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.",
"type": "string"
},
"locations": {
"description": "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.",
"items": {
"type": "string"
},
"type": "array"
},
"loggingConfig": {
"$ref": "#/definitions/LoggingConfig",
"description": "Logging configuration for the cluster."
},
"loggingService": {
"description": "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.",
"type": "string"
},
"maintenancePolicy": {
"$ref": "#/definitions/MaintenancePolicy",
"description": "Configure the maintenance policy for this cluster."
},
"masterAuth": {
"$ref": "#/definitions/MasterAuth",
"description": "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."
},
"masterAuthorizedNetworksConfig": {
"$ref": "#/definitions/MasterAuthorizedNetworksConfig",
"description": "The configuration options for master authorized networks feature."
},
"meshCertificates": {
"$ref": "#/definitions/MeshCertificates",
"description": "Configuration for issuance of mTLS keys and certificates to Kubernetes pods."
},
"monitoringConfig": {
"$ref": "#/definitions/MonitoringConfig",
"description": "Monitoring configuration for the cluster."
},
"monitoringService": {
"description": "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.",
"type": "string"
},
"name": {
"description": "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.",
"type": "string"
},
"network": {
"description": "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.",
"type": "string"
},
"networkConfig": {
"$ref": "#/definitions/NetworkConfig",
"description": "Configuration for cluster networking."
},
"networkPolicy": {
"$ref": "#/definitions/NetworkPolicy",
"description": "Configuration options for the NetworkPolicy feature."
},
"nodeConfig": {
"$ref": "#/definitions/NodeConfig",
"deprecated": true,
"description": "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."
},
"nodeIpv4CidrSize": {
"description": "[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.",
"type": "integer"
},
"nodePoolAutoConfig": {
"$ref": "#/definitions/NodePoolAutoConfig",
"description": "Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters."
},
"nodePoolDefaults": {
"$ref": "#/definitions/NodePoolDefaults",
"description": "Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object."
},
"nodePools": {
"description": "The node pools associated with this cluster. This field should not be set if \"node_config\" or \"initial_node_count\" are specified.",
"items": {
"$ref": "#/definitions/NodePool"
},
"type": "array"
},
"notificationConfig": {
"$ref": "#/definitions/NotificationConfig",
"description": "Notification configuration of the cluster."
},
"parentProductConfig": {
"$ref": "#/definitions/ParentProductConfig",
"description": "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."
},
"privateClusterConfig": {
"$ref": "#/definitions/PrivateClusterConfig",
"description": "Configuration for private cluster."
},
"releaseChannel": {
"$ref": "#/definitions/ReleaseChannel",
"description": "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."
},
"resourceLabels": {
"additionalProperties": {
"type": "string"
},
"description": "The resource labels for the cluster to use to annotate any related Google Compute Engine resources.",
"type": "object"
},
"resourceUsageExportConfig": {
"$ref": "#/definitions/ResourceUsageExportConfig",
"description": "Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified."
},
"securityPostureConfig": {
"$ref": "#/definitions/SecurityPostureConfig",
"description": "Enable/Disable Security Posture API features for the cluster."
},
"selfLink": {
"description": "[Output only] Server-defined URL for the resource.",
"type": "string"
},
"servicesIpv4Cidr": {
"description": "[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.",
"type": "string"
},
"shieldedNodes": {
"$ref": "#/definitions/ShieldedNodes",
"description": "Shielded Nodes configuration."
},
"status": {
"description": "[Output only] The current status of this cluster.",
"enum": [
"STATUS_UNSPECIFIED",
"PROVISIONING",
"RUNNING",
"RECONCILING",
"STOPPING",
"ERROR",
"DEGRADED"
],
"type": "string"
},
"statusMessage": {
"deprecated": true,
"description": "[Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.",
"type": "string"
},
"subnetwork": {
"description": "The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected.",
"type": "string"
},
"tpuIpv4CidrBlock": {
"description": "[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`).",
"type": "string"
},
"verticalPodAutoscaling": {
"$ref": "#/definitions/VerticalPodAutoscaling",
"description": "Cluster-level Vertical Pod Autoscaling configuration."
},
"workloadIdentityConfig": {
"$ref": "#/definitions/WorkloadIdentityConfig",
"description": "Configuration for the use of Kubernetes Service Accounts in GCP IAM policies."
},
"zone": {
"deprecated": true,
"description": "[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.",
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/Cluster",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

ClusterAutoscaling

{
"description": "ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs.",
"properties": {
"autoprovisioningLocations": {
"description": "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.",
"items": {
"type": "string"
},
"type": "array"
},
"autoprovisioningNodePoolDefaults": {
"$ref": "#/definitions/AutoprovisioningNodePoolDefaults",
"description": "AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP."
},
"autoscalingProfile": {
"description": "Defines autoscaling behaviour.",
"enum": [
"PROFILE_UNSPECIFIED",
"OPTIMIZE_UTILIZATION",
"BALANCED"
],
"type": "string"
},
"enableNodeAutoprovisioning": {
"description": "Enables automatic node pool creation and deletion.",
"type": "boolean"
},
"resourceLimits": {
"description": "Contains global constraints regarding minimum and maximum amount of resources in the cluster.",
"items": {
"$ref": "#/definitions/ResourceLimit"
},
"type": "array"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/ClusterAutoscaling",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

clusterLegacyAbac

{
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/clusterLegacyAbac",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

clusterLoggingService

{
"type": "string",
"tests": [
{
"input": "google.loggingservice.com"
},
{
"description": "invalid - array passed instead of string",
"input": [
"test.com"
],
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/clusterLoggingService",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

clusterMonitoringService

{
"type": "string",
"tests": [
{
"input": "monitoring.googleapis.com"
},
{
"description": "invalid - array passed instead of string",
"input": [
"test.com"
],
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/clusterMonitoringService",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

clusterName

{
"type": "string",
"pattern": "^[a-z0-9-]{1,40}$",
"tests": [
{
"description": "valid case",
"input": "test"
},
{
"description": "invalid - cannot end with a hyphen",
"input": "testName01-",
"expected": false
},
{
"description": "invalid - too long",
"input": "test555testtstststststsststest555testtstststststsststest555testtstststststsststest555testtstststststsststest555testtstststststssts",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/clusterName",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

ClusterNetworkPerformanceConfig

{
"description": "Configuration of network bandwidth tiers",
"properties": {
"totalEgressBandwidthTier": {
"description": "Specifies the total network bandwidth tier for NodePools in the cluster.",
"enum": [
"TIER_UNSPECIFIED",
"TIER_1"
],
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/ClusterNetworkPerformanceConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

ConfidentialNodes

{
"description": "ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs.",
"properties": {
"enabled": {
"description": "Whether Confidential Nodes feature is enabled.",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/ConfidentialNodes",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

ConfigConnectorConfig

{
"description": "Configuration options for the Config Connector add-on.",
"properties": {
"enabled": {
"description": "Whether Cloud Connector is enabled for this cluster.",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/ConfigConnectorConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

ConsumptionMeteringConfig

{
"description": "Parameters for controlling consumption metering.",
"properties": {
"enabled": {
"description": "Whether to enable consumption metering for this cluster. If enabled, a second BigQuery table will be created to hold resource consumption records.",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/ConsumptionMeteringConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

CostManagementConfig

{
"description": "Configuration for fine-grained cost management feature.",
"properties": {
"enabled": {
"description": "Whether the feature is enabled or not.",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/CostManagementConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

DailyMaintenanceWindow

{
"description": "Time window specified for daily maintenance operations.",
"properties": {
"duration": {
"description": "[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format \"PTnHnMnS\".",
"type": "string"
},
"startTime": {
"description": "Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format \"HH:MM\", where HH : [00-23] and MM : [00-59] GMT.",
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/DailyMaintenanceWindow",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

databaseEncryption

{
"type": "object",
"properties": {
"keyName": {
"$ref": "#/definitions/keyName"
},
"state": {
"$ref": "#/definitions/databaseEncryptionState"
},
"sha256": {
"$ref": "#/definitions/keyName"
}
},
"tests": [
{
"description": "valid input - all details provided",
"input": {
"keyName": "projects/cse-legolas/locations/global/keyRings/test/cryptoKeys/disk/cryptoKeyVersions/1",
"state": "ENCRYPTED"
}
}
],
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/databaseEncryption",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

DatabaseEncryption

{
"description": "Configuration of etcd encryption.",
"properties": {
"keyName": {
"description": "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",
"type": "string"
},
"state": {
"description": "The desired state of etcd encryption.",
"enum": [
"UNKNOWN",
"ENCRYPTED",
"DECRYPTED"
],
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/DatabaseEncryption",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

databaseEncryptionState

{
"type": "string",
"enum": [
"UNKNOWN",
"ENCRYPTED",
"DECRYPTED"
],
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/databaseEncryptionState",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

DefaultSnatStatus

{
"description": "DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster.",
"properties": {
"disabled": {
"description": "Disables cluster default sNAT rules.",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/DefaultSnatStatus",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

DnsCacheConfig

{
"description": "Configuration for NodeLocal DNSCache",
"properties": {
"enabled": {
"description": "Whether NodeLocal DNSCache is enabled for this cluster.",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/DnsCacheConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

DNSConfig

{
"description": "DNSConfig contains the desired set of options for configuring clusterDNS.",
"properties": {
"clusterDns": {
"description": "cluster_dns indicates which in-cluster DNS provider should be used.",
"enum": [
"PROVIDER_UNSPECIFIED",
"PLATFORM_DEFAULT",
"CLOUD_DNS",
"KUBE_DNS"
],
"type": "string"
},
"clusterDnsDomain": {
"description": "cluster_dns_domain is the suffix used for all cluster service records.",
"type": "string"
},
"clusterDnsScope": {
"description": "cluster_dns_scope indicates the scope of access to cluster DNS records.",
"enum": [
"DNS_SCOPE_UNSPECIFIED",
"CLUSTER_SCOPE",
"VPC_SCOPE"
],
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/DNSConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

EnterpriseConfig

{
"description": "EnterpriseConfig is the cluster enterprise configuration.",
"properties": {
"clusterTier": {
"description": "Output only. [Output only] cluster_tier specifies the premium tier of the cluster.",
"enum": [
"CLUSTER_TIER_UNSPECIFIED",
"STANDARD",
"ENTERPRISE"
],
"readOnly": true,
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/EnterpriseConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

EphemeralStorageLocalSsdConfig

{
"description": "EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs.",
"properties": {
"localSsdCount": {
"description": "Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.",
"type": "integer"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/EphemeralStorageLocalSsdConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

FastSocket

{
"description": "Configuration of Fast Socket feature.",
"properties": {
"enabled": {
"description": "Whether Fast Socket features are enabled in the node pool.",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/FastSocket",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

Filter

{
"description": "Allows filtering to one or more specific event types. If event types are present, those and only those event types will be transmitted to the cluster. Other types will be skipped. If no filter is specified, or no event types are present, all event types will be sent",
"properties": {
"eventType": {
"description": "Event types to allowlist.",
"items": {
"enum": [
"EVENT_TYPE_UNSPECIFIED",
"UPGRADE_AVAILABLE_EVENT",
"UPGRADE_EVENT",
"SECURITY_BULLETIN_EVENT"
],
"type": "string"
},
"type": "array"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/Filter",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

Fleet

{
"description": "Fleet is the fleet configuration for the cluster.",
"properties": {
"membership": {
"description": "[Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`.",
"type": "string"
},
"preRegistered": {
"description": "[Output only] Whether the cluster has been registered through the fleet API.",
"type": "boolean"
},
"project": {
"description": "The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered.",
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/Fleet",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

GatewayAPIConfig

{
"description": "GatewayAPIConfig contains the desired config of Gateway API on this cluster.",
"properties": {
"channel": {
"description": "The Gateway API release channel to use for Gateway API.",
"enum": [
"CHANNEL_UNSPECIFIED",
"CHANNEL_DISABLED",
"CHANNEL_EXPERIMENTAL",
"CHANNEL_STANDARD"
],
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/GatewayAPIConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

GcePersistentDiskCsiDriverConfig

{
"description": "Configuration for the Compute Engine PD CSI driver.",
"properties": {
"enabled": {
"description": "Whether the Compute Engine PD CSI driver is enabled for this cluster.",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/GcePersistentDiskCsiDriverConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

GcfsConfig

{
"description": "GcfsConfig contains configurations of Google Container File System (image streaming).",
"properties": {
"enabled": {
"description": "Whether to use GCFS.",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/GcfsConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

GcpFilestoreCsiDriverConfig

{
"description": "Configuration for the GCP Filestore CSI driver.",
"properties": {
"enabled": {
"description": "Whether the GCP Filestore CSI driver is enabled for this cluster.",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/GcpFilestoreCsiDriverConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

GcsFuseCsiDriverConfig

{
"description": "Configuration for the Cloud Storage Fuse CSI driver.",
"properties": {
"enabled": {
"description": "Whether the Cloud Storage Fuse CSI driver is enabled for this cluster.",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/GcsFuseCsiDriverConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

GkeBackupAgentConfig

{
"description": "Configuration for the Backup for GKE Agent.",
"properties": {
"enabled": {
"description": "Whether the Backup for GKE agent is enabled for this cluster.",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/GkeBackupAgentConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

GPUDriverInstallationConfig

{
"description": "GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed.",
"properties": {
"gpuDriverVersion": {
"description": "Mode for how the GPU driver is installed.",
"enum": [
"GPU_DRIVER_VERSION_UNSPECIFIED",
"INSTALLATION_DISABLED",
"DEFAULT",
"LATEST"
],
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/GPUDriverInstallationConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

GPUSharingConfig

{
"description": "GPUSharingConfig represents the GPU sharing configuration for Hardware Accelerators.",
"properties": {
"gpuSharingStrategy": {
"description": "The type of GPU sharing strategy to enable on the GPU node.",
"enum": [
"GPU_SHARING_STRATEGY_UNSPECIFIED",
"TIME_SHARING"
],
"type": "string"
},
"maxSharedClientsPerGpu": {
"description": "The max number of containers that can share a physical GPU.",
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/GPUSharingConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

HorizontalPodAutoscaling

{
"description": "Configuration options for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.",
"properties": {
"disabled": {
"description": "Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that metrics are collected into Stackdriver Monitoring.",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/HorizontalPodAutoscaling",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

HttpLoadBalancing

{
"description": "Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.",
"properties": {
"disabled": {
"description": "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.",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/HttpLoadBalancing",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

IdentityServiceConfig

{
"description": "IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API",
"properties": {
"enabled": {
"description": "Whether to enable the Identity Service component",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/IdentityServiceConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

ipAllocationPolicy

{
"type": "object",
"properties": {
"useIpAliases": {
"type": "boolean"
}
},
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/ipAllocationPolicy",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

IPAllocationPolicy

{
"description": "Configuration for controlling how IPs are allocated in the cluster.",
"properties": {
"additionalPodRangesConfig": {
"$ref": "#/definitions/AdditionalPodRangesConfig",
"description": "Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy.",
"readOnly": true
},
"clusterIpv4Cidr": {
"deprecated": true,
"description": "This field is deprecated, use cluster_ipv4_cidr_block.",
"type": "string"
},
"clusterIpv4CidrBlock": {
"description": "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.",
"type": "string"
},
"clusterSecondaryRangeName": {
"description": "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.",
"type": "string"
},
"createSubnetwork": {
"description": "Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true.",
"type": "boolean"
},
"defaultPodIpv4RangeUtilization": {
"description": "Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.",
"readOnly": true,
"type": "number"
},
"ipv6AccessType": {
"description": "The ipv6 access type (internal or external) when create_subnetwork is true",
"enum": [
"IPV6_ACCESS_TYPE_UNSPECIFIED",
"INTERNAL",
"EXTERNAL"
],
"type": "string"
},
"nodeIpv4Cidr": {
"deprecated": true,
"description": "This field is deprecated, use node_ipv4_cidr_block.",
"type": "string"
},
"nodeIpv4CidrBlock": {
"description": "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.",
"type": "string"
},
"podCidrOverprovisionConfig": {
"$ref": "#/definitions/PodCIDROverprovisionConfig",
"description": "[PRIVATE FIELD] Pod CIDR size overprovisioning config for the cluster. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is doubled and then rounded off to next power of 2 to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled."
},
"servicesIpv4Cidr": {
"deprecated": true,
"description": "This field is deprecated, use services_ipv4_cidr_block.",
"type": "string"
},
"servicesIpv4CidrBlock": {
"description": "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 specific range to use.",
"type": "string"
},
"servicesIpv6CidrBlock": {
"description": "Output only. [Output only] The services IPv6 CIDR block for the cluster.",
"readOnly": true,
"type": "string"
},
"servicesSecondaryRangeName": {
"description": "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.",
"type": "string"
},
"stackType": {
"description": "The IP stack type of the cluster",
"enum": [
"STACK_TYPE_UNSPECIFIED",
"IPV4",
"IPV4_IPV6"
],
"type": "string"
},
"subnetIpv6CidrBlock": {
"description": "Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods.",
"readOnly": true,
"type": "string"
},
"subnetworkName": {
"description": "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.",
"type": "string"
},
"tpuIpv4CidrBlock": {
"description": "The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](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.",
"type": "string"
},
"useIpAliases": {
"description": "Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode",
"type": "boolean"
},
"useRoutes": {
"description": "Whether routes will be used for pod IPs in the cluster. This is used in conjunction with use_ip_aliases. It cannot be true if use_ip_aliases is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/IPAllocationPolicy",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

K8sBetaAPIConfig

{
"description": "K8sBetaAPIConfig , configuration for beta APIs",
"properties": {
"enabledApis": {
"description": "Enabled k8s beta APIs.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/K8sBetaAPIConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

keyName

{
"type": "string",
"tests": [
{
"description": "valid case",
"input": "projects/cse-legolas/locations/global/keyRings/test/cryptoKeys/disk/cryptoKeyVersions/1"
}
],
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/keyName",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

kubernetesClusterName

{
"type": "string",
"pattern": "^projects/[a-z0-9-]{5,29}[a-z0-9]{1}/locations/[a-z]{2,9}-[a-z]{2,8}[0-9]/clusters/[a-z0-9-]{1,40}$",
"tests": [
{
"description": "valid case",
"input": "projects/cse-legolas-2/locations/us-east1/clusters/test"
},
{
"description": "invalid - cannot end with a hyphen",
"input": "testName01-",
"expected": false
},
{
"description": "invalid - too long",
"input": "test555testtstststststsststest555testtstststststsststest555testtstststststsststest555testtstststststsststest555testtstststststssts",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/kubernetesClusterName",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

kubernetesClusterStatus

{
"type": "string",
"enum": [
"RUNNING",
"STATUS_UNSPECIFIED",
"PROVISIONING",
"RECONCILING",
"STOPPING",
"ERROR",
"DEGRADED"
],
"tests": [
{
"input": "RUNNING"
},
{
"input": "PROVISIONING"
},
{
"description": "invalid - not listed in options",
"input": "RUNNABLE",
"expected": false
},
{
"description": "invalid - null value",
"input": null,
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/kubernetesClusterStatus",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

kubernetesDashboard

{
"type": "object",
"properties": {
"disabled": {
"type": "boolean"
}
},
"anyOf": [
{
"type": "object",
"properties": {
"disabled": {
"type": "boolean"
}
}
},
{
"type": "null"
}
],
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/kubernetesDashboard",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

KubernetesDashboard

{
"description": "Configuration for the Kubernetes Dashboard.",
"properties": {
"disabled": {
"description": "Whether the Kubernetes Dashboard is enabled for this cluster.",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/KubernetesDashboard",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

kubernetesEngine

{
"allOf": [
{
"$ref": "turbot#/definitions/service"
},
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"state": {
"$ref": "gcp#/definitions/state"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/kubernetesEngineAka"
}
},
"title": {
"type": "string"
},
"custom": {
"type": "object",
"properties": {
"gcp": {
"$ref": "gcp#/definitions/gcpMetadata"
}
}
}
}
}
},
"required": [
"name",
"turbot"
],
"additionalProperties": true,
"tests": [
{
"description": "Valid - base test",
"input": {
"name": "projects/932405488407/services/container.googleapis.com",
"turbot": {
"akas": [
"gcp://serviceusage.googleapis.com/projects/932405488407/services/container.googleapis.com"
],
"title": "Kubernetes Engine API",
"custom": {
"gcp": {
"projectId": "cse-legolas-2"
}
}
}
}
}
]
}
],
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/kubernetesEngine",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

kubernetesEngineAka

{
"type": "string",
"pattern": "^gcp://serviceusage.googleapis.com/projects/[0-9]{12}/services/container.googleapis.com",
"tests": [
{
"description": "base",
"input": "gcp://serviceusage.googleapis.com/projects/932405488407/services/container.googleapis.com"
},
{
"description": "invalid aka",
"input": "gcp://serviceusage.googleapis.com/projects/cse-legolas-2/services/container.googleapis.com",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/kubernetesEngineAka",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

LegacyAbac

{
"description": "Configuration for the legacy Attribute Based Access Control authorization mode.",
"properties": {
"enabled": {
"description": "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.",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/LegacyAbac",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

LinuxNodeConfig

{
"description": "Parameters that can be configured on Linux nodes.",
"properties": {
"cgroupMode": {
"description": "cgroup_mode specifies the cgroup mode to be used on the node.",
"enum": [
"CGROUP_MODE_UNSPECIFIED",
"CGROUP_MODE_V1",
"CGROUP_MODE_V2"
],
"type": "string"
},
"sysctls": {
"additionalProperties": {
"type": "string"
},
"description": "The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse",
"type": "object"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/LinuxNodeConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

LocalNvmeSsdBlockConfig

{
"description": "LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs",
"properties": {
"localSsdCount": {
"description": "Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.",
"type": "integer"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/LocalNvmeSsdBlockConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

LoggingComponentConfig

{
"description": "LoggingComponentConfig is cluster logging component configuration.",
"properties": {
"enableComponents": {
"description": "Select components to collect logs. An empty set would disable all logging.",
"items": {
"enum": [
"COMPONENT_UNSPECIFIED",
"SYSTEM_COMPONENTS",
"WORKLOADS",
"APISERVER",
"SCHEDULER",
"CONTROLLER_MANAGER"
],
"type": "string"
},
"type": "array"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/LoggingComponentConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

LoggingConfig

{
"description": "LoggingConfig is cluster logging configuration.",
"properties": {
"componentConfig": {
"$ref": "#/definitions/LoggingComponentConfig",
"description": "Logging components configuration"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/LoggingConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

LoggingVariantConfig

{
"description": "LoggingVariantConfig specifies the behaviour of the logging component.",
"properties": {
"variant": {
"description": "Logging variant deployed on nodes.",
"enum": [
"VARIANT_UNSPECIFIED",
"DEFAULT",
"MAX_THROUGHPUT"
],
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/LoggingVariantConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

MaintenanceExclusionOptions

{
"description": "Represents the Maintenance exclusion option.",
"properties": {
"scope": {
"description": "Scope specifies the upgrade scope which upgrades are blocked by the exclusion.",
"enum": [
"NO_UPGRADES",
"NO_MINOR_UPGRADES",
"NO_MINOR_OR_NODE_UPGRADES"
],
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/MaintenanceExclusionOptions",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

MaintenancePolicy

{
"description": "MaintenancePolicy defines the maintenance policy to be used for the cluster.",
"properties": {
"resourceVersion": {
"description": "A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.",
"type": "string"
},
"window": {
"$ref": "#/definitions/MaintenanceWindow",
"description": "Specifies the maintenance window in which maintenance may be performed."
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/MaintenancePolicy",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

MaintenanceWindow

{
"description": "MaintenanceWindow defines the maintenance window to be used for the cluster.",
"properties": {
"dailyMaintenanceWindow": {
"$ref": "#/definitions/DailyMaintenanceWindow",
"description": "DailyMaintenanceWindow specifies a daily maintenance operation window."
},
"maintenanceExclusions": {
"additionalProperties": {
"$ref": "#/definitions/TimeWindow"
},
"description": "Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows.",
"type": "object"
},
"recurringWindow": {
"$ref": "#/definitions/RecurringTimeWindow",
"description": "RecurringWindow specifies some number of recurring time periods for maintenance to occur. The time windows may be overlapping. If no maintenance windows are set, maintenance can occur at any time."
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/MaintenanceWindow",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

ManagedPrometheusConfig

{
"description": "ManagedPrometheusConfig defines the configuration for Google Cloud Managed Service for Prometheus.",
"properties": {
"enabled": {
"description": "Enable Managed Collection.",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/ManagedPrometheusConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

masterAuth

{
"type": "object",
"properties": {
"clientKey": {
"type": "string"
},
"username": {
"type": "string"
},
"password": {
"type": "string"
}
},
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/masterAuth",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

MasterAuth

{
"description": "The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates.",
"properties": {
"clientCertificate": {
"description": "[Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.",
"type": "string"
},
"clientCertificateConfig": {
"$ref": "#/definitions/ClientCertificateConfig",
"description": "Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued."
},
"clientKey": {
"description": "[Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.",
"type": "string"
},
"clusterCaCertificate": {
"description": "[Output only] Base64-encoded public certificate that is the root of trust for the cluster.",
"type": "string"
},
"password": {
"deprecated": true,
"description": "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. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication",
"type": "string"
},
"username": {
"deprecated": true,
"description": "The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication",
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/MasterAuth",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

masterAuthorizedNetworksConfig

{
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/masterAuthorizedNetworksConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

MasterAuthorizedNetworksConfig

{
"description": "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": {
"cidrBlocks": {
"description": "cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.",
"items": {
"$ref": "#/definitions/CidrBlock"
},
"type": "array"
},
"enabled": {
"description": "Whether or not master authorized networks is enabled.",
"type": "boolean"
},
"gcpPublicCidrsAccessEnabled": {
"description": "Whether master is accessbile via Google Compute Engine Public IP addresses.",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/MasterAuthorizedNetworksConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

MaxPodsConstraint

{
"description": "Constraints applied to pods.",
"properties": {
"maxPodsPerNode": {
"description": "Constraint enforced on the max num of pods per node.",
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/MaxPodsConstraint",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

MeshCertificates

{
"description": "Configuration for issuance of mTLS keys and certificates to Kubernetes pods.",
"properties": {
"enableCertificates": {
"description": "enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty).",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/MeshCertificates",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

MonitoringComponentConfig

{
"description": "MonitoringComponentConfig is cluster monitoring component configuration.",
"properties": {
"enableComponents": {
"description": "Select components to collect metrics. An empty set would disable all monitoring.",
"items": {
"enum": [
"COMPONENT_UNSPECIFIED",
"SYSTEM_COMPONENTS",
"APISERVER",
"SCHEDULER",
"CONTROLLER_MANAGER",
"STORAGE",
"HPA",
"POD",
"DAEMONSET",
"DEPLOYMENT",
"STATEFULSET"
],
"type": "string"
},
"type": "array"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/MonitoringComponentConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

MonitoringConfig

{
"description": "MonitoringConfig is cluster monitoring configuration.",
"properties": {
"advancedDatapathObservabilityConfig": {
"$ref": "#/definitions/AdvancedDatapathObservabilityConfig",
"description": "Configuration of Advanced Datapath Observability features."
},
"componentConfig": {
"$ref": "#/definitions/MonitoringComponentConfig",
"description": "Monitoring components configuration"
},
"managedPrometheusConfig": {
"$ref": "#/definitions/ManagedPrometheusConfig",
"description": "Enable Google Cloud Managed Service for Prometheus in the cluster."
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/MonitoringConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

NetworkConfig

{
"description": "NetworkConfig reports the relative names of network & subnetwork.",
"properties": {
"datapathProvider": {
"description": "The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation.",
"enum": [
"DATAPATH_PROVIDER_UNSPECIFIED",
"LEGACY_DATAPATH",
"ADVANCED_DATAPATH"
],
"type": "string"
},
"defaultSnatStatus": {
"$ref": "#/definitions/DefaultSnatStatus",
"description": "Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when default_snat_status is disabled. When disabled is set to false, default IP masquerade rules will be applied to the nodes to prevent sNAT on cluster internal traffic."
},
"dnsConfig": {
"$ref": "#/definitions/DNSConfig",
"description": "DNSConfig contains clusterDNS config for this cluster."
},
"enableFqdnNetworkPolicy": {
"description": "Whether FQDN Network Policy is enabled on this cluster.",
"type": "boolean"
},
"enableIntraNodeVisibility": {
"description": "Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network.",
"type": "boolean"
},
"enableL4ilbSubsetting": {
"description": "Whether L4ILB Subsetting is enabled for this cluster.",
"type": "boolean"
},
"enableMultiNetworking": {
"description": "Whether multi-networking is enabled for this cluster.",
"type": "boolean"
},
"gatewayApiConfig": {
"$ref": "#/definitions/GatewayAPIConfig",
"description": "GatewayAPIConfig contains the desired config of Gateway API on this cluster."
},
"inTransitEncryptionConfig": {
"description": "Specify the details of in-transit encryption.",
"enum": [
"IN_TRANSIT_ENCRYPTION_CONFIG_UNSPECIFIED",
"IN_TRANSIT_ENCRYPTION_DISABLED",
"IN_TRANSIT_ENCRYPTION_INTER_NODE_TRANSPARENT"
],
"type": "string"
},
"network": {
"description": "Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network",
"type": "string"
},
"networkPerformanceConfig": {
"$ref": "#/definitions/ClusterNetworkPerformanceConfig",
"description": "Network bandwidth tier configuration."
},
"privateIpv6GoogleAccess": {
"description": "The desired state of IPv6 connectivity to Google Services. By default, no private IPv6 access to or from Google Services (all access will be via IPv4)",
"enum": [
"PRIVATE_IPV6_GOOGLE_ACCESS_UNSPECIFIED",
"PRIVATE_IPV6_GOOGLE_ACCESS_DISABLED",
"PRIVATE_IPV6_GOOGLE_ACCESS_TO_GOOGLE",
"PRIVATE_IPV6_GOOGLE_ACCESS_BIDIRECTIONAL"
],
"type": "string"
},
"serviceExternalIpsConfig": {
"$ref": "#/definitions/ServiceExternalIPsConfig",
"description": "ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not."
},
"subnetwork": {
"description": "Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet",
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/NetworkConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

NetworkPerformanceConfig

{
"description": "Configuration of all network bandwidth tiers",
"properties": {
"totalEgressBandwidthTier": {
"description": "Specifies the total network bandwidth tier for the NodePool.",
"enum": [
"TIER_UNSPECIFIED",
"TIER_1"
],
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/NetworkPerformanceConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

networkPolicy

{
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"provider": {
"type": "string",
"enum": [
"PROVIDER_UNSPECIFIED",
"CALICO"
]
}
},
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/networkPolicy",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

NetworkPolicy

{
"description": "Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/",
"properties": {
"enabled": {
"description": "Whether network policy is enabled on the cluster.",
"type": "boolean"
},
"provider": {
"description": "The selected network policy provider.",
"enum": [
"PROVIDER_UNSPECIFIED",
"CALICO"
],
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/NetworkPolicy",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

NetworkPolicyConfig

{
"description": "Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes.",
"properties": {
"disabled": {
"description": "Whether NetworkPolicy is enabled for this cluster.",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/NetworkPolicyConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

NetworkTags

{
"description": "Collection of Compute Engine network tags that can be applied to a node's underlying VM instance.",
"properties": {
"tags": {
"description": "List of network tags.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/NetworkTags",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

NodeAffinity

{
"description": "Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).",
"properties": {
"key": {
"description": "Key for NodeAffinity.",
"type": "string"
},
"operator": {
"description": "Operator for NodeAffinity.",
"enum": [
"OPERATOR_UNSPECIFIED",
"IN",
"NOT_IN"
],
"type": "string"
},
"values": {
"description": "Values for NodeAffinity.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/NodeAffinity",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

nodeConfig

{
"type": "object",
"properties": {
"serviceAccount": {
"type": "string"
}
},
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/nodeConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

NodeConfig

{
"description": "Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead.",
"properties": {
"accelerators": {
"description": "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.",
"items": {
"$ref": "#/definitions/AcceleratorConfig"
},
"type": "array"
},
"advancedMachineFeatures": {
"$ref": "#/definitions/AdvancedMachineFeatures",
"description": "Advanced features for the Compute Engine VM."
},
"bootDiskKmsKey": {
"description": " 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",
"type": "string"
},
"confidentialNodes": {
"$ref": "#/definitions/ConfidentialNodes",
"description": "Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled."
},
"diskSizeGb": {
"description": "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.",
"type": "integer"
},
"diskType": {
"description": "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'",
"type": "string"
},
"ephemeralStorageLocalSsdConfig": {
"$ref": "#/definitions/EphemeralStorageLocalSsdConfig",
"description": "Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk."
},
"fastSocket": {
"$ref": "#/definitions/FastSocket",
"description": "Enable or disable NCCL fast socket for the node pool."
},
"gcfsConfig": {
"$ref": "#/definitions/GcfsConfig",
"description": "Google Container File System (image streaming) configs."
},
"gvnic": {
"$ref": "#/definitions/VirtualNIC",
"description": "Enable or disable gvnic in the node pool."
},
"imageType": {
"description": "The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.",
"type": "string"
},
"kubeletConfig": {
"$ref": "#/definitions/NodeKubeletConfig",
"description": "Node kubelet configs."
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "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/",
"type": "object"
},
"linuxNodeConfig": {
"$ref": "#/definitions/LinuxNodeConfig",
"description": "Parameters that can be configured on Linux nodes."
},
"localNvmeSsdBlockConfig": {
"$ref": "#/definitions/LocalNvmeSsdBlockConfig",
"description": "Parameters for using raw-block Local NVMe SSDs."
},
"localSsdCount": {
"description": "The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.",
"type": "integer"
},
"loggingConfig": {
"$ref": "#/definitions/NodePoolLoggingConfig",
"description": "Logging configuration."
},
"machineType": {
"description": "The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.",
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - \"cluster-location\" - \"cluster-name\" - \"cluster-uid\" - \"configure-sh\" - \"containerd-configure-sh\" - \"enable-os-login\" - \"gci-ensure-gke-docker\" - \"gci-metrics-enabled\" - \"gci-update-strategy\" - \"instance-template\" - \"kube-env\" - \"startup-script\" - \"user-data\" - \"disable-address-manager\" - \"windows-startup-script-ps1\" - \"common-psm1\" - \"k8s-node-setup-psm1\" - \"install-ssh-psm1\" - \"user-profile-psm1\" 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.",
"type": "object"
},
"minCpuPlatform": {
"description": "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)",
"type": "string"
},
"nodeGroup": {
"description": "Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).",
"type": "string"
},
"oauthScopes": {
"description": "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.",
"items": {
"type": "string"
},
"type": "array"
},
"preemptible": {
"description": "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.",
"type": "boolean"
},
"reservationAffinity": {
"$ref": "#/definitions/ReservationAffinity",
"description": "The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool."
},
"resourceLabels": {
"additionalProperties": {
"type": "string"
},
"description": "The resource labels for the node pool to use to annotate any related Google Compute Engine resources.",
"type": "object"
},
"resourceManagerTags": {
"$ref": "#/definitions/ResourceManagerTags",
"description": "A map of resource manager tag keys and values to be attached to the nodes."
},
"sandboxConfig": {
"$ref": "#/definitions/SandboxConfig",
"description": "Sandbox configuration for this node."
},
"serviceAccount": {
"description": "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.",
"type": "string"
},
"shieldedInstanceConfig": {
"$ref": "#/definitions/ShieldedInstanceConfig",
"description": "Shielded Instance options."
},
"soleTenantConfig": {
"$ref": "#/definitions/SoleTenantConfig",
"description": "Parameters for node pools to be backed by shared sole tenant node groups."
},
"spot": {
"description": "Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.",
"type": "boolean"
},
"tags": {
"description": "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.",
"items": {
"type": "string"
},
"type": "array"
},
"taints": {
"description": "List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/",
"items": {
"$ref": "#/definitions/NodeTaint"
},
"type": "array"
},
"windowsNodeConfig": {
"$ref": "#/definitions/WindowsNodeConfig",
"description": "Parameters that can be configured on Windows nodes."
},
"workloadMetadataConfig": {
"$ref": "#/definitions/WorkloadMetadataConfig",
"description": "The workload metadata configuration for this node."
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/NodeConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

NodeConfigDefaults

{
"description": "Subset of NodeConfig message that has defaults.",
"properties": {
"gcfsConfig": {
"$ref": "#/definitions/GcfsConfig",
"description": "GCFS (Google Container File System, also known as Riptide) options."
},
"loggingConfig": {
"$ref": "#/definitions/NodePoolLoggingConfig",
"description": "Logging configuration for node pools."
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/NodeConfigDefaults",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

NodeKubeletConfig

{
"description": "Node kubelet configs.",
"properties": {
"cpuCfsQuota": {
"description": "Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.",
"type": "boolean"
},
"cpuCfsQuotaPeriod": {
"description": "Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as \"300ms\". Valid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\". The value must be a positive duration.",
"type": "string"
},
"cpuManagerPolicy": {
"description": "Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * \"none\": the default, which represents the existing scheduling behavior. * \"static\": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.",
"type": "string"
},
"insecureKubeletReadonlyPortEnabled": {
"description": "Enable or disable Kubelet read only port.",
"type": "boolean"
},
"podPidsLimit": {
"description": "Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.",
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/NodeKubeletConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

NodeManagement

{
"description": "NodeManagement defines the set of node management services turned on for the node pool.",
"properties": {
"autoRepair": {
"description": "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.",
"type": "boolean"
},
"autoUpgrade": {
"description": "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.",
"type": "boolean"
},
"upgradeOptions": {
"$ref": "#/definitions/AutoUpgradeOptions",
"description": "Specifies the Auto Upgrade knobs for the node pool."
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/NodeManagement",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

NodeNetworkConfig

{
"description": "Parameters for node pool-level network config.",
"properties": {
"additionalNodeNetworkConfigs": {
"description": "We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface",
"items": {
"$ref": "#/definitions/AdditionalNodeNetworkConfig"
},
"type": "array"
},
"additionalPodNetworkConfigs": {
"description": "We specify the additional pod networks for this node pool using this list. Each pod network corresponds to an additional alias IP range for the node",
"items": {
"$ref": "#/definitions/AdditionalPodNetworkConfig"
},
"type": "array"
},
"createPodRange": {
"description": "Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.",
"type": "boolean"
},
"enablePrivateNodes": {
"description": "Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from cluster.privateClusterConfig.enablePrivateNodes",
"type": "boolean"
},
"networkPerformanceConfig": {
"$ref": "#/definitions/NetworkPerformanceConfig",
"description": "Network bandwidth tier configuration."
},
"podCidrOverprovisionConfig": {
"$ref": "#/definitions/PodCIDROverprovisionConfig",
"description": "[PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled."
},
"podIpv4CidrBlock": {
"description": "The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` 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](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.",
"type": "string"
},
"podIpv4RangeUtilization": {
"description": "Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.",
"readOnly": true,
"type": "number"
},
"podRange": {
"description": "The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.",
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/NodeNetworkConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

NodePool

{
"description": "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": {
"autoscaling": {
"$ref": "#/definitions/NodePoolAutoscaling",
"description": "Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present."
},
"bestEffortProvisioning": {
"$ref": "#/definitions/BestEffortProvisioning",
"description": "Enable best effort provisioning for nodes"
},
"conditions": {
"description": "Which conditions caused the current node pool state.",
"items": {
"$ref": "#/definitions/StatusCondition"
},
"type": "array"
},
"config": {
"$ref": "#/definitions/NodeConfig",
"description": "The node configuration of the pool."
},
"etag": {
"description": "This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.",
"type": "string"
},
"initialNodeCount": {
"description": "The initial node count for the pool. 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.",
"type": "integer"
},
"instanceGroupUrls": {
"description": "[Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.",
"items": {
"type": "string"
},
"type": "array"
},
"locations": {
"description": "The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.",
"items": {
"type": "string"
},
"type": "array"
},
"management": {
"$ref": "#/definitions/NodeManagement",
"description": "NodeManagement configuration for this NodePool."
},
"maxPodsConstraint": {
"$ref": "#/definitions/MaxPodsConstraint",
"description": "The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool."
},
"name": {
"description": "The name of the node pool.",
"type": "string"
},
"networkConfig": {
"$ref": "#/definitions/NodeNetworkConfig",
"description": "Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults."
},
"placementPolicy": {
"$ref": "#/definitions/PlacementPolicy",
"description": "Specifies the node placement policy."
},
"podIpv4CidrSize": {
"description": "[Output only] The pod CIDR block size per node in this node pool.",
"type": "integer"
},
"queuedProvisioning": {
"$ref": "#/definitions/QueuedProvisioning",
"description": "Specifies the configuration of queued provisioning."
},
"selfLink": {
"description": "[Output only] Server-defined URL for the resource.",
"type": "string"
},
"status": {
"description": "[Output only] The status of the nodes in this pool instance.",
"enum": [
"STATUS_UNSPECIFIED",
"PROVISIONING",
"RUNNING",
"RUNNING_WITH_ERROR",
"RECONCILING",
"STOPPING",
"ERROR"
],
"type": "string"
},
"statusMessage": {
"deprecated": true,
"description": "[Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.",
"type": "string"
},
"updateInfo": {
"$ref": "#/definitions/UpdateInfo",
"description": "Output only. [Output only] Update info contains relevant information during a node pool update.",
"readOnly": true
},
"upgradeSettings": {
"$ref": "#/definitions/UpgradeSettings",
"description": "Upgrade settings control disruption and speed of the upgrade."
},
"version": {
"description": "The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version).",
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/NodePool",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

NodePoolAutoConfig

{
"description": "Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.",
"properties": {
"networkTags": {
"$ref": "#/definitions/NetworkTags",
"description": "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 creation. Each tag within the list must comply with RFC1035."
},
"resourceManagerTags": {
"$ref": "#/definitions/ResourceManagerTags",
"description": "Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies."
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/NodePoolAutoConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

NodePoolAutoscaling

{
"description": "NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage.",
"properties": {
"autoprovisioned": {
"description": "Can this node pool be deleted automatically.",
"type": "boolean"
},
"enabled": {
"description": "Is autoscaling enabled for this node pool.",
"type": "boolean"
},
"locationPolicy": {
"description": "Location policy used when scaling up a nodepool.",
"enum": [
"LOCATION_POLICY_UNSPECIFIED",
"BALANCED",
"ANY"
],
"type": "string"
},
"maxNodeCount": {
"description": "Maximum number of nodes for one location in the NodePool. Must be >= min_node_count. There has to be enough quota to scale up the cluster.",
"type": "integer"
},
"minNodeCount": {
"description": "Minimum number of nodes for one location in the NodePool. Must be >= 1 and <= max_node_count.",
"type": "integer"
},
"totalMaxNodeCount": {
"description": "Maximum number of nodes in the node pool. Must be greater than total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields.",
"type": "integer"
},
"totalMinNodeCount": {
"description": "Minimum number of nodes in the node pool. Must be greater than 1 less than total_max_node_count. The total_*_node_count fields are mutually exclusive with the *_node_count fields.",
"type": "integer"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/NodePoolAutoscaling",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

NodePoolDefaults

{
"description": "Subset of Nodepool message that has defaults.",
"properties": {
"nodeConfigDefaults": {
"$ref": "#/definitions/NodeConfigDefaults",
"description": "Subset of NodeConfig message that has defaults."
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/NodePoolDefaults",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

nodePoolId

{
"type": "string",
"pattern": "^projects/[a-z0-9-]{5,29}[a-z0-9]{1}/locations/[a-z]{2,9}-[a-z]{2,8}[0-9]/clusters/[a-z0-9-]{1,40}/nodePools/[a-z0-9][a-z0-9-]{1,38}[a-z0-9]{1}$",
"tests": [
{
"description": "valid case",
"input": "projects/cse-legolas-2/locations/us-east1/clusters/test/nodePools/test-pool"
},
{
"description": "invalid - cannot end with a hyphen",
"input": "testName01-",
"expected": false
},
{
"description": "invalid - too long",
"input": "test555testtstststststsststest555testtstststststsststest555testtstststststsststest555testtstststststsststest555testtstststststssts",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/nodePoolId",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

NodePoolLoggingConfig

{
"description": "NodePoolLoggingConfig specifies logging configuration for nodepools.",
"properties": {
"variantConfig": {
"$ref": "#/definitions/LoggingVariantConfig",
"description": "Logging variant configuration."
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/NodePoolLoggingConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

nodePoolName

{
"type": "string",
"pattern": "^[a-z0-9][a-z0-9-]{1,38}[a-z0-9]{1}$",
"tests": [
{
"description": "valid case",
"input": "test-00123"
},
{
"description": "invalid - cannot end with a hyphen",
"input": "testName01-",
"expected": false
},
{
"description": "invalid - too long",
"input": "test555testtstststststsststest555testtstststststsststest555testtstststststsststest555testtstststststsststest555testtstststststssts",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/nodePoolName",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

nodePools

{
"type": "array",
"items": {
"$ref": "#/definitions/nodePoolsItems"
},
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/nodePools",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

nodePoolsConfig

{
"type": "object",
"properties": {
"imageType": {
"type": "string"
}
},
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/nodePoolsConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

nodePoolsItems

{
"type": "object",
"properties": {
"management": {
"$ref": "#/definitions/nodePoolsManagement"
},
"config": {
"$ref": "#/definitions/nodePoolsConfig"
}
},
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/nodePoolsItems",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

nodePoolsManagement

{
"type": "object",
"properties": {
"autoRepair": {
"type": "boolean"
},
"autoUpgrade": {
"type": "boolean"
}
},
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/nodePoolsManagement",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

NodeTaint

{
"description": "Kubernetes taint is composed of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.",
"properties": {
"effect": {
"description": "Effect for taint.",
"enum": [
"EFFECT_UNSPECIFIED",
"NO_SCHEDULE",
"PREFER_NO_SCHEDULE",
"NO_EXECUTE"
],
"type": "string"
},
"key": {
"description": "Key for taint.",
"type": "string"
},
"value": {
"description": "Value for taint.",
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/NodeTaint",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

NotificationConfig

{
"description": "NotificationConfig is the configuration of notifications.",
"properties": {
"pubsub": {
"$ref": "#/definitions/PubSub",
"description": "Notification config for Pub/Sub."
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/NotificationConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

ParentProductConfig

{
"description": "ParentProductConfig is the configuration of the parent product of the cluster. This field is used by Google internal products that are built on top of a GKE cluster and take the ownership of the cluster.",
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels contain the configuration of the parent product.",
"type": "object"
},
"productName": {
"description": "Name of the parent product associated with the cluster.",
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/ParentProductConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

PlacementPolicy

{
"description": "PlacementPolicy defines the placement policy used by the node pool.",
"properties": {
"policyName": {
"description": "If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned.",
"type": "string"
},
"tpuTopology": {
"description": "Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies",
"type": "string"
},
"type": {
"description": "The type of placement.",
"enum": [
"TYPE_UNSPECIFIED",
"COMPACT"
],
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/PlacementPolicy",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

PodCIDROverprovisionConfig

{
"description": "[PRIVATE FIELD] Config for pod CIDR size overprovisioning.",
"properties": {
"disable": {
"description": "Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default.",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/PodCIDROverprovisionConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

podSecurityPolicyConfig

{
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/podSecurityPolicyConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

PrivateClusterConfig

{
"description": "Configuration options for private clusters.",
"properties": {
"enablePrivateEndpoint": {
"description": "Whether the master's internal IP address is used as the cluster endpoint.",
"type": "boolean"
},
"enablePrivateNodes": {
"description": "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.",
"type": "boolean"
},
"masterGlobalAccessConfig": {
"$ref": "#/definitions/PrivateClusterMasterGlobalAccessConfig",
"description": "Controls master global access settings."
},
"masterIpv4CidrBlock": {
"description": "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.",
"type": "string"
},
"peeringName": {
"description": "Output only. The peering name in the customer VPC used by this cluster.",
"type": "string"
},
"privateEndpoint": {
"description": "Output only. The internal IP address of this cluster's master endpoint.",
"type": "string"
},
"privateEndpointSubnetwork": {
"description": "Subnet to provision the master's private endpoint during cluster creation. Specified in projects/*/regions/*/subnetworks/* format.",
"type": "string"
},
"publicEndpoint": {
"description": "Output only. The external IP address of this cluster's master endpoint.",
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/PrivateClusterConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

PrivateClusterMasterGlobalAccessConfig

{
"description": "Configuration for controlling master global access settings.",
"properties": {
"enabled": {
"description": "Whenever master is accessible globally or not.",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/PrivateClusterMasterGlobalAccessConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

PubSub

{
"description": "Pub/Sub specific notification config.",
"properties": {
"enabled": {
"description": "Enable notifications for Pub/Sub.",
"type": "boolean"
},
"filter": {
"$ref": "#/definitions/Filter",
"description": "Allows filtering to one or more specific event types. If no filter is specified, or if a filter is specified with no event types, all event types will be sent"
},
"topic": {
"description": "The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`.",
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/PubSub",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

QueuedProvisioning

{
"description": "QueuedProvisioning defines the queued provisioning used by the node pool.",
"properties": {
"enabled": {
"description": "Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API.",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/QueuedProvisioning",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

RangeInfo

{
"description": "RangeInfo contains the range name and the range utilization by this cluster.",
"properties": {
"rangeName": {
"description": "Output only. [Output only] Name of a range.",
"readOnly": true,
"type": "string"
},
"utilization": {
"description": "Output only. [Output only] The utilization of the range.",
"readOnly": true,
"type": "number"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/RangeInfo",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

RecurringTimeWindow

{
"description": "Represents an arbitrary window of time that recurs.",
"properties": {
"recurrence": {
"description": "An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you'd use: `FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR` To repeat some window daily (equivalent to the DailyMaintenanceWindow): `FREQ=DAILY` For the first weekend of every month: `FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU` This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you'd use something like: ``` start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR ``` Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: ``` start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA ``` Note the start and end time's specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.",
"type": "string"
},
"window": {
"$ref": "#/definitions/TimeWindow",
"description": "The window of the first recurrence."
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/RecurringTimeWindow",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

regionCluster

{
"type": "object",
"properties": {
"name": {
"$ref": "#/definitions/clusterName"
},
"labels": {
"$ref": "gcp#/definitions/labels"
},
"resourceLabels": {
"$ref": "gcp#/definitions/labels"
},
"labelFingerprint": {
"type": "string"
},
"legacyAbac": {
"$ref": "#/definitions/clusterLegacyAbac"
},
"status": {
"$ref": "#/definitions/kubernetesClusterStatus"
},
"addonsConfig": {
"$ref": "#/definitions/addonsConfig"
},
"databaseEncryption": {
"$ref": "#/definitions/databaseEncryption"
},
"masterAuthorizedNetworksConfig": {
"$ref": "#/definitions/masterAuthorizedNetworksConfig"
},
"loggingService": {
"$ref": "#/definitions/clusterLoggingService"
},
"monitoringService": {
"$ref": "#/definitions/clusterMonitoringService"
},
"nodePools": {
"$ref": "#/definitions/nodePools"
},
"networkPolicy": {
"$ref": "#/definitions/networkPolicy"
},
"masterAuth": {
"$ref": "#/definitions/masterAuth"
},
"ipAllocationPolicy": {
"$ref": "#/definitions/ipAllocationPolicy"
},
"nodeConfig": {
"$ref": "#/definitions/nodeConfig"
},
"podSecurityPolicyConfig": {
"$ref": "#/definitions/podSecurityPolicyConfig"
},
"privateCluster": {
"type": "boolean"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/regionClusterAka"
}
},
"tags": {
"$ref": "gcp#/definitions/labels"
},
"title": {
"$ref": "#/definitions/clusterName"
},
"custom": {
"type": "object",
"properties": {
"gcp": {
"$ref": "gcp#/definitions/gcpMetadata"
},
"createTimestamp": {
"$ref": "turbot#/definitions/isoTimestamp"
},
"clusterId": {
"$ref": "#/definitions/kubernetesClusterName"
}
}
}
}
}
},
"required": [
"name"
],
"additionalProperties": true,
"tests": [
{
"description": "Valid - All properties",
"input": {
"name": "testfunction01",
"databaseEncryption": {
"keyName": "projects/cse-legolas/locations/global/keyRings/test/cryptoKeys/disk/cryptoKeyVersions/1",
"state": "ENCRYPTED"
},
"resourceLabels": {
"foo": "bar",
"foo1": "bar1"
},
"loggingService": "google.loggingservice.com",
"monitoringService": "monitoring.googleapis.com",
"masterAuthorizedNetworksConfig": {
"enabled": true
},
"status": "RUNNING",
"legacyAbac": {
"enabled": true
},
"labelFingerprint": "a9dc16a7",
"turbot": {
"custom": {
"clusterId": "projects/cse-legolas/locations/us-east1/clusters/testfunction01",
"gcp": {
"projectId": "cse-legolas",
"regionName": "us-east1"
}
},
"createTimestamp": "2019-03-19T03:17:06.000Z",
"tags": {
"foo": "bar",
"foo1": "bar1"
},
"title": "testfunctiontesting01"
}
}
},
{
"description": "Invalid - Missing name",
"input": {
"databaseEncryption": {
"keyName": "projects/cse-legolas/locations/global/keyRings/test/cryptoKeys/disk/cryptoKeyVersions/1",
"state": "ENCRYPTED"
},
"resourceLabels": {
"foo": "bar",
"foo1": "bar1"
},
"loggingService": "google.loggingservice.com",
"monitoringService": "monitoring.googleapis.com",
"masterAuthorizedNetworksConfig": {
"enabled": true
},
"status": "RUNNING",
"legacyAbac": {
"enabled": true
},
"labelFingerprint": "a9dc16a7",
"turbot": {
"custom": {
"clusterId": "projects/function-test-01/locations/asia/clusters/testfunctiontesting01",
"gcp": {
"projectId": "function-test-01",
"regionName": "asia"
}
},
"createTimestamp": "2019-03-19T03:17:06.000Z",
"tags": {
"foo": "bar",
"foo1": "bar1"
},
"title": "testfunctiontesting01"
}
},
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/regionCluster",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

regionClusterAka

{
"type": "string",
"pattern": "^gcp://container.googleapis.com/projects/[a-z0-9-]{5,29}[a-z0-9]{1}/locations/[a-z]{2,9}-[a-z]{2,8}[0-9]/clusters/[a-z0-9-]{1,40}$",
"tests": [
{
"description": "Valid - Base case",
"input": "gcp://container.googleapis.com/projects/cse-legolas-2/locations/us-east1/clusters/test"
},
{
"description": "Invalid - Malformed resource collection",
"input": "gcp://container.googleapis.com/projects/cse-legolas-2/locations/us-east1/cluster/test",
"expected": false
},
{
"description": "Invalid - Malformed region name",
"input": "gcp://container.googleapis.com/projects/cse-legolas-2/locations/us-east12/clusters/test",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/regionClusterAka",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

regionClusterServiceNow

{
"defaultColumns": {
"project": {
"column": "enabled",
"type": "string",
"path": "metadata.gcp.projectId"
},
"region": {
"column": "enabled",
"path": "metadata.gcp.regionName"
},
"addons_config": {
"column": "enabled",
"type": "string",
"size": 1000
},
"authenticator_groups_config": {
"column": "enabled",
"type": "string",
"size": 1000
},
"autopilot_enabled": {
"column": "enabled",
"path": "data.autopilot.enabled",
"type": "boolean"
},
"autoscaling": {
"column": "enabled",
"type": "string",
"size": 1000
},
"binary_authorization": {
"column": "enabled",
"path": "data.binaryAuthorization.evaluationMode",
"type": "string",
"size": 1000
},
"cluster_ipv4_cidr": {
"column": "enabled",
"path": "data.clusterIpv4Cidr",
"label": "Cluster IPV4 CIDR"
},
"conditions": {
"column": "enabled",
"type": "string",
"size": 1000
},
"create_time": {
"column": "enabled"
},
"current_master_version": {
"column": "enabled"
},
"current_node_count": {
"column": "enabled"
},
"current_node_version": {
"column": "enabled"
},
"database_encryption_state": {
"column": "enabled",
"path": "data.databaseEncryption.state"
},
"endpoint": {
"column": "enabled",
"label": "Endpoint"
},
"expire_time": {
"column": "enabled"
},
"initial_cluster_version": {
"column": "enabled"
},
"instance_group_urls": {
"column": "enabled",
"path": "data.instanceGroupUrls",
"label": "Instance Group URLs",
"type": "string",
"size": 1000
},
"ip_allocation_policy": {
"column": "enabled",
"label": "IP Allocation Policy",
"type": "string",
"size": 1000
},
"region_cluster_location": {
"column": "enabled",
"label": "Location",
"path": "data.location"
},
"locations": {
"column": "enabled",
"path": "data.locations",
"type": "string",
"size": 1000
},
"region_cluster_name": {
"column": null,
"path": "data.name",
"label": "Name"
},
"network": {
"column": "enabled"
},
"network_config": {
"column": "enabled",
"type": "string",
"size": 1000
},
"node_config": {
"column": "enabled",
"type": "string",
"size": 1000
},
"node_pools": {
"column": "enabled",
"type": "string",
"size": 1000
},
"notification_config": {
"column": "enabled",
"type": "string",
"size": 1000
},
"private_cluster_config": {
"column": "enabled",
"type": "string",
"size": 1000
},
"services_ipv4_cidr": {
"column": "enabled",
"path": "data.servicesIpv4Cidr",
"label": "Services IPV4 CIDR"
},
"status": {
"column": "enabled"
},
"status_message": {
"column": "enabled"
},
"subnetwork": {
"column": "enabled"
},
"zone": {
"column": "enabled"
},
"labels": {
"column": "enabled",
"path": "data.resourceLabels",
"type": "string",
"size": 1000
}
},
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/regionClusterServiceNow",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

regionNodePool

{
"type": "object",
"properties": {
"name": {
"$ref": "#/definitions/nodePoolName"
},
"status": {
"$ref": "#/definitions/regionNodePoolStatus"
},
"management": {
"$ref": "#/definitions/nodePoolsManagement"
},
"config": {
"$ref": "#/definitions/nodePoolsConfig"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/regionNodePoolAka"
}
},
"title": {
"$ref": "#/definitions/nodePoolName"
},
"custom": {
"type": "object",
"properties": {
"clusterId": {
"$ref": "#/definitions/kubernetesClusterName"
},
"nodePoolId": {
"$ref": "#/definitions/nodePoolId"
},
"gcp": {
"$ref": "gcp#/definitions/gcpMetadata"
},
"createTimestamp": {
"$ref": "turbot#/definitions/isoTimestamp"
}
}
}
}
}
},
"required": [
"turbot"
],
"additionalProperties": true,
"tests": [
{
"description": "Valid - All properties",
"input": {
"name": "test01",
"turbot": {
"akas": [
"gcp://container.googleapis.com/projects/my-project/locations/us-east1/clusters/test/nodePools/test01"
],
"title": "test01",
"custom": {
"clusterId": "projects/my-project/locations/us-east1/clusters/test",
"nodePoolId": "projects/my-project/locations/us-east1/clusters/test/nodePools/test01",
"createTimestamp": "2017-03-05T13:58:05.590Z",
"gcp": {
"projectId": "cse-legolas",
"regionName": "us-east1"
}
}
}
}
},
{
"description": "Invalid - Missing Guardrails data",
"input": {
"name": "testnodepool01",
"clusterId": "test-cluster-01"
},
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/regionNodePool",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

regionNodePoolAka

{
"type": "string",
"pattern": "^gcp://container.googleapis.com/projects/[a-z0-9-]{5,29}[a-z0-9]{1}/locations/[a-z]{2,9}-[a-z]{2,8}[0-9]/clusters/[a-z0-9-]{1,40}/nodePools/[a-z0-9][a-z0-9-]{1,38}[a-z0-9]{1}$",
"tests": [
{
"description": "Valid - Base case",
"input": "gcp://container.googleapis.com/projects/cse-legolas-2/locations/us-east1/clusters/test/nodePools/test02"
},
{
"description": "Invalid - Malformed resource collection",
"input": "gcp://container.googleapis.com/projects/cse-legolas-2/locations/us-east1/clusters/test/nodePool/test02",
"expected": false
},
{
"description": "Invalid - Malformed region name",
"input": "gcp://container.googleapis.com/projects/cse-legolas-2/locations/us-east12/clusters/test/nodePools/tst02",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/regionNodePoolAka",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

regionNodePoolServiceNow

{
"defaultColumns": {
"project": {
"column": "enabled",
"type": "string",
"path": "metadata.gcp.projectId"
},
"region": {
"column": "enabled",
"path": "metadata.gcp.regionName"
},
"autoscaling": {
"column": "enabled",
"type": "string",
"size": 1000
},
"config": {
"column": "enabled",
"type": "string",
"size": 1000
},
"initial_node_count": {
"column": "enabled"
},
"instance_group_urls": {
"column": "enabled",
"label": "Instance Group URLs",
"type": "string",
"size": 1000
},
"locations": {
"column": "enabled",
"path": "data.locations",
"type": "string",
"size": 1000
},
"management": {
"column": "enabled",
"type": "string",
"size": 1000
},
"max_pods_constraint": {
"column": "enabled",
"type": "string",
"size": 1000
},
"region_node_pool_name": {
"column": "enabled",
"path": "data.name",
"label": "Name"
},
"pod_ipv4_cidr_size": {
"column": "enabled",
"path": "data.podIpv4CidrSize",
"label": "Pod IPV4 CIDR Size"
},
"status": {
"column": "enabled",
"label": "Status"
},
"upgrade_settings": {
"column": "enabled",
"type": "string",
"size": 1000
},
"version": {
"column": "enabled"
},
"labels": {
"column": "enabled",
"path": "data.config.resourceLabels",
"type": "string",
"size": 1000
}
},
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/regionNodePoolServiceNow",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

regionNodePoolStatus

{
"type": "string",
"enum": [
"STATUS_UNSPECIFIED",
"PROVISIONING",
"RUNNING",
"RUNNING_WITH_ERROR",
"RECONCILING",
"STOPPING",
"ERROR"
],
"tests": [
{
"input": "STATUS_UNSPECIFIED"
},
{
"input": "PROVISIONING"
},
{
"description": "invalid - not listed in options",
"input": "READY",
"expected": false
},
{
"description": "invalid - null value",
"input": null,
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/regionNodePoolStatus",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

ReleaseChannel

{
"description": "ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled.",
"properties": {
"channel": {
"description": "channel specifies which release channel the cluster is subscribed to.",
"enum": [
"UNSPECIFIED",
"RAPID",
"REGULAR",
"STABLE"
],
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/ReleaseChannel",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

ReservationAffinity

{
"description": "[ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from.",
"properties": {
"consumeReservationType": {
"description": "Corresponds to the type of reservation consumption.",
"enum": [
"UNSPECIFIED",
"NO_RESERVATION",
"ANY_RESERVATION",
"SPECIFIC_RESERVATION"
],
"type": "string"
},
"key": {
"description": "Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify \"compute.googleapis.com/reservation-name\" as the key and specify the name of your reservation as its value.",
"type": "string"
},
"values": {
"description": "Corresponds to the label value(s) of reservation resource(s).",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/ReservationAffinity",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

ResourceLimit

{
"description": "Contains information about amount of some resource in the cluster. For memory, value should be in GB.",
"properties": {
"maximum": {
"description": "Maximum amount of the resource in the cluster.",
"type": "string"
},
"minimum": {
"description": "Minimum amount of the resource in the cluster.",
"type": "string"
},
"resourceType": {
"description": "Resource name \"cpu\", \"memory\" or gpu-specific string.",
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/ResourceLimit",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

ResourceManagerTags

{
"description": "A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values.",
"properties": {
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`",
"type": "object"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/ResourceManagerTags",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

ResourceUsageExportConfig

{
"description": "Configuration for exporting cluster resource usages.",
"properties": {
"bigqueryDestination": {
"$ref": "#/definitions/BigQueryDestination",
"description": "Configuration to use BigQuery as usage export destination."
},
"consumptionMeteringConfig": {
"$ref": "#/definitions/ConsumptionMeteringConfig",
"description": "Configuration to enable resource consumption metering."
},
"enableNetworkEgressMetering": {
"description": "Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic.",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/ResourceUsageExportConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

SandboxConfig

{
"description": "SandboxConfig contains configurations of the sandbox to use for the node.",
"properties": {
"type": {
"description": "Type of the sandbox to use for the node.",
"enum": [
"UNSPECIFIED",
"GVISOR"
],
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/SandboxConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

SecurityPostureConfig

{
"description": "SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API.",
"properties": {
"mode": {
"description": "Sets which mode to use for Security Posture features.",
"enum": [
"MODE_UNSPECIFIED",
"DISABLED",
"BASIC"
],
"type": "string"
},
"vulnerabilityMode": {
"description": "Sets which mode to use for vulnerability scanning.",
"enum": [
"VULNERABILITY_MODE_UNSPECIFIED",
"VULNERABILITY_DISABLED",
"VULNERABILITY_BASIC",
"VULNERABILITY_ENTERPRISE"
],
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/SecurityPostureConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

ServiceExternalIPsConfig

{
"description": "Config to block services with externalIPs field.",
"properties": {
"enabled": {
"description": "Whether Services with ExternalIPs field are allowed or not.",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/ServiceExternalIPsConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

ShieldedInstanceConfig

{
"description": "A set of Shielded Instance options.",
"properties": {
"enableIntegrityMonitoring": {
"description": "Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.",
"type": "boolean"
},
"enableSecureBoot": {
"description": "Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/ShieldedInstanceConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

ShieldedNodes

{
"description": "Configuration of Shielded Nodes feature.",
"properties": {
"enabled": {
"description": "Whether Shielded Nodes features are enabled on all nodes in this cluster.",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/ShieldedNodes",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

SoleTenantConfig

{
"description": "SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool.",
"properties": {
"nodeAffinities": {
"description": "NodeAffinities used to match to a shared sole tenant node group.",
"items": {
"$ref": "#/definitions/NodeAffinity"
},
"type": "array"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/SoleTenantConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

StandardRolloutPolicy

{
"description": "Standard rollout policy is the default policy for blue-green.",
"properties": {
"batchNodeCount": {
"description": "Number of blue nodes to drain in a batch.",
"type": "integer"
},
"batchPercentage": {
"description": "Percentage of the blue pool nodes to drain in a batch. The range of this field should be (0.0, 1.0].",
"type": "number"
},
"batchSoakDuration": {
"description": "Soak time after each batch gets drained. Default to zero.",
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/StandardRolloutPolicy",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

StatefulHAConfig

{
"description": "Configuration for the Stateful HA add-on.",
"properties": {
"enabled": {
"description": "Whether the Stateful HA add-on is enabled for this cluster.",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/StatefulHAConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

StatusCondition

{
"description": "StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).",
"properties": {
"canonicalCode": {
"description": "Canonical code of the condition.",
"enum": [
"OK",
"CANCELLED",
"UNKNOWN",
"INVALID_ARGUMENT",
"DEADLINE_EXCEEDED",
"NOT_FOUND",
"ALREADY_EXISTS",
"PERMISSION_DENIED",
"UNAUTHENTICATED",
"RESOURCE_EXHAUSTED",
"FAILED_PRECONDITION",
"ABORTED",
"OUT_OF_RANGE",
"UNIMPLEMENTED",
"INTERNAL",
"UNAVAILABLE",
"DATA_LOSS"
],
"type": "string"
},
"code": {
"deprecated": true,
"description": "Machine-friendly representation of the condition Deprecated. Use canonical_code instead.",
"enum": [
"UNKNOWN",
"GCE_STOCKOUT",
"GKE_SERVICE_ACCOUNT_DELETED",
"GCE_QUOTA_EXCEEDED",
"SET_BY_OPERATOR",
"CLOUD_KMS_KEY_ERROR",
"CA_EXPIRING"
],
"type": "string"
},
"message": {
"description": "Human-friendly representation of the condition",
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/StatusCondition",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

TimeWindow

{
"description": "Represents an arbitrary window of time.",
"properties": {
"endTime": {
"description": "The time that the window ends. The end time should take place after the start time.",
"type": "string"
},
"maintenanceExclusionOptions": {
"$ref": "#/definitions/MaintenanceExclusionOptions",
"description": "MaintenanceExclusionOptions provides maintenance exclusion related options."
},
"startTime": {
"description": "The time that the window first starts.",
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/TimeWindow",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

UpdateInfo

{
"description": "UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade.",
"properties": {
"blueGreenInfo": {
"$ref": "#/definitions/BlueGreenInfo",
"description": "Information of a blue-green upgrade."
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/UpdateInfo",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

UpgradeSettings

{
"description": "These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is ROLLING, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted.",
"properties": {
"blueGreenSettings": {
"$ref": "#/definitions/BlueGreenSettings",
"description": "Settings for blue-green upgrade strategy."
},
"maxSurge": {
"description": "The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.",
"type": "integer"
},
"maxUnavailable": {
"description": "The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.",
"type": "integer"
},
"strategy": {
"description": "Update strategy of the node pool.",
"enum": [
"NODE_POOL_UPDATE_STRATEGY_UNSPECIFIED",
"BLUE_GREEN",
"SURGE"
],
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/UpgradeSettings",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

VerticalPodAutoscaling

{
"description": "VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it.",
"properties": {
"enabled": {
"description": "Enables vertical pod autoscaling.",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/VerticalPodAutoscaling",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

VirtualNIC

{
"description": "Configuration of gVNIC feature.",
"properties": {
"enabled": {
"description": "Whether gVNIC features are enabled in the node pool.",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/VirtualNIC",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

WindowsNodeConfig

{
"description": "Parameters that can be configured on Windows nodes. Windows Node Config that define the parameters that will be used to configure the Windows node pool settings",
"properties": {
"osVersion": {
"description": "OSVersion specifies the Windows node config to be used on the node",
"enum": [
"OS_VERSION_UNSPECIFIED",
"OS_VERSION_LTSC2019",
"OS_VERSION_LTSC2022"
],
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/WindowsNodeConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

WorkloadIdentityConfig

{
"description": "Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.",
"properties": {
"workloadPool": {
"description": "The workload pool to attach all Kubernetes service accounts to.",
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/WorkloadIdentityConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

WorkloadMetadataConfig

{
"description": "WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool.",
"properties": {
"mode": {
"description": "Mode is the configuration for how to expose metadata to workloads running on the node pool.",
"enum": [
"MODE_UNSPECIFIED",
"GCE_METADATA",
"GKE_METADATA"
],
"type": "string"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/WorkloadMetadataConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

WorkloadPolicyConfig

{
"description": "WorkloadPolicyConfig is the configuration of workload policy for autopilot clusters.",
"properties": {
"allowNetAdmin": {
"description": "If true, workloads can use NET_ADMIN capability.",
"type": "boolean"
}
},
"type": "object",
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/WorkloadPolicyConfig",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

zoneCluster

{
"type": "object",
"properties": {
"name": {
"$ref": "#/definitions/clusterName"
},
"labels": {
"$ref": "gcp#/definitions/labels"
},
"resourceLabels": {
"$ref": "gcp#/definitions/labels"
},
"labelFingerprint": {
"type": "string"
},
"legacyAbac": {
"$ref": "#/definitions/clusterLegacyAbac"
},
"clusterId": {
"$ref": "#/definitions/kubernetesClusterName"
},
"status": {
"$ref": "#/definitions/kubernetesClusterStatus"
},
"addonsConfig": {
"$ref": "#/definitions/addonsConfig"
},
"databaseEncryption": {
"$ref": "#/definitions/databaseEncryption"
},
"masterAuthorizedNetworksConfig": {
"$ref": "#/definitions/masterAuthorizedNetworksConfig"
},
"loggingService": {
"$ref": "#/definitions/clusterLoggingService"
},
"monitoringService": {
"$ref": "#/definitions/clusterMonitoringService"
},
"nodePools": {
"$ref": "#/definitions/nodePools"
},
"networkPolicy": {
"$ref": "#/definitions/networkPolicy"
},
"masterAuth": {
"$ref": "#/definitions/masterAuth"
},
"ipAllocationPolicy": {
"$ref": "#/definitions/ipAllocationPolicy"
},
"nodeConfig": {
"$ref": "#/definitions/nodeConfig"
},
"podSecurityPolicyConfig": {
"$ref": "#/definitions/podSecurityPolicyConfig"
},
"privateCluster": {
"type": "boolean"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/zoneClusterAka"
}
},
"tags": {
"$ref": "gcp#/definitions/labels"
},
"title": {
"$ref": "#/definitions/clusterName"
},
"custom": {
"type": "object",
"properties": {
"gcp": {
"$ref": "gcp#/definitions/gcpMetadata"
},
"createTimestamp": {
"$ref": "turbot#/definitions/isoTimestamp"
}
}
}
}
}
},
"required": [
"name"
],
"additionalProperties": true,
"tests": [
{
"description": "Valid - All properties",
"input": {
"name": "testfunction01",
"databaseEncryption": {
"keyName": "projects/cse-legolas/locations/global/keyRings/test/cryptoKeys/disk/cryptoKeyVersions/1",
"state": "ENCRYPTED"
},
"resourceLabels": {
"foo": "bar",
"foo1": "bar1"
},
"loggingService": "none",
"monitoringService": "monitoring.googleapis.com",
"masterAuthorizedNetworksConfig": {
"enabled": true
},
"createTimestamp": "2019-03-19T03:17:06.000Z",
"status": "RUNNING",
"legacyAbac": {
"enabled": true
},
"labelFingerprint": "a9dc16a7",
"turbot": {
"akas": [
"gcp://container.googleapis.com/projects/aar-a4b6d489/zones/us-east1-b/clusters/test-zone-cluster-for-encryption"
],
"tags": {
"foo": "bar",
"dog": "woof"
},
"title": "testfunctiontesting01",
"custom": {
"createTimestamp": "2017-03-05T13:58:05.590Z",
"gcp": {
"projectId": "aar-a4b6d489",
"regionName": "us-east1",
"zoneName": "us-east1-b"
}
}
}
}
},
{
"description": "Invalid - Missing zoneCluster name",
"input": {
"clusterId": "testfunction01",
"tagsMap": {
"foo": "bar",
"foo1": "bar1"
},
"turbot": {
"akas": [
"gcp://container.googleapis.com/projects/aar-a4b6d489/zones/us-east1-b/clusters/test-zone-cluster-for-encryption"
],
"tags": {
"foo": "bar",
"dog": "woof"
},
"title": "testfunctiontesting01",
"custom": {
"createTimestamp": "2017-03-05T13:58:05.590Z",
"gcp": {
"projectId": "aar-a4b6d489",
"regionName": "us-east1",
"zoneName": "us-east1-b"
}
}
}
},
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/zoneCluster",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

zoneClusterAka

{
"type": "string",
"pattern": "^gcp://container.googleapis.com/projects/[a-z0-9-]{5,29}[a-z0-9]{1}/zones/[a-z]{2,9}-[a-z]{2,8}[0-9]-[a-z]/clusters/[a-z0-9-]{1,40}$",
"tests": [
{
"descritpion": "base case",
"input": "gcp://container.googleapis.com/projects/aar-a4b6d489/zones/us-east1-b/clusters/test-zone-cluster-for-encryption"
},
{
"description": "invalid - project ID too short",
"input": "gcp://container.googleapis.com/projects/bad//zones/us-east1-b/clusters/test-zone-cluster-for-encryption",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/zoneClusterAka",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

zoneClusterServiceNow

{
"defaultColumns": {
"project": {
"column": "enabled",
"type": "string",
"path": "metadata.gcp.projectId"
},
"region": {
"column": "enabled",
"path": "metadata.gcp.regionName"
},
"zone_cluster_name": {
"column": "enabled",
"path": "data.name",
"label": "Name"
},
"addons_config": {
"column": "enabled",
"type": "string",
"size": 1000
},
"authenticator_groups_config": {
"column": "enabled",
"type": "string",
"size": 1000
},
"autopilot_enabled": {
"column": "enabled",
"path": "data.autopilot.enabled",
"type": "boolean"
},
"autoscaling": {
"column": "enabled",
"type": "string",
"size": 1000
},
"binary_authorization": {
"column": "enabled",
"path": "data.binaryAuthorization.evaluationMode",
"type": "string",
"size": 1000
},
"create_time": {
"column": "enabled"
},
"current_master_version": {
"column": "enabled"
},
"current_node_count": {
"column": "enabled"
},
"current_node_version": {
"column": "enabled"
},
"database_encryption_state": {
"column": "enabled",
"path": "data.databaseEncryption.state"
},
"endpoint": {
"column": "enabled"
},
"initial_cluster_version": {
"column": "enabled"
},
"instance_group_urls": {
"column": "enabled",
"path": "data.instanceGroupUrls",
"label": "Instance Group URLs",
"type": "string",
"size": 1000
},
"ip_allocation_policy": {
"column": "enabled",
"label": "IP Allocation Policy",
"type": "string",
"size": 1000
},
"zone_cluster_location": {
"column": "enabled",
"label": "Location",
"path": "data.location"
},
"locations": {
"column": "enabled",
"path": "data.locations",
"type": "string",
"size": 1000
},
"network": {
"column": "enabled"
},
"network_config": {
"column": "enabled",
"type": "string",
"size": 1000
},
"node_config": {
"column": "enabled",
"type": "string",
"size": 1000
},
"node_pools": {
"column": "enabled",
"type": "string",
"size": 1000
},
"notification_config": {
"column": "enabled",
"type": "string",
"size": 1000
},
"private_cluster_config": {
"column": "enabled",
"type": "string",
"size": 1000
},
"services_ipv4_cidr": {
"column": "enabled",
"path": "data.servicesIpv4Cidr",
"label": "Services IPV4 CIDR"
},
"status": {
"column": "enabled"
},
"subnetwork": {
"column": "enabled"
},
"zone": {
"column": "enabled"
},
"labels": {
"column": "enabled",
"path": "data.resourceLabels",
"type": "string",
"size": 1000
}
},
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/zoneClusterServiceNow",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

zoneNodePool

{
"type": "object",
"properties": {
"name": {
"$ref": "#/definitions/nodePoolName"
},
"clusterId": {
"$ref": "#/definitions/clusterName"
},
"management": {
"$ref": "#/definitions/nodePoolsManagement"
},
"config": {
"$ref": "#/definitions/nodePoolsConfig"
},
"status": {
"$ref": "#/definitions/zoneNodePoolStatus"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/zoneNodePoolAka"
}
},
"title": {
"$ref": "#/definitions/nodePoolName"
},
"custom": {
"type": "object",
"properties": {
"gcp": {
"$ref": "gcp#/definitions/gcpMetadata"
},
"createTimestamp": {
"$ref": "turbot#/definitions/isoTimestamp"
}
}
}
}
}
},
"required": [
"clusterId",
"name",
"turbot"
],
"tests": [
{
"description": "Valid - All properties",
"input": {
"name": "testnodepool01",
"clusterId": "zone-cluster-test01",
"turbot": {
"akas": [
"gcp://container.googleapis.com/projects/cse-legolas-2/zones/us-east1-b/clusters/zone-cluster-test01/nodePools/testnodepool01"
],
"title": "testnodepool01",
"custom": {
"createTimestamp": "2017-03-05T13:58:05.590Z",
"gcp": {
"projectId": "cse-legolas",
"regionName": "us-east1",
"zoneName": "us-east1-b"
}
}
}
}
},
{
"description": "Invalid - Missing name",
"input": {
"clusterId": "zone-cluster-test01",
"turbot": {
"akas": [
"gcp://container.googleapis.com/projects/cse-legolas-2/zones/us-east1-b/clusters/zone-cluster-test01/nodePools/testnodepool01"
],
"title": "testnodepool01",
"custom": {
"createTimestamp": "2017-03-05T13:58:05.590Z",
"gcp": {
"projectId": "cse-legolas",
"regionName": "us-east1",
"zoneName": "us-east1-b"
}
}
}
},
"expected": false
},
{
"description": "Invalid - Missing Guardrails data",
"input": {
"name": "testnodepool01",
"clusterId": "zone-cluster-test01"
},
"expected": false
},
{
"description": "Invalid - Missing clusterId",
"input": {
"name": "testnodepool01",
"turbot": {
"akas": [
"gcp://container.googleapis.com/projects/aar-a4b6d489/zones/us-east1-b/clusters/test-zone-cluster-for-encryption"
],
"title": "testnodepool01",
"custom": {
"createTimestamp": "2017-03-05T13:58:05.590Z",
"gcp": {
"projectId": "cse-legolas",
"regionName": "us-east1",
"zoneName": "us-east1-b"
}
}
}
},
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/zoneNodePool",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

zoneNodePoolAka

{
"type": "string",
"pattern": "^gcp://container.googleapis.com/projects/[a-z0-9-]{5,29}[a-z0-9]{1}/zones/[a-z]{2,9}-[a-z]{2,8}[0-9]-[a-z]/clusters/[a-z0-9-]{1,40}/nodePools/[a-z0-9][a-z0-9-]{1,38}[a-z0-9]{1}$",
"tests": [
{
"descritpion": "base case",
"input": "gcp://container.googleapis.com/projects/cse-legolas-2/zones/us-east1-b/clusters/test-zone-cluster-for-encryption/nodePools/test01"
},
{
"description": "invalid - project ID too short",
"input": "gcp://container.googleapis.com/projects/bad//zones/us-east1-b/clusters/test-zone-cluster-for-encryption/nodePools/test01",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/zoneNodePoolAka",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

zoneNodePoolServiceNow

{
"defaultColumns": {
"project": {
"column": "enabled",
"type": "string",
"path": "metadata.gcp.projectId"
},
"region": {
"column": "enabled",
"path": "metadata.gcp.regionName"
},
"zone_node_pool_name": {
"column": "enabled",
"path": "data.name",
"label": "Name"
},
"config": {
"column": "enabled",
"type": "string",
"size": 1000
},
"initial_node_count": {
"column": "enabled"
},
"instance_group_urls": {
"column": "enabled",
"label": "Instance Group URLs",
"type": "string",
"size": 1000
},
"locations": {
"column": "enabled",
"path": "data.locations",
"type": "string",
"size": 1000
},
"management": {
"column": "enabled",
"type": "string",
"size": 1000
},
"max_pods_constraint": {
"column": "enabled",
"type": "string",
"size": 1000
},
"network_config": {
"column": "enabled"
},
"pod_ipv4_cidr_size": {
"column": "enabled",
"path": "data.podIpv4CidrSize",
"label": "Pod IPV4 CIDR Size"
},
"status": {
"column": "enabled",
"label": "Status"
},
"upgrade_settings": {
"column": "enabled",
"type": "string",
"size": 1000
},
"version": {
"column": "enabled"
},
"labels": {
"column": "enabled",
"path": "data.config.resourceLabels",
"type": "string",
"size": 1000
}
},
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/zoneNodePoolServiceNow",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}

zoneNodePoolStatus

{
"type": "string",
"enum": [
"STATUS_UNSPECIFIED",
"PROVISIONING",
"RUNNING",
"RUNNING_WITH_ERROR",
"RECONCILING",
"STOPPING",
"ERROR"
],
"tests": [
{
"input": "RUNNING"
},
{
"input": "RUNNING_WITH_ERROR"
},
{
"description": "invalid - not listed in options",
"input": "RUNNABLE",
"expected": false
},
{
"description": "invalid - null value",
"input": null,
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/gcp-kubernetesengine#/definitions/zoneNodePoolStatus",
"modUri": "tmod:@turbot/gcp-kubernetesengine"
}
}