BigtableInstance

Property	Value
Google Cloud Service Name	Cloud Bigtable
Google Cloud Service Documentation	/bigtable/docs/
Google Cloud REST Resource Name	bigtableadmin/v2/projects.instances
Google Cloud REST Resource Documentation	/bigtable/docs/reference/admin/rest/v2/projects.instances
Config Connector Resource Short Names	gcpbigtableinstance gcpbigtableinstances bigtableinstance
Config Connector Service Name	bigtableadmin.googleapis.com
Config Connector Resource Fully Qualified Name	bigtableinstances.bigtable.cnrm.cloud.google.com
Can Be Referenced by IAMPolicy/IAMPolicyMember	Yes
Supports IAM Conditions	Yes
Supports IAM Audit Configs	No
IAM External Reference Format	projects/{{project}}/instances/{{name}}
Config Connector Default Average Reconcile Interval In Seconds	3600

Custom Resource Definition Properties

Annotations

Fields
`cnrm.cloud.google.com/project-id`

Spec

Schema

  cluster 
 : 
 - 
  
 autoscalingConfig 
 : 
  
 cpuTarget 
 : 
  
 integer 
  
 maxNodes 
 : 
  
 integer 
  
 minNodes 
 : 
  
 integer 
  
 storageTarget 
 : 
  
 integer 
  
 clusterId 
 : 
  
 string 
  
 kmsKeyRef 
 : 
  
 external 
 : 
  
 string 
  
 name 
 : 
  
 string 
  
 namespace 
 : 
  
 string 
  
 numNodes 
 : 
  
 integer 
  
 storageType 
 : 
  
 string 
  
 zone 
 : 
  
 string 
 deletionProtection 
 : 
  
 boolean 
 displayName 
 : 
  
 string 
 instanceType 
 : 
  
 string 
 resourceID 
 : 
  
 string

Fields

Fields
`cluster` Optional	`list (object)` A block of cluster configuration options. This can be specified at least once.
`cluster[]` Optional	`object`
`cluster[].autoscalingConfig` Optional	`object` A list of Autoscaling configurations. Only one element is used and allowed.
`cluster[].autoscalingConfig.cpuTarget` Required*	`integer` The target CPU utilization for autoscaling. Value must be between 10 and 80.
`cluster[].autoscalingConfig.maxNodes` Required*	`integer` The maximum number of nodes for autoscaling.
`cluster[].autoscalingConfig.minNodes` Required*	`integer` The minimum number of nodes for autoscaling.
`cluster[].autoscalingConfig.storageTarget` Optional	`integer` The target storage utilization for autoscaling, in GB, for each node in a cluster. This number is limited between 2560 (2.5TiB) and 5120 (5TiB) for a SSD cluster and between 8192 (8TiB) and 16384 (16 TiB) for an HDD cluster. If not set, whatever is already set for the cluster will not change, or if the cluster is just being created, it will use the default value of 2560 for SSD clusters and 8192 for HDD clusters.
`cluster[].clusterId` Required*	`string` The ID of the Cloud Bigtable cluster. Must be 6-30 characters and must only contain hyphens, lowercase letters and numbers.
`cluster[].kmsKeyRef` Optional	`object` Describes the Cloud KMS encryption key that will be used to protect the destination Bigtable cluster. The requirements for this key are: 1) The Cloud Bigtable service account associated with the project that contains this cluster must be granted the cloudkms.cryptoKeyEncrypterDecrypter role on the CMEK key. 2) Only regional keys can be used and the region of the CMEK key must match the region of the cluster. 3) All clusters within an instance must use the same CMEK key access to this encryption key.
`cluster[].kmsKeyRef.external` Optional	`string` A reference to an externally managed KMSCryptoKey. Should be in the format `projects/[kms_project_id]/locations/[region]/keyRings/[key_ring_id]/cryptoKeys/[key]`.
`cluster[].kmsKeyRef.name` Optional	`string` The `name` of a `KMSCryptoKey` resource.
`cluster[].kmsKeyRef.namespace` Optional	`string` The `namespace` of a `KMSCryptoKey` resource.
`cluster[].numNodes` Optional	`integer` The number of nodes in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.
`cluster[].storageType` Optional	`string` The storage type to use. One of "SSD" or "HDD". Defaults to "SSD".
`cluster[].zone` Required*	`string` The zone to create the Cloud Bigtable cluster in. Each cluster must have a different zone in the same region. Zones that support Bigtable instances are noted on the Cloud Bigtable locations page.
`deletionProtection` Optional	`boolean` DEPRECATED. This field no longer serves any function and is intended to be dropped in a later version of the resource.
`displayName` Optional	`string` Required. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.
`instanceType` Optional	`string` DEPRECATED. It is recommended to leave this field unspecified since the distinction between "DEVELOPMENT" and "PRODUCTION" instances is going away, and all instances will become "PRODUCTION" instances. This means that new and existing "DEVELOPMENT" instances will be converted to "PRODUCTION" instances. It is recommended for users to use "PRODUCTION" instances in any case, since a 1-node "PRODUCTION" instance is functionally identical to a "DEVELOPMENT" instance, but without the accompanying restrictions. The instance type to create. One of "DEVELOPMENT" or "PRODUCTION". Defaults to "PRODUCTION".
`resourceID` Optional	`string` The Instance name. If not given, the metadata.name will be used.

cluster

Optional

list (object)

A block of cluster configuration options. This can be specified at least once.

cluster[]

Optional

object

cluster[].autoscalingConfig

Optional

object

A list of Autoscaling configurations. Only one element is used and allowed.

