RedisInstance
| Property | Value |
|---|---|
| Google Cloud Service Name | Cloud Memorystore for Redis |
| Google Cloud Service Documentation | /memorystore/docs/redis/ |
| Google Cloud REST Resource Name | v1.projects.locations.instances |
| Google Cloud REST Resource Documentation | /memorystore/docs/redis/reference/rest/v1/projects.locations.instances |
| Config Connector Resource Short Names | gcpredisinstance gcpredisinstances redisinstance |
| Config Connector Service Name | redis.googleapis.com |
| Config Connector Resource Fully Qualified Name | redisinstances.redis.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
alternativeLocationId: string
authEnabled: boolean
authString: string
authorizedNetworkRef:
external: string
name: string
namespace: string
connectMode: string
customerManagedKeyRef:
external: string
name: string
namespace: string
displayName: string
locationId: string
maintenancePolicy:
createTime: string
description: string
updateTime: string
weeklyMaintenanceWindow:
- day: string
duration: string
startTime:
hours: integer
minutes: integer
nanos: integer
seconds: integer
maintenanceSchedule:
- endTime: string
scheduleDeadlineTime: string
startTime: string
memorySizeGb: integer
persistenceConfig:
persistenceMode: string
rdbNextSnapshotTime: string
rdbSnapshotPeriod: string
rdbSnapshotStartTime: string
readReplicasMode: string
redisConfigs:
string: string
redisVersion: string
region: string
replicaCount: integer
reservedIpRange: string
resourceID: string
secondaryIpRange: string
tier: string
transitEncryptionMode: string
| Fields | |
|---|---|
|
Optional |
Immutable. Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones. If provided, it must be a different zone from the one provided in [locationId]. |
|
Optional |
Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to "true" AUTH is enabled on the instance. Default value is "false" meaning AUTH is disabled. |
|
Optional |
Output only. AUTH String set on the instance. This field will only be populated if auth_enabled is true. |
|
Optional |
The network to which the instance is connected. If left unspecified, the default network will be used. |
|
Optional |
Allowed value: The `selfLink` field of a `ComputeNetwork` resource. |
|
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
Optional |
Immutable. The connection mode of the Redis instance. Default value: "DIRECT_PEERING" Possible values: ["DIRECT_PEERING", "PRIVATE_SERVICE_ACCESS"]. |
|
Optional |
Immutable. Optional. The KMS key reference that you want to use to encrypt the data at rest for this Redis instance. If this is provided, CMEK is enabled. |
|
Optional |
Allowed value: The `selfLink` field of a `KMSCryptoKey` resource. |
|
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
Optional |
An arbitrary and optional user-provided name for the instance. |
|
Optional |
Immutable. The zone where the instance will be provisioned. If not provided, the service will choose a zone for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures. If [alternativeLocationId] is also provided, it must be different from [locationId]. |
|
Optional |
Maintenance policy for an instance. |
|
Optional |
Output only. The time when the policy was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. |
|
Optional |
Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512. |
|
Optional |
Output only. The time when the policy was last updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. |
|
Optional |
Optional. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_window is expected to be one. |
|
Optional |
|
|
Required* |
Required. The day of week that maintenance updates occur. - DAY_OF_WEEK_UNSPECIFIED: The day of the week is unspecified. - MONDAY: Monday - TUESDAY: Tuesday - WEDNESDAY: Wednesday - THURSDAY: Thursday - FRIDAY: Friday - SATURDAY: Saturday - SUNDAY: Sunday Possible values: ["DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"]. |
|
Optional |
Output only. Duration of the maintenance window. The current window is fixed at 1 hour. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". |
|
Required* |
Required. Start time of the window in UTC time. |
|
Optional |
Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
|
Optional |
Minutes of hour of day. Must be from 0 to 59. |
|
Optional |
Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
|
Optional |
Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
|
Optional |
Upcoming maintenance schedule. |
|
Optional |
|
|
Optional |
Output only. The end time of any upcoming scheduled maintenance for this instance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. |
|
Optional |
Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. |
|
Optional |
Output only. The start time of any upcoming scheduled maintenance for this instance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. |
|
Required |
Redis memory size in GiB. |
|
Optional |
Persistence configuration for an instance. |
|
Optional |
Optional. Controls whether Persistence features are enabled. If not provided, the existing value will be used. - DISABLED: Persistence is disabled for the instance, and any existing snapshots are deleted. - RDB: RDB based Persistence is enabled. Possible values: ["DISABLED", "RDB"]. |
|
Optional |
Output only. The next time that a snapshot attempt is scheduled to occur. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z". |
|
Optional |
Optional. Available snapshot periods for scheduling. - ONE_HOUR: Snapshot every 1 hour. - SIX_HOURS: Snapshot every 6 hours. - TWELVE_HOURS: Snapshot every 12 hours. - TWENTY_FOUR_HOURS: Snapshot every 24 hours. Possible values: ["ONE_HOUR", "SIX_HOURS", "TWELVE_HOURS", "TWENTY_FOUR_HOURS"]. |
|
Optional |
Optional. Date and time that the first snapshot was/will be attempted, and to which future snapshots will be aligned. If not provided, the current time will be used. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z". |
|
Optional |
Optional. Read replica mode. Can only be specified when trying to create the instance. If not set, Memorystore Redis backend will default to READ_REPLICAS_DISABLED. - READ_REPLICAS_DISABLED: If disabled, read endpoint will not be provided and the instance cannot scale up or down the number of replicas. - READ_REPLICAS_ENABLED: If enabled, read endpoint will be provided and the instance can scale up and down the number of replicas. Possible values: ["READ_REPLICAS_DISABLED", "READ_REPLICAS_ENABLED"]. |
|
Optional |
Redis configuration parameters, according to http://redis.io/topics/config. Please check Memorystore documentation for the list of supported parameters: https://cloud.google.com/memorystore/docs/redis/reference/rest/v1/projects.locations.instances#Instance.FIELDS.redis_configs. |
|
Optional |
The version of Redis software. If not provided, latest supported version will be used. Please check the API documentation linked at the top for the latest valid values. |
|
Required |
Immutable. The name of the Redis region of the instance. |
|
Optional |
Optional. The number of replica nodes. The valid range for the Standard Tier with read replicas enabled is [1-5] and defaults to 2. If read replicas are not enabled for a Standard Tier instance, the only valid value is 1 and the default is 1. The valid value for basic tier is 0 and the default is also 0. |
|
Optional |
Immutable. The CIDR range of internal addresses that are reserved for this instance. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique and non-overlapping with existing subnets in an authorized network. |
|
Optional |
Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default. |
|
Optional |
Optional. Additional IP range for node placement. Required when enabling read replicas on an existing instance. For DIRECT_PEERING mode value must be a CIDR range of size /28, or "auto". For PRIVATE_SERVICE_ACCESS mode value must be the name of an allocated address range associated with the private service access connection, or "auto". |
|
Optional |
Immutable. The service tier of the instance. Must be one of these values: - BASIC: standalone instance - STANDARD_HA: highly available primary/replica instances Default value: "BASIC" Possible values: ["BASIC", "STANDARD_HA"]. |
|
Optional |
Immutable. The TLS mode of the Redis instance, If not provided, TLS is disabled for the instance. - SERVER_AUTHENTICATION: Client to Server traffic encryption enabled with server authentication Default value: "DISABLED" Possible values: ["SERVER_AUTHENTICATION", "DISABLED"]. |
* Field is required when parent field is specified
Status
Schema
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
createTime: string
currentLocationId: string
host: string
maintenanceSchedule:
- endTime: string
scheduleDeadlineTime: string
startTime: string
nodes:
- id: string
zone: string
observedGeneration: integer
observedState:
authString: string
persistenceIamIdentity: string
port: integer
readEndpoint: string
readEndpointPort: integer
serverCaCerts:
- cert: string
createTime: string
expireTime: string
serialNumber: string
sha1Fingerprint: string
| Fields | |
|---|---|
conditions |
Conditions represent the latest available observation of the resource'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. |
createTime |
The time the instance was created in RFC3339 UTC "Zulu" format, accurate to nanoseconds. |
currentLocationId |
The current zone where the Redis endpoint is placed. For Basic Tier instances, this will always be the same as the [locationId] provided by the user at creation time. For Standard Tier instances, this can be either [locationId] or [alternativeLocationId] and can change after a failover event. |
host |
Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service. |
maintenanceSchedule |
Upcoming maintenance schedule. |
maintenanceSchedule[] |
|
maintenanceSchedule[].endTime |
Output only. The end time of any upcoming scheduled maintenance for this instance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. |
maintenanceSchedule[].scheduleDeadlineTime |
Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. |
maintenanceSchedule[].startTime |
Output only. The start time of any upcoming scheduled maintenance for this instance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. |
nodes |
Output only. Info per node. |
nodes[] |
|
nodes[].id |
Node identifying string. e.g. 'node-0', 'node-1'. |
nodes[].zone |
Location of the node. |
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 |
The observed state of the underlying GCP resource. |
observedState.authString |
Output only. AUTH String set on the instance. This field will only be populated if auth_enabled is true. |
persistenceIamIdentity |
Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:". The value may change over time for a given instance so should be checked before each import/export operation. |
port |
The port number of the exposed Redis endpoint. |
readEndpoint |
Output only. Hostname or IP address of the exposed readonly Redis endpoint. Standard tier only. Targets all healthy replica nodes in instance. Replication is asynchronous and replica nodes will exhibit some lag behind the primary. Write requests must target 'host'. |
readEndpointPort |
Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'. |
serverCaCerts |
List of server CA certificates for the instance. |
serverCaCerts[] |
|
serverCaCerts[].cert |
The certificate data in PEM format. |
serverCaCerts[].createTime |
The time when the certificate was created. |
serverCaCerts[].expireTime |
The time when the certificate expires. |
serverCaCerts[].serialNumber |
Serial number, as extracted from the certificate. |
serverCaCerts[].sha1Fingerprint |
Sha1 Fingerprint of the certificate. |
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: redis.cnrm.cloud.google.com/v1beta1
kind: RedisInstance
metadata:
labels:
label-one: "value-one"
name: redisinstance-sample
spec:
displayName: Sample Redis Instance
region: us-central1
tier: BASIC
memorySizeGb: 16