MemcacheInstance

Property Value
Google Cloud Service Name Cloud Memorystore for Memcached
Google Cloud Service Documentation /memorystore/docs/memcached/
Google Cloud REST Resource Name v1beta2.projects.locations.instances
Google Cloud REST Resource Documentation /memorystore/docs/memcached/reference/rest/v1beta2/projects.locations.instances
Config Connector Resource Short Names gcpmemcacheinstance
gcpmemcacheinstances
memcacheinstance
Config Connector Service Name memcache.googleapis.com
Config Connector Resource Fully Qualified Name memcacheinstances.memcache.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

  displayName: string
  memcacheParameters:
    id: string
    params:
      string: string
  memcacheVersion: string
  networkRef:
    external: string
    name: string
    namespace: string
  nodeConfig:
    cpuCount: integer
    memorySizeMb: integer
  nodeCount: integer
  region: string
  resourceID: string
  zones:
  - string
Fields

displayName

Optional

string

A user-visible name for the instance.

memcacheParameters

Optional

object

Immutable. User-specified parameters for this memcache instance.

memcacheParameters.id

Optional

string

This is a unique ID associated with this set of parameters.

memcacheParameters.params

Optional

map (key: string, value: string)

User-defined set of parameters to use in the memcache process.

memcacheVersion

Optional

string

The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is MEMCACHE_1_5. The minor version will be automatically determined by our system based on the latest supported minor version. Default value: "MEMCACHE_1_5" Possible values: ["MEMCACHE_1_5"]

networkRef

Optional

object

The full name of the network to connect the instance to.

networkRef.external

Optional

string

The name of a ComputeNetwork.

networkRef.name

Optional

string

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

networkRef.namespace

Optional

string

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

nodeConfig

Required

object

Immutable. Configuration for memcache nodes.

nodeConfig.cpuCount

Required

integer

Number of CPUs per node.

nodeConfig.memorySizeMb

Required

integer

Memory size in Mebibytes for each memcache node.

nodeCount

Required

integer

Number of nodes in the memcache instance.

region

Required

string

Immutable. The region of the Memcache instance. If it is not provided, the provider region is used.

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.

zones

Optional

list (string)

Immutable. Zones where memcache nodes should be provisioned. If not provided, all zones will be used.

zones.[]

Optional

string

Status

Schema

  conditions:
  - lastTransitionTime: string
    message: string
    reason: string
    status: string
    type: string
  createTime: string
  discoveryEndpoint: string
  memcacheFullVersion: string
  memcacheNodes:
  - host: string
    nodeId: string
    port: integer
    state: string
    zone: string
  observedGeneration: integer
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

Creation timestamp in RFC3339 text format.

discoveryEndpoint

string

Endpoint for Discovery API

memcacheFullVersion

string

The full version of memcached server running on this instance.

memcacheNodes

list (object)

Additional information about the instance state, if available.

memcacheNodes.[]

object

memcacheNodes.[].host

string

Hostname or IP address of the Memcached node used by the clients to connect to the Memcached server on this node.

memcacheNodes.[].nodeId

string

Identifier of the Memcached node. The node id does not include project or location like the Memcached instance name.

memcacheNodes.[].port

integer

The port number of the Memcached server on this node.

memcacheNodes.[].state

string

Current state of the Memcached node.

memcacheNodes.[].zone

string

Location (GCP Zone) for the Memcached 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.

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: memcache.cnrm.cloud.google.com/v1beta1
  kind: MemcacheInstance
  metadata:
    labels:
      size: small
      process-type: long-queue
    name: memcacheinstance-sample
  spec:
    networkRef:
      name: memcacheinstance-dep
    nodeConfig:
      memorySizeMb: 1024
      cpuCount: 1
    nodeCount: 2
    region: us-central1
    zones:
      - us-central1-a
      - us-central1-c
    displayName: Sample Memcache Instance
    memcacheParameters:
      params:
        listen-backlog: "10000"
        max-item-size: "524288"
        max-reqs-per-event: "1"
  ---
  apiVersion: compute.cnrm.cloud.google.com/v1beta1
  kind: ComputeAddress
  metadata:
    name: memcacheinstance-dep
  spec:
    addressType: INTERNAL
    location: global
    purpose: VPC_PEERING
    prefixLength: 16
    networkRef:
      name: memcacheinstance-dep
  ---
  apiVersion: compute.cnrm.cloud.google.com/v1beta1
  kind: ComputeNetwork
  metadata:
    name: memcacheinstance-dep
  spec:
    autoCreateSubnetworks: false
  ---
  apiVersion: servicenetworking.cnrm.cloud.google.com/v1beta1
  kind: ServiceNetworkingConnection
  metadata:
    name: memcacheinstance-dep
  spec:
    networkRef:
      name: memcacheinstance-dep
    reservedPeeringRanges:
      - name: memcacheinstance-dep
    service: "servicenetworking.googleapis.com"