Conectar-se a uma instância do Memorystore para Valkey

Esta página explica como se conectar a uma instância do Memorystore para Valkey.

Suporte ao cliente

Para exemplos e orientações sobre quais clientes de conexão usar, consulte Exemplos de código da biblioteca de cliente.

Permitir portas no firewall

Se você não permitir as portas corretas no firewall, a instância poderá encontrar erros de conexão porque o firewall poderá bloquear as portas usadas pelo Memorystore para Valkey.

Para todos os endpoints do Private Service Connect da instância, é necessário permitir a porta TCP 6379, bem como as portas TCP de 11000 a 13047. Para mais informações, consulte Resolver problemas.

Acesso entre regiões

É possível acessar uma instância do Memorystore para Valkey de um cliente localizado em uma região diferente da instância.

Conectar a uma instância com o modo de cluster ativado

Esta seção explica como se conectar a uma instância do Memorystore para Valkey com o modo de cluster ativado.

Conferir o endpoint de descoberta da instância

Cada instância com o modo de cluster ativado tem um endpoint de descoberta ao qual o cliente se conecta. Esse endpoint é uma combinação de um endereço IP e um número de porta.

É possível conferir o endpoint de descoberta de uma instância do Memorystore para Valkey usando o Google Cloud console ou a CLI gcloud.

gcloud

Para conferir o endpoint de descoberta da instância, execute a describe CLI gcloud, conforme explicado em Acessar informações da instância.

A saída será semelhante a esta:

authorizationMode: AUTH_DISABLED
createTime: '2024-08-06T22:02:55.224704101Z'
deletionProtectionEnabled: false
engineVersion: VALKEY_7_2
name: projects/myproject/locations/us-central1/instances/my-instance
nodeConfig:
  sizeGb: 6.5
nodeType: STANDARD_SMALL
persistenceConfig:
  mode: DISABLED
endpoints:
- connections:
  - pscAutoConnection:
       connectionType: CONNECTION_TYPE_DISCOVERY
       forwardingRule: https://www.googleapis.com/compute/v1/projects/my-project/regions/us-central1/forwardingRules/sca-auto-fr-ec00907a-3ee3-4740-8092-ae832428f8e4
       ipAddress: 10.128.0.58
       network: projects/my-project/global/networks/default
       port: 6379
       projectId: my-project
       pscConnectionId: '38876592440606778'
       serviceAttachment: projects/129109085717/regions/us-east1/serviceAttachments/gcp-memorystore-auto-58e78f71-fdb7-48-psc-sa
    - pscAutoConnection:
       forwardingRule: https://www.googleapis.com/compute/v1/projects/my-project/regions/us-central1/forwardingRules/sca-auto-fr-5ce5518f-1c59-4b46-aa74-799fad70d7b1
       ipAddress: 10.128.0.59
       network: projects/my-project/global/networks/default
       port: 6379
       projectId: my-project
       pscConnectionId: '38876592440606779'
       serviceAttachment: projects/129109085717/regions/us-east1/serviceAttachments/gcp-memorystore-auto-58e78f71-fdb7-48-psc-sa-2
replicaCount: 2
shardCount: 5
state: ACTIVE
transitEncryptionMode: TRANSIT_ENCRYPTION_DISABLED
uid: 869f2d09-d20b-46d8-94ba-be83c48ceb54
updateTime: '2024-08-06T22:18:59.389980051Z'
zoneDistributionConfig:
  mode: MULTI_ZONE

Anote o endereço do endpoint e o número da porta listados na seção endpoints: da entrada connectionType: CONNECTION_TYPE_DISCOVERY. Esses dois valores usados juntos são o endpoint de descoberta da instância.

Conectar-se de uma VM do Compute Engine usando valkey-cli

É possível se conectar à instância do Memorystore para Valkey de qualquer VM do Compute Engine que use a rede autorizada da instância do Memorystore.

