SourcePipeline を使用する

Prev Next

Classic/VPC環境で利用できます。

SourcePipelineサービスが提供するスペックを確認して使用シナリオと用語を十分熟知したら、SourcePipelineの利用を始めるための準備が完了します。次は SourcePipelineを作成してパイプラインプロジェクトを作成します。SourcePipelineの作成、実行と管理は NAVERクラウドプラットフォームで行います。

ユーザー権限

ログインアカウントに応じた SourcePipeline利用権限を確認し、必要に応じてンソールの i_menu > Services > Management & Governance > Sub Accountメニューでサブアカウントの権限を設定します。

  • 顧客アカウント: SourcePipelineのすべての機能を制限なく利用可能
  • 顧客が作成したサブアカウント: SourcePipelineを使用するには、以下の権限のうち1つが必要
    • NCP_INFRA_MANAGER: すべてのサービスにアクセスできるものの、コンソールの My Account > 課金情報と費用管理 > 請求と決済管理メニューのみアクセスが制限された権限
    • NCP_SOURCE_PIPELINE_MANAGER / NCP_VPC_SOURCE_PIPELINE_MANAGER: SourcePipelineサービス内のすべての機能を利用可能
参考

SourcePipeline作成準備

SourcePipelineを作成と使用するには、まず SourceCommit、SourceBuild、SourceDeploy、Object Storageサービスを利用します。
詳しい使用方法は各サービスのご利用ガイドをご参照ください。

項目 説明 ガイド
SourceCommit ソースコードと様々なファイルを安全に保存できるプライベート Gitリポジトリサービス SourceCommit
SourceBuild 独立したビルドサーバをリアルタイムに作成し、複数のビルドリクエストを同時処理するサービス SourceBuild
SourceDeploy サーバグループに対するリリースを自動化するリリースサービス SourceDeploy
Object Storage ユーザーがいつでもどこでもデータを保存して検索できるようにファイルの保存場所を提供するサービス Object Storage

SourcePipeline作成

パイプラインを作成する方法は次の通りです。

  1. NAVERクラウドプラットフォームコンソールにアクセスします。
  2. コンソール画面右上のリージョン＆プラットフォームボタンをクリックします。
  3. 利用中のリージョンとプラットフォームを選択し、 [適用] ボタンをクリックします。
  4. コンソール画面左上の i_menuをクリックします。
  5. Services > Developer Tools > SourcePipelineメニューを順にクリックします。
  6. [パイプライン作成] ボタンをクリックして新規パイプラインを作成します。
  7. パイプラインの作成画面が表示されたら、以下の手順で行います。

1.基本設定

基本設定情報を入力し、 [次へ] ボタンをクリックします。

  • パイプライン名には英数字、特殊文字(「-」「_」)のみ使用できます。
  • パイプライン説明は500文字以内で入力します。

2.パイプライン構成

連携するタスクを設定してパイプラインを構成します。

参考
  • パイプラインを構成する際に SourceDeployサービスでリリースの承認ステップを使用中の場合、承認ステップをそのまま使用できます。ただし、トリガーでパイプラインを実行する場合は承認ステップを使用できません。
  • パイプラインを構成するとリリース承認関連のメール(email)、テキスト(sms)送信機能を提供します(予定)。

パイプラインの構成画面は次の通りです。

SourcePipeline-create_ko

領域 説明
① タスク追加 連携するタスクを設定(以下の手順2番を参照)
② 未設定領域 上記のタスク①として追加したタスクを表示(以下の手順3~4番を参照)
  • パイプラインの実行対象に設定された状態ではない
  • タスク対象として設定されたら、③ 設定領域に移動
③ 設定領域 タスク連携を完了した設定領域(以下の手順5番を参照)
  • パイプラインの実行順序に合わせてタスクをチェーンの形で表示
  • タスク対象から削除すると、② 未設定領域に移動
④ Trigger設定 トリガーイベントを設定(以下の手順6番を参照)

