Code Stream で使用可能なタスクのタイプ

パイプラインを構成するときは、必要なアクションに対してパイプラインが実行する特定タイプのタスクを追加します。各タスクタイプは別のアプリケーションと連携し、ユーザーのアプリケーションをビルド、テスト、配信するときにパイプラインを有効にします。

展開のためにリポジトリからアーティファクトを取得する必要がある場合でも、リモートスクリプトを実行する必要がある場合でも、チームメンバーからユーザー操作の承認を得る必要がある場合でも、 Code Stream ではパイプライン実行のために、ユーザーに適したタイプのタスクタイプを用意しています。

Code Stream では、さまざまなタイプのタスクでパイプラインの実行をキャンセルできます。パイプラインの実行で [キャンセル] をクリックすると、タスク、ステージ、またはパイプライン全体がキャンセル状態になり、パイプラインの実行がキャンセルされます。

次のタスクを使用しているとき、 Code Stream によってタスク、ステージ、またはパイプライン全体でパイプラインの実行をキャンセルできます。

Jenkins
SSH
PowerShell
ユーザー操作
パイプライン
クラウドテンプレート
vRO
ポーリング

Code Stream は、CI、カスタム統合、Kubernetes などのタスクに対するキャンセル動作をサードパーティシステムに伝達しません。 Code Stream はタスクをキャンセル済みとしてマークし、タスクが終了するのを待つことなくステータスの取得をただちに停止します。サードパーティシステムではタスクが完了することも失敗することもありますが、 Code Stream での実行は [キャンセル] をクリックするとただちに停止します。

パイプラインでタスクを使用する前に、対応するエンドポイントが使用可能であることを確認します。

表 1. 承認の取得または決定ポイントの設定
タスクのタイプ	機能	例と詳細
[ユーザー操作]	ユーザー操作タスクでは、いつパイプラインを実行し、承認のために停止する必要があるのかを制御する、必須の承認が有効になります。	パイプラインを実行して結果を確認する方法を参照してください。また、Code Stream でユーザーアクセスと承認を管理する方法も参照してください。
[条件]	決定ポイントを追加します。決定ポイントでは、パイプラインの実行を継続するか、または停止するかが条件式に基づいて決定されます。条件が true の場合、パイプラインは後続のタスクを実行します。false の場合、パイプラインは停止します。	条件タスクで変数バインドを使用して、 Code Stream でパイプラインを実行または停止する方法を参照してください。

表 2. 継続的インテグレーションと展開の自動化
タスクのタイプ	機能	例と詳細
[クラウドテンプレート]	GitHub から自動クラウドテンプレートを展開してアプリケーションをプロビジョニングし、クラウドテンプレートの継続的インテグレーションおよび継続的デリバリ (CICD) を展開用に自動化します。	Code Stream の YAML クラウドテンプレートから展開するアプリケーションのリリースを自動化する方法を参照してください。最初に [作成] または [更新] を選択してから [クラウドテンプレート] と [バージョン] を選択すると、クラウドテンプレートのパラメータが表示されます。次の要素を追加することにより、クラウドテンプレートタスクの入力テキスト領域で変数のバインドを使用できます。整数列挙文字列ブール値配列変数入力で変数のバインドを使用する場合は、次の例外に注意してください。列挙の場合は、固定セットから列挙値を選択する必要があります。ブール値の場合は、入力テキスト領域に値を入力する必要があります。 Cloud Assembly 内のクラウドテンプレートに入力変数がある場合、クラウドテンプレートのパラメータがクラウドテンプレートタスクに表示されます。たとえば、クラウドテンプレートに `Integer` の入力タイプが含まれている場合は、整数を直接入力するか、変数バインドを使用して変数として入力できます。
[CI]	CI タスクでは、レジストリエンドポイントから Docker ビルドイメージを取得し、Kubernetes クラスタに展開することで、コードからパイプラインへの継続的インテグレーションが可能です。 CI タスクでは、ログの 100 行が出力として表示され、ログをダウンロードすると 500 行が表示されます。 CI タスクには、短期ポート 32768 ～ 61000 が必要です。	スマートパイプラインテンプレートを使用する前の Code Stream での CICD ネイティブビルドの計画を参照してください。
[カスタム]	カスタムタスクでは、 Code Stream が自分のビルド、テスト、展開ツールと統合されます。	ビルド、テスト、展開用の独自のツールを Code Streamに統合する方法を参照してください。
[Kubernetes]	Kubernetes クラスタへのソフトウェアアプリケーションの展開を自動化します。	Kubernetes クラスタへの Code Stream のアプリケーションのリリースを自動化する方法を参照してください。
[パイプライン]	パイプラインをプライマリパイプラインにネストします。パイプラインはネストされると、プライマリパイプラインのタスクとして動作します。ネストされたパイプラインには、プライマリパイプラインの [タスク] タブでリンクをクリックして簡単に移動することができます。ネストされたパイプラインは、新しいブラウザタブで開きます。	[実行] でネストされたパイプラインを検索するには、検索領域に `nested` と入力します。

