Githubでの自動配置

Atlas App Services Githubアプリのインストール

Githubリポジトリに基づいて を自動的に配置するには、 Atlas App Servicesは、少なくともリポジトリへの読み取りアクセス権を持つGithubアプリをインストールする必要があります。

アプリをインストールするには、App Services UI の左側のナビゲーション メニューで [ Deploymentをクリックします。 [ Configuration ] タブを選択し、[ Install App Services on GitHubをクリックします。 Githubアプリケーション インストール フローに対して新しいブラウザ ウィンドウが開きます。

アプリをインストールするGithubアカウントまたは組織を選択します。

App Services に読み取りアクセスを許可する 1 つ以上のリポジトリを指定します。 Githubの特定のリポジトリを選択することも、すべてのリポジトリへのアクセスを許可することもできます。 使用するリポジトリを選択し、[ Install ] をクリックします。

アプリケーションをインストールしたら、Configuration タブに戻り、Authorize ボタンをクリックして Atlas App Services とGithubの接続を終了します。 Github権限画面が表示されます。 Authorize MongoDB Atlas App Servicesをクリックします。

Githubリポジトリの指定

Githubアカウントを App にリンクしたら、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をクリックして選択を確定します。

アプリケーションに変更を加える

配置には、前回の配置以降にアプリケーションに対して行った 1 つ以上の変更が含まれます。 配置に含めるリポジトリを追加、変更、または削除します。

アプリケーション ディレクトリの構造とスキーマの詳細については、「 App Configuration 」リファレンス ページと個々のコンポーネントに関するリファレンス ページを参照してください。

変更をコミットしてプッシュする

アプリケーション構成を更新したら、指定した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 deployment configure を参照してください。

このコマンドを完了すると、App Services CLI は自動配置をすぐに有効にします。 追加のステップとしてenableコマンドを実行する必要はありません。

構成の詳細を無効化、有効化、または表示する（任意）

自動配置を構成した後、App Services CLI を使用して構成の詳細を表示できます。

appservices deploy describe

App Services CLI を使用して、自動配置を無効および有効にすることもできます。 これらのコマンドとそのオプションについて詳しくは、 appservices deployment を参照してください。

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 へのアクセスを許可します。 すべての管理 API リクエストのAuthorizationヘッダーに Bearer トークンとして含める必要があります。

既存の配置構成を取得する（任意）

アプリの既存の配置構成を取得するには、配置構成を取得するエンドポイントに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
      }'