パイプラインを構成する方法は次の通りです。

  1. パイプラインの構成画面で [タスク追加] ボタンをクリックします。
  2. タスク設定のポップアップで設定情報を入力し、 [確認] ボタンをクリックします。
    • 名前: タスクの名前は、現在のパイプライン内で固有の名前
    • タイプ: SourceBuildまたは SourceDeployを選択。選択したサービスタイプに応じて表示される入力情報項目が変わる。
    • [SourceBuildを選択した場合]
      • プロジェクト: SourceBuildプロジェクトを選択。選択時に接続情報が項目の下に表示される。
      • 接続情報領域
        • タイプ: SourceBuildプロジェクトの作成時または設定の変更時に、ビルド対象項目で選択したタイプ(SourceCommit、Github、Bitbucket、Github Enterprise Server)
        • リポジトリ: 接続されたリポジトリ情報を表示
        • ブランチ: 接続されたリポジトリのブランチ情報を表示。パイプラインの構成に必要なブランチに変更可能。
    • [SourceDeployを選択した場合]
      • プロジェクト: SourceDeployのプロジェクトを選択
      • ステージ: 選択した SourceDeployプロジェクトのステージを選択
      • シナリオ: 選択した SourceDeployプロジェクトのシナリオを選択。実行可能なシナリオのみリストに表示される。選択時に接続情報が項目の下に表示される。
      • 接続情報領域
        • タイプ: リリースシナリオの作成時または設定の変更時に、リリースファイルの保存場所項目で選択したタイプ(SourceBuild、Object Storage)を表示
        • 情報: リリースシナリオのリリースファイルの保存場所項目で選択したタイプに応じて、設定したビルドプロジェクト名または Object Storageパス情報を表示
  3. パイプラインの構成画面で未設定領域にあるタスクの中から、設定するタスクの i-SourcePipeline-addをクリックします。
    • タスクの設定ステータスを詳細確認・変更するには、当該タスクの i-SourcePipeline-setをクリックして設定を確認・変更します(上記の手順2番を参照)。
    • タスクを削除するには、i-SourcePipeline-delete-02をクリックしてポップアップで [削除] ボタンをクリックします。
  4. 先行タスクの選択ポップアップで先行タスクを選択し、 [確認] ボタンをクリックします。
    • 設定したタスクは右側の設定領域に移動します。
    • 先行タスクなしを選択する場合は1番目のタスクに設定されます。
    • 先行タスクを選択する場合はそのタスクは先行タスクの次のタスクに設定されます。
  5. 設定領域でパイプラインがタスク順に合わせて設定されているか確認します。
    • タスクの設定ステータスを詳細確認・変更するには、当該タスクの i-SourcePipeline-setをクリックして設定を確認・変更します(上記の手順2番を参照)。
    • タスク手順を変更するには、当該タスクの i-SourcePipeline-addをクリックして希望する先行タスクを選択し、 [確認] ボタンをクリックします。
    • 当該タスクを1番目のタスクに設定するには、選択された先行タスクをクリックして選択を解除し、先行タスクなしを選択してから [確認] ボタンをクリックします。
    • 設定領域に1番目のタスク(先行タスクなしと設定されたタスク)が2つ以上ある場合、パイプラインは構成できません。先行タスクを選択してタスクの順序を設定するか、不要な場合は削除してください。
    • タスクを削除するには、当該タスクの i-SourcePipeline-delete-02をクリックし、ポップアップで [削除] ボタンをクリックします。設定領域で削除したタスクはプロジェクトから完全に削除されず、未設定領域に移動します。
  6. トリガーイベントを設定するには、種類項目のチェックボックスをクリックして選択します。
    • Pushトリガー
      • リポジトリ/ブランチ(SourceCommit)に pushイベントが発生すると、そのパイプラインが自動で実行されます。SourceCommitサービスのコンソール上で、ウェブ編集などのコミット(commit)イベントの発生時にも実行されます。
      • Pushトリガーイベントを追加するには、Repository、Branch項目で SourceCommitに登録したリポジトリとブランチを選択し、 [追加] ボタンをクリックします。
      • 設定したトリガーイベントを削除するには i-SourcePipeline-delete-01をクリックしてトリガーリストから削除します。
    • パイプライントリガー
      • トリガー設定されたパイプラインが実行完了すると、そのパイプラインが自動的に実行されます。
      • パイプライントリガーを追加するには、パイプライン項目で SourcePipelineに登録したプロジェクトを選択し、 [追加] ボタンをクリックします。
      • 再帰的に構成する場合、パイプラインが連続して実行される可能性があります。
    • 予約トリガー
      • 設定された予約時間に対応するパイプラインが自動的に実行されます。
      • 予約の設定方法は次の通りです。
        • 1.予約設定画面で [作成] ボタンをクリックします。
        • 2.予約登録のポップアップで設定情報を入力し、 [確認] ボタンをクリックします。
          • 繰り返し: 繰り返す曜日を選択します。毎日をクリックすると、すべての曜日が選択されます。
          • 時間: パイプラインが自動実行される時間を入力します。[HH:mm] 形式で入力でき、選択した TimeZoneに合わせて実行されます。
          • 実行有無: SourcePipelineを設定する際に、SourceBuildプロジェクト、SourceDeployシナリオに設定した SourceCommitリポジトリに追加したコミットがある場合、または SourcePipelineの設定を変更した後に成功した実行がない場合に実行されます。
  7. パイプラインの構成が完了したら [次へ] ボタンをクリックします。

