Gerenciar Secrets

Nesta seção, você encontra: detalhes sobre como cadastrar e gerenciar as Secrets em um Perfil Pessoal.

As Secrets podem ser cadastradas para uso em Perfis Pessoais, permitindo que informações sensíveis, como chaves de acesso, tokens e credenciais, sejam utilizadas de forma segura em contextos individuais.

Confira um exemplo a seguir:

Existem momentos em que você precisa que a StackSpot acesse um repositório privado no GitHub para realizar deploys ou clonar o código.

Para isso, você pode cadastrar um Personal Access Token (PAT) como uma Secret no seu perfil pessoal. Esse token será usado pela StackSpot para autenticar o acesso ao repositório.

Siga os passos a seguir para cadastrar uma Secret:

Pré-requisitos

Você precisa ter uma das seguintes permissões: developer, creator ou ai_developer. Para mais informações, acesse a página de Permissões.

Passo a passo para cadastrar uma Secret

Passo 1. Acesse o Portal da StackSpot. Você tem duas opções para acessar o Portal:

Acessar diretamente o Portal da Conta;
Após fazer login no Portal StackSpot EDP, clicar no seu avatar de perfil.

Passo 2. Acesse o Perfil e selecione a opção 'Meu Perfil';

Passo 3. Clique na seção 'Gerenciamento de Secrets';

Passo 4. Clique no botão 'Cadastrar Secret' para iniciar o cadastro;

Passo 5. Selecione o tipo de Secret que deseja cadastrar e preencha as informações específicas de acordo com o tipo escolhido. Confira os detalhes a seguir:

Tipos de Secrets e campos necessários

1. API Key: usado para autenticar solicitações de aplicações clientes para APIs. Preencha os campos a seguir:

Nome da Secret
Nome do Header
Valor
Data de Expiração (Opcional)

2. Bearer Tokens (OAuth): Tokens são emitidos como parte do framework de autorização OAuth2, permitindo que clientes acessem recursos protegidos. Preencha os campos a seguir:

Nome da Secret
Nome do Header
Valor do Header
Data de Expiração (Opcional)

3. Client Credentials: comumente usado para comunicação de servidor para servidor, uma aplicação do cliente deve se autenticar usando credenciais de cliente. Preencha os campos a seguir:

Nome da Secret
Client ID
URL
Client Secret

4. Certificado: certificados de cliente são utilizados para autenticação mútua TLS, garantindo validação de identidade e comunicação criptografada. Preencha os campos a seguir:

Nome da Secret
Certificado: arraste e solte os arquivos.
Chave Privada (Opcional): arraste e solte os arquivos. Suporta apenas arquivos .key.
Data de Expiração: preenchida automaticamente ao adicionar o certificado.

5. Chave/Valor (Key/Value). Preencha os campos a seguir:

Nome da Secret
Método de Cadastro: escolha entre adicionar um arquivo ou inserir manualmente (adicione a chave e o valor).
Data de Expiração (Opcional)

Passo 6. Clique no botão 'Cadastrar Secret';

Passo 7. Após o cadastro, confira sua Secret na tela de listagem. Você poderá visualizar informações como:

Tipo de Credencial
Data de Criação
Data de Expiração
Status da Secret

Como editar uma Secret

Atenção!

Certifique-se de copiar e salvar as informações da Secret ao cadastrá-la, pois alguns dados podem não ser exibidos novamente.
Utilize a funcionalidade de edição para verificar onde a Secret está sendo utilizada antes de realizar alterações ou exclusões.

Você pode editar uma Secret cadastrada seguindo os passos a seguir:

Passo 1. No Portal da StackSpot, vá até a seção 'Secrets';

Passo 2. Clique no botão 'Mais Opções' ao lado da Secret que deseja editar;

Passo 3. Clique no botão 'Editar' para editar a secret. Preencha os campos necessários:

Novo Nome do Header
Novo Valor
Data de Expiração (Opcional)

Como excluir uma Secret

Se uma Secret não é usada durante 30 dias, ela automaticamente passa a ter o status de Inativa.

O Portal da StackSpot notifica a exclusão quando faltar 15, 10 e 1 dia antes da exclusão de uma Secret. A partir do momento em que a Secret passa a ter o status de Inativa e você é notificado sobre, você tem as seguintes opções:

Voltar a usar a Secret para que ela seja reativada automaticamente e mude o status de Exclusão programada para Ativa. Você pode reativá-la dentro do período de 30 dias.
Escolher excluir a Secret agora.
Agendar a exclusão para 30 dias.

Confira a seguir o passo a passo das duas últimas opções: Excluir uma Secret agora e Agendar exclusão da Secret.

Excluir uma Secret agora

É possível excluir, de forma imediata, uma Secret que tem um dos status a seguir:

Ativa
Inativa
Exclusão programada

Atenção!

Excluir uma Secret é um processo irreversível.

Passo 1. Na seção 'Secrets', clique no botão 'Mais Opções';

Passo 2. Clique no botão 'Excluir Secret';

Passo 3. Em seguida, selecione a opção Excluir agora;

Antes de excluir, você pode visualizar e pesquisar quais locais a Secret está em uso.

Passo 4. Para concluir, digite a palavra EXCLUIR. Em seguida, clique no botão 'Excluir secret'.

Pronto, você terminou de excluir uma Secret.

Agendar exclusão da Secret

Passo 1. Ainda na seção 'Secrets', clique no botão 'Mais Opções';