SpannerInstance

Property	Value
Google Cloud Service Name	Cloud Spanner
Google Cloud Service Documentation	/spanner/docs/
Google Cloud REST Resource Name	v1.projects.instances
Google Cloud REST Resource Documentation	/spanner/docs/reference/rest/v1/projects.instances
Config Connector Resource Short Names	gcpspannerinstance gcpspannerinstances spannerinstance
Config Connector Service Name	spanner.googleapis.com
Config Connector Resource Fully Qualified Name	spannerinstances.spanner.cnrm.cloud.google.com
Can Be Referenced by IAMPolicy/IAMPolicyMember	Yes
Supports IAM Conditions	No
Supports IAM Audit Configs	No
IAM External Reference Format	projects/{{project}}/instances/{{name}}
Config Connector Default Average Reconcile Interval In Seconds	600

Custom Resource Definition Properties

Annotations

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

Spec

Schema

autoscalingConfig:
  autoscalingLimits:
    maxNodes: integer
    maxProcessingUnits: integer
    minNodes: integer
    minProcessingUnits: integer
  autoscalingTargets:
    highPriorityCpuUtilizationPercent: integer
    storageUtilizationPercent: integer
config: string
defaultBackupScheduleType: string
displayName: string
edition: string
labels:
  string: string
numNodes: integer
processingUnits: integer
resourceID: string

Fields