3.最終確認

設定内容を確認し、 [パイプライン作成] ボタンをクリックします。

SourcePipeline画面

パイプラインの基本情報を確認する方法は次の通りです。

  1. NAVERクラウドプラットフォームコンソールで、i_menu > Services > Developer Tools > SourcePipelineメニューを順にクリックします。
  2. パイプラインリストでパイプラインの基本情報を確認します。

パイプラインリスト画面の各項目についての説明は次の通りです。

SourcePipeline-screen_ko

領域 説明
① メニュー名 現在確認中のメニュー名と運用中の SourcePipeline数
② パイプライン作成 新規パイプライン作成
③ パイプラインに移動 パイプライン実行画面に移動
④ 設定変更 パイプライン設定変更
⑤ 削除 パイプライン削除
⑥ 検索領域 検索画面とリストに表示する項目数を表示
⑦ パイプラインのリスト 作成したパイプラインの基本情報を確認
⑧ triggerを見る パイプラインに設定したトリガーイベント確認

トリガーイベント確認

トリガーイベントを確認する方法は次の通りです。

  1. NAVERクラウドプラットフォームコンソールで、i_menu > Services > Developer Tools > SourcePipelineメニューを順にクリックします。
  2. パイプラインリストで確認対象のパイプライン名にある trigger列の [見る] ボタンをクリックします。
  3. トリガー(Trigger)情報のポップアップで設定したトリガーイベントを確認します。

SourcePipeline実行

パイプラインを実行する方法は次の通りです。

  1. NAVERクラウドプラットフォームコンソールで、i_menu > Services > Developer Tools > SourcePipelineメニューを順にクリックします。
  2. パイプラインリストで実行対象のパイプライン名をクリックします。
    • または、パイプライン名の左側にあるチェックボックスを選択し、 [パイプラインに移動] ボタンをクリックします。
  3. パイプラインタブ画面でパイプラインの情報と設定を確認します。
    • パイプラインを実行する前に、リポジトリのブランチとリリースシナリオを変更できます。ただし、変更された設定は今回のパイプラインの実行にのみ適用されます。
  4. SourceBandイシュー関連付け情報を確認します。
  5. 今回のパイプライン実行を SourceBandイシューに関連付けるには関連付けを選択します。
    • 関連付ける SourceBandイシューを選択するには [イシュー選択] ボタンをクリックします。
    • SourceBandイシュー関連付けポップアップで関連付けるイシューを検索して追加します。
    参考
    • SourceBandイシューを関連付けるには SourceBandサービスの申し込みが必要です。
    • SourceBandイシューの関連付け情報は保存されず、今回のパイプライン実行でのみ適用されます。
  6. パイプラインタブ画面で [パイプラインを実行する] ボタンをクリックします。
    • パイプラインを実行するとタスク結果タブに移動し、タスク結果リストにタスクのステータスが Readyから Runningに切り替わります。
  7. タスク結果タブ画面で進捗状況を確認します。
    • パイプラインの実行中にタスクをキャンセルするには、そのタスクにある [キャンセル] ボタンをクリックします。キャンセルするとタスクのステータスが Canceledと表示されます。
    • タスクのステータスが失敗、キャンセル、エラーの場合、 [再実行] ボタンが表示されます。[再実行] ボタンは最後に実行したタスクにのみ表示されます。
    • タスク結果に関する詳細は、SourcePipelineタスク結果確認をご参照ください。

