Dev Tools > Pipeline > コンソール使用ガイド

コンソール使用ガイドではPipelineを使用するために必要な基本的な内容を説明します。 - 環境設定 - パイプラインの作成 - パイプラインの実行 - パイプラインの管理 - 開発環境設定

環境設定

Pipelineは、アプリケーション配布フローを構成するとき、さまざまな外部システムを使用します。環境設定でPipelineが使用する外部システムを追加できます。

Pipelineに追加できる外部システムは次のとおりです。 - ソースリポジトリ - イメージストア - ビルドツール - 配布対象

ソースリポジトリ

ソースリポジトリを追加すると、NHN Cloudビルドツールを使用してソースコードをビルドできます。 GitHub、GitLab、GitHub Enterpriseなどのgitコマンドを使用してアクセスできるリポジトリを追加できます。

console-guide-01

環境設定でソースリポジトリ設定をクリックすると、ソースリポジトリを管理する画面に移動します。ソースリポジトリ追加をクリックしてソースリポジトリを追加できます。

console-guide-02

ソースリポジトリ情報を入力し、ソースリポジトリ接続確認の確認をクリックします。GitLabソースリポジトリのトークン発行時にread_user、api、read_api権限が必ず必要です。接続確認後に確認をクリックします。

console-guide-03

イメージストア

イメージストアを追加すると、認証情報が必要なイメージストアにアクセスするときに使用できます。 NHN Cloudビルドツールでソースコードをビルドするコンテナを作成するときや、新たに作成したコンテナイメージをアップロードするときに使用できます。そしてパイプライン自動実行設定で自動実行を実行させるコンテナイメージを設定するときに使用できます。イメージストアにはNHN Cloud Container Registry、Docker Hubの他にPrivate Docker Registryを追加できます。

console-guide-04

環境設定でイメージストア設定をクリックすると、イメージストアを管理する画面に移動します。 イメージストア追加をクリックしてソースリポジトリを追加できます。

console-guide-05

イメージストア情報を入力し、イメージストア接続確認の確認をクリックします。接続確認後に確認をクリックします。イメージストアURLを入力していない場合はDocker Hubとして動作します。

console-guide-06

ビルドツール

ビルドツールを追加すると、パイプラインでビルドツールに定義したさまざまな作業を使用できます。ビルドツールにはJenkinsを追加できます。

console-guide-07

環境設定でビルドツール設定をクリックすると、ビルドツールを管理する画面に移動します。 ビルドツール追加をクリックしてビルドツールを追加できます。

console-guide-08

ビルドツール情報を入力し、ビルドツール接続確認の確認をクリックします。接続確認後に確認をクリックします。

console-guide-09

配布対象

配布対象を追加すると、パイプラインで配布対象を管理できます。配布対象にコンテナイメージを配布したり、実行中のコンテナを変更できます。配布対象にはNHN Cloud Container、Kubernetesを追加できます。

console-guide-10

環境設定で配布対象設定をクリックすると、配布対象を管理する画面に移動します。 配布対象追加をクリックして配布対象を追加できます。

console-guide-11

配布対象の名前と説明を入力し、Kubeconfigファイルを選択して配布対象接続確認の 確認をクリックします。接続確認後に確認をクリックします。

console-guide-12

Pipeline IP

Pipelineと連動したシステムが正常に動作しない場合はACLを確認してください。Pipelineが使用するIPアドレスは 211.56.1.0/27です。

サービス CIDR
Pipeline 211.56.1.0/27

パイプラインの作成

Pipelineはアプリケーション配布フローを1つ以上のステージで構成したパイプラインとして保存します。パイプライン作成ではソースコードのビルド > コンテナイメージの作成 > コンテナイメージのアップロード、コンテナイメージの配布の順序で動作する基本的なパイプラインを作成できます。

console-guide-13

パイプライン管理でパイプライン作成をクリックします。パイプラインの作成は、次の手順で進めます。 - パイプライン情報の入力 - ソース設定 - ビルド設定 - 配布設定 - 最終検討およびパイプラインの作成

パイプライン情報の入力

パイプラインの基本情報を入力します。

