Segredos

Os segredos do Vonage Cloud Runtime permitem que você armazene informações confidenciais para uso em seus projetos, como chaves de API para serviços de terceiros. Os segredos são gerenciados por meio da CLI do Vonage Cloud Runtime.

Criando um segredo

Para criar um segredo, você pode usar o comando `secrets create` da CLI do Vonage Cloud Runtime.

vcr secret create --name $NAME --value $VALUE

Então, para criar um segredo FOO com o valor bar:

vcr secret create --name FOO --value bar

Você também pode adicionar arquivos como segredos:

vcr secret create --name $NAME --filename $FILE_PATH

Acessando seus segredos

Para acessar um segredo na sua instância, você precisa adicioná-lo ao seu arquivo de configuração para exibi-lo. Adicione um environment chave no seu arquivo de configuração com uma lista dos segredos que você deseja expor e um nome para se referir a eles:

project:
    name: app
instance:
    name: dev
    runtime: nodejs24
    region: aws.euw1
    application-id: fcd08ece-f3c2-4adf-bf84-5ba8a1c86e0e
    capabilities: [voice, messages-v1]
    entrypoint: [node, index.js]
    environment:
        - name: FOO_SECRET
          secret: FOO
        - name: BAZ_SECRET
          secret: BAZ

Agora que o segredo está no seu arquivo de configuração, ele será injetado na sua instância quando você executar o depurador do Vonage Cloud Runtime ou implantar seu projeto. Portanto, para usar o exemplo de FOO No seu aplicativo, você escreveria:

const fooValue = process.env.FOO_SECRET;

Atualização de segredos

A atualização de segredos funciona de maneira semelhante à criação de segredos, mas, para atualizá-los, você usa vcr secret update:

vcr secret update --name $NAME --value $NEW_VALUE

Para atualizar o FOO exemplo:

vcr secret update --name FOO --value baz

Segredos dos Anúncios

Para ver todos os segredos armazenados na sua Account, execute:

vcr secret list

Isso gera uma tabela com os nomes das chaves secretas. Os valores das chaves secretas nunca são exibidos.

Eliminando segredos

Os segredos podem ser removidos usando vcr secret remove:

vcr secret remove --name $NAME

Para remover o FOO exemplo:

vcr secret remove --name FOO

Trabalhando com segredos localmente

Ao depurar seu projeto localmente, você não terá acesso aos segredos armazenados na plataforma Vonage Cloud Runtime. Recomenda-se que você crie um .env arquivo no diretório do seu projeto e adicione seus segredos de desenvolvimento nele:

export FOO=BAR
export BAZ=BAT
export X=Y

Então, antes de começar a depurar, execute:

source .env

As variáveis de ambiente precisam ser definidas no mesmo processo do shell em que você está executando o depurador do Vonage Cloud Runtime.

Isso exportará os segredos de desenvolvimento no processo atual do shell do terminal, permitindo que o depurador tenha acesso a eles.