Para se conectar à instância:

  1. Se você ainda não tem uma VM do Linux Compute Engine que usa a rede autorizada para a instância do Memorystore para Valkey, crie uma e se conecte a ela seguindo o Guia de início rápido para criar uma VM do Linux.

  2. Instale valkey-cli na VM do Compute Engine seguindo as instruções em Instalar o Valkey.

  3. Confira o endpoint de descoberta da instância e anote-o.

  4. Conecte-se ao endpoint de descoberta da instância executando o comando a seguir:

    valkey-cli -h DISCOVERY_ENDPOINT_ADDRESS -p PORT_NUMBER -c

    Em que:

    • DISCOVERY_ENDPOINT_ADDRESS e PORT_NUMBER são os valores que você anotou na etapa anterior.

  5. Execute o comando CLUSTER SHARDS para conferir a topologia do nó. Anote um dos endereços IP e números de porta do nó.

  6. Conecte-se ao nó desejado executando o comando a seguir:

    valkey-cli -h NODE_IP_ADDRESS -p NODE_PORT -c

    Substitua:

    • NODE_IP_ADDRESS é o endereço IP do nó encontrado na etapa anterior.
    • NODE_PORT é o número da porta do nó encontrado na etapa anterior.

  7. Depois de se conectar ao nó, insira alguns comandos do Valkey:

    Insira o seguinte:

    PING

    Result:

    PONG

    Enter

    SET HELLO WORLD

    Result:

    OK

    Insira o seguinte:

    GET HELLO

    Resultado:

    "WORLD"

  8. Depois de testar a conexão com o nó do Valkey, considere excluir a VM do Compute Engine usada para se conectar à instância do Valkey. Isso ajuda a evitar cobranças na sua conta do Cloud Billing.

Conectar a uma instância com criptografia em trânsito ativada

Esta seção fornece um exemplo de como se conectar a uma instância do Memorystore for Valkey Cluster Mode Enabled que tem a criptografia em trânsito ativada.

  1. Se você ainda não tem uma VM do Compute Engine que usa a mesma rede autorizada que a instância do Valkey da etapa anterior, crie uma e se conecte a ela seguindo o Guia de início rápido sobre como usar uma VM do Linux.

    1. Instale a versão 6.0 ou mais recente do valkey-cli na VM do Compute Engine seguindo as instruções em Instalar o Valkey.

  2. Instale os certificados de autoridade certificadora (CA) da instância na VM do Linux seguindo as instruções em Instalar certificados de CA no cliente.

  3. Confira o endpoint de descoberta da instância e anote o endereço IP e o número da porta do endpoint.

  4. Conecte-se ao endpoint de descoberta da instância executando o comando a seguir:

    valkey-cli -h DISCOVERY_ENDPOINT_ADDRESS -p PORT_NUMBER -c --tls --cacert /tmp/server_ca.pem

    Substitua:

    • DISCOVERY_ENDPOINT_ADDRESS: o endereço IP do endpoint de descoberta que você anotou na etapa anterior
    • PORT_NUMBER: o número da porta que você anotou na etapa anterior

    Para ativar o modo de suporte valkey-cli, use a opção -c. Se você não fornecer essa opção, ao tentar acessar chaves de um fragmento diferente daquele a que você está conectado, a instância retornará um erro MOVED. No entanto, se você usar a opção, o cliente será reconectado automaticamente ao endereço fornecido na resposta de erro.

    Se você ativar a autenticação do Identity and Access Management (IAM) ou a autenticação básica baseada em token na instância, será necessário fornecer credenciais de autenticação junto com as flags do Transport Layer Security (TLS). Exemplo:

    valkey-cli -h DISCOVERY_ENDPOINT_ADDRESS -p PORT_NUMBER -c --tls --cacert /tmp/server_ca.pem --user USERNAME -a TOKEN

    Substitua:

    • USERNAME: o nome de usuário da instância
    • TOKEN: o token de autenticação

    Para mais informações sobre como gerar ou gerenciar suas credenciais de autenticação, consulte Gerenciar a autenticação do IAM e Proteger o acesso às instâncias usando a autenticação básica baseada em token.

  5. Execute o comando CLUSTER SHARDS para conferir a topologia do nó. Anote o endereço IP e o número da porta de um dos nós.

  6. Conecte-se ao nó executando o comando a seguir:

    valkey-cli -h NODE_IP_ADDRESS -p NODE_PORT -c --tls --cacert /tmp/server_ca.pem

    Substitua:

    • NODE_IP_ADDRESS: o endereço IP do nó que você anotou na etapa anterior.
    • NODE_PORT: o número da porta do nó que você anotou na etapa anterior.

    Se o cluster usar a autenticação do IAM ou a autenticação básica baseada em token, inclua as flags --user e -a, como fez na etapa do endpoint de descoberta.

  7. Depois de se conectar ao nó, insira os seguintes comandos do Valkey:

    Insira o seguinte:

    PING

    Resultado:

    PONG