cluster[].autoscalingConfig.cpuTarget

Required*

integer

The target CPU utilization for autoscaling. Value must be between 10 and 80.

cluster[].autoscalingConfig.maxNodes

Required*

integer

The maximum number of nodes for autoscaling.

cluster[].autoscalingConfig.minNodes

Required*

integer

The minimum number of nodes for autoscaling.

cluster[].autoscalingConfig.storageTarget

Optional

integer

The target storage utilization for autoscaling, in GB, for each node in a cluster. This number is limited between 2560 (2.5TiB) and 5120 (5TiB) for a SSD cluster and between 8192 (8TiB) and 16384 (16 TiB) for an HDD cluster. If not set, whatever is already set for the cluster will not change, or if the cluster is just being created, it will use the default value of 2560 for SSD clusters and 8192 for HDD clusters.

cluster[].clusterId

Required*

string

The ID of the Cloud Bigtable cluster. Must be 6-30 characters and must only contain hyphens, lowercase letters and numbers.

cluster[].kmsKeyRef

Optional

object

Describes the Cloud KMS encryption key that will be used to protect the destination Bigtable cluster. The requirements for this key are: 1) The Cloud Bigtable service account associated with the project that contains this cluster must be granted the cloudkms.cryptoKeyEncrypterDecrypter role on the CMEK key. 2) Only regional keys can be used and the region of the CMEK key must match the region of the cluster. 3) All clusters within an instance must use the same CMEK key access to this encryption key.

cluster[].kmsKeyRef.external

Optional

string

A reference to an externally managed KMSCryptoKey. Should be in the format `projects/[kms_project_id]/locations/[region]/keyRings/[key_ring_id]/cryptoKeys/[key]`.

cluster[].kmsKeyRef.name

Optional

string

The `name` of a `KMSCryptoKey` resource.

cluster[].kmsKeyRef.namespace

Optional

string

The `namespace` of a `KMSCryptoKey` resource.

cluster[].numNodes

Optional

integer

The number of nodes in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.

cluster[].storageType

Optional

string

The storage type to use. One of "SSD" or "HDD". Defaults to "SSD".

cluster[].zone

Required*

string

The zone to create the Cloud Bigtable cluster in. Each cluster must have a different zone in the same region. Zones that support Bigtable instances are noted on the Cloud Bigtable locations page.

deletionProtection

Optional

boolean

DEPRECATED. This field no longer serves any function and is intended to be dropped in a later version of the resource.

displayName

Optional

string

Required. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.

instanceType

Optional

string

DEPRECATED. It is recommended to leave this field unspecified since the distinction between "DEVELOPMENT" and "PRODUCTION" instances is going away, and all instances will become "PRODUCTION" instances. This means that new and existing "DEVELOPMENT" instances will be converted to "PRODUCTION" instances. It is recommended for users to use "PRODUCTION" instances in any case, since a 1-node "PRODUCTION" instance is functionally identical to a "DEVELOPMENT" instance, but without the accompanying restrictions. The instance type to create. One of "DEVELOPMENT" or "PRODUCTION". Defaults to "PRODUCTION".

resourceID

Optional

string

The Instance name. If not given, the metadata.name will be used.

* Field is required when parent field is specified

Status

Schema

  conditions 
 : 
 - 
  
 lastTransitionTime 
 : 
  
 string 
  
 message 
 : 
  
 string 
  
 reason 
 : 
  
 string 
  
 status 
 : 
  
 string 
  
 type 
 : 
  
 string 
 observedGeneration 
 : 
  
 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.

Sample YAML(s)

Auto Scaling

  # 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 
 : 
  
 bigtable.cnrm.cloud.google.com/v1beta1 
 kind 
 : 
  
 BigtableInstance 
 metadata 
 : 
  
 name 
 : 
  
 bigtableinstance-sample 
 spec 
 : 
  
 displayName 
 : 
  
 BigtableSample 
  
 cluster 
 : 
  
 - 
  
 clusterId 
 : 
  
 bigtableinstance-dep1 
  
 zone 
 : 
  
 us-central1-a 
  
 autoscalingConfig 
 : 
  
 cpuTarget 
 : 
  
 60 
  
 maxNodes 
 : 
  
 3 
  
 minNodes 
 : 
  
 1

Replicated Instance

  # 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 
 : 
  
 bigtable.cnrm.cloud.google.com/v1beta1 
 kind 
 : 
  
 BigtableInstance 
 metadata 
 : 
  
 name 
 : 
  
 bigtableinstance-sample 
 spec 
 : 
  
 displayName 
 : 
  
 BigtableSample 
  
 cluster 
 : 
  
 - 
  
 clusterId 
 : 
  
 bigtableinstance-dep1 
  
 zone 
 : 
  
 us-central1-a 
  
 numNodes 
 : 
  
 3 
  
 - 
  
 clusterId 
 : 
  
 bigtableinstance-dep2 
  
 zone 
 : 
  
 us-west1-a 
  
 numNodes 
 : 
  
 3

Simple Instance

  # 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 
 : 
  
 bigtable.cnrm.cloud.google.com/v1beta1 
 kind 
 : 
  
 BigtableInstance 
 metadata 
 : 
  
 name 
 : 
  
 bigtableinstance-sample 
 spec 
 : 
  
 displayName 
 : 
  
 BigtableSample 
  
 cluster 
 : 
  
 - 
  
 clusterId 
 : 
  
 bigtableinstance-dep1 
  
 zone 
 : 
  
 us-central1-a 
  
 numNodes 
 : 
  
 3