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
config: string
displayName: string
numNodes: integer
processingUnits: integer
resourceID: string
Fields | |
---|---|
Required |
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). |
Required |
The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length. |
Optional |
|
Optional |
|
Optional |
Immutable. 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: {}
state: string
Fields | |
---|---|
conditions |
Conditions represent the latest available observations of the SpannerInstance's current state. |
conditions[] |
|
conditions[].lastTransitionTime |
Last time the condition transitioned from one status to another. |
conditions[].message |
Human-readable message indicating details about last transition. |
conditions[].reason |
Unique, one-word, CamelCase reason for the condition's last transition. |
conditions[].status |
Status is the status of the condition. Can be True, False, Unknown. |
conditions[].type |
Type is the type of the condition. |
externalRef |
A unique specifier for the SpannerInstance resource in GCP. |
observedGeneration |
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 |
ObservedState is the state of the resource as most recently observed in GCP. |
state |
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