第5章 TemplateInstance [template.openshift.io/v1]
- Description
TemplateInstance は、テンプレートのインスタンス化を要求して記録します。TemplateInstance は実験的な API の一部です。
互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object
- 必須
-
spec
-
5.1. 仕様
プロパティー | 型 | 説明 |
---|---|---|
|
| APIVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。更新はできません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| ||
|
| TemplateInstanceSpec は、TemplateInstance の望ましい状態を記述します。 |
|
| TemplateInstanceStatus は、TemplateInstance の現在の状態を記述します。 |
5.1.1. .spec
- Description
- TemplateInstanceSpec は、TemplateInstance の望ましい状態を記述します。
- タイプ
-
object
- 必須
-
template
-
プロパティー | 型 | Description |
---|---|---|
|
| TemplateInstanceRequester は、テンプレートのインスタンス化を要求するエージェントの ID を保持します。 |
| secret は、必要なテンプレートパラメーターを含む Secret オブジェクトへの参照です。 | |
|
| Template には、Config を作成するために必要な入力が含まれています。 互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。 |
5.1.2. .spec.requester
- Description
- TemplateInstanceRequester は、テンプレートのインスタンス化を要求するエージェントの ID を保持します。
- タイプ
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| extra は、オーセンティケーターによって提供される追加情報を保持します。 |
|
| |
|
| グループは、このユーザーが参加しているグループを表します。 |
|
| uid は、時間の経過とともにこのユーザーを識別する一意の値です。このユーザーが削除され、同じ名前の別のユーザーが追加された場合、それらの UID は異なります。 |
|
| username は、すべてのアクティブユーザーの中でこのユーザーを一意に識別します。 |
5.1.3. .spec.requester.extra
- Description
- extra は、オーセンティケーターによって提供される追加情報を保持します。
- タイプ
-
object
5.1.4. .spec.template
- Description
Template には、Config を作成するために必要な入力が含まれています。
互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object
- 必須
-
objects
-
プロパティー | 型 | 説明 |
---|---|---|
|
| APIVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。更新はできません。CamelCase を使用します。詳細については、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| ラベルは、Template から Config への変換中にすべてのオブジェクトに適用される任意のラベルのセットです。 |
|
| message は、このテンプレートがインスタンス化されたときに表示される任意の指示メッセージです。このフィールドで、新規作成されたリソースの使用方法をユーザーに通知します。生成された認証情報や他のパラメーターを出力に追加できるように、メッセージの表示前にパラメーターの置換が行われます。 |
| ||
| オブジェクトは、このテンプレートに含めるリソースの配列です。namespace 値がオブジェクトにハードコーディングされている場合は、テンプレートのインスタンス化中に削除されますが、namespace 値が ${PARAMETER_REFERENCE} であるか、それを含む場合は、パラメーター置換後に解決された値が尊重され、オブジェクトはその namespace に作成されます。 | |
|
| parameters は、Template から Config への変換中に使用される Parameters のオプションの配列です。 |
|
| パラメーターは、Template から Config への変換中に処理される名前/値変数を定義します。 |
5.1.5. .spec.template.parameters
- Description
- parameters は、Template から Config への変換中に使用される Parameters のオプションの配列です。
- タイプ
-
array
5.1.6. .spec.template.parameters[]
- Description
- パラメーターは、Template から Config への変換中に処理される名前/値変数を定義します。
- タイプ
-
object
- 必須
-
name
-
プロパティー | 型 | 説明 |
---|---|---|
|
| パラメーターの説明。任意。 |
|
| オプション: パラメーター 'Name' の代わりに UI に表示される名前 |
|
| From は、ジェネレーターの入力値です。任意。 |
|
| generate は、From フィールドで指定された入力値からランダムな文字列を生成するために使用されるジェネレーターを指定します。結果の文字列は Value フィールドに保存されます。空の場合、ジェネレーターは使用されておらず、結果の値は変更されません。任意。 サポートされている唯一のジェネレーターは "expression" です。これは、範囲式 "[a-zA-Z0-9]" と長さ式 "a{length}" を含む単純な正規表現の形式で "from" 値を受け入れます。。 例: from | value ----------------------------- "test[0-9]{1}x" | "test7x" "[0-1]{8}" | "01001100" "0x[A-F0-9]{4}" | "0xB3AF" "[a-zA-Z0-9]{8}" | "hW4yQU5i" |
|
| 名前を設定する必要があり、${PARAMETER_NAME} を使用して Template Items で参照できます。必須。 |
|
| オプション: パラメーターに値が必要であることを示します。デフォルトは false です。 |
|
| 値はパラメーターデータを保持します。指定した場合は、ジェネレーターが無視されます。この値は、Template から Config への変換中に発生するすべてのパラメーター ${Name} 式を置き換えます。任意。 |
5.1.7. .status
- Description
- TemplateInstanceStatus は、TemplateInstance の現在の状態を記述します。
- タイプ
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 条件は、TemplateInstance の現在の状態について利用可能な最新の観測値を表します。 |
|
| TemplateInstanceCondition には、TemplateInstance の条件情報が含まれています。 |
|
| オブジェクトは、TemplateInstance によって作成されたオブジェクトを参照します。 |
|
| TemplateInstanceObject は、TemplateInstance によって作成されたオブジェクトを参照します。 |
5.1.8. .status.conditions
- Description
- 条件は、TemplateInstance の現在の状態について利用可能な最新の観測値を表します。
- タイプ
-
array
5.1.9. .status.conditions[]
- Description
- TemplateInstanceCondition には、TemplateInstance の条件情報が含まれています。
- タイプ
-
object
- 必須
-
type
-
status
-
lastTransitionTime
-
reason
-
message
-
プロパティー | 型 | 説明 |
---|---|---|
| LastTransitionTime は、条件ステータスが 1 つの状態から別の状態に遷移した最後の時間です。 | |
|
| メッセージは、最後の遷移の詳細を人間が読める形式で説明したものであり、理由を補足します。 |
|
| Reason は、条件の最後の遷移に関する機械可読な簡単な説明です。 |
|
| 条件のステータス (True、False、Unknown のいずれか)。 |
|
| 状態のタイプ。現在、Ready または InstantiateFailure です。 |
5.1.10. .status.objects
- Description
- オブジェクトは、TemplateInstance によって作成されたオブジェクトを参照します。
- タイプ
-
array
5.1.11. .status.objects[]
- Description
- TemplateInstanceObject は、TemplateInstance によって作成されたオブジェクトを参照します。
- タイプ
-
object
プロパティー | 型 | Description |
---|---|---|
| ObjectReference | ref は、作成されたオブジェクトへの参照です。.spec で使用する場合は、名前と namespace のみが使用されます。これらには、通常のルールに従って置換されるパラメーターへの参照を含めることができます。 |