console-guide-14

パイプライン名、パイプラインの説明を入力し、 次へをクリックします。

ソース設定

NHN Cloudビルドツールでソースコードをビルドするときに使用するソースリポジトリを設定します。 NHN Cloudビルドツールを使用しない場合や、NHN Cloudビルドツールでソースコードをビルドしない場合は省略できます。

console-guide-15

ステージ名、環境設定で登録したソースリポジトリ、ソースコードをビルドするブランチを入力し、 次へをクリックします。

ビルド設定

ビルド設定では、NHN Cloudビルドツールや、環境設定で登録したビルドツールを使用できます。ステージ名を入力し、ビルドツールで使用するビルドツールを選択します。

console-guide-16

NHN Cloudビルドツールを使用すると、別途ソフトウェアをインストールせずにソースリポジトリに保存したアプリケーションソースコードをビルドし、ビルドしたアプリケーションでコンテナイメージを作成し、作成したコンテナイメージをイメージストアにアップロードできます。 ビルド環境設定にはソース設定で設定したソースコードを使用してアプリケーションをビルドする方法を入力します。ソースコードのビルドに使用するコンテナイメージ、ビルドマシンの性能、ビルドに使用するコマンドを入力できます。 ビルド結果設定にはビルドしたアプリケーションでコンテナイメージを作成する方法を入力します。コンテナイメージを作成するときに使用するDockerfile、作成したコンテナイメージをアップロードするイメージストア、アップロードするコンテナイメージの名前とタグを入力できます。 タグフォーマット使用チェックボックスをクリックするとイメージタグフォーマットを使用できます。イメージタグフォーマットを使用すると、作成されたイメージのタグをNHN Cloudビルドツールで付与するビルド番号として使用します。作成されるタグは_{BUILD_NUMBER}形式で、BUILD_NUMBERがビルド番号です。 ビルド番号はビルドごとに増加する数字型のデータです。イメージタグフォーマット使用時にはタグが_{BUILD_NUMBER}形式で固定されます。

console-guide-17

環境設定で追加したビルドツールを使用すると、ビルドツールのビルドジョブを実行できます。実行するビルドジョブを選択すると、ビルドジョブのパラメータを追加で入力できます。

ビルド設定が完了したら次へをクリックします。

配布設定

配布設定は、環境設定で追加した配布対象にコンテナイメージを配布する方法を設定します。

console-guide-18

ステージ名、配布対象、配布に使用するManifestを入力し、次へをクリックします。 Manifestを作成する方法はKubernetes文書を参照してください。

console-guide-38

ビルド設定でタグフォーマットを使用した場合、ドッカー(Docker)イメージ入力部分にタグを上記のように_{BUILD_NUMBER}に入力します。イメージのタグに_{BUILD_NUMBER}が入力されている場合、最新の番号で入力されて配布されます。 タグフォーマットを使用するにはビルドステージおよびNHN Cloudビルドツールを設定する必要があります。

最終検討とパイプラインの作成

最終検討ではパイプラインに設定した全ての入力内容を確認できます。

console-guide-19

入力した内容を確認し、作成をクリックします。

console-guide-20

パイプラインの実行

パイプラインを実行する方法には手動実行と自動実行があります。

手動実行

手動実行を使用した場合、ユーザーが望むときにパイプラインを実行できます。

console-guide-21

パイプライン管理で▶(手動実行)をクリックし、ダイアログボックスが表示されたら確認をクリックします。

自動実行

自動実行を使用すると、GitHub Repositoryにイベントが発生したりイメージストアのコンテナイメージを更新した場合にパイプラインを自動的に実行するように設定できます。

console-guide-22

自動実行設定をクリックし、自動実行設定ダイアログボックスで追加をクリックします。

console-guide-23

GitHub Webフックを使用して、GitHubまたはGitHub EnterpriseのRepositoryにイベントが発生した場合にパイプラインを自動的に実行するように設定できます。自動実行タイプをGitHubに設定し、Repositoryの組織またはユーザー名、プロジェクト名、ブランチ、シークレットを入力し、確認をクリックします。

console-guide-24

