Dev Tools > Pipeline > コンソール使用ガイド > Pipeline Management
パイプラインは、1つ以上のステージで構成されたアプリケーション配布フローを定義します。
パイプラインの構成
パイプラインの作成
パイプラインの作成をクリックしてパイプラインを作成することができ、パイプラインテンプレートファイルをアップロードしてパイプラインを作成することもできます。
パイプライン管理で+パイプライン作成をクリックします。
パイプライン作成モーダルウィンドウでパイプライン名とパイプラインの説明を入力し、確認をクリックします。
または、パイプラインテンプレートファイルでパイプラインを作成することもできます(パイプラインテンプレートはJSONファイルを使用します)。
パイプラインテンプレートファイルをアップロードした後、確認をクリックします。
パイプラインスタジオ
パイプラインスタジオは、ユーザーがパイプラインの基本情報を管理したり、パイプラインを構成するステージを追加、変更、削除することができるページです。
パイプラインスタジオの上部には、パイプラインの名前、説明、最終修正日、コンストラクタの基本情報が表示されます。
パイプラインスタジオパネルでは、そのパイプラインを構成するステージを確認できます。
編集モード
右上の編集モードトグルをクリックして編集モードに入ることができます。編集モードでは、ステージの追加、変更、削除、位置変更を行うことができます。
ステージの追加
編集モードを有効にすると、左側にアプリケーション配布フローを構成する際に使用できる様々なステージで構成されたソース、ビルド、配布、機能のグループが表示されます。
4つのグループから追加するステージを選択し、ドラッグ＆ドロップで画面に追加できます。
ステージが追加されたら、そのステージを選択して必要な情報を入力します。
以前に実行するステージと追加するステージを接続して実行順序を設定します。
右上のパイプライン保存をクリックしてステージの追加を完了できます。
ステージの編集
編集モードを有効にした後、編集したいステージをクリックしてステージを編集できます。
編集を完了した後、右上のパイプラインを保存をクリックしてステージの編集を完了できます。
ステージの削除
編集モードを有効にした後、削除したいステージの右上のXをクリックしてステージを削除できます。
削除後、右上のパイプライン保存をクリックしてステージの削除を完了できます。
パイプラインの実行
パイプラインは手動または自動で実行できます。
手動実行
手動実行を使用すると、ユーザーが好きな時にパイプラインを実行できます。
パイプライン管理で▶︎実行をクリックし、パイプライン実行モーダルウィンドウが表示されたら内容を確認し、確認をクリックします。
自動実行
自動実行を使うと、GitHubまたはGitLabリポジトリにイベントが発生したり、イメージストアのコンテナイメージを更新すると、パイプラインを自動で実行するように設定できます。
自動実行設定をクリックした後、自動実行設定モーダルウィンドウで追加をクリックします。
- GitHub自動実行設定
GitHub Webフックを使用してGitHubまたはGitHub Enterpriseのリポジトリにイベントが発生すると、パイプラインを自動で実行するように設定できます。自動実行タイプを GitHubに設定し、リポジトリの組織名またはユーザー名、プロジェクト名、ブランチまたはタグ、シークレットを入力して確認をクリックします。
タグで自動実行を設定するには、ブランチまたはタグ項目にrefs/tags/タグ名のようにタグ名を入力します。タグ名部分にはJAVA正規表現を使用できます。
タグで自動実行を設定した後、NHN Cloudビルドツール使用時に設定されたタグでビルドを実行します。ビルド - Jenkinsステージでタグでビルドを実行するためには次のように設定する必要があります。
Jenkinsで次のようにパラメータを設定します。
Pipelineのビルドツール設定でビルドジョブパラメータに次のように入力します。
- GitHub Webフック設定値
| 項目 | 設定値 |
|---|---|
| Payload URL | https://kr1-pipeline.api.nhncloudservice.com/webhooks/git/github |
| Content type | application/json |
| Secret | パイプライン自動実行設定のシークレットに入力した値 |
| event | push event, create event(タグを使用する場合) |
特定のファイルがPushされた時だけ自動実行するように設定できます(最大5つまで)。
ソースリポジトリ名は環境設定で登録したソースリポジトリを選択します。 GitHubファイルパスは、選択したソースリポジトリのファイルを含むパスを入力します。
- GitLab自動実行設定
GitLab Webフックを使用して、GitLabリポジトリにイベントが発生するとパイプラインを自動で実行するように設定できます。自動実行タイプをGitLabに設定し、リポジトリの組織名またはユーザー名、プロジェクト名、ブランチまたはタグを入力して確認をクリックします。GitLabシークレット設定は後日サポートする予定です。
- GitLab Webフック設定値
| 項目 | 設定値 |
|---|---|
| URL | https://kr1-pipeline.api.nhncloudservice.com/webhooks/git/gitlab |
| Trigger | Push eventsチェック |
| Secret | 設定しない |
| SSL verification | Enable SSL verificationチェック |
- GitLab Webフック設定時の注意事項
GitLabのユーザー名で自動実行を設定する場合、ユーザー名をGitLabのユーザー名と同じに設定する必要があります。ユーザー名が違う場合、自動実行が動作しない場合があります。
- イメージストア自動実行設定
コンテナイメージを更新した時、パイプラインを自動で実行するには、自動実行タイプを イメージストアに設定します。
イメージリポジトリを環境設定で登録した項目として選択し、イメージ名を入力します。イメージ名はNHN Cloud Container Registryの場合registry名/イメージ名の形で入力します。
Docker Hubの場合Docker Hubアカウント/イメージ名の形式で入力します。 タグはJAVA正規表現を使用することができ、入力したタグとマッチングするタグがpushされた場合、自動実行されます。
タグを入力しない場合、latestを除く新規タグがpushされた場合、自動実行されます。
入力が終わったら確認をクリックします。
パイプラインを新規作成すると、自動実行のトグルスイッチがオフの状態で適用されます。パイプラインを自動で実行するには、自動実行のトグルスイッチをクリックして有効にする必要があります。
パイプライン管理
ユーザーはパイプラインの基本情報を修正できます。
パイプライン名の横にある修正アイコンをクリックして、パイプラインの名前と説明を修正できます。
情報を修正した後、確認をクリックして修正を完了できます。
▶手動実行をクリックして該当パイプラインを実行することができ、■実行停止をクリックして実行中のパイプラインを停止できます。
最近の実行情報を確認
パイプラインの最近の実行に関する各ステージの基本情報と実行状態を確認するには、最近の実行情報をクリックします。
パイプラインJSONの修正及びダウンロード
JSONを修正してパイプラインを変更できます。
パイプラインバージョンをクリックしてJSON形式でパイプラインを確認できます。
左上のパイプライン修正日が表示されたドロップダウンボタンをクリックして修正日別に確認できます。
右上のパイプラインテンプレートのダウンロードをクリックしてJSONファイルとして保存できます。
編集をクリックすると、画面上でJSONファイルを直接修正できます。