×

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

GCPManagedMachinePoolSpec defines the desired state of GCPManagedMachinePool.

status

object

GCPManagedMachinePoolStatus defines the observed state of GCPManagedMachinePool.

.spec

Description

GCPManagedMachinePoolSpec defines the desired state of GCPManagedMachinePool.

Type

object

Property Type Description

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.

diskSizeGB

integer

DiskSizeGB is size of the disk attached to each node, specified in GB.

diskSizeGb

integer

DiskSizeGb is the 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.

diskType

string

DiskType is type of the disk attached to each node.

imageType

string

ImageType is image type to use for this nodepool.

instanceType

string

InstanceType is name of Compute Engine machine type.

kubernetesLabels

object (string)

KubernetesLabels specifies the labels to apply to the nodes of the node pool.

kubernetesTaints

array

KubernetesTaints specifies the taints to apply to the nodes of the node pool.

kubernetesTaints[]

object

Taint represents a Kubernetes taint.

linuxNodeConfig

object

LinuxNodeConfig specifies the settings for Linux agent nodes.

localSsdCount

integer

LocalSsdCount is the number of local SSD disks to be attached to the node.

machineType

string

MachineType is 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.

management

object

Management specifies the node pool management options.

maxPodsPerNode

integer

MaxPodsPerNode is constraint enforced on the max num of pods per node.

nodeLocations

array (string)

NodeLocations is the list of zones in which the NodePool’s nodes should be located.

nodeNetwork

object

NodeNetwork specifies the node network configuration options.

nodePoolName

string

NodePoolName specifies the name of the GKE node pool corresponding to this MachinePool. If you don’t specify a name then a default name will be created based on the namespace and name of the managed machine pool.

nodeSecurity

object

NodeSecurity specifies the node security options.

providerIDList

array (string)

ProviderIDList are the provider IDs of instances in the managed instance group corresponding to the nodegroup represented by this machine pool

scaling

object

Scaling specifies scaling for the node pool

.spec.kubernetesTaints

Description

KubernetesTaints specifies the taints to apply to the nodes of the node pool.

Type

array

.spec.kubernetesTaints[]

Description

Taint represents a Kubernetes taint.

Type

object

Required
  • effect

  • key

  • value

Property Type Description

effect

string

Effect specifies the effect for the taint.

key

string

Key is the key of the taint

value

string

Value is the value of the taint

.spec.linuxNodeConfig

Description

LinuxNodeConfig specifies the settings for Linux agent nodes.

Type

object

Property Type Description

cgroupMode

integer

CgroupMode specifies the cgroup mode for this node pool.

sysctls

array

Sysctls specifies the sysctl settings for this node pool.

sysctls[]

object

SysctlConfig specifies the sysctl settings for Linux nodes.

.spec.linuxNodeConfig.sysctls

Description

Sysctls specifies the sysctl settings for this node pool.

Type

array

.spec.linuxNodeConfig.sysctls[]

Description

SysctlConfig specifies the sysctl settings for Linux nodes.

Type

object

Property Type Description

parameter

string

Parameter specifies sysctl parameter name.

value

string

Value specifies sysctl parameter value.

.spec.management

Description

Management specifies the node pool management options.

Type

object

Property Type Description

autoRepair

boolean

AutoRepair 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.

autoUpgrade

boolean

AutoUpgrade 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.

.spec.nodeNetwork

Description

NodeNetwork specifies the node network configuration options.

Type

object

Property Type Description

createPodRange

boolean

CreatePodRange specifies whether to create a new range for pod IPs in this node pool.

podRangeCidrBlock

string

PodRangeCidrBlock is the IP address range for pod IPs in this node pool.

podRangeName

string

PodRangeName is ID of the secondary range for pod IPs.

tags

array (string)

Tags is list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls.

.spec.nodeSecurity

Description

NodeSecurity specifies the node security options.

Type

object

Property Type Description

enableIntegrityMonitoring

boolean

EnableIntegrityMonitoring defines whether the instance has integrity monitoring enabled.

enableSecureBoot

boolean

EnableSecureBoot defines whether the instance has Secure Boot enabled.

sandboxType

string

SandboxType is type of the sandbox to use for the node.

serviceAccount

object

ServiceAccount specifies the identity details for node pool.

.spec.nodeSecurity.serviceAccount

Description

ServiceAccount specifies the identity details for node pool.

