GCPInstanceClass
Scope: Cluster
Parameters of a group of GCP Instances used by machine-controller-manager (the node-manager module).
The CloudInstanceClass resource of the node-manager module refers to this resource.
- objectspec
Required value
- objectspec.additionalLabels
Additional labels.
Example:
additionalLabels: project: cms-production severity: critical - array of strings
The list of additional tags.
For example, you can use tags to apply firewall rules to instances. The detailed description of network tags is available in the official documentation.
- objectspec.capacityDeprecated
Deprecated: the parameter is no longer used. Deckhouse is using parameters from the cloud for passed instance type.
Instance capacity for non-standard instance types (the
machineTypeparameter).Cluster-autoscaler uses the parameter for scheduling only when there are no nodes in NodeGroup yet (if
minPerZoneequal to 0). If there are already nodes in the NodeGroup, then cluster-autoscaler uses the actual node capacity (CPU, memory) when planning, and does not use thecapacityparameter.The parameter must be specified only for non-standard instance types. Info about the capacity of standard instance types (
a2-highgpu-8g,c2-standard-8, etc.) is embedded in Deckhouse.- integer or stringspec.capacity.cpu
Required value
Node vCPU resources.
Pattern:
^[0-9]+m?$Example:
cpu: 1000m - integer or stringspec.capacity.memory
Required value
Node memory resources.
Pattern:
^[0-9]+(\.[0-9]+)?(E|P|T|G|M|k|Ei|Pi|Ti|Gi|Mi|Ki)?$Example:
memory: 1500Mi
- booleanspec.disableExternalIP
Defines whether to disable external ip for an instance or not. True means that an instance is created without external ip
- integerspec.diskSizeGb
Instance’s root disk size in gibibytes.
Default:
50Example:
diskSizeGb: 20 - stringspec.diskType
Instance’s disk type.
Default:
pd-standardAllowed values:
pd-standard,pd-ssdExample:
diskType: pd-ssd - stringspec.image
Not required value.
Image to use while provisioning GCP servers.
You can find a list of available images in the provider documentation.
The list of OS and their versions supported by Deckhouse can be found in the Deckhouse documentation (take into account the Deckhouse version used).
Example:
image: https://www.googleapis.com/compute/v1/projects/ubuntu-os-cloud/global/images/ubuntu-2404-noble-amd64-v20250313 - stringspec.machineType
Required value
Machine type of GCP instance.
Caution! Make sure that this type is present in all zones specified in the
zonesparameter.GCP lets you specify a custom amount of resources (CPU and RAM), e.g.,
custom-8-40960orn2-custom-8-40960.Example:
machineType: n1-standard-4 - booleanspec.preemptible
Should instances be preemptible.
Default:
false
Parameters of a group of GCP Instances used by machine-controller-manager (the node-manager module).
The CloudInstanceClass resource of the node-manager module refers to this resource.
- objectspec
Required value
- objectspec.additionalLabels
Additional labels.
Example:
additionalLabels: project: cms-production severity: critical - array of strings
The list of additional tags.
For example, you can use tags to apply firewall rules to instances. The detailed description of network tags is available in the official documentation.
- objectspec.capacityDeprecated
Deprecated: the parameter is no longer used. Deckhouse is using parameters from the cloud for passed instance type.
Instance capacity for non-standard instance types (the
machineTypeparameter).Cluster-autoscaler uses the parameter for scheduling only when there are no nodes in NodeGroup yet (if
minPerZoneequal to 0). If there are already nodes in the NodeGroup, then cluster-autoscaler uses the actual node capacity (CPU, memory) when planning, and does not use thecapacityparameter.The parameter must be specified only for non-standard instance types. Info about the capacity of standard instance types (
a2-highgpu-8g,c2-standard-8, etc.) is embedded in Deckhouse.- integer or stringspec.capacity.cpu
Required value
Node vCPU resources.
Pattern:
^[0-9]+m?$Example:
cpu: 1000m - integer or stringspec.capacity.memory
Required value
Node memory resources.
Pattern:
^[0-9]+(\.[0-9]+)?(E|P|T|G|M|k|Ei|Pi|Ti|Gi|Mi|Ki)?$Example:
memory: 1500Mi
- booleanspec.disableExternalIP
Defines whether to disable external ip for an instance or not. True means that an instance is created without external ip
- integerspec.diskSizeGb
Instance’s root disk size in gibibytes.
Default:
50Example:
diskSizeGb: 20 - stringspec.diskType
Instance’s disk type.
Default:
pd-standardAllowed values:
pd-standard,pd-ssdExample:
diskType: pd-ssd - stringspec.image
Not required value.
Image to use while provisioning GCP servers.
You can find a list of available images in the provider documentation.
The list of OS and their versions supported by Deckhouse can be found in the Deckhouse documentation (take into account the Deckhouse version used).
Example:
image: https://www.googleapis.com/compute/v1/projects/ubuntu-os-cloud/global/images/ubuntu-2404-noble-amd64-v20250313 - stringspec.machineType
Required value
Machine type of GCP instance.
Caution! Make sure that this type is present in all zones specified in the
zonesparameter.GCP lets you specify a custom amount of resources (CPU and RAM), e.g.,
custom-8-40960orn2-custom-8-40960.Example:
machineType: n1-standard-4 - booleanspec.preemptible
Should instances be preemptible.
Default:
false