2.4. アドオン

2.4.1. 概要

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

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

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

例: anyuid アドオン定義ファイル

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

mytoken := oc sa get-token oauth-client                                                 6

oc new-app -p OPENSHIFT_OAUTH_CLIENT_SECRET=#{mytoken}                                  7
oc adm policy add-scc-to-group anyuid system:authenticated                              8

1
(必須) アドオンの名前。
2
(必須) アドオンの説明。
3
(必要に応じて) 必要な挿入変数のコンマ区切りリスト。「変数の挿入」を参照してください。
4
(必要に応じて) 特定のアドオンの実行に必要な OpenShift バージョン。「OpenShift バージョンセマンティクス」を参照してください。
5
(必要に応じて) 特定のアドオンの実行に必要な CDK バージョン。「最小バージョンセマンティクス」を参照してください。
6
実際のアドオンコマンドを実行し、その出力を変数に保存します。「内部変数」を参照してください。
7
実際の追加コマンドです。この場合、コマンドは mytoken 変数の値を使用して oc バイナリーを実行します。
8
実際の追加コマンドです。この場合、コマンドは oc バイナリーを実行します。
注記
  • 「#」文字で始まるコメント行は、ファイルのどこにでも挿入できます。
  • ! 文字で始まるコマンドは、実行の失敗を無視します。そのため、アドオンがべき等になります (つまり、アドオンの最終的な動作を変更せずに、コマンドは複数回実行できます)。

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