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

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

ヒント:

必要に応じて、VB Studioでビルド・ジョブおよびパイプラインを作成して有効にできます。ビジュアル・アプリケーションの設定エディタの「ビルドおよびパブリッシュ」で、本番ブランチを選択し、「CI/CDパイプラインの作成」をクリックします。その後、必要に応じて新しく作成したビルド・ジョブを変更できます(追加の構成ステップについては、次のガイダンスを参照)。たとえば、デプロイメント・ジョブでは、デプロイメント・ターゲットは常にワークスペースに関連付けられた環境であるため、ターゲット・インスタンスを本番インスタンスに変更する必要があります。

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

本番パッケージ・ジョブで、Gitリポジトリの本番ブランチを使用して本番アーティファクトを生成します。
開発パッケージング・ジョブで、アーカイブ・アーティファクト・ファイルのデフォルト・ファイル名を変更した場合は、新しい名前とそのパスを取得します。これらは、本番パッケージング・ジョブを構成するときに必要になります。
visual-application.jsonで定義されたアプリケーションのバージョンを上書きするように開発パッケージング・ジョブを構成した場合は、新しいバージョンを取得します。これは、本番パッケージング・ジョブを構成するときに必要になります。
デプロイメント・ビルド・ジョブの構成時に、アプリケーションのバージョンをURLに含めるかどうかを指定します。URLにバージョンがないビジュアル・アプリケーションは、ライブ・アプリケーションと呼ばれます。通常は、本番インスタンスにライブ・アプリケーションをデプロイします。
デプロイされていないビジュアル・アプリケーションのバージョンをデプロイした場合、VB Studioは最後にデプロイされたバージョンを新しいバージョンで上書きします。
VB Studioは、以前にデプロイされたバージョンを本番インスタンスからアンデプロイしません。ターゲット・インスタンスに引き続き存在しますが、アクセスできません。
ライブ・アプリケーションまたは以前にデプロイされたバージョンを再デプロイする場合は、最初にアンデプロイしてください。そうしないと、デプロイ・ビルドが失敗します。以前にデプロイしたビジュアル・アプリケーション・バージョンをアンデプロイするには、アンデプロイ・ビルド・ジョブを構成して実行します。「環境」ページから手動でアンデプロイすることはできません。
カスタムURLにアプリケーションをデプロイする場合は、カスタムURLをホストする環境にデプロイするようにデプロイ・ジョブを構成する必要があります。デプロイできるのは基本認証を使用したアプリケーションのみであるため、環境への接続およびデプロイに必要な資格証明が正しいことを確認する必要があります。
本番用のアプリケーション・プロファイルを作成した場合は、その名前を取得します。これは、本番デプロイメント・ジョブを構成するときに必要になります。

本番パッケージ作成ジョブの作成

本番パッケージング・ジョブは、デプロイの準備が整ったビジュアル・アプリケーション・アーティファクトを生成します。

左側のナビゲータで、「ビルド」をクリックします。
「ジョブ」タブで、「+ジョブの作成」をクリックします。
「新規ジョブ」ダイアログ・ボックスの「名前」に、一意の名前を入力します。
「説明」に、ジョブの説明を入力します。
「テンプレート」で、「Visual Builderのシステム・デフォルトOL7」テンプレートを選択します。
「作成」をクリックします。
「構成」 をクリックします。
「Git」タブをクリックします。
「Gitの追加」リストから、「Git」を選択します。
「リポジトリ」で、Gitリポジトリをクリックします。「ブランチまたはタグ」で、本番ブランチを選択します。
「ステップ」タブをクリックします。
「ステップの追加」から、「ビジュアル・アプリケーション」を選択し、「パッケージ」を選択します。
デフォルトでは、ビルド・ジョブは、ビルドを実行する前にアプリケーションのソース・コードを最小化します。ソース・ファイルを最小化しない場合は、「アプリケーションの最適化」チェック・ボックスの選択を解除します。
最小化とは、ソース・コードから不要な文字(空白、改行、コメントなど)を削除し、ファイルのサイズを小さくして、ファイルの転送で消費される帯域幅と記憶域を少なくするプロセスです。
アーカイブ・ファイルのデフォルト名を変更する場合は、「ファイル名」で「カスタム・ファイル名の使用」を選択します。
「ソース」で、ビジュアル・アプリケーション・ソース・アーカイブ・ファイルの名前とパスを指定します。「アーティファクトのビルド」で、ビルド・アーティファクト・アーカイブ・ファイルの名前とパスを指定します。
ビジュアル・アプリケーションをデプロイするには、両方のアーカイブ・ファイルが必要です。
「作成後」タブをクリックします。
「ビルド・アクション後に追加」から、「アーティファクト・アーカイバ」を選択します。
「アーカイブするファイル」に、ビルド・アーティファクト名を入力します。ワイルドカード文字を使用することもできます。たとえば、*.zipです。
ビルドの古いアーティファクトを破棄する場合は、「設定」 をクリックします。「一般」タブで、「古いビルドの破棄」チェック・ボックスを選択し、破棄オプションを指定します。
「保存」をクリックします。

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

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

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

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

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