Conectar a uma instância com o modo de cluster desativado

Esta seção explica como se conectar a uma instância do Memorystore para Valkey com o modo de cluster desativado.

Conferir o endpoint principal e do leitor da instância

Para conferir o endpoint principal e do leitor da instância, use as instruções a seguir:

gcloud

Para conferir o endpoint principal e do leitor da instância, execute a describe CLI gcloud, conforme explicado em Acessar informações da instância.

A saída será semelhante a esta:

authorizationMode: AUTH_DISABLED
createTime: '2024-08-06T22:02:55.224704101Z'
deletionProtectionEnabled: false
engineVersion: VALKEY_7_2
name: projects/myproject/locations/us-central1/instances/my-instance
nodeConfig:
  sizeGb: 6.5
nodeType: STANDARD_SMALL
persistenceConfig:
  mode: DISABLED
endpoints:
- connections:
  - pscAutoConnection:
      connectionType: CONNECTION_TYPE_PRIMARY
      forwardingRule: https://www.googleapis.com/compute/v1/projects/my-project/regions/us-central1/forwardingRules/sca-auto-fr-ec00907a-3ee3-4740-8092-ae832428f8e4
      ipAddress: 10.128.0.124
      network: projects/my-project/global/networks/default
      port: 6379
      projectId: my-project
      pscConnectionId: '38876592440606778'
      serviceAttachment: projects/448055306617/regions/us-central1/serviceAttachments/gcp-memorystore-auto-b3c43536-4a77-40-psc-sa
  - pscAutoConnection:
      connectionType: CONNECTION_TYPE_READER
      forwardingRule: https://www.googleapis.com/compute/v1/projects/my-project/regions/us-central1/forwardingRules/sca-auto-fr-5ce5518f-1c59-4b46-aa74-799fad70d7b1
      ipAddress: 10.128.0.125
      network: projects/my-project/global/networks/default
      port: 6379
      projectId: my-project
      pscConnectionId: '38876592440606779'
      serviceAttachment: projects/448055306617/regions/us-central1/serviceAttachments/gcp-memorystore-auto-b3c43536-4a77-40-psc-sa-2
replicaCount: 2
shardCount: 1
mode: CLUSTER_DISABLED
state: ACTIVE
transitEncryptionMode: TRANSIT_ENCRYPTION_DISABLED
uid: 869f2d09-d20b-46d8-94ba-be83c48ceb54
updateTime: '2024-08-06T22:18:59.389980051Z'
zoneDistributionConfig:
  mode: MULTI_ZONE

Endpoint principal:anote o endereço do endpoint e o número da porta listados em CONNECTION_TYPE_PRIMARY na seção endpoints:. Esses dois valores usados juntos são o endpoint principal da instância.

Endpoint do leitor:anote o endereço do endpoint e o número da porta listados em CONNECTION_TYPE_READER na seção endpoints:. Esses dois valores usados juntos são o endpoint do leitor da instância.

Conectar-se de uma VM do Compute Engine usando valkey-cli

É possível se conectar à instância do Memorystore para Valkey de qualquer VM do Compute Engine que use a rede autorizada da instância do Memorystore.

