ComputeNodeGroup


Property Value
Google Cloud Service Name Compute Engine
Google Cloud Service Documentation /compute/docs/
Google Cloud REST Resource Name v1.nodeGroups
Google Cloud REST Resource Documentation /compute/docs/reference/rest/v1/nodeGroups
Config Connector Resource Short Names gcpcomputenodegroup
gcpcomputenodegroups
computenodegroup
Config Connector Service Name compute.googleapis.com
Config Connector Resource Fully Qualified Name computenodegroups.compute.cnrm.cloud.google.com
Can Be Referenced by IAMPolicy/IAMPolicyMember No
Config Connector Default Average Reconcile Interval In Seconds 600

Custom Resource Definition Properties

Annotations

Fields
cnrm.cloud.google.com/project-id
cnrm.cloud.google.com/state-into-spec

Spec

Schema

autoscalingPolicy:
  maxNodes: integer
  minNodes: integer
  mode: string
description: string
initialSize: integer
maintenancePolicy: string
maintenanceWindow:
  startTime: string
nodeTemplateRef:
  external: string
  name: string
  namespace: string
resourceID: string
shareSettings:
  projectMap:
  - idRef:
      external: string
      name: string
      namespace: string
    projectIdRef:
      external: string
      name: string
      namespace: string
  shareType: string
size: integer
zone: string
Fields

autoscalingPolicy

Optional

object

Immutable. If you use sole-tenant nodes for your workloads, you can use the node group autoscaler to automatically manage the sizes of your node groups.

autoscalingPolicy.maxNodes

Optional

integer

Immutable. Maximum size of the node group. Set to a value less than or equal to 100 and greater than or equal to min-nodes.

autoscalingPolicy.minNodes

Optional

integer

Immutable. Minimum size of the node group. Must be less than or equal to max-nodes. The default value is 0.

autoscalingPolicy.mode

Optional

string

Immutable. The autoscaling mode. Set to one of the following: - OFF: Disables the autoscaler. - ON: Enables scaling in and scaling out. - ONLY_SCALE_OUT: Enables only scaling out. You must use this mode if your node groups are configured to restart their hosted VMs on minimal servers. Possible values: ["OFF", "ON", "ONLY_SCALE_OUT"].

description

Optional

string

Immutable. An optional textual description of the resource.

initialSize

Optional

integer

Immutable. The initial number of nodes in the node group. One of 'initial_size' or 'size' must be specified.

maintenancePolicy

Optional

string

Immutable. Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT.

maintenanceWindow

Optional

object

Immutable. contains properties for the timeframe of maintenance.

maintenanceWindow.startTime

Required*

string

Immutable. instances.start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.

nodeTemplateRef

Required

object

The node template to which this node group belongs.

nodeTemplateRef.external

Optional

string

Allowed value: The `selfLink` field of a `ComputeNodeTemplate` resource.

nodeTemplateRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

nodeTemplateRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceID

Optional

string

Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default.

shareSettings

Optional

object

Immutable. Share settings for the node group.

shareSettings.projectMap

Optional

list (object)

Immutable. A map of project id and project config. This is only valid when shareType's value is SPECIFIC_PROJECTS.

shareSettings.projectMap[]

Optional

object

shareSettings.projectMap[].idRef

Required*

object

The key of this project config in the parent map.

shareSettings.projectMap[].idRef.external

Optional

string

Allowed value: The `name` field of a `Project` resource.

shareSettings.projectMap[].idRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

shareSettings.projectMap[].idRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

shareSettings.projectMap[].projectIdRef

Required*

object

The project id/number should be the same as the key of this project config in the project map.

shareSettings.projectMap[].projectIdRef.external

Optional

string

Allowed value: The `name` field of a `Project` resource.

shareSettings.projectMap[].projectIdRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

shareSettings.projectMap[].projectIdRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

shareSettings.shareType

Required*

string

Immutable. Node group sharing type. Possible values: ["ORGANIZATION", "SPECIFIC_PROJECTS", "LOCAL"].

size

Optional

integer

Immutable. The total number of nodes in the node group. One of 'initial_size' or 'size' must be specified.

zone

Required

string

Immutable. Zone where this node group is located.

* Field is required when parent field is specified

Status

Schema

conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
creationTimestamp: string
observedGeneration: integer
selfLink: string
Fields
conditions

list (object)

Conditions represent the latest available observation of the resource's current state.

conditions[]

object

conditions[].lastTransitionTime

string

Last time the condition transitioned from one status to another.

conditions[].message

string

Human-readable message indicating details about last transition.

conditions[].reason

string

Unique, one-word, CamelCase reason for the condition's last transition.

conditions[].status

string

Status is the status of the condition. Can be True, False, Unknown.

conditions[].type

string

Type is the type of the condition.

creationTimestamp

string

Creation timestamp in RFC3339 text format.

observedGeneration

integer

ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource.

selfLink

string

Sample YAML(s)

Typical Use Case

# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeNodeGroup
metadata:
  name: computenodegroup-sample
spec:
  description: A single sole-tenant node in the us-central1-b zone.
  size: 1
  nodeTemplateRef:
    name: computenodegroup-dep
  zone: us-central1-b
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeNodeTemplate
metadata:
  name: computenodegroup-dep
spec:
  region: us-central1
  nodeType: n1-node-96-624