Usando uma chave de API com Secrets Manager para autorizar um projeto a implementar uma arquitetura

Ao configurar sua arquitetura implementável, é necessário selecionar um método de autenticação. O método de autenticação identifica a conta de destino onde os recursos são implementados e autoriza a implementação. Você pode criar uma chave de API diretamente no projeto ou armazenar uma chave de API como um segredo para autorizar um projeto a ser implantado em uma conta.

Um segredo é uma informação sensível, por exemplo, uma chave de API, uma senha ou qualquer tipo de credencial que você possa usar para acessar um sistema confidencial. É possível usar um segredo no IBM Cloud® Secrets Manager como uma maneira de gerenciar chaves de API dinamicamente e armazená-las com segurança em sua própria instância dedicada.

Está implementando uma prova de conceito para fins de teste? Você pode criar uma chave de API ao editar uma configuração em seu projeto. Isso autoriza o projeto a ser implementado na conta selecionada no momento.

Antes de Iniciar

  1. Certifique-se de que você tenha designado as permissões necessárias para criar os recursos do conjunto de ferramentas do projeto na conta, além da permissão para criar projetos:

    • A função de Editor no serviço IBM Cloud Projetos.
    • A função Editor e Gerenciador no serviço IBM Cloud® Schematics.
    • A função de Visualizador no grupo de recursos para o projeto

    Para obter mais informações sobre acesso e permissões, consulte Designando acesso de usuários a projetos.

  2. Cada chave de API criada tem o mesmo acesso que você designou como um usuário. Antes de criar uma chave API, certifique-se de ter acesso para implementar arquiteturas na conta na qual você deseja implementar, também conhecida como sua conta de destino. Se você tiver o amplo acesso a seguir, poderá implementar arquiteturas na conta:

    • A função de Administrador para todos os serviços habilitados para Identidade e Acesso.
    • A função de administrador para todos os serviços de gerenciamento de contas.

    Como alternativa, é possível criar uma chave de API associada a um ID de serviço. As chaves de API de ID de serviço herdam todo o acesso que é designado ao ID de serviço específico. Portanto, é possível definir o escopo do acesso para o ID de serviço para o mínimo necessário para a arquitetura implementável que você está configurando. Essa abordagem é semelhante a usar um perfil confiável com acesso específico baseado na arquitetura implementável. Para obter mais informações sobre como localizar as funções de acesso necessárias para qualquer arquitetura implementável especificada, consulte concedendo acesso específico com base na arquitetura implementável

  3. Conclua as etapas necessárias para criar um projeto e incluir uma arquitetura implementável.. Você autoriza o projeto a implementar com uma chave de API ou segredo existente ao configurar sua arquitetura implementável.

Criando uma chave API

Conclua as etapas a seguir para criar uma chave de API:

  1. No console do IBM Cloud, conecte-se à conta na qual você deseja implementar.

  2. Vá para Gerenciar > Acesso (IAM) > Chaves de API.

  3. Clique em Criar uma chave de API do IBM Cloud.

  4. Insira um nome e uma descrição para sua chave API.

  5. Clique em Criar.

  6. Em seguida, clique em Mostrar para exibir a chave de API. Ou clique em Copiar para copiar e salvá-la para mais tarde ou clique em Download.

    Por motivos de segurança, a chave API está disponível apenas para ser copiada ou transferida por download no momento da criação. Se a chave API for perdida, uma nova chave API deverá ser criada.

Incluindo uma chave API no Secrets Manager

Depois de criar uma chave API, conclua as etapas a seguir para incluí-la em Secrets Manager na conta que contém seu projeto:

  1. Crie uma Secrets Manager instância de serviço em sua conta do IBM Cloud. Para criar um segredo, você deve ter a função Writer ou superior no serviço Secrets Manager.
  2. Após criar sua instância secreta, certifique-se de selecionar Outro tipo de segredo para incluir um segredo arbitrário. Para obter informações sobre como criar um segredo arbitrário, consulte Criando segredos arbitrários na IU. Seu segredo arbitrário deve conter a chave API. A chave de API deve ser criada na conta de destino na qual você deseja implementar.

Usando uma referência secreta

Depois de criar um segredo, é possível usar esse segredo como uma referência para autorizar seu projeto a ser implementado.. Para obter mais informações sobre referências, consulte Valores de referência. Para configurar sua arquitetura implementável com uma referência secreta, conclua as etapas a seguir:

  1. No console do IBM Cloud, conecte-se à conta na qual você deseja implementar o projeto.
  2. Acesse Menu ícone Menu > Projetos.
  3. Selecione o projeto que inclui a configuração de arquitetura implementável que você deseja autorizar
  4. Na guia Configurações, selecione a configuração..
  5. Clique em Editar
  6. Na seção Configurar, passe o mouse sobre o campo de chave de API e selecione o ícone Chave.
  7. Escolha a instância de serviço e selecione o segredo que você deseja usar e clique em OK

Você também pode usar um perfil confiável como uma referência. Na seção Configurar, para o método, selecione Perfil confiável e insira seu ID de perfil confiável. Para obter mais informações, consulte Usando perfis confiáveis