Overview
La interfaz de línea de comandos de Atlas App Services (appservices) le permite administrar sus aplicaciones mediante programación.
Con la CLI de App Services, puede crear o actualizar aplicaciones desde un directorio local, así como exportar aplicaciones existentes a un directorio local.
Instalación
La CLI de App Services está disponible en npm. Para instalar la CLI en su sistema, asegúrese de tener Node.js
instalado y luego ejecute el siguiente comando en su shell:
npm install -g atlas-app-services-cli
Autenticación
Para usar la CLI de App Services, debe autenticarse. Para ello, debe generar una clave API.
Generar una clave API
Navegue hasta MongoDB nube administrador de acceso
El Administrador de acceso a MongoDB Cloud le permite administrar el acceso a su proyecto para usuarios, equipos y claves API. Use el Administrador de acceso al proyecto haciendo clic en el icono Project Access pestaña en el access manager dropdown en la parte superior izquierda de la pantalla.
Crear una clave API.
Project Users can log in with a Project API Key. Create a project API Key by clicking the grey Create API Key button on the right-hand side of the Project Access Manager.
Clicking this button navigates you to the "Create API Key" screen. Set a description for your key.
Para el acceso de escritura, la CLI requiere una clave API con permisos de "Propietario del proyecto". Para el acceso de solo lectura, puede usar "Solo lectura del proyecto". Utilice el menú desplegable Project Permissions para seleccionar los permisos adecuados para su caso de uso.
Copia la llave pública para usarla más tarde para iniciar sesión. Haz clic en next para continuar configurando los detalles de tu clave.
Configurar su lista de acceso API
Copia tu clave privada a un lugar seguro para usarla posteriormente. Por seguridad, la clave privada no volverá a ser visible tras la inicialización. Otra función de seguridad es la Lista de Acceso a la API. Crear una entrada en la Lista de Acceso a la API garantiza que las llamadas a la API se originen desde las IP permitidas.
Se requiere la dirección IP del usuario que utilizará la clave API para poder utilizar la clave. Haga clic en el botón Add Access List Entry. Escriba la dirección IP o haga clic en el botón Use Current IP Address y guarde. Por último, haga clic en el botón de finalización en la parte inferior derecha de su pantalla para terminar de configurar su clave de API.
Autenticarse con una clave API
El .mdb directorio
Al usar la CLI de App Services para enviar o recibir archivos de configuración, la CLI almacena información sobre la aplicación con la que trabaja en el directorio .mdb de la configuración de la aplicación. Esto permite que la CLI recuerde una implementación específica a la que están asociados los archivos de configuración en varios comandos.
Este directorio se genera automáticamente y, por lo general, no se recomienda modificarlo manualmente. Si elimina el directorio .mdb, la CLI ya no podrá asociar sus archivos de configuración con una implementación específica. La CLI crea un nuevo directorio .mdb al ejecutar un comando dirigido a una implementación específica.
La CLI almacena identificadores y metadatos de configuración en el archivo .mdb/meta.json, que tiene el siguiente formato:
{ "config_version": 20230101, "app_id": "42249d526d97af5a287c1eae", "group_id": "4b2cf422930196872221a2d4", "client_app_id": "myapp-abcde" }
Campo | Descripción |
|---|---|
config_versionnumber | La versión del formato de archivo de configuración que cumplen todos los archivos de configuración del directorio. Esto se utiliza para garantizar que la CLI pueda leer los archivos de configuración. |
app_idstring | El valor ObjectId interno de la aplicación. |
group_idstring | El ID del proyecto Atlas con el que está asociada la aplicación. |
client_app_idstring | El ID de la aplicación cliente legible para humanos. |
Perfiles CLI
La CLI almacena información sobre sus usuarios en un perfil. Esto permite ejecutar comandos en un contexto determinado. Por ejemplo, al iniciar sesión con una clave API de administrador de Atlas, la CLI almacena la clave API y el token de acceso de la sesión actual. Luego, reutiliza dicho token para comandos posteriores hasta su vencimiento.
You can set up multiple named profiles and choose a profile to use for any given CLI command. If you don't specify one, the CLI uses the default profile, which is a profile named default.
Para especificar un perfil, agregue el argumento --profile a cualquier comando. Por ejemplo, para iniciar sesión con un nuevo perfil llamado my-profile, ejecute lo siguiente:
appservices login --profile my-profile
Una vez que haya iniciado sesión, puede ejecutar otros comandos con el mismo perfil:
appservices pull --remote=myapp-abcde --profile my-profile
Puede enumerar todos los perfiles de su sistema con un comando CLI:
appservices profiles list
Found 2 profile(s) Profile API Key ---------- ----------------------------------------------- my-profile rjxerfwi (********-****-****-****-f00b471ec015) default xkwwtlmj (********-****-****-****-f03b321dae23)
La CLI almacena los perfiles en su equipo en archivos de configuración individuales, cada uno con su nombre. La ubicación de las definiciones de perfil depende del sistema:
Sistema operativo | Directorio de perfiles |
|---|---|
Unix / Linux |
|
macOS |
|
Windows |
|
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--profile | string | false | Especifique su perfil (valor predeterminado: "predeterminado") [Más información ] |
--telemetry | string | false | Habilitar o deshabilitar el seguimiento del uso de CLI para su perfil actual (valor predeterminado: "activado"; valores permitidos: "activado", "desactivado") |
-o, --output-target | string | false | Guardar la salida de CLI en la ruta de archivo especificada |
-f, --output-format | string | false | Establezca el formato de salida de la CLI (valor predeterminado:; <blank> valores<blank> permitidos:, "json") |
--disable-colors | false | Deshabilite todos los estilos de salida CLI (por ejemplo, colores, estilos de fuente, etc.) | |
-y, --yes | false | Proceda automáticamente a través de los comandos CLI al aceptar cualquier solicitud de usuario requerida | |
-h, --help | false | help for appservices |
Comandos relacionados
appservices accessList - [OBSOLETO] Administre las direcciones IP permitidas y los bloques CIDR de su aplicación (alias: accesslist, access-list)
appservices apps - Manage the App Service Apps associated with the current user (alias: app)
appservices implementar - Administrar implementaciones automáticas de tu aplicación
Funciónappservices: interactúa con las funciones de tu aplicación (alias: funciones)
appservices login - Registra la CLI en Servicios de aplicación usando una clave API de MongoDB de la nube
appservices logout - Cerrar la sesión de la CLI de App Services
appservices logs - Interact with the Logs of your app (alias: log)
appservices pull - Pulls the latest version of your app into your local directory
appservices push - Envía e implementa cambios de tu directorio local a tu aplicación
esquema de appservices - [OBSOLETO] Administre los Esquemas de su aplicación (alias: schemas)
Secretos de AppServices: Administra los secretos de tu aplicación (alias: secreto)
appservices users - [OBSOLETO] Administrar los Usuarios de tu aplicación (alias: usuario)
appservices whoami - Mostrar información sobre el usuario actual