本番ビルド・ジョブの作成および構成

ビジュアル・アプリケーションをVisual Builder本番インスタンスにデプロイする前に、いくつかのパッケージ・ジョブおよびデプロイメント・ジョブを設定する必要があります。このトピックでは、その方法について説明します。

本番ビルド・ジョブを構成する前に、次の点に注意してください:

  • 本番パッケージング・ジョブで、Gitリポジトリの本番ブランチを使用して本番アーティファクトを生成します。
  • 開発パッケージング・ジョブで、アーカイブ・アーティファクト・ファイルのデフォルト・ファイル名を変更した場合は、新しい名前とそのパスを取得します。これらは、本番パッケージング・ジョブを構成するときに必要になります。
  • visual-application.jsonで定義されたアプリケーションのバージョンを上書きするように開発パッケージング・ジョブを構成した場合は、新しいバージョンを取得します。本番パッケージング・ジョブを構成するときに必要になります。
  • デプロイメント・ビルド・ジョブの構成時に、アプリケーションのバージョンをURLに含めるかどうかを指定します。URLにバージョンがないビジュアル・アプリケーションは、ライブ・アプリケーションと呼ばれます。通常、本番インスタンスにライブ・アプリケーションをデプロイします。
  • デプロイされていないビジュアル・アプリケーションのバージョンをデプロイすると、VB Studioは最後にデプロイされたバージョンを新しいバージョンで上書きします。

    VB Studioは、以前にデプロイされたバージョンを本番インスタンスからアンデプロイしません。ターゲット・インスタンスには引き続き残りますが、アクセスできません。

  • ライブ・アプリケーションまたは以前にデプロイされたバージョンを再デプロイする場合は、最初にデプロイ解除してください。そうしないと、デプロイ・ビルドが失敗します。以前にデプロイされたビジュアル・アプリケーション・バージョンをアンデプロイするには、アンデプロイ・ビルド・ジョブを構成して実行します「環境」ページから手動でアンデプロイすることはできません。
  • アプリケーションをカスタムURLにデプロイする場合は、カスタムURLをホストする環境にデプロイするようにデプロイ・ジョブを構成する必要があります。基本的な認証認証を使用してのみアプリケーションをデプロイできるため、環境への接続およびデプロイに必要な資格証明が正しいことを確認する必要があります。
  • 本番用のアプリケーション・プロファイルを作成した場合は、その名前を取得します。本番デプロイメント・ジョブを構成するときに必要になります。

本番パッケージ・ビルド・ジョブの作成

本番パッケージング・ジョブは、デプロイ可能なビジュアル・アプリケーション・アーティファクトを生成します。

  1. 左側のナビゲータで、「ビルド」 ビルドをクリックします。
  2. 「ジョブ」タブで、「+ジョブの作成」をクリックします。
  3. 「新規ジョブ」ダイアログ・ボックスの「名前」に、一意の名前を入力します。
  4. 「説明」にジョブの説明を入力します。
  5. 「テンプレート」で、Visual Builderのシステム・デフォルトOL7テンプレートを選択します。
  6. 「作成」をクリックします
  7. 「構成」 ビルドをクリックします。
  8. 「Git」タブをクリックします。
  9. 「Gitの追加」リストから、「Git」を選択します。
  10. 「Repository」で、Gitリポジトリを選択します。「ブランチまたはタグ」で、本番ブランチを選択します。
  11. 「ステップ」タブをクリックします。
  12. 「ステップの追加」から、「ビジュアル・アプリケーション」「パッケージ」の順に選択します。
  13. デフォルトでは、ビルド・ジョブによって、ビルドを実行する前にアプリケーションのソース・コードが最小化されます。ソース・ファイルを最小化しない場合は、「アプリケーションの最適化」チェック・ボックスの選択を解除します。
    最小化とは、ソース・コードから不要な文字(空白、改行、コメントなど)を削除し、ファイルのサイズを小さくするプロセスであり、ファイル転送の帯域幅とストレージの消費が少なくなります。
  14. アーカイブ・ファイルのデフォルト名を変更する場合は、「ファイル名」「カスタム・ファイル名の使用」を選択します。
    「ソース」で、ビジュアル・アプリケーション・ソース・アーカイブ・ファイルの名前とパスを指定します。「アーティファクトのビルド」で、ビルド・アーティファクト・アーカイブ・ファイルの名前とパスを指定します。

    ビジュアル・アプリケーションをデプロイするには、両方のアーカイブ・ファイルが必要になります。

  15. 「構築後」タブをクリックします。
  16. 「ビルド後に追加」アクションから、「アーティファクト・アーカイバ」を選択します。
  17. 「アーカイブするファイル」に、ビルド・アーティファクト名を入力します。ワイルド文字を使用することもできます。たとえば、*.zip
  18. ビルドの古いアーティファクトを破棄する場合は、「設定」 「Gear」アイコンをクリックします。「一般」タブで、「Discard Old Builds」チェック・ボックスを選択し、破棄オプションを指定します。
  19. 「保存」をクリックします。

