GCPCluster [infrastructure.cluster.x-k8s.io/v1beta1]

additionalLabels

object (string)

AdditionalLabels is an optional set of tags to add to GCP resources managed by the GCP provider, in addition to the ones added by default.

controlPlaneEndpoint

object

ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.

credentialsRef

object

CredentialsRef is a reference to a Secret that contains the credentials to use for provisioning this cluster. If not supplied then the credentials of the controller will be used.

failureDomains

array (string)

FailureDomains is an optional field which is used to assign selected availability zones to a cluster FailureDomains if empty, defaults to all the zones in the selected region and if specified would override the default zones.

loadBalancer

object

LoadBalancer contains configuration for one or more LoadBalancers.

network

object

NetworkSpec encapsulates all things related to GCP network.

project

string

Project is the name of the project to deploy the cluster to.

region

string

The GCP Region the cluster lives in.

resourceManagerTags

array

ResourceManagerTags is an optional set of tags to apply to GCP resources managed by the GCP provider. GCP supports a maximum of 50 tags per resource.

resourceManagerTags[]

object

ResourceManagerTag is a tag to apply to GCP resources managed by the GCP provider.

host

string

The hostname on which the API server is serving.

port

integer

The port on which the API server is serving.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespace

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

apiServerInstanceGroupTagOverride

string

APIServerInstanceGroupTagOverride overrides the default setting for the tag used when creating the API Server Instance Group.

internalLoadBalancer

object

InternalLoadBalancer is the configuration for an Internal Passthrough Network Load Balancer.

loadBalancerType

string

LoadBalancerType defines the type of Load Balancer that should be created. If not set, a Global External Proxy Load Balancer will be created by default.

name

string

Name is the name of the Load Balancer. If not set a default name will be used. For an Internal Load Balancer service the default name is "api-internal".

subnet

string

Subnet is the name of the subnet to use for a regional Load Balancer. A subnet is required for the Load Balancer, if not defined the first configured subnet will be used.

autoCreateSubnetworks

boolean

AutoCreateSubnetworks: When set to true, the VPC network is created in "auto" mode. When set to false, the VPC network is created in "custom" mode.

An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges.

Defaults to true.

hostProject

string

HostProject is the name of the project hosting the shared VPC network resources.

loadBalancerBackendPort

integer

Allow for configuration of load balancer backend (useful for changing apiserver port)

name

string

Name is the name of the network to be used.

subnets

array

Subnets configuration.

subnets[]

object

SubnetSpec configures an GCP Subnet.

cidrBlock

string

CidrBlock is the range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field can be set only at resource creation time.

description

string

Description is an optional description associated with the resource.

enableFlowLogs

boolean

EnableFlowLogs: Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is to disable flow logging.

name

string

Name defines a unique identifier to reference this resource.

privateGoogleAccess

boolean

PrivateGoogleAccess defines whether VMs in this subnet can access Google services without assigning external IP addresses

purpose

string

Purpose: The purpose of the resource. If unspecified, the purpose defaults to PRIVATE_RFC_1918. The enableFlowLogs field isn’t supported with the purpose field set to INTERNAL_HTTPS_LOAD_BALANCER.

Possible values: "INTERNAL_HTTPS_LOAD_BALANCER" - Subnet reserved for Internal HTTP(S) Load Balancing. "PRIVATE" - Regular user created or automatically created subnet. "PRIVATE_RFC_1918" - Regular user created or automatically created subnet. "PRIVATE_SERVICE_CONNECT" - Subnetworks created for Private Service Connect in the producer network. "REGIONAL_MANAGED_PROXY" - Subnetwork used for Regional Internal/External HTTP(S) Load Balancing.

region

string

Region is the name of the region where the Subnetwork resides.

secondaryCidrBlocks

object (string)

SecondaryCidrBlocks defines secondary CIDR ranges, from which secondary IP ranges of a VM may be allocated