Para se conectar à instância:

  1. Se você ainda não tem uma VM do Linux Compute Engine que usa a rede autorizada para a instância do Memorystore para Valkey, crie uma e se conecte a ela seguindo o Guia de início rápido para criar uma VM do Linux.

  2. Instale valkey-cli na VM do Compute Engine seguindo as instruções em Instalar o Valkey.

  3. Confira o endpoint principal e do leitor da instância e anote-o.

  4. Conecte-se ao endpoint principal da instância executando o comando a seguir:

    valkey-cli -h PRIMARY_ENDPOINT_ADDRESS -p PORT_NUMBER

    Em que:

    • PRIMARY_ENDPOINT_ADDRESS e PORT_NUMBER são os valores que você anotou na etapa anterior.

  5. Depois de se conectar ao nó principal, insira os seguintes comandos do Valkey:

    Insira o seguinte:

    PING

    Result:

    PONG

    Enter

    SET HELLO WORLD

    Result:

    OK

    Insira o seguinte:

    GET HELLO

    Resultado:

    "WORLD"

  6. Conecte-se ao endpoint do leitor da instância executando o comando a seguir:

    valkey-cli -h READER_ENDPOINT_ADDRESS -p PORT_NUMBER

    Em que:

    • READER_ENDPOINT_ADDRESS e PORT_NUMBER são os valores que você anotou na etapa anterior.

  7. Depois de se conectar ao nó principal, insira os seguintes comandos do Valkey Get:

    Insira o seguinte:

    PING

    Resultado:

    PONG

    Insira o seguinte:

    GET HELLO

    Resultado:

    "WORLD"

  8. Depois de testar a conexão com o nó do Valkey, exclua a VM do Compute Engine usada para se conectar à instância do Valkey. Isso ajuda a evitar cobranças na sua conta do Cloud Billing.

Conectar a uma instância com criptografia em trânsito ativada

Esta seção fornece um exemplo de como se conectar a uma instância do Memorystore para Valkey com o modo de cluster desativado que tem a criptografia em trânsito ativada.

  1. Se você ainda não tem uma VM do Compute Engine que usa a mesma rede autorizada que a instância do Valkey da etapa anterior, crie uma e se conecte a ela seguindo o Guia de início rápido sobre como usar uma VM do Linux.

    1. Instale a versão 6.0 ou mais recente do valkey-cli na VM do Compute Engine seguindo as instruções em Instalar o Valkey.

  2. Verifique o modo de autoridade certificadora (CA) que você está usando para sua instância.

  3. Confira os endpoints principal e do leitor da instância e anote o endereço IP e o número da porta de cada endpoint.

  4. Conecte-se ao endpoint principal da instância executando o comando a seguir:

    valkey-cli -h PRIMARY_ENDPOINT_ADDRESS -p PORT_NUMBER --tls --cacert /tmp/server_ca.pem

    Substitua:

    • PRIMARY_ENDPOINT_ADDRESS: o endereço IP do endpoint principal que você anotou na etapa anterior
    • PORT_NUMBER: o número da porta desse endpoint que você anotou em a etapa anterior

  5. Conecte-se ao endpoint do leitor da instância executando o comando a seguir:

    valkey-cli -h READER_ENDPOINT_ADDRESS -p PORT_NUMBER --tls --cacert /tmp/server_ca.pem

    Substitua:

    • READER_ENDPOINT_ADDRESS: o endereço IP do endpoint do leitor que você anotou
    • PORT_NUMBER: o número da porta desse endpoint que você anotou

    Se você ativar a autenticação do IAM ou a autenticação básica baseada em token na instância, será necessário fornecer credenciais de autenticação junto com as flags TLS para os endpoints principal e do leitor.

    Exemplo:

    valkey-cli -h PRIMARY_ENDPOINT_ADDRESS -p PORT_NUMBER --tls --cacert /tmp/server_ca.pem --user USERNAME -a TOKEN

    e

    valkey-cli -h READER_ENDPOINT_ADDRESS -p PORT_NUMBER -c --tls --cacert /tmp/server_ca.pem --user USERNAME -a TOKEN

    Substitua:

    • USERNAME: o nome de usuário da instância
    • TOKEN: o token de autenticação

    Para mais informações sobre como gerar ou gerenciar suas credenciais de autenticação, consulte Gerenciar a autenticação do IAM e Proteger o acesso às instâncias usando a autenticação básica baseada em token.

  6. Depois de se conectar ao nó, insira alguns comandos do Valkey:

    Insira o seguinte:

    PING

    Resultado:

    PONG