表 3. 開発、テスト、展開アプリケーションの統合
タスクタイプ	機能...	例と詳細
[Bamboo]	展開の準備中にソフトウェアを継続的にビルド、テスト、および統合する Bamboo の継続的インテグレーション (CI) サーバと連携し、開発者が変更をコミットする際にコードビルドをトリガします。Bamboo ビルドが生成するアーティファクトの場所を公開し、他のタスクでビルドと展開に使用するためにタスクでパラメータを出力できるようにします。	Bamboo サーバエンドポイントに接続し、パイプラインから Bamboo ビルドプランを開始します。
[Jenkins]	ソースコードのビルドおよびテスト、テストケースの実行、カスタムスクリプトの使用が可能な Jenkins ジョブをトリガします。	Code Stream を Jenkins と統合する方法を参照してください。
[TFS]	パイプラインを Team Foundation Server に接続して、コードのビルドとテストを実行する構成済みのジョブを含むビルドプロジェクトの管理と呼び出しが可能になります。	Code Stream でサポートされる Team Foundation Server のバージョンについては、Code Stream でのエンドポイントとはを参照してください。
[vRO]	vRealize Orchestrator で事前定義またはカスタムワークフローを実行して、 Code Stream の機能を拡張します。 Code Stream は、vRealize Orchestrator の基本認証とトークンベースの認証をサポートします。 Code Stream は、API トークンを使用して vRealize Orchestrator クラスタの認証と検証を行います。トークンベースの認証では、 Code Stream はクラウド拡張性プロキシを使用する vRealize Orchestrator エンドポイントをサポートします。そのため、 Code Stream で、クラウド拡張性プロキシを使用する vRealize Orchestrator エンドポイントを使用してワークフローをトリガできます。	Code Stream を vRealize Orchestrator と統合する方法を参照してください。

表 4. API を使用した他のアプリケーションの統合
タスクタイプ	機能...	例と詳細
[REST]	Code Stream を REST API を使用する他のアプリケーションと連携して、相互に連携可能なソフトウェアアプリケーションを継続的に開発および提供できるようにします。	REST API を使用して Code Stream を他のアプリケーションと統合する方法を参照してください。
[ポーリング]	REST API を呼び出し、パイプラインタスクが終了基準を満たして完了するまでポーリングします。 Code Stream 管理者は、ポーリング数を最大 10,000 に設定できます。ポーリング間隔は 60 秒以上にする必要があります。 [失敗時に続行] チェックボックスをオンにすると、回数または間隔がこれらの値を超えた場合でも、ポーリングタスクは引き続き実行されます。 `POLL Iteration Count`：パイプラインの実行に表示され、POLL タスクが URL からの応答を要求した回数が表示されます。たとえば、POLL 入力が 65 で、POLL 要求が実際に実行された回数が 4 の場合、パイプライン実行出力の反復回数は 4（65 件中）と表示されます。	REST API を使用して Code Stream を他のアプリケーションと統合する方法を参照してください。

