Saltar al contenido principal

Antes de empezar

Configura un Tenant de Auth0.
Auth0 Deploy CLI es una herramienta que te ayuda a administrar la configuración de tu Tenant de Auth0. Se integra en tus flujos de trabajo de desarrollo como una CLI independiente o como un módulo de Node.js. Tipos de recursos compatibles: actions, branding, client grants, clients (applications), connections, custom domains, email templates, emails, grants, guardian, hook secrets, log streams, migrations, organizations, pages, prompts, resource servers (APIs), roles, tenant settings, themes.

​
Aspectos destacados

  • Orientado a múltiples entornos: Diseñado para ayudarle a probar las integraciones de Auth0 de sus aplicaciones, desde las ramas de funcionalidades hasta producción.
  • Reemplazo de palabras clave: Configuraciones de recursos compartidos en todos los entornos con reemplazo dinámico de palabras clave.
  • Versátil: Intégrelo en sus flujos de trabajo de CI/CD, ya sea como CLI o como módulo de Node.

​
Primeros pasos

Esta guía le ayudará a implementar y poner en funcionamiento la herramienta Deploy CLI utilizada como una CLI independiente. Hay tres pasos principales antes de poder ejecutar Deploy CLI:
  1. Crear una aplicación de Auth0 específica
  2. Configurar Deploy CLI
  3. Ejecutar Deploy CLI
Esta herramienta puede realizar cambios destructivos en su Tenant de Auth0. Se recomienda familiarizarse con la configuración AUTH0_ALLOW_DELETE y realizar pruebas en Tenants de desarrollo antes de usarla en producción.

​
Instala Deploy CLI

Para ejecutarla como una herramienta de línea de comandos independiente: npm install -g auth0-deploy-cli

​
Cree una aplicación de Auth0 dedicada

Para que Deploy CLI pueda llamar a la , debe crear una aplicación de Auth0 dedicada para realizar llamadas en nombre de la herramienta:
  1. Vaya a Auth0 Dashboard > Applications > Applications.
  2. Seleccione + Create Application.
    1. Asígnele un nombre descriptivo (como “Deploy CLI”).
    2. Seleccione Machine to Machine Applications como Application Type.
    3. Seleccione Create.
  3. Cambie a la vista Authorize Machine to Machine Application:
    1. Seleccione Auth0 Management API.
    2. Seleccione los permisos adecuados para los recursos que desea administrar. Consulte la sección Alcances del cliente para obtener más información.
    3. Seleccione Authorize.
El cliente propio de Deploy CLI no se puede configurar para evitar cambios potencialmente destructivos.

​
Alcances del cliente

A la aplicación designada se le deben conceder alcances para permitir que Deploy CLI ejecute operaciones de administración. Se aplica el principio de privilegio mínimo, por lo que operará dentro del conjunto de permisos concedidos. Deberá seleccionar read:clients, pero se recomienda seleccionar los permisos read:*, create:* y update:* para todos los tipos de recursos dentro del ámbito de administración. Para habilitar las eliminaciones, necesita alcances delete:*.

​
Configurar el Deploy CLI

Puede configurar el Deploy CLI de dos maneras:
  1. Usar el archivo de configuración (config.json).
  2. Configurar variables de entorno.
La decisión de usar una o ambas opciones dependerá de su caso de uso específico y de sus preferencias. Para obtener más información, lea Configurar el Deploy CLI. Para este ejemplo, configure las siguientes variables de entorno:
  • AUTH0_DOMAIN
  • AUTH0_CLIENT_ID
  • AUTH0_CLIENT_SECRET
Puede encontrar estos valores en la pestaña Settings de la aplicación específica de Auth0 que creó anteriormente.

​
Ejecuta el Deploy CLI

El comando export de Deploy CLI se puede ejecutar con el siguiente comando: a0deploy export --format=yaml --output_folder=local Una vez completado el proceso, revise los archivos de configuración de recursos generados en el directorio local. Luego, ejecute el comando import para enviar la configuración desde su equipo local a su Tenant de Auth0: a0deploy import --config_file=config.json --input_file local/tenant.yaml Para obtener una lista completa de flags y opciones, lea Usar como CLI.