Este documento foi traduzido usando tecnologia de tradução automática de máquina. Sempre trabalhamos para apresentar traduções precisas, mas não oferecemos nenhuma garantia em relação à integridade, precisão ou confiabilidade do conteúdo traduzido. Em caso de qualquer discrepância, a versão original em inglês prevalecerá e constituirá o texto official.

Chaves de API

Deprecation of v3 API tokens

Rancher v2.13 introduced a new token resource in the ext.cattle.io API group to serve as the public API for tokens, which was only accessible through kubectl.

Starting with Rancher v2.14.1:

  • Legacy v3 API tokens (tokens.management.cattle.io) are being phased out and scheduled for removal in a future release. If you currently rely on legacy tokens for automation or API access, transition to the new tokens.ext.cattle.io tokens to ensure continued compatibility.

  • The Rancher dashboard provides basic support for tokens.ext.cattle.io (create, view or list, and delete).

Chaves da API e Autenticação de Usuário

Se você deseja acessar seus clusters, projetos ou outros objetos do Rancher usando aplicativos externos, pode fazê-lo usando a API do Rancher. No entanto, antes que seu aplicativo possa acessar a API, você deve fornecer ao aplicativo uma chave usada para autenticar com o Rancher. Você pode obter uma chave usando a interface do usuário do Rancher.

Uma chave da API também é necessária para usar o Rancher CLI.

As chaves da API são compostas por quatro componentes:

  • Endpoint: Este é o endereço IP e o caminho que outros aplicativos usam para enviar solicitações à API do Rancher.

  • Chave de Acesso: O nome de usuário do token.

  • Chave Secreta: A senha do token. Para aplicativos que solicitam duas strings diferentes para autenticação da API, você geralmente insere as duas chaves juntas.

  • Bearer Token: O nome de usuário e a senha do token concatenados. Use esta string para aplicativos que solicitam uma string de autenticação.

Os usuários podem optar por habilitar hashing do token.

Criando uma Chave de API

  1. Selecione Avatar do Usuário  Conta e Chaves de API no canto superior direito.

  2. Clique em Criar Chave de API.

  3. Opcional: Insira uma descrição para a chave da API e selecione um período de expiração ou um escopo. Recomendamos definir uma data de expiração.

    A chave da API não será válida após a expiração. Períodos de expiração mais curtos são mais seguros.

    O período de expiração é limitado por v3/settings/auth-token-max-ttl-minutes. Se exceder o max-ttl, a chave da API é criada com max-ttl como o período de expiração.

    Um escopo limita a chave da API para que ela funcione apenas contra a API do Kubernetes do cluster especificado. Se o cluster estiver configurado com um Endpoint de Cluster Autorizado, você poderá usar um token com escopo diretamente contra a API do cluster sem passar pelo servidor Rancher. Veja Endpoints de Cluster Autorizados para mais informações.

  4. Clique em Criar.

    Resultado da Etapa: Sua chave da API foi criada. Seu Endpoint da API, Chave de Acesso, Chave Secreta e Bearer Token são exibidos.

    Use o Bearer Token para autenticar com o Rancher CLI.

  5. Copie as informações exibidas para um local seguro. Essas informações são exibidas apenas uma vez, então, se você perder sua chave, terá que criar uma nova.

O Que Mais?

  • Insira as informações da sua chave da API no aplicativo que envia solicitações para a API do Rancher.

  • Saiba mais sobre os endpoints e parâmetros do Rancher selecionando Ver na API para um objeto na interface do usuário do Rancher.

  • As chaves da API são usadas para chamadas de API e Rancher CLI.

Excluindo Chaves da API

Se você precisar revogar uma chave da API, exclua-a. Você deve excluir as chaves de API:

  • Elas podem ter sido comprometidas.

  • Elas expiraram.

Para excluir uma chave de API, selecione a chave obsoleta e clique em Excluir.