19.4. InstallPlan [operators.coreos.com/v1alpha1]


Description
InstallPlan は、一連の Operator のインストールを定義します。
タイプ
object
必須
  • metadata
  • spec

19.4.1. 仕様

Expand
プロパティータイプ説明

apiVersion

string

APIVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これを更新することはできません。CamelCase詳細については、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

metadata

ObjectMeta_v2

標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。

spec

object

InstallPlanSpec は、インストールするアプリケーションリソースのセットを定義します

status

object

InstallPlanStatus は、インストールを完了するために必要な手順のステータスに関する情報を表します。ステータスは、システムの実際の状態を追跡する場合があります。

19.4.1.1. .spec

Description
InstallPlanSpec は、インストールするアプリケーションリソースのセットを定義します
タイプ
object
必須
  • approval
  • 承認
  • clusterServiceVersionNames
Expand
プロパティータイプDescription

approval

string

承認は、InstallPlan のユーザー承認ポリシーです。自動または手動のいずれかである必要があります。

承認

ブール値

 

clusterServiceVersionNames

array (string)

 

generation

integer

 

source

string

 

sourceNamespace

string

 

19.4.1.2. .status

Description
InstallPlanStatus は、インストールを完了するために必要な手順のステータスに関する情報を表します。ステータスは、システムの実際の状態を追跡する場合があります。
タイプ
object
必須
  • catalogSources
  • phase
Expand
プロパティータイプDescription

attenuatedServiceAccountRef

object

AttenuatedServiceAccountRef は、スコープ Operator のインストールを行うために使用されるサービスアカウントを参照します。

bundleLookups

array

BundleLookups は、バンドルコンテンツをクラスターにプルおよびアンパッケージするための進行中のリクエストのセットです。

bundleLookups[]

object

BundleLookup は、バンドルのコンテンツをクラスターにプルしてアンパッケージするためのリクエストです。

catalogSources

array (string)

 

conditions

array

 

conditions[]

object

InstallPlanCondition は、InstallPlan の実行の全体的なステータスを表します。

message

string

メッセージは、計画が現在のステータスになっている理由を理解するために重要な詳細情報を含む、人間が読めるメッセージです。

phase

string

InstallPlanPhase は、InstallPlan 全体の現在のステータスです。

plan

array

 

plan[]

object

ステップは、InstallPlan の個々のステップのステータスを表します。

startTime

string

StartTime は、コントローラーがプランにリストされているリソースをクラスターに適用し始めた時刻です。

19.4.1.3. .status.attenuatedServiceAccountRef

Description
AttenuatedServiceAccountRef は、スコープ Operator のインストールを行うために使用されるサービスアカウントを参照します。
タイプ
object
Expand
プロパティータイプ説明

apiVersion

string

参照先の API バージョン。

fieldPath

string

オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、spec.containers{name} などの値に設定されます (name はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、spec.containers[2] の値に設定されます (この Pod 内でインデックス が 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。TODO: この設計は最終版ではないので今後このフィールドは変更される可能性があります。

kind

string

参照先の種類。詳細については、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespace

string

参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersion

string

この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uid

string

参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

19.4.1.4. .status.bundleLookups

Description
BundleLookups は、バンドルコンテンツをクラスターにプルおよびアンパッケージするための進行中のリクエストのセットです。
タイプ
array

19.4.1.5. .status.bundleLookups[]

Description
BundleLookup は、バンドルのコンテンツをクラスターにプルしてアンパッケージするためのリクエストです。
タイプ
object
必須
  • catalogSourceRef
  • identifier
  • path
  • replaces
Expand
プロパティータイプDescription

catalogSourceRef

object

CatalogSourceRef は、バンドルパスが解決された CatalogSource への参照です。

conditions

array

条件は、BundleLookup の全体的な状態を表します。

conditions[]

object

 

identifier

string

識別子は、カタログ固有の Operator 名 (CSV を含むバンドルの CSV 名) です。

path

string

パスは、プルするバンドルの場所を指します。これは通常、イメージ参照です。

properties

string

開梱されたバンドルの有効なプロパティー。

replaces

string

Replaces は、Path で見つかったものと置き換えるバンドルの名前です。

19.4.1.6. .status.bundleLookups[].catalogSourceRef

Description
CatalogSourceRef は、バンドルパスが解決された CatalogSource への参照です。
タイプ
object
Expand
プロパティータイプ説明

apiVersion

string

参照先の API バージョン。

fieldPath

string

オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、spec.containers{name} などの値に設定されます (name はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、spec.containers[2] の値に設定されます (この Pod 内でインデックス が 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。TODO: この設計は最終版ではないので今後このフィールドは変更される可能性があります。

kind

string

参照先の種類。詳細については、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespace

string

参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersion

string

この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uid

string

参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

19.4.1.7. .status.bundleLookups[].conditions

Description
条件は、BundleLookup の全体的な状態を表します。
タイプ
array

19.4.1.8. .status.bundleLookups[].conditions[]

Description
タイプ
object
必須
  • status
  • type
Expand
プロパティータイプ説明

lastTransitionTime

string

最後にある状態から別の状態に遷移した時間。

lastUpdateTime

string

前回、状態が調査されました。

message

string

遷移の詳細を示す人が判読できるメッセージ。

reason

string

条件の最後の遷移の理由。

status

string

状態のステータス、True、False、Unknown のいずれか。

type

string

状態のタイプ。

19.4.1.9. .status.conditions

Description
タイプ
array

19.4.1.10. .status.conditions[]

Description
InstallPlanCondition は、InstallPlan の実行の全体的なステータスを表します。
タイプ
object
Expand
プロパティータイプ説明

lastTransitionTime

string

 

lastUpdateTime

string

 

message

string

 

reason

string

ConditionReason は、状態遷移のキャメルケースの理由です。

status

string

 

type

string

InstallPlanConditionType は、全体として特定の時点での InstallPlan の状態を記述します。

19.4.1.11. .status.plan

Description
タイプ
array

19.4.1.12. .status.plan[]

Description
ステップは、InstallPlan の個々のステップのステータスを表します。
タイプ
object
必須
  • resolving
  • resource
  • status
Expand
プロパティータイプDescription

resolving

string

 

resource

object

StepResource は、InstallPlan によって追跡されるリソースのステータスを表します。

status

string

StepStatus は、InstallPlan 内の特定のリソースの現在のステータスです。

19.4.1.13. .status.plan[].resource

Description
StepResource は、InstallPlan によって追跡されるリソースのステータスを表します。
タイプ
object
必須
  • group
  • kind
  • name
  • sourceName
  • sourceNamespace
  • version
Expand
プロパティータイプDescription

group

string

 

kind

string

 

manifest

string

 

name

string

 

sourceName

string

 

sourceNamespace

string

 

version

string

 

19.4.2. API エンドポイント

以下の API エンドポイントを利用できます。

  • /apis/operators.coreos.com/v1alpha1/installplans

    • GET:InstallPlan の種類のオブジェクトを一覧表示します
  • /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/installplans

    • 削除:InstallPlan のコレクションを削除します
    • GET:InstallPlan の種類のオブジェクトを一覧表示します
    • POST:InstallPlan を作成します
  • /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/installplans/{name}

    • 削除:InstallPlan を削除します
    • GET: 指定された InstallPlan を読み取ります
    • PATCH: 指定された InstallPlan を部分的に更新します
    • PUT: 指定された InstallPlan を置き換えます
  • /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/installplans/{name}/status

    • GET: 指定された InstallPlan のステータスを読み取ります
    • PATCH: 指定された InstallPlan のステータスを部分的に更新します
    • PUT: 指定された InstallPlan のステータスを置き換えます

19.4.2.1. /apis/operators.coreos.com/v1alpha1/installplans

Expand
表19.69 グローバルクエリーパラメーター
パラメータータイプ説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが BOOKMARK の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの裁量で送信されます。クライアントは、ブックマークが特定の間隔で返されると想定したり、サーバーがセッション中に BOOKMARK イベントを送信すると想定したりすることはできません。これが watch でない場合には、このフィールドは無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で前のクエリー結果からの continue 値のみを使用でき、サーバーは認識しない continue 値を拒否できます。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合、続行フィールドなしでリストを再起動する必要があります。そうしないと、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信する可能性があり、サーバーは次のキーから始まるリストで応答しますが、前のリスト結果と矛盾する最新のスナップショットから - 作成されたオブジェクト、変更、または削除された後、最初のリストリクエストは、それらのキーが次のキーの後にある限り、応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトはすべてです。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクターです。デフォルトはすべてです。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの continue フィールドを、同じ初期クエリーで使用して次の結果セットを取得できる値に設定します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしないことを選択でき、利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、制限を使用して非常に大きな結果の小さなチャンクを受信するクライアントが、すべての可能なオブジェクトを確実に表示できるようにします。チャンクリスト中にオブジェクトが更新された場合、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

pretty

string

'true' の場合、出力はきれいに印刷されます。

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することを強くお勧めします。詳細については、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

timeoutSeconds

integer

リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。

watch

boolean

説明されているリソースへの変更を監視し、それらを追加、更新、および削除の通知のストリームとして返します。resourceVersion を指定します。

HTTP メソッド
GET
Description
InstallPlan の種類のオブジェクトを一覧表示します
Expand
表19.70 HTTP 応答
HTTP コードレスポンス本文

200 - OK

InstallPlanList スキーマ

401 - Unauthorized

空白

19.4.2.2. /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/installplans

Expand
表19.71 グローバルパスパラメーター
パラメータータイプ説明

namespace

string

チームやプロジェクトなどのオブジェクト名と認証スコープ

Expand
表19.72 グローバルクエリーパラメーター
パラメータータイプ説明

pretty

string

'true' の場合、出力はきれいに印刷されます。

HTTP メソッド
DELETE
Description
InstallPlan のコレクションを削除します
Expand
表19.73 クエリーパラメーター
パラメータータイプ説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが BOOKMARK の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの裁量で送信されます。クライアントは、ブックマークが特定の間隔で返されると想定したり、サーバーがセッション中に BOOKMARK イベントを送信すると想定したりすることはできません。これが watch でない場合には、このフィールドは無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で前のクエリー結果からの continue 値のみを使用でき、サーバーは認識しない continue 値を拒否できます。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合、続行フィールドなしでリストを再起動する必要があります。そうしないと、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信する可能性があり、サーバーは次のキーから始まるリストで応答しますが、前のリスト結果と矛盾する最新のスナップショットから - 作成されたオブジェクト、変更、または削除された後、最初のリストリクエストは、それらのキーが次のキーの後にある限り、応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトはすべてです。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクターです。デフォルトはすべてです。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの continue フィールドを、同じ初期クエリーで使用して次の結果セットを取得できる値に設定します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしないことを選択でき、利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、制限を使用して非常に大きな結果の小さなチャンクを受信するクライアントが、すべての可能なオブジェクトを確実に表示できるようにします。チャンクリスト中にオブジェクトが更新された場合、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することを強くお勧めします。詳細については、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

timeoutSeconds

integer

リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。

watch

boolean

説明されているリソースへの変更を監視し、それらを追加、更新、および削除の通知のストリームとして返します。resourceVersion を指定します。

Expand
表19.74 HTTP 応答
HTTP コードレスポンス本文

200 - OK

Status_v2 schema

401 - Unauthorized

空白

HTTP メソッド
GET
Description
InstallPlan の種類のオブジェクトを一覧表示します
Expand
表19.75 クエリーパラメーター
パラメータータイプ説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが BOOKMARK の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの裁量で送信されます。クライアントは、ブックマークが特定の間隔で返されると想定したり、サーバーがセッション中に BOOKMARK イベントを送信すると想定したりすることはできません。これが watch でない場合には、このフィールドは無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で前のクエリー結果からの continue 値のみを使用でき、サーバーは認識しない continue 値を拒否できます。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合、続行フィールドなしでリストを再起動する必要があります。そうしないと、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信する可能性があり、サーバーは次のキーから始まるリストで応答しますが、前のリスト結果と矛盾する最新のスナップショットから - 作成されたオブジェクト、変更、または削除された後、最初のリストリクエストは、それらのキーが次のキーの後にある限り、応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトはすべてです。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクターです。デフォルトはすべてです。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの continue フィールドを、同じ初期クエリーで使用して次の結果セットを取得できる値に設定します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしないことを選択でき、利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、制限を使用して非常に大きな結果の小さなチャンクを受信するクライアントが、すべての可能なオブジェクトを確実に表示できるようにします。チャンクリスト中にオブジェクトが更新された場合、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することを強くお勧めします。詳細については、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

timeoutSeconds

integer

リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。

watch

boolean

説明されているリソースへの変更を監視し、それらを追加、更新、および削除の通知のストリームとして返します。resourceVersion を指定します。

Expand
表19.76 HTTP 応答
HTTP コードレスポンス本文

200 - OK

InstallPlanList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
Description
InstallPlan を作成します
Expand
表19.77 クエリーパラメーター
パラメータータイプ説明

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

Expand
表19.78 ボディパラメーター
パラメータータイプ説明

ボディー

InstallPlan スキーマ

 
Expand
表19.79 HTTP 応答
HTTP コードレスポンス本文

200 - OK

InstallPlan スキーマ

201 - Created

InstallPlan スキーマ

202 - Accepted

InstallPlan スキーマ

401 - Unauthorized

空白

19.4.2.3. /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/installplans/{name}

Expand
表19.80 グローバルパスパラメーター
パラメータータイプ説明

name

string

InstallPlan の名前

namespace

string

チームやプロジェクトなどのオブジェクト名と認証スコープ

Expand
表19.81 グローバルクエリーパラメーター
パラメータータイプ説明

pretty

string

'true' の場合、出力はきれいに印刷されます。

HTTP メソッド
DELETE
Description
InstallPlan を削除します
Expand
表19.82 クエリーパラメーター
パラメータータイプ説明

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

gracePeriodSeconds

integer

オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。

orphanDependents

boolean

非推奨: PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、孤立したファイナライザーがオブジェクトのファイナライザー一覧で追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。

propagationPolicy

string

ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定することはできません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシー。

Expand
表19.83 ボディパラメーター
パラメータータイプ説明

body

DeleteOptions_v2 schema

 
Expand
表19.84 HTTP 応答
HTTP コードレスポンス本文

200 - OK

Status_v2 schema

202 - Accepted

Status_v2 schema

401 - Unauthorized

空白

HTTP メソッド
GET
Description
指定された InstallPlan を読みます
Expand
表19.85 クエリーパラメーター
パラメータータイプ説明

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

Expand
表19.86 HTTP 応答
HTTP コードレスポンス本文

200 - OK

InstallPlan スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
Description
指定された InstallPlan を部分的に更新します
Expand
表19.87 クエリーパラメーター
パラメータータイプ説明

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

Expand
表19.88 ボディパラメーター
パラメータータイプ説明

body

Patch schema

 
Expand
表19.89 HTTP 応答
HTTP コードレスポンス本文

200 - OK

InstallPlan スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
Description
指定された InstallPlan を置き換えます
Expand
表19.90 クエリーパラメーター
パラメータータイプ説明

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

Expand
表19.91 ボディパラメーター
パラメータータイプ説明

ボディー

InstallPlan スキーマ

 
Expand
表19.92 HTTP 応答
HTTP コードレスポンス本文

200 - OK

InstallPlan スキーマ

201 - Created

InstallPlan スキーマ

401 - Unauthorized

空白

19.4.2.4. /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/installplans/{name}/status

Expand
表19.93 グローバルパスパラメーター
パラメータータイプ説明

name

string

InstallPlan の名前

namespace

string

チームやプロジェクトなどのオブジェクト名と認証スコープ

Expand
表19.94 グローバルクエリーパラメーター
パラメータータイプ説明

pretty

string

'true' の場合、出力はきれいに印刷されます。

HTTP メソッド
GET
Description
指定された InstallPlan のステータスを読み取ります
Expand
表19.95 クエリーパラメーター
パラメータータイプ説明

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

Expand
表19.96 HTTP 応答
HTTP コードレスポンス本文

200 - OK

InstallPlan スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
Description
指定された InstallPlan のステータスを部分的に更新します
Expand
表19.97 クエリーパラメーター
パラメータータイプ説明

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

Expand
表19.98 ボディパラメーター
パラメータータイプ説明

body

Patch schema

 
Expand
表19.99 HTTP 応答
HTTP コードレスポンス本文

200 - OK

InstallPlan スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
Description
指定された InstallPlan のステータスを置き換えます
Expand
表19.100 クエリーパラメーター
パラメータータイプ説明

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

Expand
表19.101 ボディパラメーター
パラメータータイプ説明

ボディー

InstallPlan スキーマ

 
Expand
表19.102 HTTP 応答
HTTP コードレスポンス本文

200 - OK

InstallPlan スキーマ

201 - Created

InstallPlan スキーマ

401 - Unauthorized

空白

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat