×

Specification

Property Type Description

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

GCPManagedControlPlaneSpec defines the desired state of GCPManagedControlPlane.

status

object

GCPManagedControlPlaneStatus defines the observed state of GCPManagedControlPlane.

.spec

Description

GCPManagedControlPlaneSpec defines the desired state of GCPManagedControlPlane.

Type

object

Required
  • location

  • project

Property Type Description

clusterName

string

ClusterName allows you to specify the name of the GKE cluster. If you don’t specify a name then a default name will be created based on the namespace and name of the managed control plane.

controlPlaneVersion

string

ControlPlaneVersion represents the control plane version of the GKE cluster. If not specified, the default version currently supported by GKE will be used.

enableAutopilot

boolean

EnableAutopilot indicates whether to enable autopilot for this GKE cluster.

endpoint

object

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

location

string

Location represents the location (region or zone) in which the GKE cluster will be created.

master_authorized_networks_config

object

MasterAuthorizedNetworksConfig represents configuration options for master authorized networks feature of the GKE cluster. This feature is disabled if this field is not specified.

project

string

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

releaseChannel

string

ReleaseChannel represents the release channel of the GKE cluster.

.spec.endpoint

Description

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

Type

object

Required
  • host

  • port

Property Type Description

host

string

The hostname on which the API server is serving.

port

integer

The port on which the API server is serving.

.spec.master_authorized_networks_config

Description

MasterAuthorizedNetworksConfig represents configuration options for master authorized networks feature of the GKE cluster. This feature is disabled if this field is not specified.

Type

object

Property Type Description

cidr_blocks

array

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

cidr_blocks[]

object

MasterAuthorizedNetworksConfigCidrBlock contains an optional name and one CIDR block.

gcp_public_cidrs_access_enabled

boolean

Whether master is accessible via Google Compute Engine Public IP addresses.

.spec.master_authorized_networks_config.cidr_blocks

Description

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

Type

array

.spec.master_authorized_networks_config.cidr_blocks[]

Description

MasterAuthorizedNetworksConfigCidrBlock contains an optional name and one CIDR block.

Type

object

Property Type Description

cidr_block

string

cidr_block must be specified in CIDR notation.

display_name

string

display_name is an field for users to identify CIDR blocks.

.status

Description

GCPManagedControlPlaneStatus defines the observed state of GCPManagedControlPlane.

Type

object

Required
  • ready

Property Type Description

conditions

array

Conditions specifies the conditions for the managed control plane

conditions[]

object

Condition defines an observation of a Cluster API resource operational state.

currentVersion

string

CurrentVersion shows the current version of the GKE control plane.

initialized

boolean

Initialized is true when the control plane is available for initial contact. This may occur before the control plane is fully ready.

ready

boolean

Ready denotes that the GCPManagedControlPlane API Server is ready to receive requests.

.status.conditions

Description

Conditions specifies the conditions for the managed control plane

Type

array

.status.conditions[]

Description

Condition defines an observation of a Cluster API resource operational state.

Type

object

Required
  • lastTransitionTime

  • status

  • type

Property Type Description

lastTransitionTime

string

Last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

message

string

A human readable message indicating details about the transition. This field may be empty.

reason

string

The reason for the condition’s last transition in CamelCase. The specific API may choose whether or not this field is considered a guaranteed API. This field may not be empty.

severity

string

Severity provides an explicit classification of Reason code, so the users or machines can immediately understand the current situation and act accordingly. The Severity field MUST be set only when Status=False.

status

string

Status of the condition, one of True, False, Unknown.

type

string

Type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important.

API endpoints

