Implementar automáticamente con GitHub

Install the Atlas App Services GitHub App

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.

After you install the application, return to the Configuration tab and click the Authorize button to finish connecting App Services to GitHub. This leads you to a github permissions screen. Click Authorize MongoDB Atlas App Services.

Specify a GitHub Repository

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.

Initialize the Repository

Clone a local copy of the Git repository that you specified:

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"

Once you have committed the latest version of the application to the repository, push it to your GitHub repository:

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

A deployment contains one or more changes that you have made to your application since the previous deployment. Make any additions, modifications, or deletions to the repository that you want to include in your deployment.

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

Once you have updated your application configuration, you can deploy the updates as a new version of your App by pushing them to the GitHub repo that you specified. If Automatic GitHub Deployment is enabled, App Services immediately deploys the latest commit for the configured branch and directory.

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 logras enviar correctamente tus cambios a GitHub, App Services implementa inmediatamente una nueva versión de tu aplicación que coincide con el estado del último commit. Las aplicaciones cliente usarán automáticamente la versión más reciente, así que asegúrate de actualizar también tu código del cliente para usar la nueva versión si es necesario.

Autenticar a un usuario de MongoDB Atlas

Utiliza tu clave de 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>"

Ejecutar el comando de configuración de implementar

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.

Disable, Enable, or View Configuration Details (Optional)

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 a un usuario de MongoDB Atlas

Call the admin user authentication endpoint with your MongoDB Atlas API key pair:

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>"
  }'

If authentication succeeds, the response body contains a JSON object with an access_token value:

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

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

Get an Existing Deployment Configuration (Optional)

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 configuración de implementación existente para su aplicación realizando una solicitud PATCH al endpoint 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
      }'