本番デプロイメント・ビルド・ジョブの作成

本番デプロイメント・ジョブは、本番パッケージング・ジョブで生成されたビジュアル・アプリケーションのアーティファクトをVisual Builder本番インスタンスにデプロイします。ジョブを作成する前に、Visual Builder本番インスタンスに接続してデプロイできるユーザーのアクセス資格証明を取得します。

  1. 左側のナビゲータで、「ビルド」 ビルドをクリックします。
  2. 「ジョブ」タブで、「+ジョブの作成」をクリックします。
  3. 「新規ジョブ」ダイアログ・ボックスの「名前」に、一意の名前を入力します。
  4. 「説明」にジョブの説明を入力します。
  5. 「テンプレート」で、Visual Builderのシステム・デフォルトOL7テンプレートを選択します。
  6. 「作成」をクリックします
  7. 「構成」 ビルドをクリックします。
  8. 「ビルド前」タブをクリックします。
  9. 「ビルド前に追加」アクションから、「アーティファクトのコピー」を選択します。
  10. 「ジョブから」で、ビジュアル・アプリケーションのアーティファクトを生成した本番パッケージング・ジョブを選択します。
  11. 「どのビルド」で、「最終成功ビルド」を選択します。
  12. 他のフィールドは、デフォルトまたは空の値のままにします。
  13. 「ステップ」タブをクリックします。
  14. 「ステップの追加」から、「ビジュアル・アプリケーション」「デプロイ」の順に選択します。
  15. 「ターゲット・インスタンス」で、Visual Builderの本番インスタンスを選択します。
  16. 「認可」セクションで、このビルド・ステップを実行する認可タイプを指定します。「OAuthの使用」をデフォルトで選択すると、Authorization is requiredメッセージが表示され、このビルド・ステップでは、環境のVisual BuilderインスタンスへのOAuthリクエストを処理するために1回かぎりの認可が必要であることが示されます。「認可」をクリックし、資格証明を入力してVisual Builderインスタンスにアクセスします。ジョブを手動で実行し、プロンプトが表示されたら資格証明を入力することもできます。

    いずれの場合も、初期構成時にOAuth接続を承認することをお薦めします。このステップをスキップすると、デザイナから変更を公開できなくなり、変更のデプロイを試行する前に必要な承認を完了する必要があります。

    承認されると、Authorization has been providedメッセージが表示されます。

    ノート

    OAuthが推奨される認可タイプです。OAuth接続の設定で問題が発生した場合のみ、Basic認証を使用します。Basic認証を使用するには、「基本の使用」を選択し、「ユーザー名」および「パスワード」でVisual Builderインスタンスにアクセスできるユーザーの資格証明を入力します。

    OAuthトークン(アクセスおよびリフレッシュ)は、通常の使用中に循環されます。リフレッシュ・トークンは、ユーザーがターゲット・インスタンスにアクセスするたびにアクセス・トークンを取得するために使用されます。このリフレッシュ・トークンは通常、7日間有効です。(トークンの有効期限はIDCSリソース・アプリケーションで設定され、セキュリティ要件によって異なる場合があります。)ユーザーが7日以内にターゲット・インスタンスで認証すると、アクティブなリフレッシュ・トークンによって新しいアクセス・トークンと新しいリフレッシュ・トークンが生成されます。リフレッシュ・トークンが有効であるかぎり、このサイクルは無期限に継続されます。リフレッシュ・トークンが長時間非アクティブ状態(休暇中など)で期限切れになった場合は、「認可の更新」をクリックします(またはジョブを手動で実行するため、期限切れのOAuthトークンを認可するように求められます)。

  17. 本番パッケージング・ジョブで、アーカイブ・アーティファクト・ファイルのデフォルトのファイル名を変更した場合は、「ファイル名」「カスタム・ファイル名の使用」を選択します。
    「ソース」および「アーティファクトのビルド」に、パッケージング・ジョブで指定したものと同じファイル名(パス付き)を入力します。

    ファイル名を変更しなかった場合は、デフォルト・オプションを使用します。

  18. (オプション)開発デプロイメント・ジョブを構成してアプリケーションのデフォルト・バージョンを上書きする場合は、「アプリケーション・バージョン」で同じバージョンを指定します。アプリケーションのvisual-application.jsonファイルに定義されているバージョンを使用するには、空のままにします。
    バージョンがすでにデプロイされている場合は、最初にアンデプロイします。
  19. 「URLにアプリケーション・バージョンを含める」チェック・ボックスの選択を解除します。
    本番インスタンスにデプロイする場合は、デプロイされたアプリケーションのURLにアプリケーションのバージョンを含めないでください。
  20. (オプション)「アプリケーション・プロファイル」で、本番アプリケーション・プロファイルを指定します。アプリケーションのデフォルト・プロファイルを使用するには、空のままにします。

    ビジュアル・アプリケーションは、RESTサービスの異なるサーバーのデータにアクセスするため、開発や本番などの環境ごとに異なるセキュリティ設定が必要になる場合があります。アプリケーション・プロファイルを使用すると、環境ごとに異なるサーバーとセキュリティ設定の組合せを定義し、アプリケーションを環境にデプロイするときに使用できます。これにより、開発から本番への移行時にビジュアル・アプリケーションの管理が簡略化されます。詳細は、「アプリケーション・プロファイルについて」を参照してください。

  21. アプリケーションにクリーン・データベースを使用するには、「データ管理」「クリーン・データベースの使用」を選択します。
  22. 「保存」をクリックします。

