Este documento ha sido traducido utilizando tecnología de traducción automática. Si bien nos esforzamos por proporcionar traducciones precisas, no ofrecemos garantías sobre la integridad, precisión o confiabilidad del contenido traducido. En caso de discrepancia, la versión original en inglés prevalecerá y constituirá el texto autorizado.

Claves 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).

Claves API y Autenticación de Usuarios

Si deseas acceder a tus clústeres de Rancher, proyectos u otros objetos utilizando aplicaciones externas, puedes hacerlo utilizando la API de Rancher. Sin embargo, antes de que tu aplicación pueda acceder a la API, debes proporcionarle una clave que se usará para autenticarla con Rancher. Puedes obtener una clave utilizando la interfaz de usuario de Rancher.

También se requiere una clave API para utilizar Rancher CLI.

Las claves API se componen de cuatro componentes:

  • Endpoint: Esta es la dirección IP y la ruta que utilizan otras aplicaciones para enviar solicitudes a la API de Rancher.

  • Clave de Acceso: El nombre de usuario del token.

  • Clave Secreta: La contraseña del token. Para aplicaciones que te piden dos cadenas diferentes para la autenticación API, normalmente introduces las dos claves juntas.

  • Token portador: El nombre de usuario y la contraseña del token concatenados. Utiliza esta cadena para aplicaciones que te piden una cadena de autenticación.

Los usuarios pueden optar por habilitar hashing de tokens.

Creando una Clave API

  1. Selecciona Avatar de Usuario  Cuenta y Claves API en la esquina superior derecha.

  2. Haz clic en Crear Clave API.

  3. Opcional: Introduce una descripción para la clave API y selecciona un período de expiración o un ámbito. Recomendamos establecer una fecha de expiración.

    La clave API no será válida después de la expiración. Los períodos de expiración más cortos son más seguros.

    El período de expiración está limitado por v3/settings/auth-token-max-ttl-minutes. Si excede el max-ttl, la clave API se crea con max-ttl como período de expiración.

    Un ámbito limita la clave API para que solo funcione contra la API de Kubernetes del clúster especificado. Si el clúster está configurado con un Endpoint de Clúster Autorizado, puedes usar un token con ámbito directamente contra la API del clúster sin pasar por el servidor Rancher. Consulta Endpoints de Clúster Autorizados para más información.

  4. Haga clic en Crear.

    Resultado del Paso: Tu clave API ha sido creada. Tu API Endpoint, Clave de Acceso, Clave Secreta y Token portador se muestran.

    Utiliza el Token portador para autenticarte con Rancher CLI.

  5. Copia la información mostrada en un lugar seguro. Esta información solo se muestra una vez, así que si pierdes tu clave, tendrás que crear una nueva.

¿Qué sigue?

  • Introduce la información de tu clave API en la aplicación que envía solicitudes a la API de Rancher.

  • Aprende más sobre los endpoints y parámetros de Rancher seleccionando Ver en API para un objeto en la interfaz de usuario de Rancher.

  • Las claves API se utilizan para llamadas a la API y Rancher CLI.

Eliminando Claves API

Si necesitas revocar una clave API, elimínala. Debes eliminar las claves API:

  • Que puedan haber sido comprometidas.

  • Que hayan caducado.

Para eliminar una clave API, selecciona la clave obsoleta y haz clic en Eliminar.