Fields
`autoscalingConfig` Optional	`object` Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance.
`autoscalingConfig.autoscalingLimits` Optional	`object` Required. Autoscaling limits for an instance.
`autoscalingConfig.autoscalingLimits.maxNodes` Optional	`integer` Maximum number of nodes allocated to the instance. If set, this number should be greater than or equal to min_nodes.
`autoscalingConfig.autoscalingLimits.maxProcessingUnits` Optional	`integer` Maximum number of processing units allocated to the instance. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units.
`autoscalingConfig.autoscalingLimits.minNodes` Optional	`integer` Minimum number of nodes allocated to the instance. If set, this number should be greater than or equal to 1.
`autoscalingConfig.autoscalingLimits.minProcessingUnits` Optional	`integer` Minimum number of processing units allocated to the instance. If set, this number should be multiples of 1000.
`autoscalingConfig.autoscalingTargets` Optional	`object` Required. The autoscaling targets for an instance.
`autoscalingConfig.autoscalingTargets.highPriorityCpuUtilizationPercent` Optional	`integer` Required. The target high priority cpu utilization percentage that the autoscaler should be trying to achieve for the instance. This number is on a scale from 0 (no utilization) to 100 (full utilization). The valid range is [10, 90] inclusive.
`autoscalingConfig.autoscalingTargets.storageUtilizationPercent` Optional	`integer` Required. The target storage utilization percentage that the autoscaler should be trying to achieve for the instance. This number is on a scale from 0 (no utilization) to 100 (full utilization). The valid range is [10, 100] inclusive.
`config` Required	`string` Immutable. The name of the instance's configuration (similar but not quite the same as a region) which defines the geographic placement and replication of your databases in this instance. It determines where your data is stored. Values are typically of the form 'regional-europe-west1' , 'us-central' etc. In order to obtain a valid list please consult the [Configuration section of the docs](https://cloud.google.com/spanner/docs/instances).
`defaultBackupScheduleType` Optional	`string` Optional. Controls the default backup schedule behavior for new databases within the instance. By default, a backup schedule is created automatically when a new database is created in a new instance. Note that the `AUTOMATIC` value isn't permitted for free instances, as backups and backup schedules aren't supported for free instances. In the `GetInstance` or `ListInstances` response, if the value of `default_backup_schedule_type` isn't set, or set to `NONE`, Spanner doesn't create a default backup schedule for new databases in the instance.
`displayName` Required	`string` The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
`edition` Optional	`string` Optional. The `Edition` of the current instance. Currently accepted values are STANDARD, ENTERPRISE, ENTERPRISE_PLUS. If edition is unspecified, it has automatically upgraded to the lowest edition that matches your usage pattern.
`labels` Optional	`map (key: string, value: string)` Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.). - Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z][a-z0-9_-]{0,62}`. - Label values must be between 0 and 63 characters long and must conform to the regular expression `[a-z0-9_-]{0,63}`. - No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. And so you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "_" + value would prove problematic if we were to allow "_" in a future release.
`numNodes` Optional	`integer`
`processingUnits` Optional	`integer`
`resourceID` Optional	`string` The SpannerInstance name. If not given, the metadata.name will be used.

autoscalingConfig

Optional

object

Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance.

autoscalingConfig.autoscalingLimits

Optional

object

Required. Autoscaling limits for an instance.

autoscalingConfig.autoscalingLimits.maxNodes

Optional

integer

Maximum number of nodes allocated to the instance. If set, this number should be greater than or equal to min_nodes.

autoscalingConfig.autoscalingLimits.maxProcessingUnits

Optional

integer

Maximum number of processing units allocated to the instance. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units.

autoscalingConfig.autoscalingLimits.minNodes

Optional

integer

Minimum number of nodes allocated to the instance. If set, this number should be greater than or equal to 1.

autoscalingConfig.autoscalingLimits.minProcessingUnits

Optional

integer

Minimum number of processing units allocated to the instance. If set, this number should be multiples of 1000.

autoscalingConfig.autoscalingTargets

Optional

object

Required. The autoscaling targets for an instance.

autoscalingConfig.autoscalingTargets.highPriorityCpuUtilizationPercent

Optional

integer

Required. The target high priority cpu utilization percentage that the autoscaler should be trying to achieve for the instance. This number is on a scale from 0 (no utilization) to 100 (full utilization). The valid range is [10, 90] inclusive.

autoscalingConfig.autoscalingTargets.storageUtilizationPercent

Optional

integer

Required. The target storage utilization percentage that the autoscaler should be trying to achieve for the instance. This number is on a scale from 0 (no utilization) to 100 (full utilization). The valid range is [10, 100] inclusive.

config

Required

string

Immutable. The name of the instance's configuration (similar but not quite the same as a region) which defines the geographic placement and replication of your databases in this instance. It determines where your data is stored. Values are typically of the form 'regional-europe-west1' , 'us-central' etc. In order to obtain a valid list please consult the [Configuration section of the docs](https://cloud.google.com/spanner/docs/instances).

defaultBackupScheduleType

Optional

string

Optional. Controls the default backup schedule behavior for new databases within the instance. By default, a backup schedule is created automatically when a new database is created in a new instance. Note that the `AUTOMATIC` value isn't permitted for free instances, as backups and backup schedules aren't supported for free instances. In the `GetInstance` or `ListInstances` response, if the value of `default_backup_schedule_type` isn't set, or set to `NONE`, Spanner doesn't create a default backup schedule for new databases in the instance.

displayName

Required

string

The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.

edition

Optional

string

Optional. The `Edition` of the current instance. Currently accepted values are STANDARD, ENTERPRISE, ENTERPRISE_PLUS. If edition is unspecified, it has automatically upgraded to the lowest edition that matches your usage pattern.

labels

Optional

map (key: string, value: string)

Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.). - Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z][a-z0-9_-]{0,62}`. - Label values must be between 0 and 63 characters long and must conform to the regular expression `[a-z0-9_-]{0,63}`. - No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. And so you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "_" + value would prove problematic if we were to allow "_" in a future release.

numNodes

Optional

integer

processingUnits

Optional

integer

resourceID

Optional

string

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

Status

Schema

conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
externalRef: string
observedGeneration: integer
observedState:
  numNodes: integer
  processingUnits: integer
state: string

Fields
`conditions`	`list (object)` Conditions represent the latest available observations of the SpannerInstance'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.
`externalRef`	`string` A unique specifier for the SpannerInstance resource in GCP.
`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.
`observedState`	`object` ObservedState is the state of the resource as most recently observed in GCP.
`observedState.numNodes`	`integer` NumNodes and ProcessUnits is output fields with AutoScaler is set.
`observedState.processingUnits`	`integer`
`state`	`string` Instance status: 'CREATING' or 'READY'.

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: spanner.cnrm.cloud.google.com/v1beta1
kind: SpannerInstance
metadata:
  labels:
    label-one: "value-one"
  name: spannerinstance-sample
spec:
  config: regional-us-west1
  displayName: Spanner Instance Sample
  numNodes: 2