SourcePipeline使用前に
Q. SourcePipelineとは何ですか？
- SourcePipelineは迅速で安定的なソフトウェア発売のためのプロセス自動化商品です。
- SourcePipelineは簡単に新たな機能を発売できるようにリポジトリ、ビルド、デプロイを統合して提供します。
Q. SourcePipelineはどのように構成されますか？
- SourcePipelineはSource Phase, Build Phase, Deploy Phaseで構成され、それぞれのPhaseは SourceCommit, SourceBuild, SourceDeploy 商品と連動されます。
- SourcePipelineを使用するためには SourceCommit, SourceBuild, SourceDeploy 商品を利用する必要があります。
Q. SourcePipelineの使用手続きはどうなりますか？
- NAVERクラウドプラットフォームコンソールへアクセスします。
- SourcePipeline コンソールでパイプラインを生成します。(SourceCommit, SourceBuild, SourceDeployと連動)
- 生成したパイプラインを実行します。
- 実行したパイプラインの作業結果を確認します。
SourcePipelineの使用権限
SourcePipelineはパイプライン別にユーザーのアクセス権限を与えることができ、次のような権限があります。
全ての権限
1. 顧客アカウント
- 顧客アカウントはSourcePipelineの全ての機能を制約なしに使用できます。
- コンソールで パイプラインを生成 及び全てのパイプラインの 設定を変更, [削除] ボタンを使用でき、全てのパイプラインを実行できます。
2. NCP_INFRA_MANAGER
- 顧客アカウントと同じ権限を有するサブアカウントで、顧客アカウントと同じくSourcePipelineの全ての機能を制約なしに使用できます。
- この権限は顧客アカウントが Management > Sub Account メニューでサブアカウントに与えることができます。 (Sub Account 利用案内へショートカット)
パイプラインの作成権限
この権限は顧客アカウントが Management > Sub Account メニューでサブアカウントに与えることができます。 (Sub Account利用案内へショートカット)
1. NCP_SOURCE_PIPELINE_MANAGER
コンソールで'パイプラインを作成'機能を通じてパイプラインを作成でき、自分が作成したパイプラインを管理して他のサブアカウントに共有できます。
顧客アカウントには当該権限が基本で付与されており、サブアカウントは顧客アカウントのユーザーから Management > Sub Account メニューで当該権限を割り当ててもらうことができます。
参考: NCP_SOURCE_PIPELINE_MANGER 権限の付与
① サブアカウントに SourcePipelineの管理者権限を与えるためにはSub AccountメニューのSub Accountsを選択します。
② 付与するサブアカウントを選択します。
① 選択したサブアカウントのポリシーにNCP_SOURCE_PIPELINE_MANAGER ポリシーを追加します。
パイプラインの使用権限
当該権限は顧客アカウント、もしくは SourcePipeline管理者(サブアカウント)が SourcePipelineでパイプラインを共有するサブアカウントに付与する権限です。
1. ADMIN
- パイプラインの照会、設定の変更、削除権限を含みます。
- パイプラインを作成したアカウントには自動でADMIN権限が与えられます。
- パイプラインのユーザーアカウント(サブアカウント）を割り当てて権限を与えることができます。
- パイプライン実行ページにアクセスしてパイプラインを実行できます。
2. USER
- パイプラインの照会権限を含みます。
- パイプライン実行ページにアクセスしてパイプラインを実行できます。
パイプラインの作成
Step 1. コンソールへアクセス
コンソールからDev Tools > SourcePipeline メニューへアクセスします。
① パイプラインを作成 ボタンをクリックして新たなパイプラインを作成します。
パイプラインを作成するためにはログインしたアカウントが顧客アカウント、もしくはNCP_INFRA_MANAGER, NCP_SOURCE_PIPELINE_MANAGER 権限を有しているサブアカウントでなければなりません。
- NCP_SOURCE_PIPELINE_MANAGER 権限はコンソールの Management > Sub Accountメニューで割り当てることができます。
② SourcePipelineに初めてアクセスすると次のような文が表示されます。
- 現在作成されたパイプラインがありません。パイプラインを作成ボタンをクリックしてパイプラインを作成してください。
Step 2. Name Phase
パイプライン名を入力します。
① 生成するパイプライン名を入力します。パイプライン名は英文字、数字、特殊文字(-＿)のみ含めることができます。
Step 3. Source Phase
パイプラインに連動するリポジトリを選択します。
① パイプラインに連動するリポジトリソースとして SourceCommitまたはGitHubの中から一つを選択します。
① 保有しているSourceCommitのリポジトリの中から一つ選択します。
- SourceCommit 商品を使用していて、作成されたSourceCommitリポジトリが存在しなければなりません。
- SourceCommit商品の権限がなくてもリポジトリリストは表示されます。 但し、SourceCommit コンソールにアクセスするためには当該商品の権限が必要です。
① 連動されているGitHubのリポジトリの中から一つ選択します。
- SourceBuild 商品で設定したGitHubリポジトリが表示されます。
Step 4. Build Phase
パイプラインに連動するSourceBuildプロジェクトを選択します。
① SourceBuild リストの中から一つのプロジェクトを選択します。
- SourceBuildを使用していて、Source Phaseで選択したリポジトリと連動されたSourceBuild プロジェクトが存在する必要があります。
- SourceBuild商品の権限がなくてもリポジトリと連動されたSourceBuildプロジェクトがあればリストに表示されます。但し、SourceBuild コンソールにアクセスするためには当該商品の権限が必要です。
Step 5. Deploy Phase
パイプラインに連動するSourceDeployプロジェクトを選択します。
① SourceDeploy リストの中から一つ選択します。
- SourceDeploy商品を使用していて、 Build Phaseで選択したSourceBuildプロジェクトと連動されたSourceDeploy プロジェクト、またはSourceDeployプロジェクトで選択したデプロイファイル位置が選択したSourceBuildプロジェクトのビルド成果物をアップロードするObject Storageルートが同じSourceDeployプロジェクトが存在する必要があります。
- SourceDeploy商品の権限がなくても条件を満たすプロジェクトがあればリストに表示されます。但し、SourceDeploy コンソールにアクセスするためには当該商品の権限が必要です。
② SourceDeploy の詳細を設定します。
① 選択したSourceDeployプロジェクトのステージを選択します。
② 選択したステージのシナリオを選択します。
③ 確認 ボタンをクリックして詳細設定を保存します。
Step 6. パイプラインの説明
① 生成するパイプラインの説明を作成します。最小3字、最大500字の制限があります。
Step 7. パイプラインのユーザー設定
① .パイプラインを共有するユーザーをリストから選択します。
- パイプラインを共有するユーザーはサブアカウントの中から選択できます。サブアカウントユーザーを追加するためには、まずSub Accountメニューでアカウントを追加登録してください。 (Sub Account利用案内へショートカット)
② 共有するユーザーに割り当てるアクセス権限を選択します。アクセス権限は二つです。
- ADMIN: パイプラインの照会/実行及び修正/削除権限を含みます。
- USER: パイプラインの照会/実行権限を含みます。
③ 追加されたユーザーは下のリストで確認できます。
④ サブアカウントでパイプラインを生成する際に本人のアカウントは自動でADMIN権限が与えられます。
Step 8. パイプライン生成の完了
① 確認 ボタンをクリックして生成を完了します。
パイプライン設定の変更
生成したパイプラインはNAVERクラウドプラットフォームコンソールで設定を変更できます。
Step 1. パイプラインを選択
① 設定を変更するパイプラインを選択します。
② 設定を変更 ボタンをクリックします。
- パイプラインの設定を変更するためにはログインしたアカウントが顧客アカウント、もしくはNCP_INFRA_MANAGER 権限を有するサブアカウント、もしくはパイプラインユーザーアカウント(サブアカウント)が選択したパイプラインのADMIN権限を有していなければなりません。
Step 2. パイプライン設定の変更
① パイプラインに設定されたリポジトリを変更できます。
- Source Phaseを修正した場合、 Build / Deploy Phaseが初期化されます。
② パイプラインに設定されたSourceBuild プロジェクトを変更できます。
- Build Phaseを修正した場合、Deploy Phaseが初期化されます。
③ パイプラインに設定された SourceDeploy プロジェクトを変更できます。
④ 選択したSourceDeployプロジェクトの詳細設定を変更します。
⑤ パイプラインの説明を変更します。
⑥ パイプラインを使用するユーザーを変更できます。
- パイプラインを共有するユーザーはサブアカウントの中から選択できます。サブアカウントユーザーを追加するためには、まずSub Accountメニューでアカウントを追加登録してください。(Sub Account 利用案内へショートカット)
⑦ 変更事項を適用します。
パイプラインの削除
NAVERクラウドプラットフォームコンソールでパイプラインを削除できます。
Step 1. パイプラインを選択
① 削除するパイプラインを選択します。
② [削除] ボタンをリクックします。
- パイプラインを削除するためにはログインしたアカウントが顧客アカウント、もしくはNCP_INFRA_MANAGER 権限を有するサブアカウント、もしくはパイプラインユーザーアカウント(サブアカウント)が選択したパイプラインのADMIN権限を有していなければなりません。
Step 2. パイプラインの削除
① [削除] ボタンをクリックするとパイプラインが削除されます。
- 削除されたパイプラインは再度リカバリーできません。
パイプラインの実行
Step 1. パイプラインの実行ページへ移動
① パイプラインを選択します。
② パイプラインへ移動 ボタンまたは パイプライン名(リンク)をクリックします。
Step 2. パイプラインを実行
① Source Phaseで選択したリポジトリのブランチを選択またはコミットハッシュを入力します。
② Build Phaseで選択したSourceBuild プロジェクトの命令語を確認して修正できます。
修正した命令語は現在のパイプライン実行にのみ適用されます。
① ビルド前命令語を修正します。
② ビルド命令語を修正します。
③ ビルド後命令語を修正します。
④ 修正したビルド命令語を保存します。
③ Deploy Phaseで選択した SourceDeploy プロジェクトのステージの中からデプロイするステージを選択します。
- パイプラインの生成/変更でデプロイプロジェクトの詳細設定で適用したステージとシナリオが基本で選択されて表示されます。
④ 選択したステージでデプロイするシナリオを選択します。
⑤ パイプラインを実行する ボタンをクリックしてパイプラインを実行します。
Step 3. パイプライン実行中
① パイプラインが実行されるとパイプラインを実行する ボタンと各Phaseの変更項目がある部分が無効化されます。
Step 4. パイプラインの完了
パイプラインが完了すると各Phaseの状態を確認できます。
① Build / Deploy Phaseで ログを詳しくみる をクリックすると各商品のログを確認できるようにSourceBuild, SourceDeployの作業結果に移動します。この際、SourceBuild, SourceDeploy 商品の権限がない場合はログの確認が制限されます。
パイプラインの作業結果
パイプラインを実行した結果を 作業結果 タブで確認できます。
① 作業結果 タブをクリックします。
② 確認するパイプライン作業結果の行を選択します。
③ ログをみるをクリックすると SourceBuild / SourceDeploy 作業結果画面に移動します。
参考事項
この商品はグローバルリージョンサービスとしても提供されます。
関連情報へショートカット
以下のガイドから関連情報を確認できます。
