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

alternativeLocationId

Optional

string

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].

authEnabled

Optional

boolean

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.

authString

Optional

string

Output only. AUTH String set on the instance. This field will only be populated if auth_enabled is true.

authorizedNetworkRef

Optional

object

The network to which the instance is connected. If left unspecified, the default network will be used.

authorizedNetworkRef.external

Optional

string

Allowed value: The `selfLink` field of a `ComputeNetwork` resource.

authorizedNetworkRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

authorizedNetworkRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

connectMode

Optional

string

Immutable. The connection mode of the Redis instance. Default value: "DIRECT_PEERING" Possible values: ["DIRECT_PEERING", "PRIVATE_SERVICE_ACCESS"].

customerManagedKeyRef

Optional

object

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.

customerManagedKeyRef.external

Optional

string

Allowed value: The `selfLink` field of a `KMSCryptoKey` resource.

customerManagedKeyRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

customerManagedKeyRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

displayName

Optional

string

An arbitrary and optional user-provided name for the instance.

locationId

Optional

string

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].

maintenancePolicy

Optional

object

Maintenance policy for an instance.

maintenancePolicy.createTime

Optional

string

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.

maintenancePolicy.description

Optional

string

Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.

maintenancePolicy.updateTime

Optional

string

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.

maintenancePolicy.weeklyMaintenanceWindow

Optional

list (object)

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.

maintenancePolicy.weeklyMaintenanceWindow[]

Optional

object

maintenancePolicy.weeklyMaintenanceWindow[].day

Required*

string

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"].

maintenancePolicy.weeklyMaintenanceWindow[].duration

Optional

string

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".

maintenancePolicy.weeklyMaintenanceWindow[].startTime

Required*

object

Required. Start time of the window in UTC time.

maintenancePolicy.weeklyMaintenanceWindow[].startTime.hours

Optional

integer

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.

maintenancePolicy.weeklyMaintenanceWindow[].startTime.minutes

Optional

integer

Minutes of hour of day. Must be from 0 to 59.

maintenancePolicy.weeklyMaintenanceWindow[].startTime.nanos

Optional

integer

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

maintenancePolicy.weeklyMaintenanceWindow[].startTime.seconds

Optional

integer

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.

maintenanceSchedule

Optional

list (object)

Upcoming maintenance schedule.

maintenanceSchedule[]

Optional

object

maintenanceSchedule[].endTime

Optional

string

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

Optional

string

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

Optional

string

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.

memorySizeGb

Required

integer

Redis memory size in GiB.

persistenceConfig

Optional

object

Persistence configuration for an instance.

persistenceConfig.persistenceMode

Optional

string

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"].

persistenceConfig.rdbNextSnapshotTime

Optional

string

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".

persistenceConfig.rdbSnapshotPeriod

Optional

string

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"].

persistenceConfig.rdbSnapshotStartTime

Optional

string

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".

readReplicasMode

Optional

string

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"].

redisConfigs

Optional

map (key: string, value: string)

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.

redisVersion

Optional

string

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.

region

Required

string

Immutable. The name of the Redis region of the instance.

replicaCount

Optional

integer

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.

reservedIpRange

Optional

string

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.

resourceID

Optional

string

Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default.

secondaryIpRange

Optional

string

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".

tier

Optional

string

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"].

transitEncryptionMode

Optional

string

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

list (object)

Conditions represent the latest available observation of the resource'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.

createTime

string

The time the instance was created in RFC3339 UTC "Zulu" format, accurate to nanoseconds.

currentLocationId

string

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

string

Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.

maintenanceSchedule

list (object)

Upcoming maintenance schedule.

maintenanceSchedule[]

object

maintenanceSchedule[].endTime

string

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

string

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

string

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

list (object)

Output only. Info per node.

nodes[]

object

nodes[].id

string

Node identifying string. e.g. 'node-0', 'node-1'.

nodes[].zone

string

Location of the node.

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

The observed state of the underlying GCP resource.

observedState.authString

string

Output only. AUTH String set on the instance. This field will only be populated if auth_enabled is true.

persistenceIamIdentity

string

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

integer

The port number of the exposed Redis endpoint.

readEndpoint

string

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

integer

Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'.

serverCaCerts

list (object)

List of server CA certificates for the instance.

serverCaCerts[]

object

serverCaCerts[].cert

string

The certificate data in PEM format.

serverCaCerts[].createTime

string

The time when the certificate was created.

serverCaCerts[].expireTime

string

The time when the certificate expires.

serverCaCerts[].serialNumber

string

Serial number, as extracted from the certificate.

serverCaCerts[].sha1Fingerprint

string

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