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

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
  displayName: string
  locationId: string
  memorySizeGb: integer
  redisConfigs:
    string: string
  redisVersion: string
  region: string
  reservedIpRange: string
  resourceID: string
  tier: 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

authorizedNetworkRef

Optional

object

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

authorizedNetworkRef.external

Optional

string

The selfLink of a ComputeNetwork.

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

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

memorySizeGb

Required

integer

Redis memory size in GiB.

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

Immutable. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: - REDIS_5_0 for Redis 5.0 compatibility - REDIS_4_0 for Redis 4.0 compatibility - REDIS_3_2 for Redis 3.2 compatibility

region

Required

string

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

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.

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

Status

Schema

  conditions:
  - lastTransitionTime: string
    message: string
    reason: string
    status: string
    type: string
  createTime: string
  currentLocationId: string
  host: string
  persistenceIamIdentity: string
  port: integer
Fields
conditions

list (object)

Conditions represents 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.

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.

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