The following API endpoints are available:

  • /apis/infrastructure.cluster.x-k8s.io/v1beta1/gcpmanagedcontrolplanes

    • GET: list objects of kind GCPManagedControlPlane

  • /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/gcpmanagedcontrolplanes

    • DELETE: delete collection of GCPManagedControlPlane

    • GET: list objects of kind GCPManagedControlPlane

    • POST: create a GCPManagedControlPlane

  • /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/gcpmanagedcontrolplanes/{name}

    • DELETE: delete a GCPManagedControlPlane

    • GET: read the specified GCPManagedControlPlane

    • PATCH: partially update the specified GCPManagedControlPlane

    • PUT: replace the specified GCPManagedControlPlane

  • /apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/gcpmanagedcontrolplanes/{name}/status

    • GET: read status of the specified GCPManagedControlPlane

    • PATCH: partially update status of the specified GCPManagedControlPlane

    • PUT: replace status of the specified GCPManagedControlPlane

/apis/infrastructure.cluster.x-k8s.io/v1beta1/gcpmanagedcontrolplanes

HTTP method

GET

Description

list objects of kind GCPManagedControlPlane

Table 1. HTTP responses
HTTP code Reponse body

200 - OK

GCPManagedControlPlaneList schema

401 - Unauthorized

Empty

/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/gcpmanagedcontrolplanes

HTTP method

DELETE

Description

delete collection of GCPManagedControlPlane

Table 2. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method

GET

Description

list objects of kind GCPManagedControlPlane

Table 3. HTTP responses
HTTP code Reponse body

200 - OK

GCPManagedControlPlaneList schema

401 - Unauthorized

Empty

HTTP method

POST

Description

create a GCPManagedControlPlane

Table 4. Query parameters
Parameter Type Description

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.

Table 5. Body parameters
Parameter Type Description

body

GCPManagedControlPlane schema

Table 6. HTTP responses
HTTP code Reponse body

200 - OK

GCPManagedControlPlane schema

201 - Created

GCPManagedControlPlane schema

202 - Accepted

GCPManagedControlPlane schema

401 - Unauthorized

Empty

/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/gcpmanagedcontrolplanes/{name}

Table 7. Global path parameters
Parameter Type Description

name

string

name of the GCPManagedControlPlane

HTTP method

DELETE

Description

delete a GCPManagedControlPlane

Table 8. Query parameters
Parameter Type Description

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

Table 9. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method

GET

Description

read the specified GCPManagedControlPlane

Table 10. HTTP responses
HTTP code Reponse body

200 - OK

GCPManagedControlPlane schema

401 - Unauthorized

Empty

HTTP method

PATCH

Description

partially update the specified GCPManagedControlPlane

Table 11. Query parameters
Parameter Type Description

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.

Table 12. HTTP responses
HTTP code Reponse body

200 - OK

GCPManagedControlPlane schema

401 - Unauthorized

Empty

HTTP method

PUT

Description

replace the specified GCPManagedControlPlane

Table 13. Query parameters
Parameter Type Description

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.

Table 14. Body parameters
Parameter Type Description

body

GCPManagedControlPlane schema

Table 15. HTTP responses
HTTP code Reponse body

200 - OK

GCPManagedControlPlane schema

201 - Created

GCPManagedControlPlane schema

401 - Unauthorized

Empty

/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/gcpmanagedcontrolplanes/{name}/status

Table 16. Global path parameters
Parameter Type Description

name

string

name of the GCPManagedControlPlane

HTTP method

GET

Description

read status of the specified GCPManagedControlPlane

Table 17. HTTP responses
HTTP code Reponse body

200 - OK

GCPManagedControlPlane schema

401 - Unauthorized

Empty

HTTP method

PATCH

Description

partially update status of the specified GCPManagedControlPlane

Table 18. Query parameters
Parameter Type Description

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.

Table 19. HTTP responses
HTTP code Reponse body

200 - OK

GCPManagedControlPlane schema

401 - Unauthorized

Empty

HTTP method

PUT

Description

replace status of the specified GCPManagedControlPlane

Table 20. Query parameters
Parameter Type Description

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.

Table 21. Body parameters
Parameter Type Description

body

GCPManagedControlPlane schema

Table 22. HTTP responses
HTTP code Reponse body

200 - OK

GCPManagedControlPlane schema

201 - Created

GCPManagedControlPlane schema

401 - Unauthorized

Empty