使用 GitHub 自动部署

安装 Atlas App Services GitHub 应用

为了基于 GitHub 存储库自动部署，Atlas App Services 要求您安装至少具有对存储库的读取访问权限的 GitHub 应用。

要安装应用，请单击 App Services 用户界面左侧导航菜单中的 Deployment。选择 Configuration 标签页，然后单击 Install App Services on GitHub。随即会打开一个新的浏览器窗口，显示 GitHub 应用程序安装流程。

选择要安装应用的 GitHub 账户或组织：

指定一个或多个要授予 App Services 读取权限的存储库。您既可以选择特定的存储库，也可以授权访问 GitHub 上的所有存储库。选择要使用的存储库，然后单击 Install。

安装应用程序后，返回到Configuration选项卡并单击Authorize按钮以完成将 App Services 连接到 GitHub 的操作。这将引导您进入 github 权限屏幕。单击Authorize MongoDB Atlas App Services。

指定 GitHub 存储库

将 GitHub 帐户链接到应用后，您可以指定 App Services 应自动部署的存储库。指定包含应用配置文件的Repository、Branch和Directory，然后单击Save。

初始化存储库

克隆您指定的 Git 存储库的本地副本：

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

配置的分支和目录必须包含定义应用程序的配置文件。您可以手动创建配置，或导出现有应用的应用程序目录。

将应用程序目录添加到存储库，然后提交更改：

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

将最新版本的应用程序提交到存储库后，将其推送到 GitHub 存储库：

git push origin <branch name>

启用自动部署

指定要部署的存储库并使用最新版本的应用程序对其进行初始化后，您需要启用自动部署才能开始部署应用。在 Deploy（部署）页面的 Configuration（配置）标签页上，单击 Enable Automatic Deployment（启用自动部署）。在出现的模态窗口中，单击 Enable Automatic Deployment（启用自动部署）以确认您的选择。

对应用程序进行更改

部署包含自上一个部署以来您对应用程序所做的一项或多项更改。对要包含在部署中的存储库执行任何添加、修改、或删除操作。

有关应用程序目录结构和模式的详细信息，请参阅应用配置参考页面和个别组件参考页面。

提交并推送更改

更新应用程序配置后，可以通过将更新推送到您指定的 GitHub 存储库，将更新部署为新版本的应用。如果已启用自动 GitHub 部署，则 App Services 会立即部署已配置的分支和目录的最新提交。

当您准备好部署时，提交您想要包含的所有文件，然后将它们推送到 GitHub：

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

成功将更改推送到 GitHub 后，App Services 就会立即部署与最新提交的状态匹配的应用程序的新版本。客户端应用程序将自动使用最新版本，因此如有必要，请确保同时更新客户端代码以使用新版本。

对 MongoDB Atlas 用户进行身份验证

使用 MongoDB Atlas Admin API 密钥登录到 CLI：

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

运行部署配置命令

App Services CLI 可以引导您完成配置自动部署的过程。 这是一个交互式命令。

appservices deploy configure

该命令还支持您可以选择包含的其他标志。 有关这些标志的信息，请参阅appservices部署配置。

完成此命令后， App Services CLI会立即启用自动部署。 您无需额外运行enable命令。

禁用、启用或查看配置详细信息（可选）

配置自动部署后，可以使用App Services CLI查看配置详细信息。

appservices deploy describe

还可以使用App Services CLI禁用和启用自动部署。 有关这些命令及其选项的更多信息，请参阅appservices部署。

对 MongoDB Atlas 用户进行身份验证

使用您的 MongoDB Atlas API 密钥对调用管理员用户身份验证端点：

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

如果身份验证成功，响应正文将包含一个具有access_token值的JSON对象：

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

access_token授予对App Services Admin API的访问权限。 您必须将其作为持有者令牌包含在所有 Admin API请求的Authorization标头中。

获取现有部署配置（可选）

您可以通过向“获取部署配置”端点发出GET请求来获取应用的现有部署配置。

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

更新部署配置

您可以通过向配置部署端点发出PATCH请求来更新应用的现有部署配置。

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