GCPManagedControlPlane is the Schema for the gcpmanagedcontrolplanes API.
GCPManagedControlPlane is the Schema for the gcpmanagedcontrolplanes API.
object
Property | Type | Description |
---|---|---|
|
|
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 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 |
|
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
|
|
GCPManagedControlPlaneSpec defines the desired state of GCPManagedControlPlane. |
|
|
GCPManagedControlPlaneStatus defines the observed state of GCPManagedControlPlane. |
GCPManagedControlPlaneSpec defines the desired state of GCPManagedControlPlane.
object
location
project
Property | Type | Description |
---|---|---|
|
|
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 represents the control plane version of the GKE cluster. If not specified, the default version currently supported by GKE will be used. |
|
|
EnableAutopilot indicates whether to enable autopilot for this GKE cluster. |
|
|
Endpoint represents the endpoint used to communicate with the control plane. |
|
|
Location represents the location (region or zone) in which the GKE cluster will be created. |
|
|
MasterAuthorizedNetworksConfig represents configuration options for master authorized networks feature of the GKE cluster. This feature is disabled if this field is not specified. |
|
|
Project is the name of the project to deploy the cluster to. |
|
|
ReleaseChannel represents the release channel of the GKE cluster. |
Endpoint represents the endpoint used to communicate with the control plane.
object
host
port
Property | Type | Description |
---|---|---|
|
|
The hostname on which the API server is serving. |
|
|
The port on which the API server is serving. |
MasterAuthorizedNetworksConfig represents configuration options for master authorized networks feature of the GKE cluster. This feature is disabled if this field is not specified.
object
Property | Type | Description |
---|---|---|
|
|
cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS. |
|
|
MasterAuthorizedNetworksConfigCidrBlock contains an optional name and one CIDR block. |
|
|
Whether master is accessible via Google Compute Engine Public IP addresses. |
cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.
array
MasterAuthorizedNetworksConfigCidrBlock contains an optional name and one CIDR block.
object
Property | Type | Description |
---|---|---|
|
|
cidr_block must be specified in CIDR notation. |
|
|
display_name is an field for users to identify CIDR blocks. |
GCPManagedControlPlaneStatus defines the observed state of GCPManagedControlPlane.
object
ready
Property | Type | Description |
---|---|---|
|
|
Conditions specifies the conditions for the managed control plane |
|
|
Condition defines an observation of a Cluster API resource operational state. |
|
|
CurrentVersion shows the current version of the GKE control plane. |
|
|
Initialized is true when the control plane is available for initial contact. This may occur before the control plane is fully ready. |
|
|
Ready denotes that the GCPManagedControlPlane API Server is ready to receive requests. |
Conditions specifies the conditions for the managed control plane
array
Condition defines an observation of a Cluster API resource operational state.
object
lastTransitionTime
status
type
Property | Type | Description |
---|---|---|
|
|
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. |
|
|
A human readable message indicating details about the transition. This field may be empty. |
|
|
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 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 of the condition, one of True, False, Unknown. |
|
|
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. |
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
GET
list objects of kind GCPManagedControlPlane
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
DELETE
delete collection of GCPManagedControlPlane
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
GET
list objects of kind GCPManagedControlPlane
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
POST
create a GCPManagedControlPlane
Parameter | Type | Description |
---|---|---|
|
|
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 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. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized |
Empty |
Parameter | Type | Description |
---|---|---|
|
|
name of the GCPManagedControlPlane |
DELETE
delete a GCPManagedControlPlane
Parameter | Type | Description |
---|---|---|
|
|
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 |
HTTP code | Reponse body |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized |
Empty |
GET
read the specified GCPManagedControlPlane
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
PATCH
partially update the specified GCPManagedControlPlane
Parameter | Type | Description |
---|---|---|
|
|
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 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. |
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
PUT
replace the specified GCPManagedControlPlane
Parameter | Type | Description |
---|---|---|
|
|
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 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. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized |
Empty |
Parameter | Type | Description |
---|---|---|
|
|
name of the GCPManagedControlPlane |
GET
read status of the specified GCPManagedControlPlane
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
PATCH
partially update status of the specified GCPManagedControlPlane
Parameter | Type | Description |
---|---|---|
|
|
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 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. |
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
PUT
replace status of the specified GCPManagedControlPlane
Parameter | Type | Description |
---|---|---|
|
|
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 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. |
Parameter | Type | Description |
---|---|---|
|
|
HTTP code | Reponse body |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized |
Empty |