SourcePipelineタスク結果確認

パイプラインのタスク結果を確認する方法は次の通りです。

  1. NAVERクラウドプラットフォームコンソールで、i_menu > Services > Developer Tools > SourcePipelineメニューを順にクリックします。
  2. パイプラインリストでタスク結果を確認する対象パイプライン名をクリックします。
    • または、パイプライン名のチェックボックスを選択し、 [パイプラインに移動] ボタンをクリックします。
  3. パイプラインの詳細画面でタスク結果タブをクリックします。
  4. パイプラインのタスク結果リストで確認対象のタスクをクリックし、タスク結果を確認します。
    SourcePipeline-result-detail_ko
    • 各タスクの詳細結果を確認するには、i-SourcePipeline-logをクリックします。SourceBuild、SourceDeployサービスのタスク結果画面に移動します。この場合に SourceBuild、SourceDeployの使用権限がないと、ログの確認が制限される場合があります。
    • タスクのステータスが失敗、キャンセル、エラーの場合、SourcePipelineを再実行できます。
    • SourceBuild、SourceDeployの使用方法は各サービスのご利用ガイドをご参照ください。

SourcePipeline再実行

失敗、キャンセル、エラーが発生した最後のパイプラインタスクを再実行できます。
パイプラインのタスク構成を変更しない場合でも再実行できます。

パイプラインを再実行する方法は次の通りです。

  1. NAVERクラウドプラットフォームコンソールで、i_menu > Services > Developer Tools > SourcePipelineメニューを順にクリックします。
  2. パイプラインリストで再実行対象のパイプライン名をクリックします。
    • または、パイプライン名のチェックボックスを選択し、 [パイプラインに移動] ボタンをクリックします。
  3. パイプラインの詳細画面でタスク結果タブをクリックします。
  4. パイプラインのタスク結果リストで [再実行] ボタンをクリックします。
    • タスクのステータスが失敗の場合、当該タスクの i-SourcePipeline-logをクリックしてその SourceBuildまたは SourceDeployサービスのタスク結果画面で失敗の原因を把握し、再設定してから [再実行] ボタンをクリックします。
  5. タスクの失敗が続く場合、上記の5番を繰り返して失敗の原因を削除します。

SourcePipeline設定変更

パイプラインの設定を変更する方法は次の通りです。

  1. NAVERクラウドプラットフォームコンソールで、i_menu > Services > Developer Tools > SourcePipelineメニューを順にクリックします。
  2. パイプラインリストで設定を変更する対象パイプライン名のチェックボックスを選択し、 [設定変更] ボタンをクリックします。
    • 作成したパイプライン名をクリックすると、パイプラインの実行画面に移動します。選択の際はご注意ください。
  3. 基本情報領域でパイプラインの説明を変更します。
  4. パイプライン構成、Trigger設定領域でパイプラインと接続されたタスクとトリガーイベントの設定を変更します。
  5. 設定変更を完了し、 [適用] ボタンをクリックします。
参考

パイプライン設定を変更するには、ログインしたアカウントが顧客アカウントまたは NCP_INFRA_MANAGER権限を持つサブアカウントや、パイプラインユーザーのアカウント(サブアカウント)が選択したパイプラインに対してパイプラインの詳細権限の中から changeProject権限を持つ必要があります。

SourcePipeline削除

パイプラインを削除する方法は次の通りです。

  1. NAVERクラウドプラットフォームコンソールで、i_menu > Services > Developer Tools > SourcePipelineメニューを順にクリックします。
  2. パイプラインリストで削除対象のパイプラインを選択し、 [削除] ボタンをクリックします。
    • 作成したパイプライン名をクリックすると、パイプラインの実行画面に移動します。選択の際はご注意ください。
  3. パイプラインプロジェクト削除のポップアップで内容を確認し、 [削除] ボタンをクリックします。
参考

パイプラインを削除するには、ログインしたアカウントが顧客アカウントまたは NCP_INFRA_MANAGER権限を持つサブアカウントや、パイプラインユーザーのアカウント(サブアカウント)が選択したパイプラインに対して詳細権限の中から deleteProject権限を持つ必要があります。