表 5. リモートおよびユーザー定義のスクリプトの実行
タスクのタイプ	機能	例と詳細
[PowerShell]	PowerShell タスクを使用すると、 Code Stream は、リモートホスト上でスクリプトコマンドを実行できます。たとえば、スクリプトで、テストタスクを自動化したり、管理タイプのコマンドを実行したりできます。スクリプトは、リモートとユーザー定義のいずれも可能です。HTTP または HTTPS を介した接続や、TLS の使用も可能です。 Windows ホストでは、`winrm` サービスが構成されている必要があります。また、`winrm` では、`MaxShellsPerUser` と `MaxMemoryPerShellMB` が構成されている必要があります。 PowerShell タスクを実行するには、リモート Windows ホストへのアクティブなセッションが必要です。 [PowerShell コマンドラインの長さ] base64 PowerShell コマンドを入力する場合は、コマンド全体の長さを計算する必要があることに注意してください。 Code Stream パイプラインは base64 PowerShell コマンドをエンコードして、別のコマンド内にラッピングするため、コマンドの全体の長さが増加します。 PowerShell winrm コマンドで許可される最大長は 8192 バイトです。PowerShell タスクがエンコードおよびラッピングされている場合は、コマンド長の上限が低くなります。したがって、PowerShell コマンドを入力する前に、コマンド長を計算する必要があります。 Code Stream PowerShell タスクのコマンド長の上限は、元のコマンドを base64 でエンコードした後の長さによって決まります。コマンド長は次のように計算されます。 `3 * (length of original command / 4)) - (numberOfPaddingCharacters) + 77 (Length of Write-output command)` Code Stream のコマンド長は、上限の 8192 よりも小さくする必要があります。	`MaxShellsPerUser` と `MaxMemoryPerShellMB` を設定する場合： `MaxShellsPerUser` の許容値は、各パイプラインには 5 個の PowerShell タスクがある 50 個の同時実行パイプラインには `500` です。値を設定するには、次を実行します：winrm set winrm/config/winrs '@{MaxShellsPerUser="500"}' `MaxMemoryPerShellMB` の許容可能なメモリ値は `2048` です。値を設定するには、次を実行します：winrm set winrm/config/winrs '@{MaxMemoryPerShellMB="2048"}' このスクリプトは、別のパイプラインが使用できる応答ファイルに出力を書き込みます。
[SSH]	SSH タスクでは、Bash シェルスクリプトタスクがリモートホスト上でスクリプトコマンドを実行できます。たとえば、スクリプトで、テストタスクを自動化したり、管理タイプのコマンドを実行したりできます。スクリプトは、リモートとユーザー定義のいずれも可能です。HTTP または HTTPS を介した接続が可能で、プライベートキーまたはパスワードが必要です。 Linux ホスト上で SSH サービスが構成されている必要があります。また、`MaxSessions` の SSHD 設定は `50` にする必要があります。複数の SSH タスクを同時に実行する場合は、SSH ホストの `MaxSessions` と `MaxOpenSessions` を増やします。MaxSessions および MaxOpenSessions の設定を変更する必要がある場合は、vRealize Automation インスタンスを SSH ホストとして使用しないでください。 SSH タスクは、OpenSSH タイプのプライベートキーをサポートしていません。次のいずれかの方法を使用して、パブリック/プライベートキーペアを生成します。 Windows マシンでは、`PuTTYgen` を使用してキーペアを生成します。 Mac または Linux マシンでは、ssh -V を使用して SSH のバージョンが 7.8 より前であることを確認してから、ssh -keygen を使用してターミナルウィンドウでキーペアを生成します。注：生成されたキーが `BEGIN OPENSSH PRIVATE KEY` と一緒に表示されないことを確認します。生成されたパブリックキーがリモートマシンの認証済みキーである場合は、次のいずれかの記事を参照して OpenSSH プライベート形式を変更します。 PuTTY キージェネレータを使用するには、https://www.simplified.guide/putty/convert-ssh-key-to-ppkを参照してください。 WinSCP を使用するには、https://superuser.com/questions/912304/how-do-you-convert-an-ssh-private-key-to-a-ppk-on-the-windows-command-lineを参照してください。 SSH タスクを構成する場合は、プライベートキーをプレーンテキストで入力する必要があります。キーを変数または入力として保存すると、キーの形式が変更され、パイプラインタスクの実行は失敗します。	スクリプトは、リモートとユーザー定義のいずれも可能です。たとえば、スクリプトは次のようになります。 `message="Hello World" echo $message` このスクリプトは、別のパイプラインが使用できる応答ファイルに出力を書き込みます。