18.8. Config [samples.operator.openshift.io/v1]
- Description
- Config には、SamplesOperator の設定と詳細な条件ステータスが含まれています。
- タイプ
-
object
- 必須
-
metadata
-
spec
-
18.8.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 を参照してください。 |
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| ConfigSpec には、Samples Operator に必要な設定と状態が含まれており、openshift 名前空間で作成/更新するイメージストリームとテンプレートに関するさまざまな動作を制御します。 |
|
| ConfigStatus には、実際の設定と、サンプル Operator の状態を説明するさまざまな詳細が含まれています。 |
18.8.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- Description
- ConfigSpec には、Samples Operator に必要な設定と状態が含まれており、openshift 名前空間で作成/更新するイメージストリームとテンプレートに関するさまざまな動作を制御します。
- タイプ
-
object
プロパティー | タイプ | Description |
---|---|---|
|
| アーキテクチャーは、インストールするハードウェアアーキテクチャーを決定します。現在サポートされている選択肢は、x86_64、ppc64le、および s390x のみです。 |
|
| managementState は、すべての Operator にとって最上位のオン/オフタイプのスイッチです。管理対象の場合、この Operator は設定を処理し、それに応じてサンプルを操作します。管理されていない場合、この Operator は、監視しているリソースの更新を無視します。削除済みの場合、Config オブジェクトが削除された場合と同じように反応します。つまり、管理する ImageStream またはテンプレート (スキップされたリストを尊重する) とレジストリーシークレットが、Operator の名前空間の ConfigMap とともに削除されます。これは、サンプルの操作に使用された最後の設定を表します。 |
|
| samplesRegistry を使用すると、ImageStreams がイメージコンテンツのためにアクセスするレジストリーを指定できます。この github リポジトリーにプルされる https://github.com/openshift/library のコンテンツのデフォルトですが、ocp コンテンツのみのプルに基づいて、通常はデフォルトで registry.redhat.io になります。 |
|
| skippedImagestreams は、作成/更新してはならないイメージストリームの名前を指定します。管理者はこれを使用して、不要なコンテンツを削除できるようにすることができます。コンテンツを手動で削除する必要がありますが、Operator はここにリストされているものを再作成 (または更新) しません。 |
|
| skippedTemplates は、作成/更新してはならないテンプレートの名前を指定します。管理者はこれを使用して、不要なコンテンツを削除できるようにすることができます。コンテンツを手動で削除する必要がありますが、Operator はここにリストされているものを再作成 (または更新) しません。 |
18.8.1.2. .status リンクのコピーリンクがクリップボードにコピーされました!
- Description
- ConfigStatus には、実際の設定と、サンプル Operator の状態を説明するさまざまな詳細が含まれています。
- タイプ
-
object
プロパティー | タイプ | Description |
---|---|---|
|
| アーキテクチャーは、インストールするハードウェアアーキテクチャーを決定します。ここで、x86_64 と ppc64le がサポートされている選択肢です。 |
|
| 条件は、サンプルイメージストリームとテンプレートの利用可能なメンテナンスステータスを表します。 |
|
| ConfigCondition は、エントリーが処理されるときに Config のさまざまな条件をキャプチャします。 |
|
| managementState は、Operator のオン/オフスイッチの現在の動作ステータスを反映します。この Operator は、Operator をオンに戻していることを確認する一環として、ManagementState を比較します (つまり、以前は管理されていなかった場合は管理された)。 |
|
| samplesRegistry を使用すると、ImageStreams がイメージコンテンツのためにアクセスするレジストリーを指定できます。この github リポジトリーにプルされる https://github.com/openshift/library のコンテンツのデフォルトですが、ocp コンテンツのみのプルに基づいて、通常はデフォルトで registry.redhat.io になります。 |
|
| skippedImagestreams は、作成/更新してはならないイメージストリームの名前を指定します。管理者はこれを使用して、不要なコンテンツを削除できるようにすることができます。コンテンツを手動で削除する必要がありますが、Operator はここにリストされているものを再作成 (または更新) しません。 |
|
| skippedTemplates は、作成/更新してはならないテンプレートの名前を指定します。管理者はこれを使用して、不要なコンテンツを削除できるようにすることができます。コンテンツを手動で削除する必要がありますが、Operator はここにリストされているものを再作成 (または更新) しません。 |
|
| version は、最後に正常に処理されたときの Operator のペイロードベースのバージョンインジケーターの値です。 |
18.8.1.3. .status.conditions リンクのコピーリンクがクリップボードにコピーされました!
- Description
- 条件は、サンプルイメージストリームとテンプレートの利用可能なメンテナンスステータスを表します。
- タイプ
-
array
18.8.1.4. .status.conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- Description
- ConfigCondition は、エントリーが処理されるときに Config のさまざまな条件をキャプチャします。
- タイプ
-
object
- 必須
-
status
-
type
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。 |
|
| lastUpdateTime は、この条件が最後に更新された時刻です。 |
|
| message は、遷移の詳細を示す人が判読できるメッセージです。 |
|
| 理由は、条件の最後の遷移を引き起こしたものです。 |
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
| 状態のタイプ。 |
18.8.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/samples.operator.openshift.io/v1/configs
-
DELETE
: 設定のコレクションを削除します -
GET
: 種類のオブジェクトを一覧表示する Config -
POST
: 設定を作成します
-
/apis/samples.operator.openshift.io/v1/configs/{name}
-
削除
: 設定を削除します -
GET
: 指定された設定を読み取ります -
PATCH
: 指定された設定を部分的に更新します -
PUT
: 指定された設定を置き換えます
-
/apis/samples.operator.openshift.io/v1/configs/{name}/status
-
GET
: 指定された設定のステータスを読み取ります -
PATCH
: 指定された設定のステータスを部分的に更新します -
PUT
: 指定された設定のステータスを置き換えます
-
18.8.2.1. /apis/samples.operator.openshift.io/v1/configs リンクのコピーリンクがクリップボードにコピーされました!
パラメーター | タイプ | 説明 |
---|---|---|
|
| 'true' の場合、出力はきれいに印刷されます。 |
- HTTP メソッド
-
DELETE
- Description
- Config のコレクションを削除します
パラメーター | タイプ | 説明 |
---|---|---|
|
| allowWatchBookmarks は、タイプが BOOKMARK の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの裁量で送信されます。クライアントは、ブックマークが特定の間隔で返されると想定したり、サーバーがセッション中に BOOKMARK イベントを送信すると想定したりすることはできません。これが watch でない場合には、このフィールドは無視されます。 |
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で前のクエリー結果からの continue 値のみを使用でき、サーバーは認識しない continue 値を拒否できます。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合、続行フィールドなしでリストを再起動する必要があります。そうしないと、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信する可能性があり、サーバーは次のキーから始まるリストで応答しますが、前のリスト結果と矛盾する最新のスナップショットから - 作成されたオブジェクト、変更、または削除された後、最初のリストリクエストは、それらのキーが次のキーの後にある限り、応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトはすべてです。 |
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクターです。デフォルトはすべてです。 |
|
| limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの continue フィールドを、同じ初期クエリーで使用して次の結果セットを取得できる値に設定します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしないことを選択でき、利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、制限を使用して非常に大きな結果の小さなチャンクを受信するクライアントが、すべての可能なオブジェクトを確実に表示できるようにします。チャンクリスト中にオブジェクトが更新された場合、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 Defaults to unset |
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することを強くお勧めします。詳細については、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 Defaults to unset |
|
| リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。 |
|
| 説明されているリソースへの変更を監視し、それらを追加、更新、および削除の通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- Description
- 種類のオブジェクトを一覧表示する Config
パラメーター | タイプ | 説明 |
---|---|---|
|
| allowWatchBookmarks は、タイプが BOOKMARK の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの裁量で送信されます。クライアントは、ブックマークが特定の間隔で返されると想定したり、サーバーがセッション中に BOOKMARK イベントを送信すると想定したりすることはできません。これが watch でない場合には、このフィールドは無視されます。 |
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で前のクエリー結果からの continue 値のみを使用でき、サーバーは認識しない continue 値を拒否できます。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合、続行フィールドなしでリストを再起動する必要があります。そうしないと、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信する可能性があり、サーバーは次のキーから始まるリストで応答しますが、前のリスト結果と矛盾する最新のスナップショットから - 作成されたオブジェクト、変更、または削除された後、最初のリストリクエストは、それらのキーが次のキーの後にある限り、応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトはすべてです。 |
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクターです。デフォルトはすべてです。 |
|
| limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの continue フィールドを、同じ初期クエリーで使用して次の結果セットを取得できる値に設定します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしないことを選択でき、利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、制限を使用して非常に大きな結果の小さなチャンクを受信するクライアントが、すべての可能なオブジェクトを確実に表示できるようにします。チャンクリスト中にオブジェクトが更新された場合、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 Defaults to unset |
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することを強くお勧めします。詳細については、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 Defaults to unset |
|
| リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。 |
|
| 説明されているリソースへの変更を監視し、それらを追加、更新、および削除の通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- Description
- 設定を作成する
パラメーター | タイプ | 説明 |
---|---|---|
|
| これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
パラメーター | タイプ | 説明 |
---|---|---|
|
|
18.8.2.2. /apis/samples.operator.openshift.io/v1/configs/{name} リンクのコピーリンクがクリップボードにコピーされました!
パラメーター | タイプ | 説明 |
---|---|---|
|
| 設定の名前 |
パラメーター | タイプ | 説明 |
---|---|---|
|
| 'true' の場合、出力はきれいに印刷されます。 |
- HTTP メソッド
-
DELETE
- Description
- 設定を削除する
パラメーター | タイプ | 説明 |
---|---|---|
|
| これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。 |
|
| オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。 |
|
| 非推奨: PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、孤立したファイナライザーがオブジェクトのファイナライザー一覧で追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。 |
|
| ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定することはできません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシー。 |
パラメーター | タイプ | 説明 |
---|---|---|
|
|
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- Description
- 指定された設定を読み取ります
パラメーター | タイプ | 説明 |
---|---|---|
|
| resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 Defaults to unset |
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- Description
- 指定された設定を部分的に更新します
パラメーター | タイプ | 説明 |
---|---|---|
|
| これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
パラメーター | タイプ | 説明 |
---|---|---|
|
|
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- Description
- 指定された設定を置き換えます
パラメーター | タイプ | 説明 |
---|---|---|
|
| これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
パラメーター | タイプ | 説明 |
---|---|---|
|
|
18.8.2.3. /apis/samples.operator.openshift.io/v1/configs/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
パラメーター | タイプ | 説明 |
---|---|---|
|
| 設定の名前 |
パラメーター | タイプ | 説明 |
---|---|---|
|
| 'true' の場合、出力はきれいに印刷されます。 |
- HTTP メソッド
-
GET
- Description
- 指定された設定のステータスを読み取ります
パラメーター | タイプ | 説明 |
---|---|---|
|
| resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 Defaults to unset |
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- Description
- 指定された設定のステータスを部分的に更新します
パラメーター | タイプ | 説明 |
---|---|---|
|
| これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
パラメーター | タイプ | 説明 |
---|---|---|
|
|
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- Description
- 指定された設定のステータスを置き換えます
パラメーター | タイプ | 説明 |
---|---|---|
|
| これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
パラメーター | タイプ | 説明 |
---|---|---|
|
|