Type

object

Property Type Description

email

string

Email is the Google Cloud Platform Service Account to be used by the node VMs.

scopes

array (string)

Scopes is a set of Google API scopes to be made available on all of the node VMs under the "default" service account.

.spec.scaling

Description

Scaling specifies scaling for the node pool

Type

object

Property Type Description

enableAutoscaling

boolean

Is autoscaling enabled for this node pool. If unspecified, the default value is true.

locationPolicy

string

Location policy used when scaling up a nodepool.

maxCount

integer

MaxCount specifies the maximum number of nodes in the node pool

minCount

integer

MinCount specifies the minimum number of nodes in the node pool

.status

Description

GCPManagedMachinePoolStatus defines the observed state of GCPManagedMachinePool.

Type

object

Required
  • ready

Property Type Description

conditions

array

Conditions specifies the cpnditions for the managed machine pool

conditions[]

object

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

ready

boolean

Ready denotes that the GCPManagedMachinePool has joined the cluster

replicas

integer

Replicas is the most recently observed number of replicas.

.status.conditions

Description

Conditions specifies the cpnditions for the managed machine pool

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/gcpmanagedmachinepools

    • GET: list objects of kind GCPManagedMachinePool

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

    • DELETE: delete collection of GCPManagedMachinePool

    • GET: list objects of kind GCPManagedMachinePool

    • POST: create a GCPManagedMachinePool

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

    • DELETE: delete a GCPManagedMachinePool

    • GET: read the specified GCPManagedMachinePool

    • PATCH: partially update the specified GCPManagedMachinePool

    • PUT: replace the specified GCPManagedMachinePool

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

    • GET: read status of the specified GCPManagedMachinePool

    • PATCH: partially update status of the specified GCPManagedMachinePool

    • PUT: replace status of the specified GCPManagedMachinePool

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

HTTP method

GET

Description

list objects of kind GCPManagedMachinePool

Table 1. HTTP responses
HTTP code Reponse body

200 - OK

GCPManagedMachinePoolList schema

401 - Unauthorized

Empty

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

HTTP method

DELETE

Description

delete collection of GCPManagedMachinePool

Table 2. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method

GET

Description

list objects of kind GCPManagedMachinePool

Table 3. HTTP responses
HTTP code Reponse body

200 - OK

GCPManagedMachinePoolList schema

401 - Unauthorized

Empty

HTTP method

POST

Description

create a GCPManagedMachinePool

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

GCPManagedMachinePool schema

Table 6. HTTP responses
HTTP code Reponse body

200 - OK

GCPManagedMachinePool schema

201 - Created

GCPManagedMachinePool schema

202 - Accepted

GCPManagedMachinePool schema

401 - Unauthorized

Empty

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

Table 7. Global path parameters
Parameter Type Description

name

string

name of the GCPManagedMachinePool

HTTP method

DELETE

Description

delete a GCPManagedMachinePool

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 GCPManagedMachinePool

Table 10. HTTP responses
HTTP code Reponse body

200 - OK

GCPManagedMachinePool schema

401 - Unauthorized

Empty

HTTP method

PATCH

Description

partially update the specified GCPManagedMachinePool

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

GCPManagedMachinePool schema

401 - Unauthorized

Empty

HTTP method

PUT

Description

replace the specified GCPManagedMachinePool

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

GCPManagedMachinePool schema

Table 15. HTTP responses
HTTP code Reponse body

200 - OK

GCPManagedMachinePool schema

201 - Created

GCPManagedMachinePool schema

401 - Unauthorized

Empty

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

Table 16. Global path parameters
Parameter Type Description

name

string

name of the GCPManagedMachinePool

HTTP method

GET

Description

read status of the specified GCPManagedMachinePool

Table 17. HTTP responses
HTTP code Reponse body

200 - OK

GCPManagedMachinePool schema

401 - Unauthorized

Empty

HTTP method

PATCH

Description

partially update status of the specified GCPManagedMachinePool

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

GCPManagedMachinePool schema

401 - Unauthorized

Empty

HTTP method

PUT

Description

replace status of the specified GCPManagedMachinePool

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

GCPManagedMachinePool schema

Table 22. HTTP responses
HTTP code Reponse body

200 - OK

GCPManagedMachinePool schema

201 - Created

GCPManagedMachinePool schema

401 - Unauthorized

Empty