GitHubまたはGitHub EnterpriseのRepositoryでWebフックを設定します。

項目 設定値
Payload URL https://kr1-pipeline.api.nhncloudservice.com/webhooks/git/github
Content type application/json
Secret パイプライン自動実行設定のシークレットに入力した値

console-guide-35

GitLab Webフックを使用して、GitLab Repositoryにイベントが発生した場合にパイプラインを自動的に実行するように設定できます。自動実行タイプをGitLabに設定し、Repositoryの組織またはユーザー名、プロジェクト名、ブランチを入力し、確認をクリックします。 GitLabシークレット設定は今後サポートする予定です。

console-guide-36 GitLab RepositoryでWebフックを設定します。

項目 設定値
URL https://kr1-pipeline.api.nhncloudservice.com/webhooks/git/gitlab
Trigger Push eventsチェック
Secret 設定しない
SSL verification Enable SSL verificationチェック

console-guide-37 GitLabのユーザー名で自動実行を設定したとき、GitLabのユーザー名とFull nameが異なる場合、自動実行が動作しない可能性がありますので、同じ値に設定する必要があります。

console-guide-25

コンテナイメージを更新したときにパイプラインを自動的に実行するには、自動実行タイプをイメージストアに設定します。 イメージストアを環境設定で登録した項目に選択したした後、イメージ名を入力します。イメージ名はNHN Cloud Container Registryの場合registry名/イメージ名の形式で入力します。 DockerHubの場合、ドッカーハブアカウント/イメージ名形式で入力します。タグはJAVA正規表現式を使用でき、入力したタグとマッチするタグがpushされた場合に自動実行されます。 タグを入力しない場合、latestを除く新規タグがpushされる場合に自動実行されます。 入力が終わったら確認をクリックします。

console-guide-26

パイプラインを新しく作成したら、自動実行防止を 使用に設定します。パイプラインを自動的に実行するには自動実行防止を未使用に変更する必要があります。パイプラインを選択した後、下部の基本情報の自動実行防止で変更をクリックします。自動実行防止設定ダイアログボックスで未使用を選択した後、確認をクリックします。

console-guide-27

実行中のパイプラインの詳細情報を確認するには、実行中のパイプラインを選択した後、下部の基本情報の最近の実行状態で詳細情報をクリックします。

パイプライン管理

ユーザーはパイプラインを構成するステージを追加、変更、削除できます。

console-guide-28

パイプラインを選択した後、下部のステージをクリックすると、ステージ管理画面が表示されます。ステージ追加をクリックするとステージ追加ダイアログボックスが表示されます。

console-guide-29

ステージ名、ステージタイプ、ステージタイプ別の入力値、以前の段階を設定した後、ステージ追加をクリックしてパイプラインにステージを追加できます。 Pipelineはアプリケーション配布フローを構成するときに使用できるさまざまなステージタイプを提供します。

console-guide-30

以前のステージを選択する方式に基づいてステージを並列に実行できます。並列構成したステージのうち1つが失敗すると、残りのステージは実行がキャンセルされ、パイプラインの実行は失敗します。

開発環境設定

開発環境設定を使用すると、Kubernetesの使用方法を知らないユーザーもKubernetesにコンテナイメージを配布できます。

console-guide-31

開発環境設定で開発環境の作成をクリックします。

console-guide-32

開発環境名と開発環境の説明を入力し、基本イメージから配布するコンテナイメージを選択します。コンテナイメージのアクセスに必要な情報はイメージストアに設定します。配布対象はコンテナイメージを配布するKubernetesを選択します。サービスポートはコンテナが提供するサービスのポートを入力します。サービスポートを入力すると、コンテナサービスにアクセスできるサービスIPを自動的に割り当て(KubernetesがLoadBalancerタイプのサービスを提供する場合)ます。最後に開発環境の制約事項を入力して作成をクリックすると開発環境を作成します。

console-guide-33

開発環境の作成中は開発環境の状態は作成中と表示されます。

console-guide-34

開発環境の作成が完了すると、開発環境の状態が実行中に変更されます。サービスIPとサービスポートを使用してコンテナサービスにアクセスできます。

目次
TOP