第2章 CLI ツール

APB CLI ツールは apb パッケージによって提供されます。これは rhel-7-server-ose-3.7-rpms チャンネルで利用できます。

$ sudo yum install apb

apb help を実行して、ツールが適切にインストールされていることを確認します。

$ apb help
usage: apb [-h] [--debug] [--project BASE_PATH]
           {init,help,prepare,push,bootstrap,list,remove,build} ...

APB tooling for assisting in building and packaging APBs.

optional arguments:
  -h, --help            show this help message and exit
  --debug               Enable debug output
  --project BASE_PATH, -p BASE_PATH
                        Specify a path to your project. Defaults to CWD.

subcommand:
  {init,help,prepare,push,bootstrap,list,remove,build}
    init                Initialize the directory for APB development
    help                Display this help message
    prepare             Prepare an ansible-container project for APB packaging
    push                Push local APB spec to an OAB
    bootstrap           Tell OAB to reload APBs from the
                        container repository
    list                List APBs from the target OAB
    remove              Remove APBs from the target OAB
    build               Build and package APB container

OpenShift Container レジストリーを使用して APB を調達するには、OpenShift Ansible Broker を local_openshift タイプのレジストリーアダプターを使用するように設定する必要があります。詳細は、「config」のセクションを参照してください。

$ apb init my-new-apb
$ cd my-new-apb
$ apb build
$ apb push
$ apb list

APB をホストするためにデフォルトの openshift namespace 以外の namespace を使用する場合は、以下のコマンドを使用できます。

$ apb push --namespace <namespace>

OAB は、docker.io/ansibleplaybookbundle または独自の個人アカウントなどの、リモートレジストリーや組織を使用するように設定することもできます。これを APB を開発するために使用するには、APB をビルドし、リモートレジストリーにプッシュしてから bootstrap を実行して APB を再ロードできます。

$ apb init my-new-apb
$ cd my-new-apb
$ apb build --tag docker.io/my-org/my-new-apb
$ docker push docker.io/my-org/my-new-apb
$ apb bootstrap
$ apb list

説明

新規 APB のディレクトリー構造を初期化します。さらに、適切なデフォルト値が設定された新規 APB のサンプルファイルを作成します。

使用法

$ apb init [OPTIONS] NAME

引数

NAME: 作成される APB およびディレクトリーの名前です。

オプション

例

ディレクトリー my-new-apb を作成します。

$ apb init my-new-apb
# my-new-apb/
# ├── apb.yml
# ├── Dockerfile
# ├── playbooks
# │   ├── deprovision.yml
# │   └── provision.yml
# └── roles
#     ├── deprovision-my-new-apb
#     │   └── tasks
#     │       └── main.yml
#     └── provision-my-new-apb
#         └── tasks
#             └── main.yml

ディレクトリー my-new-apb を作成しますが、プロビジョニング解除 Playbook およびロールの生成を省略します。

$ apb init my-new-apb --skip-deprovision
# my-new-apb/
# ├── apb.yml
# ├── Dockerfile
# ├── playbooks
# │   └── provision.yml
# └── roles
#     └── provision-my-new-apb
#         └── tasks
#             └── main.yml

ディレクトリー my-new-apb を作成し、古いバージョンを上書きします。APB はバインド可能になるように設定され、async をオプションに設定します。

$ apb init my-new-apb --force --bindable --async optional
# my-new-apb/
# ├── apb.yml
# ├── Dockerfile
# ├── playbooks
# │   ├── bind.yml
# │   ├── deprovision.yml
# │   ├── provision.yml
# │   └── unbind.yml
# └── roles
#     ├── bind-my-new-apb
#     │   └── tasks
#     │       └── main.yml
#     ├── deprovision-my-new-apb
#     │   └── tasks
#     │       └── main.yml
#     ├── provision-my-new-apb
#     │   └── tasks
#     │       └── main.yml
#     └── unbind-my-new-apb
#         └── tasks
#             └── main.yml

説明

APB を base64 エンコーディングでコンパイルし、これを Dockerfile のラベルとして作成します。

これにより、OAB はイメージをダウンロードせずにレジストリーから APB メタデータを読み取ることができます。このコマンドは APB ディレクトリー内から実行される必要があります。build コマンドを実行すると、prepare も自動的に実行されます。つまり、通常は prepare 自体を実行する必要はありません。

使用法

$ apb prepare [OPTIONS]

オプション

例

Dockerfile に仕様フィールドのラベルを作成します。

$ apb prepare

Dockerfile-custom に仕様フィールドのラベルを作成します。

$ apb prepare --dockerfile Dockerfile-custom

説明

APB のイメージをビルドします。

タグを使って apb prepare および docker build を実行するのと同様です。

使用法

$ apb build [OPTIONS]

オプション

例

イメージをビルドし、apb.yml の名前フィールドをタグとして使用します。

$ apb build

イメージをビルドし、タグ docker.io/my-org/my-new-apb を使用します。

$ apb build --tag docker.io/my-org/my-new-apb

イメージをビルドし、タグ docker.io/my-org/<my-apb-name> を使用します。

$ apb build --registry docker.io --org my-org

ファイル Dockerfile-custom を Dockerfile 定義として使用してイメージをビルドします。

$ apb build --dockerfile Dockerfile-custom

説明

APB を OpenShift Container レジストリーに、またはこれが OAB による読み取りが行われるブローカーのモックレジストリーにアップロードします。

ブローカーのモックレジストリーを使用する場合、仕様はアップロードされ、OpenShift Container Platform に表示されますが、通常 OpenShift Container Platform はイメージをレジストリーからプルします。このレジストリーは通常は oc cluster up が実行されるレジストリーになります。

OpenShift Container レジストリーを使用する場合、イメージは OpenShift Container Platform に直接アップロードされます。

使用法

$ apb push [OPTIONS]

オプション

例

OAB 開発エンドポイントにプッシュします。

$ apb push

ローカルの OpenShift Container レジストリーにプッシュします。

$ apb push

namespace myproject の下のローカルの OpenShift Container レジストリーにプッシュします。

$ apb push --namespace myproject

説明

APB 単体テストを実行します。

使用法

$ apb test [OPTIONS]

オプション

例

テストを実行します。

$ apb test

テストを実行しますが、ビルドされたイメージの特定のタグを使用します。

$ apb test --tag docker.io/my-org/my-new-apb

説明

ブローカーが読み込んだすべての APB を一覧表示します。

使用法

$ apb list [OPTIONS]

オプション

例

名前、ID および説明を含む APB の基本的な一覧です。

$ apb list

詳細な、読み取りが容易な仕様を一覧表示します。

$ apb list -v

すべての JSON 出力を一覧表示します。

$ apb list -v -o json

説明

OAB がすべての APB をレジストリーからリロードすることを要求します。

使用法

$ apb bootstrap [OPTIONS]

オプション

例

APB の基本的なリロード:

$ apb bootstrap

説明

1 つ (またはすべての) APB を OAB から削除します。

使用法

$ apb remove [OPTIONS]

オプション

例

ID を使用して APB を削除します。

$ apb remove --id ca91b61da8476984f18fc13883ae2fdb

$ apb list
ID                                NAME                     DESCRIPTION
ca91b61da8476984f18fc13883ae2fdb  dh-etherpad-apb          Note taking web application

すべての APB を削除します。

$ apb remove --all

説明

サービスカタログに対し、ブローカーに一致する提供されたサービスを再度一覧表示するよう強制します。

使用法

$ apb relist [OPTIONS]

オプション

例

$ apb relist

説明

ヘルプメッセージを表示します。

使用法

$ apb help

例

$ apb help

$ apb -h