Implementar automáticamente con GitHub

Instalar la aplicación Atlas App Services GitHub

Para realizar una implementación automática basada en un repositorio de GitHub, Atlas App Services requiere que instales una aplicación de GitHub que tenga, como mínimo, acceso de lectura al repositorio.

Para instalar la aplicación, haga clic en Deployment En el menú de navegación izquierdo de la interfaz de usuario de App Services, seleccione la pestaña Configuration y haga clic en Install App Services on GitHub. Se abrirá una nueva ventana del navegador con el proceso de instalación de la aplicación de GitHub.

Seleccione la cuenta u organización de GitHub para la que desea instalar la aplicación:

Especifique uno o más repositorios para los cuales quiere otorgar acceso de lectura a Servicios de aplicación. Se puede dar acceso a repositorios específicos o bien conceder acceso a todos tus repositorios en GitHub. Selecciona los repositorios que quieras usar y haz clic en Install.

Después de instalar la aplicación, regresa a la pestaña Configuration y haz clic en el botón Authorize para terminar de conectar App Services a GitHub. Esto te llevará a la pantalla de permisos de GitHub. Haz clic en Authorize MongoDB Atlas App Services.

Especificar un repositorio de GitHub

Una vez que hayas vinculado tu cuenta de GitHub a tu aplicación, puedes especificar un repositorio que App Services debe implementar automáticamente. Indica los Repository, Branch y Directory que contienen los archivos de configuración de la aplicación y haz clic en Save.

Inicializar el repositorio

Clona una copia local del repositorio Git que especificaste:

git clone https://github.com/<organization>/<repo>.git

La rama y el directorio configurados deben contener los archivos de configuración que definen su aplicación. Puede crear la configuración manualmente o exportar el directorio de una aplicación existente.

Agregue el directorio de la aplicación al repositorio y luego confirme los cambios:

git add -A
git commit -m "Adds App Services Application Directory"

Una vez que hayas enviado la última versión de la aplicación al repositorio, envíala a tu repositorio de GitHub:

git push origin <branch name>

Habilitar la implementación automática

Después de especificar un repositorio para implementar e inicializarlo con la última versión de tu aplicación, debes habilitar la implementación automática para comenzar a implementarla. En la pestaña Configuration de la página Deploy, haz clic en Enable Automatic Deployment. En la ventana emergente, haz clic en Enable Automatic Deployment para confirmar tu selección.

Realice cambios en su aplicación

Una implementación contiene uno o más cambios realizados en la aplicación desde la implementación anterior. Realice las adiciones, modificaciones o eliminaciones que desee incluir en el repositorio.

Consulte la página de referencia de configuración de la aplicación y las páginas de referencia de componentes individuales para obtener detalles sobre la estructura y el esquema del directorio de su aplicación.

Confirme y envíe sus cambios

Una vez que haya actualizado la configuración de su aplicación, puede implementar las actualizaciones como una nueva versión de su aplicación subiéndolas al repositorio de GitHub especificado. Si la Implementación Automática de GitHub está habilitada, App Services implementa inmediatamente la última confirmación para la rama y el directorio configurados.

Cuando estés listo para implementar, confirma todos los archivos que quieras incluir y luego súbelos a GitHub:

git add -A
git commit -m "<commit message>"
git push origin <branch name>

Una vez que hayas subido correctamente tus cambios a GitHub, App Services implementará inmediatamente una nueva versión de tu aplicación que coincida con el estado de la última confirmación. Las aplicaciones cliente usarán automáticamente la versión más reciente, así que asegúrate de actualizar también tu código cliente para usarla si es necesario.

Autenticar un usuario de MongoDB Atlas

Utilice su clave API de administrador de MongoDB Atlas para iniciar sesión en la CLI:

appservices login --api-key="<my api key>" --private-api-key="<my private api key>"

Ejecute el comando Implementar y configurar

La CLI de App Services puede guiarte a través del proceso de configuración de la implementación automática. Este es un comando interactivo.

appservices deploy configure

El comando también admite flags adicionales que puede incluir opcionalmente. Para información sobre estos flags, consulte appservices implementar configure.

La CLI de App Services habilita inmediatamente la implementación automática al completar este comando. No es necesario ejecutar el comando enable como paso adicional.

Deshabilitar, habilitar o ver detalles de configuración (opcional)

Puede utilizar la CLI de App Services para ver los detalles de configuración después de haber configurado la implementación automática.

appservices deploy describe

También puede deshabilitar y habilitar la implementación automática mediante la CLI de App Services. Para obtener más información sobre estos comandos y sus opciones, consulte appservices deploy.

Autenticar un usuario de MongoDB Atlas

Llame al punto final de autenticación del usuario administrador con su par de claves API de MongoDB Atlas:

curl -X POST \
  https://services.cloud.mongodb.com/api/admin/v3.0/auth/providers/mongodb-cloud/login \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{
    "username": "<Public API Key>",
    "apiKey": "<Private API Key>"
  }'

Si la autenticación es exitosa, el cuerpo de la respuesta contiene un objeto JSON con un valor access_token:

{
  "access_token": "<access_token>",
  "refresh_token": "<refresh_token>",
  "user_id": "<user_id>",
  "device_id": "<device_id>"
}

El access_token otorga acceso a la API de administración de App Services. Debe incluirlo como token de portador en el encabezado Authorization para todas las solicitudes de la API de administración.

Obtener una configuración de implementación existente (opcional)

Puede obtener la GET configuración de implementación existente para su aplicación realizando una solicitud al punto final Obtener la configuración de implementación.

curl -X GET \
   https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/deploy/config \
   -H 'Authorization: Bearer <access_token>'

Actualizar la configuración de implementación

Puede actualizar la PATCH configuración de implementación existente para su aplicación realizando una solicitud al punto final Configurar implementación.

curl -X PATCH \
   https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/deploy/config \
   -H 'Authorization: Bearer <access_token>' \
   -d '{
      "ui_drafts_disabled": true,
      "automatic_deployment": {
         "enabled": true,
         "provider": "github",
         "installation_ids": [
            "string"
         ]
      },
      "last_modified": 0
      }'