key

string

Key is the key part of the tag. A tag key can have a maximum of 63 characters and cannot be empty. Tag key must begin and end with an alphanumeric character, and must contain only uppercase, lowercase alphanumeric characters, and the following special characters ._-.

parentID

string

ParentID is the ID of the hierarchical resource where the tags are defined e.g. at the Organization or the Project level. To find the Organization or Project ID ref https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects An OrganizationID must consist of decimal numbers, and cannot have leading zeroes. A ProjectID must be 6 to 30 characters in length, can only contain lowercase letters, numbers, and hyphens, and must start with a letter, and cannot end with a hyphen.

value

string

Value is the value part of the tag. A tag value can have a maximum of 63 characters and cannot be empty. Tag value must begin and end with an alphanumeric character, and must contain only uppercase, lowercase alphanumeric characters, and the following special characters _-.@%=+:,*#&(){}[] and spaces.

failureDomains

object

FailureDomains is a slice of FailureDomains.

failureDomains{}

object

FailureDomainSpec is the Schema for Cluster API failure domains. It allows controllers to understand how many failure domains a cluster can optionally span across.

network

object

Network encapsulates GCP networking resources.

ready

boolean

Bastion Instance json:"bastion,omitempty"

attributes

object (string)

Attributes is a free form map of attributes an infrastructure provider might use or require.

controlPlane

boolean

ControlPlane determines if this failure domain is suitable for use by control plane machines.

apiInternalBackendService

string

APIInternalBackendService is the full reference to the backend service created for the internal Load Balancer.

apiInternalForwardingRule

string

APIInternalForwardingRule is the full reference to the forwarding rule created for the internal Load Balancer.

apiInternalHealthCheck

string

APIInternalHealthCheck is the full reference to the health check created for the internal Load Balancer.

apiInternalIpAddress

string

APIInternalAddress is the IPV4 regional address assigned to the internal Load Balancer.

apiServerBackendService

string

APIServerBackendService is the full reference to the backend service created for the API Server.

apiServerForwardingRule

string

APIServerForwardingRule is the full reference to the forwarding rule created for the API Server.

apiServerHealthCheck

string

APIServerHealthCheck is the full reference to the health check created for the API Server.

apiServerInstanceGroups

object (string)

APIServerInstanceGroups is a map from zone to the full reference to the instance groups created for the control plane nodes created in the same zone.

apiServerIpAddress

string

APIServerAddress is the IPV4 global address assigned to the load balancer created for the API Server.

apiServerTargetProxy

string

APIServerTargetProxy is the full reference to the target proxy created for the API Server.

firewallRules

object (string)

FirewallRules is a map from the name of the rule to its full reference.

router

string

Router is the full reference to the router created within the network it’ll contain the cloud nat gateway

selfLink

string

SelfLink is the link to the Network used for this cluster.

200 - OK

GCPClusterList schema

401 - Unauthorized

Empty

200 - OK

Status schema

401 - Unauthorized

Empty

200 - OK

GCPClusterList schema

401 - Unauthorized

Empty

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

body

GCPCluster schema

200 - OK

GCPCluster schema

201 - Created

GCPCluster schema

202 - Accepted

GCPCluster schema

401 - Unauthorized

Empty

name

string

name of the GCPCluster

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

200 - OK

GCPCluster schema

401 - Unauthorized

Empty

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

200 - OK

GCPCluster schema

401 - Unauthorized

Empty

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

body

GCPCluster schema

200 - OK

GCPCluster schema

201 - Created

GCPCluster schema

401 - Unauthorized

Empty

name

string

name of the GCPCluster

200 - OK

GCPCluster schema

401 - Unauthorized

Empty

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

200 - OK

GCPCluster schema

401 - Unauthorized

Empty

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

body

GCPCluster schema

200 - OK

GCPCluster schema

201 - Created

GCPCluster schema

401 - Unauthorized

Empty