ノート

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

OAuthトークン(アクセスおよびリフレッシュ)は、通常の使用中に循環されます。リフレッシュ・トークンは、ユーザーがターゲット・インスタンスにアクセスするたびにアクセス・トークンを取得するために使用されます。このリフレッシュ・トークンは通常、7日間有効です。(トークンの有効期限はIDCSリソース・アプリケーションで設定され、セキュリティ要件によって異なる場合があります。) ユーザーが7日以内にターゲット・インスタンスで認証すると、アクティブなリフレッシュ・トークンによって新しいアクセス・トークンと新しいリフレッシュ・トークンが生成されます。リフレッシュ・トークンが有効であるかぎり、このサイクルは無期限に続行されます。リフレッシュ・トークンが長時間非アクティブ状態(休暇中など)で期限切れになった場合は、「認可の更新」をクリックします(または、ジョブを手動で実行すると、期限切れのOAuthトークンを承認するよう求められます)。
本番パッケージング・ジョブで、アーカイブ・アーティファクト・ファイルのデフォルト・ファイル名を変更した場合は、「ファイル名」で「カスタム・ファイル名の使用」を選択します。
「ソース」および「アーティファクトの構築」に、パッケージング・ジョブで指定したものと同じファイル名(パス付き)を入力します。
ファイル名を変更しなかった場合は、デフォルト・オプションを使用します。
(オプション)アプリケーションのデフォルト・バージョンを上書きするように開発デプロイメント・ジョブを構成した場合は、「アプリケーション・バージョン」で同じバージョンを指定します。アプリケーションのvisual-application.jsonファイルに定義されているバージョンを使用する場合は、空のままにします。
バージョンがすでにデプロイされている場合は、最初にアンデプロイします。
「URLにアプリケーション・バージョンを含めます」チェック・ボックスの選択を解除します。
本番インスタンスにデプロイする場合は、デプロイされたアプリケーションのURLにアプリケーションのバージョンを含めないでください。
(オプション)「アプリケーション・プロファイル」で、本番アプリケーション・プロファイルを指定します。アプリケーションのデフォルト・プロファイルを使用するには、空のままにします。

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

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

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

プライベート・ジョブは手動で実行する必要があります。権限のないユーザーが、SCM/定期トリガーまたはパイプラインを介してジョブを直接実行しようとした場合、実行されません。

左側のナビゲータで、「プロジェクト管理」 をクリックします。
「ビルド」をクリックします。
「ジョブ保護」タブをクリックします。
ジョブ・リストから、本番ジョブを選択します。
「プライベート」オプションを選択します。
「認可ユーザー」で、自分を追加します。
次に、他のユーザーを追加するには、ユーザーを個別に選択するか、「グループ」でユーザーのグループを選択します。
デプロイメント本番ジョブに対してステップ4から6を繰り返します。
「保存」をクリックします。

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

パイプラインの作成および構成

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

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

最終化されたパイプラインの例を次に示します:

図visualapp-prod-pipeline3.pngの説明
「保存」をクリックします。

パイプラインの実行

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

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

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

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