2.4. アドオン

CDK を使用すると、cluster up により提供される dashilla OpenShift 設定をアドオンメカニズムで拡張できます。

アドオンは、.addon 拡張子が付いたテキストファイルを含むディレクトリーです。このディレクトリーには、JSON テンプレートファイルなどの他のリソースファイルを含めることもできます。ただし、アドオンごとに 1 つの .addon ファイルのみが許可されます。

以下の例は、アドオンの名前と説明、追加のメタデータ、および適用する実際のアドオンコマンドなど、アドオンの内容を示しています。

Name: anyuid
Description: Allows authenticated users to run images under a non pre-allocated UID
Required-Vars: ACME_TOKEN
OpenShift-Version: >3.6.0
Minishift-Version: >1.22.0

# Name: anyuid                                                                          

# Description: Allows authenticated users to run images under a non pre-allocated UID   

# Required-Vars: ACME_TOKEN                                                             

# OpenShift-Version: >3.6.0                                                             

# Minishift-Version: >1.22.0                                                            

mytoken := oc sa get-token oauth-client                                                 

oc new-app -p OPENSHIFT_OAUTH_CLIENT_SECRET=#{mytoken}                                  

oc adm policy add-scc-to-group anyuid system:authenticated                              

有効なアドオンは、初期クラスタープロビジョニングが正常に完了した直後に、minishift start 時に適用されます。

アドオンメタデータの一部として、アドオンを適用するために実行中の OpenShift バージョンを指定できます。これを実行するには、任意の OpenShift-Version メタデータフィールドを指定できます。セマンティクスは以下のとおりです。

アドオンメタデータの一部として、アドオンを適用するために実行する必要のある Minishift バージョンを指定できます。これを行うには、オプションの Minishift-Version メタデータフィールドを指定できます。セマンティクスは以下のとおりです。

アドオン依存関係は、Depends-On メタデータフィールドを使用して定義できます。複数の依存関係は、アドオン名のコンマ区切りリストを使用して定義できます。

Name: example
Description: Shows the use of the Depends-On metadata field
Depends-On: anyuid, admin-user

# Name: example
# Description: Shows the use of the Depends-On metadata field
# Depends-On: anyuid, admin-user

echo Depends on the anyuid and admin-user add-ons, requiring them to be installed.

本セクションでは、アドオンファイルに追加できるコマンドを説明します。CDK アドオンのドメイン固有の小さな言語を形成します。

CDK では、アドオンコマンド内で変数を使用できます。変数の形式は #{<variable-name>} です。以下の例は、OpenShift ルーティング接尾辞が openshift コマンドに挿入され、OpenShift レジストリーのセキュリティー保護の一環として新規証明書を作成する方法を示しています。使用された変数 #{routing-suffix} は組み込みアドオン変数の一部です。

openshift admin ca create-server-cert \
  --signer-cert=/var/lib/origin/openshift.local.config/master/ca.crt \
  --signer-key=/var/lib/origin/openshift.local.config/master/ca.key \
  --signer-serial=/var/lib/origin/openshift.local.config/master/ca.serial.txt \
  --hostnames='docker-registry-default.#{routing-suffix},docker-registry.default.svc.cluster.local,172.30.1.1' \
  --cert=/etc/secrets/registry.crt \
  --key=/etc/secrets/registry.key

$ openshift admin ca create-server-cert \
  --signer-cert=/var/lib/origin/openshift.local.config/master/ca.crt \
  --signer-key=/var/lib/origin/openshift.local.config/master/ca.key \
  --signer-serial=/var/lib/origin/openshift.local.config/master/ca.serial.txt \
  --hostnames='docker-registry-default.#{routing-suffix},docker-registry.default.svc.cluster.local,172.30.1.1' \
  --cert=/etc/secrets/registry.crt \
  --key=/etc/secrets/registry.key

minishift addons apply --addon-env PROJECT_USER=user acme

$ minishift addons apply --addon-env PROJECT_USER=user acme

minishift config set addon-env PROJECT_USER=user
minishift addons apply acme

$ minishift config set addon-env PROJECT_USER=user
$ minishift addons apply acme

minishift config set addon-env PROJECT_USER=env.USER
minishift addons apply acme

$ minishift config set addon-env PROJECT_USER=env.USER        

$ minishift addons apply acme                                 

Name: acme
Description: ACME add-on
Required-Vars: PROJECT_USER

# Name: acme
# Description: ACME add-on
# Required-Vars: PROJECT_USER

Name: acme
Description: ACME add-on
Required-Vars: PROJECT_USER
Var-Defaults: PROJECT_USER=user

# Name: acme
# Description: ACME add-on
# Required-Vars: PROJECT_USER
# Var-Defaults: PROJECT_USER=user

mytoken := oc sa get-token oauth-client
oc new-app -p OPENSHIFT_OAUTH_CLIENT_SECRET=#{mytoken}

mytoken := oc sa get-token oauth-client
oc new-app -p OPENSHIFT_OAUTH_CLIENT_SECRET=#{mytoken}

CDK は、開発を支援する共通の OpenShift カスタマイズを提供する一連のビルトインアドオンを提供します。minishift setup-cdk では、Minishift は自動的に xpaas アドオン、anyuid アドオン、および admin-user アドオンをインストールして有効にします。デフォルトのアドオンをインストールするには、以下を実行します。

