GCPClusterTemplate is the Schema for the gcpclustertemplates API.
GCPClusterTemplate is the Schema for the gcpclustertemplates 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 |
|
|
|
GCPClusterTemplateSpec defines the desired state of GCPClusterTemplate. |
GCPClusterTemplateSpec defines the desired state of GCPClusterTemplate.
object
template
Property | Type | Description |
---|---|---|
|
|
GCPClusterTemplateResource contains spec for GCPClusterSpec. |
GCPClusterTemplateResource contains spec for GCPClusterSpec.
object
spec
Property | Type | Description |
---|---|---|
|
|
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
|
GCPClusterSpec defines the desired state of GCPCluster. |
Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
object
Property | Type | Description |
---|---|---|
|
|
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations |
|
|
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels |
GCPClusterSpec defines the desired state of GCPCluster.
object
project
region
Property | Type | Description |
---|---|---|
|
|
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 represents the endpoint used to communicate with the control plane. |
|
|
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 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 contains configuration for one or more LoadBalancers. |
|
|
NetworkSpec encapsulates all things related to GCP network. |
|
|
Project is the name of the project to deploy the cluster to. |
|
|
The GCP Region the cluster lives in. |
|
|
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. |
|
|
ResourceManagerTag is a tag to apply to GCP resources managed by the GCP provider. |
ControlPlaneEndpoint 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. |
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.
object
name
namespace
Property | Type | Description |
---|---|---|
|
|
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
LoadBalancer contains configuration for one or more LoadBalancers.
object
Property | Type | Description |
---|---|---|
|
|
APIServerInstanceGroupTagOverride overrides the default setting for the tag used when creating the API Server Instance Group. |
|
|
InternalLoadBalancer is the configuration for an Internal Passthrough Network Load Balancer. |
|
|
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. |
InternalLoadBalancer is the configuration for an Internal Passthrough Network Load Balancer.
object
Property | Type | Description |
---|---|---|
|
|
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 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. |
NetworkSpec encapsulates all things related to GCP network.
object
Property | Type | Description |
---|---|---|
|
|
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 is the name of the project hosting the shared VPC network resources. |
|
|
Allow for configuration of load balancer backend (useful for changing apiserver port) |
|
|
Name is the name of the network to be used. |
|
|
Subnets configuration. |
|
|
SubnetSpec configures an GCP Subnet. |
SubnetSpec configures an GCP Subnet.
object
Property | Type | Description |
---|---|---|
|
|
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 is an optional description associated with the resource. |
|
|
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 defines a unique identifier to reference this resource. |
|
|
PrivateGoogleAccess defines whether VMs in this subnet can access Google services without assigning external IP addresses |
|
|
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 is the name of the region where the Subnetwork resides. |
|
|
SecondaryCidrBlocks defines secondary CIDR ranges, from which secondary IP ranges of a VM may be allocated |
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.
array
ResourceManagerTag is a tag to apply to GCP resources managed by the GCP provider.
object
key
parentID
value
Property | Type | Description |
---|---|---|
|
|
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 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 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 |
The following API endpoints are available:
/apis/infrastructure.cluster.x-k8s.io/v1beta1/gcpclustertemplates
GET
: list objects of kind GCPClusterTemplate
/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/gcpclustertemplates
DELETE
: delete collection of GCPClusterTemplate
GET
: list objects of kind GCPClusterTemplate
POST
: create a GCPClusterTemplate
/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/gcpclustertemplates/{name}
DELETE
: delete a GCPClusterTemplate
GET
: read the specified GCPClusterTemplate
PATCH
: partially update the specified GCPClusterTemplate
PUT
: replace the specified GCPClusterTemplate
GET
list objects of kind GCPClusterTemplate
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
DELETE
delete collection of GCPClusterTemplate
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
GET
list objects of kind GCPClusterTemplate
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
POST
create a GCPClusterTemplate
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 GCPClusterTemplate |
DELETE
delete a GCPClusterTemplate
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 GCPClusterTemplate
HTTP code | Reponse body |
---|---|
200 - OK |
|
401 - Unauthorized |
Empty |
PATCH
partially update the specified GCPClusterTemplate
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 GCPClusterTemplate
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 |