ComputeInstanceGroup

Property	Value
Google Cloud Service Name	Compute Engine
Google Cloud Service Documentation	/compute/docs/
Google Cloud REST Resource Name	v1.instances
Google Cloud REST Resource Documentation	/compute/docs/reference/rest/v1/instanceGroups
Config Connector Resource Short Names	computeinstancegroup gcpcomputeinstancegroup gcpcomputeinstancegroups
Config Connector Service Name	compute.googleapis.com
Config Connector Resource Fully Qualified Name	computeinstancegroups.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

Spec

Schema

description: string
instances:
- external: string
  name: string
  namespace: string
namedPort:
- name: string
  port: integer
networkRef:
  external: string
  name: string
  namespace: string
resourceID: string
zone: string

Fields
description Optional	string Immutable. An optional textual description of the instance group.
instances Optional	list (object)
instances[] Optional	object InstanceRef is a reference to a ComputeInstance.
instances[].external Optional	string A reference to an externally managed ComputeInstance resource. Should be in the format "projects/{{projectID}}/zones/{{zone}}/instances/{{instanceID}}".
instances[].name Optional	string The name of a ComputeInstance resource.
instances[].namespace Optional	string The namespace of a ComputeInstance resource.
namedPort Optional	list (object) The named port configuration.
namedPort[] Optional	object
namedPort[].name Required*	string The name which the port will be mapped to.
namedPort[].port Required*	integer The port number to map the name to.
networkRef Optional	object ComputeNetworkRef is a reference to a Google Cloud ComputeNetwork.
networkRef.external Optional	string A reference to an externally managed ComputeNetwork resource. Should be in the format "projects/{{projectID}}/global/networks/{{networkID}}".
networkRef.name Optional	string The name of a ComputeNetwork resource.
networkRef.namespace Optional	string The namespace of a ComputeNetwork resource.
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.
zone Required	string Immutable. The zone that this instance group should be created in.

* Field is required when parent field is specified

Status

Schema

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

Fields
conditions	list (object) Conditions represent the latest available observations of the object'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.
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 The URI of the created resource.
size	integer The number of instances in the group.

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: ComputeInstanceGroup
metadata:
  name: computeinstancegroup-sample
spec:
  description: Compute instance group with two specified instances and named http and https ports.
  instances:
  - name: computeinstancegroup-dep1
  - name: computeinstancegroup-dep2
  namedPort:
  - name: http
    port: 8080
  - name: https
    port: 8443
  zone: us-central1-a
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeInstance
metadata:
  name: computeinstancegroup-dep1
spec:
  zone: us-central1-a
  instanceTemplateRef:
    name: computeinstancegroup-dep
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeInstance
metadata:
  name: computeinstancegroup-dep2
spec:
  zone: us-central1-a
  instanceTemplateRef:
    name: computeinstancegroup-dep
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeInstanceTemplate
metadata:
  name: computeinstancegroup-dep
spec:
  machineType: n1-standard-1
  disk:
    - sourceImageRef:
        external: debian-cloud/debian-11
      boot: true
  networkInterface:
    - networkRef:
        name: computeinstancegroup-dep
      subnetworkRef:
        name: computeinstancegroup-dep
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeNetwork
metadata:
  name: computeinstancegroup-dep
spec:
  autoCreateSubnetworks: false
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeSubnetwork
metadata:
  name: computeinstancegroup-dep
spec:
  ipCidrRange: 10.2.0.0/16
  region: us-central1
  networkRef:
    name: computeinstancegroup-dep

Note: If you have any trouble with instantiating the resource, refer to Troubleshoot Config Connector.