本番ジョブのプライバシ設定の構成

ジョブを非公開としてマークして、ジョブの構成を表示または編集できるユーザーを制限したり、そのビルドを実行します。

プライベート・ジョブは手動で実行する必要があります。権限のないユーザーがSCM/定期的なトリガーまたはパイプラインを介してジョブを直接実行しようとした場合、実行されません。
  1. 左側のナビゲータで、「プロジェクト管理」プロジェクト管理者をクリックします。
  2. 「ビルド」をクリックします。
  3. 「ジョブ保護」タブをクリックします。
  4. ジョブ・リストから、本番ジョブを選択します。
  5. 「プライベート」オプションを選択します。
  6. 「認可ユーザー」に、自分自身を追加します。
    次に、他のユーザーを追加するには、ユーザーを個別に選択するか、「グループ」でユーザーのグループ(1つまたは複数)を選択します。
  7. デプロイメント本番ジョブに対して、ステップ4から6を繰り返します。
  8. 「保存」をクリックします。

プライベート・ジョブでは、ジョブ保護ページの右側にあるジョブ・リスト、「ビルド」ページの「ジョブ」タブ、およびパイプラインに「ロック」ロックアイコンが表示されます。

パイプラインの作成と構成

本番デプロイメント・ジョブが本番パッケージ・ジョブ後に自動的に実行されるようにするには、パイプラインを作成し、依存関係を設定します。

  1. 左側のナビゲータで、「ビルド」 ビルドをクリックします。
  2. 「パイプライン」タブをクリックします。
  3. 「+パイプラインの作成」をクリックします。
  4. 「パイプラインの作成」ダイアログ・ボックスの「名前」および「摘要」に、一意の名前と摘要を入力します。
  5. 「作成」をクリックします
  6. 「パイプライン構成」ページで、「開始」ノードを右クリックし、「新規開始の追加」ジョブを選択します。
  7. 「成功時に新規ジョブを選択」フィールドをクリックし、パッケージング・ジョブを選択して「保存」をクリックします。
  8. パッケージング・ジョブを右クリックし、「追加」「成功時に新規ジョブの追加」の順に選択します。
  9. 「成功時に新規ジョブを選択」フィールドをクリックし、デプロイメント・ジョブを選択して、「保存」をクリックします。

    ファイナライズされたパイプラインの例を次に示します。

  10. 「保存」をクリックします。

パイプラインの実行

ビジュアル・アプリケーションを本番インスタンスにデプロイする準備ができたら、本番パイプラインを実行します。

  1. 左側のナビゲータで、「ビルド」 ビルドをクリックします。
  2. 「パイプライン」タブをクリックします。
  3. 開発パイプラインの行で、「アクション」 アクションメニューをクリックし、「パイプラインの実行」を選択します。

ビルドが成功すると、デプロイされたアプリケーションのリンクが「環境」ページの「デプロイメント」タブに表示されます。

ジョブの最新ビルド・ログを表示するには、「ビルド」ページを開き、ジョブの名前をクリックして、「ログの作成」をクリックします。