minishift addons install --defaults

$ minishift addons install --defaults

このコマンドは、デフォルトのアドオンインストールディレクトリー $MINISHIFT_HOME/addons に展開します。インストールされたアドオンの一覧を表示するには、以下のコマンドを実行します。

minishift addons list --verbose=true

$ minishift addons list --verbose=true

このコマンドは、インストールされているアドオンの一覧を出力します。少なくとも、anyuid アドオンが表示されるはずです。これは、事前に割り当てられた UID を使用しないイメージを実行できるようにする重要なアドオンです。デフォルトでは、これは OpenShift では使用できません。

アドオンは minishift addons install コマンドでインストールされます。

以下の例は、アドオンのインストール方法を示しています。

minishift addons install <path_to_addon_directory>

$ minishift addons install <path_to_addon_directory>

アドオンは minishift addons enable コマンドで有効にされ、minishift addons disable コマンドで無効にされます。有効にするアドオンは、minishift start 時に自動的に実行されます。

以下の例は、anyuid アドオンを有効にして無効にする方法を示しています。

minishift addons enable anyuid

$ minishift addons enable anyuid

minishift addons disable anyuid

$ minishift addons disable anyuid

minishift addons enable registry --priority=5

$ minishift addons enable registry --priority=5

minishift addons list

$ minishift addons list
- anyuid         : enabled    P(0)
- registry       : enabled    P(5)
- eap            : enabled    P(10)

アドオンは minishift addons apply コマンドを使用して明示的に実行できます。有効なアドオンと無効なアドオンの両方に apply コマンドを使用できます。1 つのコマンドで複数のアドオンを適用するには、スペースで区切られたアドオン名を指定します。

以下の例は、anyuid アドオンおよび admin-user アドオンを明示的に適用する方法を示しています。

minishift addons apply anyuid admin-user

$ minishift addons apply anyuid admin-user

アドオンは minishift addons remove コマンドを使用して削除できます。これは minishift addons apply のミラーコマンドであり、アドオンが有効かどうかに関わらず、同様に使用できます。指定したアドオンがインストールされ、<addon_name>.addon.remove ファイルがある場合、minishift addons remove は、このファイルで指定されたコマンドを実行します。

1 つのコマンドで複数のアドオンを削除するには、スペースで区切られたアドオン名を指定します。以下の例は、admin-user アドオンを明示的に削除する方法を示しています。

minishift addons remove admin-user

$ minishift addons remove admin-user
-- Removing addon 'admin-user':.
admin user deleted

アドオンは、minishift addons uninstall コマンドを使用してアンインストールできます。これは minishift addons install のミラーコマンドであり、アドオンが有効かどうかに関わらず、同様に使用できます。指定したアドオンがインストールされている場合、minishift addons uninstall は対応するアドオンディレクトリーを $MINISHIFT_HOME/addons から削除します。

以下の例は、admin-user アドオンを明示的にアンインストールする方法を示しています。

minishift addons uninstall admin-user

$ minishift addons uninstall admin-user
Add-on 'admin-user' uninstalled

カスタムアドオンを作成するには、ディレクトリーを作成し、そのディレクトリーに、拡張子 .addon で少なくとも 1 つのテキストファイルを作成する必要があります (例: admin-role.addon)。

このファイルには、アドオンの一部として実行するコマンドと、Name および Description メタデータフィールドが含まれている必要があります。

以下の例は、開発者ユーザーに cluster-admin 権限を付与するアドオンの定義を示しています。

Name: admin-role
Description: Gives the developer user cluster-admin privileges

# Name: admin-role
# Description: Gives the developer user cluster-admin privileges

oc adm policy add-role-to-user cluster-admin developer

アドオンを定義したら、以下を実行してインストールできます。

minishift addons install <ADDON_DIR_PATH>

$ minishift addons install <ADDON_DIR_PATH>

Name: prometheus
Description: This template creates a Prometheus instance preconfigured to gather OpenShift and
Kubernetes platform and node metrics and report them to admins. It is protected by an
OAuth proxy that only allows access for users who have view access to the prometheus
namespace. You may customize where the images (built from openshift/prometheus
and openshift/oauth-proxy) are pulled from via template parameters.
Url: https://prometheus.io/

# Name: prometheus
# Description: This template creates a Prometheus instance preconfigured to gather OpenShift and
# Kubernetes platform and node metrics and report them to admins. It is protected by an
# OAuth proxy that only allows access for users who have view access to the prometheus
# namespace. You may customize where the images (built from openshift/prometheus
# and openshift/oauth-proxy) are pulled from via template parameters.
# Url: https://prometheus.io/

CDK アドオンインストールディレクトリー $MINISHIFT_HOME/addons で、アドオンを直接編集することもできます。アドオンにエラーがある場合は、addons コマンドの実行時には表示されませんが、これは minishift start プロセス中は適用されないことに注意してください。

アドオンの削除手順を提供するには、拡張子 .addon.remove でテキストファイルを作成できます (例: admin-user.addon.remove)。.addon ファイルと同様に、Name および Description メタデータフィールドが必要です。.addon.remove ファイルが存在する場合は、remove コマンドで適用できます。