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 No
IAM External Reference Format

projects/{{project}}/instances/{{name}}

Custom Resource Definition Properties

Annotations

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

Spec

Schema

cluster:
- clusterId: string
  numNodes: integer
  storageType: string
  zone: string
deletionProtection: boolean
displayName: string
instanceType: string
Fields

cluster

Optional

list (object)

cluster.[]

Optional

object

cluster.[].clusterId

Required*

string

The ID of the Cloud Bigtable cluster.

cluster.[].numNodes

Optional

integer

The number of nodes in your Cloud Bigtable cluster. Required, with a minimum of 1 for a PRODUCTION instance. Must be left unset for a DEVELOPMENT instance.

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

The human-readable display name of the Bigtable instance. Defaults to the instance name.

instanceType

Optional

string

The instance type to create. One of "DEVELOPMENT" or "PRODUCTION". Defaults to "PRODUCTION".

* Field is required when parent field is specified

Status

Schema

conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
Fields
conditions

list (object)

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.

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