コマンド

Screwdriver のコマンドは、ユーザが screwdriver.yaml でステップを定義する代わりに利用できる実行可能なスクリプトやバイナリのコマンドです。

コマンドを検索する

既に存在しているコマンドを見つけるには、GET メソッドで /commands APIエンドポイントにアクセスしてください。またこちらのパス<YOUR_UI_URL>/commandsにアクセスすることでコマンドを確認できます。

コマンドページの例: Commands

コマンドを利用する

コマンドを利用するには、ステップ内で sd-cmd という CLI を実行するよう、 sd-cmd exec <namespace>/<name>@<version> <arguments> というフォーマットで screwdriver.yaml に定義します。

入力:

出力

コマンドの取得と実行に関する全てのデバッグログは、$SD_ARTIFACTS_DIR/.sd/commands/namespace/name/version/timestamp.log に保存されます。

以下の例では、awscli/install commandを使用しています。

screwdriver.yamlの例:

jobs:
    main:
        requires: [~pr, ~commit]
        image: node:lts
        steps:
            - init: sd-cmd exec awscli/install@1.0 -i mySecretID -s secretAccessKey -r us-west-2

Screwdriver は Store からバイナリやスクリプトをダウンロードし、実行可能にした後、-i mySecretID -s secretAccessKey -r us-west-2 を引数として実行します:

$ /opt/sd/commands/awscli/install/1.0.1/install.sh -i mySecretID -s secretAccessKey -r us-west-2

コマンドを作成する

コマンドのパブリッシュと実行は Screwdriver のパイプラインから行う必要があります。

コマンド yaml を書く

コマンドを作成するために、sd-command.yaml を含んだリポジトリを作成します。yaml には、コマンドのネームスペース、名前、バージョン、説明、管理者のメールアドレス、使用するフォーマットとそのフォーマットに応じた設定が必要です。またオプションとして、利用方法を設定できます。こちらを設定することで、UIから利用方法を参照できるようになります。利用方法を設定しなかった場合はデフォルトとして、sd-cmd exec <namespace>/<name>@<version>　が表示されます。　

Binary の場合の sd-command.yaml の例:

namespace: foo # コマンドのネームスペース
name: bar # コマンドの名前
version: '1.0' # メジャーバージョンとマイナーバージョン (パッチバージョンは自動付与)
description: |
  Lorem ipsum dolor sit amet.
usage: |
  sd-cmd exec foo/bar@<VERSION> <OPTION> <TARGET>
  Options:
          --config              コンフィグファイル
          --debug               デバッグモード (デフォルト "false")
          --host                スーパーホスト
          --log-level           ログレベル ("debug"|"info"|"warn"|"error"|"fatal") (デフォルト "info")
  Target:                       ファイルパス
maintainer: foo@bar.com # コマンドの管理者
format: binary # コマンドのフォーマット (binary または habitat)
binary:
    file: ./foobar.sh # スクリプトやバイナリファイルの sd-command.yaml ファイルからの相対パス、もしくは絶対パス

Remote Habitat の場合の sd-command.yaml の例:

namespace: foo
name: bar
version: '1.0'
description: |
  Lorem ipsum dolor sit amet.
maintainer: foo@bar.com
format: habitat # コマンドのフォーマット (binary または habitat)
habitat:
    package: core/node8 # コマンドで利用する Habitat のパッケージ
    mode: remote # Habitat コマンドのモード (remote または local)
    command: node # 実行可能なコマンド

Local Habitat の場合の sd-command.yaml の例:

namespace: foo
name: bar
version: '1.0'
description: |
  Lorem ipsum dolor sit amet.
maintainer: foo@bar.com
format: habitat コマンドのフォーマット (binary または habitat)
habitat:
    package: core/node8 # コマンドで利用する Habitat のパッケージ
    mode: local # Habitat コマンドのモード (remote または local)
    file: ./foobar.hart # .hart ファイルの sd-command.yaml ファイルからの相対パス、もしくは絶対パス
    command: node # 実行可能なコマンド

警告

コマンドリポジトリ用の screwdriver.yaml を書く

コマンドのバリデーションを行うには、sd-cmd validate を実行します。-f オプションで、対象のyamlファイルを指定します (デフォルトでは sd-command.yamlとなっています)。

コマンドをパブリッシュするために、 sd-cmd publish を別のジョブで実行します。 -f で、パブリッシュするyamlファイルを指定します (デフォルトでは sd-command.yamlとなっています)。 -t でパブリッシュしたコマンドにつけるタグを指定します (デフォルトでは latestとなっています)。

コマンドにタグをつけるために, sd-cmd promote を次のフォーマットに沿って実行します。 sd-cmd promote <namespace>/<name> <version> <tag> <version>には厳密なバージョンもしくはタグを指定できます(e.g. 1.0.1, latest)。

screwdriver.yamlの例:

shared:
    image: node:lts
jobs:
    main:
        requires: [~pr, ~commit]
        steps:
            - validate: sd-cmd validate -f sd-command.yaml
    publish:
        requires: [main]
        steps:
            - publish: sd-cmd publish -f sd-command.yaml -t latest
    promote:
        requires: [publish]
        steps:
            - promote: sd-cmd promote foo/bar 1.0.1 stable

コマンドを削除する

コマンドページのUIにあるゴミ箱アイコンをクリックすることで、コマンドとそれに関連するすべてのタグおよびバージョンを削除できます。

注意: 誰がコマンドを削除する権限を持っているか判断するのに必要なため、事前にコマンドのパイプラインを削除しないでください。

Removing

更に詳しく

*古くなっている可能性があります。