コンソール API

description

string

description は、CLI ダウンロードの説明です (マークダウンを含めることができます)。

displayName

string

displayName は、CLI ダウンロードの表示名です。

links

array

リンクは、CLI ダウンロードリンクの詳細を提供するオブジェクトのリストです。

links[]

object

href

string

href はリンクの絶対的に安全な URL です (https を使用する必要があります)

text

string

text は、リンクの表示テキストです

200 - OK

Status スキーマ

401 - Unauthorized

空白

200 - OK

ConsoleCLIDownloadList スキーマ

401 - Unauthorized

空白

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

body

ConsoleCLIDownload schema

200 - OK

ConsoleCLIDownload schema

201 - Created

ConsoleCLIDownload schema

202 - Accepted

ConsoleCLIDownload schema

401 - Unauthorized

空白

name

string

ConsoleCLIDownload の名前

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

200 - OK

ConsoleCLIDownload schema

401 - Unauthorized

空白

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

200 - OK

ConsoleCLIDownload schema

401 - Unauthorized

空白

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

body

ConsoleCLIDownload schema

200 - OK

ConsoleCLIDownload schema

201 - Created

ConsoleCLIDownload schema

401 - Unauthorized

空白

name

string

ConsoleCLIDownload の名前

200 - OK

ConsoleCLIDownload schema

401 - Unauthorized

空白

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

200 - OK

ConsoleCLIDownload schema

401 - Unauthorized

空白

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

body

ConsoleCLIDownload schema

200 - OK

ConsoleCLIDownload schema

201 - Created

ConsoleCLIDownload schema

401 - Unauthorized

空白

hrefTemplate

string

hrefTemplate は、置き換えられる変数を含むログリンクの絶対的に安全な URL(https を使用する必要があります) です。変数は、URL で $ {variableName}の形式で指定されます (例:$ {containerName})。これは、リソースからの対応する値に置き換えられます。リソースは Pod です。サポートされている変数: - ${resourceName} - ログを含むリソースの名前 - ${resourceUID} - ログを含むリソースの UID - 例: 11111111-2222-3333-4444-555555555555 - ${containerName} - ログを含むリソースのコンテナー - ${resourceNamespace} - ログを含むリソースの namespace - ${resourceNamespaceUID} - ログを含むリソースの namespace UID - ${podLabels} - Pod とログを一致させるラベルの JSON 表現 - 例: {"key1":"value1","key2":"value2"}

例: https://example.com/logs?resourceName=${resourceName}&containerName=${containerName}&resourceNamespace=${resourceNamespace}&podLabels=${podLabels}

namespaceFilter

string

namespaceFilter は、ログリンクを一致する名前空間のセット (^ openshift- など) に制限するために使用される正規表現です。文字列は、JavaScript RegExp コンストラクターを使用して正規表現に変換されます。指定しない場合、すべてのネームスペースのリンクが表示されます。

text

string

text は、リンクの表示テキストです

200 - OK

Status スキーマ

401 - Unauthorized

空白

200 - OK

ConsoleExternalLogLinkList スキーマ

401 - Unauthorized

空白

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

body

ConsoleExternalLogLink schema

200 - OK

ConsoleExternalLogLink schema

201 - Created

ConsoleExternalLogLink schema

202 - Accepted

ConsoleExternalLogLink schema

401 - Unauthorized

空白

name

string

ConsoleExternalLogLink の名前

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

200 - OK

ConsoleExternalLogLink schema

401 - Unauthorized

空白

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

200 - OK

ConsoleExternalLogLink schema

401 - Unauthorized

空白

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

body

ConsoleExternalLogLink schema

200 - OK

ConsoleExternalLogLink schema

201 - Created

ConsoleExternalLogLink schema

401 - Unauthorized

空白

name

string

ConsoleExternalLogLink の名前

200 - OK

ConsoleExternalLogLink schema

401 - Unauthorized

空白

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

200 - OK

ConsoleExternalLogLink schema

401 - Unauthorized

空白

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

body

ConsoleExternalLogLink schema

200 - OK

ConsoleExternalLogLink schema

201 - Created

ConsoleExternalLogLink schema

401 - Unauthorized

空白

applicationMenu

object

applicationMenu は、アプリケーションメニューのリンクに使用されるセクションと icon に関する情報を保持します。これは、場所が ApplicationMenu に設定されている場合にのみ適用されます。

href

string

href はリンクの絶対的に安全な URL です (https を使用する必要があります)

location

string

location は、リンクが追加されるコンソール内の場所 (ApplicationMenu、HelpMenu、UserMenu、NamespaceDashboard) を決定します。

namespaceDashboard

object

namespaceDashboard は、ダッシュボードリンクが表示される名前空間に関する情報を保持します。これは、場所が NamespaceDashboard に設定されている場合にのみ適用されます。指定しない場合、リンクはすべてのネームスペースに表示されます。

text

string

text は、リンクの表示テキストです

imageURL

string

imageURL は、アプリケーションメニューのリンクの前に使用されている icon の URL です。URL は HTTPS URL または Data URI である必要があります。イメージは正方形で、24x24 ピクセルで表示されます。

セクション

string

セクションは、リンクが表示されるアプリケーションメニューのセクションです。これは、アプリケーションメニューのドロップダウンに小見出しとして表示される任意のテキストにすることができます。テキストが既存のセクションのテキストと一致しない場合、新しいセクションが作成されます。

namespaceSelector

object

namespaceSelector は、ラベルごとにダッシュボードリンクを含める必要がある名前空間を選択するために使用されます。名前空間ラベルが一致する場合、名前空間のダッシュボードリンクが表示されます。

namespaces

array (string)

namespaces は、ダッシュボードリンクが表示される名前空間名の配列です。

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

200 - OK

Status スキーマ

401 - Unauthorized

空白

200 - OK

ConsoleLinkList スキーマ

401 - Unauthorized

空白

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

body

ConsoleLink schema

200 - OK

ConsoleLink schema

201 - Created

ConsoleLink schema

202 - Accepted

ConsoleLink schema

401 - Unauthorized

空白

name

string

ConsoleLink の名前

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

200 - OK

ConsoleLink schema

401 - Unauthorized

空白

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

200 - OK

ConsoleLink schema

401 - Unauthorized

空白

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

body

ConsoleLink schema

200 - OK

ConsoleLink schema

201 - Created

ConsoleLink schema

401 - Unauthorized

空白

name

string

ConsoleLink の名前

200 - OK

ConsoleLink schema

401 - Unauthorized

空白

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

200 - OK

ConsoleLink schema

401 - Unauthorized

空白

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

body

ConsoleLink schema

200 - OK

ConsoleLink schema

201 - Created

ConsoleLink schema

401 - Unauthorized

空白

backgroundColor

string

backgroundColor は、CSS データ型の色としての通知の背景色です。

color

string

color は、CSS データ型 color としての通知のテキストの色です。

リンク

object

link は、通知リンクの詳細を保持するオブジェクトです。

location

string

location は、コンソールでの通知の場所です。有効な値は、"BannerTop"、"BannerBottom"、"BannerTopBottom" です。

text

string

text は、通知の表示テキストです。

href

string

href はリンクの絶対的に安全な URL です (https を使用する必要があります)

text

string

text は、リンクの表示テキストです

200 - OK

Status スキーマ

401 - Unauthorized

空白

200 - OK

ConsoleNotificationList スキーマ

401 - Unauthorized

空白

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

body

ConsoleNotification schema

200 - OK

ConsoleNotification schema

201 - Created

ConsoleNotification schema

202 - Accepted

ConsoleNotification schema

401 - Unauthorized

空白

name

string

ConsoleNotification の名前

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

200 - OK

ConsoleNotification schema

401 - Unauthorized

空白

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

200 - OK

ConsoleNotification schema

401 - Unauthorized

空白

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

body

ConsoleNotification schema

200 - OK

ConsoleNotification schema

201 - Created

ConsoleNotification schema

401 - Unauthorized

空白

name

string

ConsoleNotification の名前

200 - OK

ConsoleNotification schema

401 - Unauthorized

空白

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

200 - OK

ConsoleNotification schema

401 - Unauthorized

空白

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

body

ConsoleNotification schema

200 - OK

ConsoleNotification schema

201 - Created

ConsoleNotification schema

401 - Unauthorized

空白

backend

object

backend は、コンソールのプラグインを提供するバックエンドの設定を保持します。

contentSecurityPolicy

array

contentSecurityPolicy は、プラグインの Content-Security-Policy (CSP) ディレクティブのリストです。各ディレクティブは、指定されたディレクティブタイプに適した値のリストを指定します。たとえば、ScriptSrc などの fetch ディレクティブのリモートエンドポイントのリストなどです。コンソール Web アプリケーションは、CSP を使用して、クロスサイトスクリプティング (XSS) やデータインジェクション攻撃などの特定の種類の攻撃を検出し、緩和します。動的プラグインでは、クラスター外部からアセットをロードする必要がある場合、または違反レポートが観察された場合に、このフィールドを指定する必要があります。動的プラグインでは、常にクラスター内からのアセット取得を優先する必要があります。その場合、アセットのベンダー化とクラスターサービスからの取得のいずれかの方法を使用します。CSP 違反レポートは、OpenShift Web コンソールでのプラグイン開発およびテスト時に、ブラウザーのコンソールログで表示できます。使用可能なディレクティブタイプは、DefaultSrc、ScriptSrc、StyleSrc、ImgSrc、FontSrc、ConnectSrc です。使用可能な各ディレクティブは、リスト内で 1 回だけ定義できます。'self' の値は、OpenShift Web コンソールのバックエンドによってすべての fetch ディレクティブに自動的に追加されます。CSP ディレクティブの詳細は、https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy を参照してください。

OpenShift Web コンソールサーバーは、独自のデフォルト値とすべての有効な ConsolePlugin CR で CSP ディレクティブと値を集約し、それらを 1 つのポリシー文字列にマージして、Content-Security-Policy HTTP 応答ヘッダーを介してブラウザーに送信します。

例: ConsolePlugin A ディレクティブ: script-src: https://script1.com/, https://script2.com/ font-src: https://font1.com/

ConsolePlugin B ディレクティブ: script-src: https://script2.com/, https://script3.com/ font-src: https://font2.com/ img-src: https://img1.com/

OpenShift Web コンソールサーバーに渡される CSP ディレクティブの統合セット: script-src: https://script1.com/, https://script2.com/, https://script3.com/ font-src: https://font1.com/, https://font2.com/ img-src: https://img1.com/

OpenShift Web コンソールサーバー CSP 応答ヘッダー: Content-Security-Policy: default-src 'self'; base-uri 'self'; script-src 'self' https://script1.com/ https://script2.com/ https://script3.com/; font-src 'self' https://font1.com/ https://font2.com/; img-src 'self' https://img1.com/; style-src 'self'; frame-src 'none'; object-src 'none'

contentSecurityPolicy[]

object

ConsolePluginCSP は特定の CSP ディレクティブの設定を保持します

displayName

string

displayName は、プラグインの表示名です。dispalyName は 1 - 128 文字の間で指定する必要があります。

i18n

object

i18n は、プラグインのローカリゼーションリソースの設定です。

proxy

array

proxy は、プラグインが接続する必要のあるさまざまなサービスタイプを記述するプロキシーのリストです。

proxy[]

object

ConsolePluginProxy は、コンソールのバックエンドがプラグインのリクエストをプロキシーするさまざまなサービスタイプに関する情報を保持します。

service

object

service は、HTTP サーバーを使用したデプロイを使用してプラグインを公開する Kubernetes サービスです。Service は HTTPS と Service 提供証明書を使用する必要があります。コンソールバックエンドは、サービス CA バンドルを使用してサービスからプラグインアセットをプロキシーします。

type

string

type は、コンソールのプラグインを提供するバックエンドタイプです。現在、"Service" のみがサポートされています。

basePath

string

basePath は、プラグインのアセットへのパスです。主な資産は、plugin-manifest.json と呼ばれるマニフェストファイルです。これは、プラグインと拡張機能に関するメタデータを含む JSON ドキュメントです。

name

string

プラグインアセットを提供している Service の名前です。

namespace

string

プラグインアセットを提供している Service の namespace です。

port

integer

プラグインを提供しているサービスがリッスンしているポート。

directive

string

directive は、どの Content-Security-Policy ディレクティブを設定するか指定します。使用可能なディレクティブタイプは、DefaultSrc、ScriptSrc、StyleSrc、ImgSrc、FontSrc、ConnectSrc です。DefaultSrc ディレクティブは、他の CSP fetch ディレクティブのフォールバックとして機能します。DefaultSrc ディレクティブの詳細は、https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/default-src を参照してください。ScriptSrc ディレクティブは、JavaScript の有効なソースを指定します。ScriptSrc ディレクティブの詳細は、https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/script-src を参照してください。StyleSrc ディレクティブは、スタイルシートの有効なソースを指定します。StyleSrc ディレクティブの詳細は、https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/style-src を参照してください。ImgSrc ディレクティブは、イメージとファビコンの有効なソースを指定します。ImgSrc ディレクティブの詳細は、https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/img-src を参照してください。FontSrc ディレクティブは、@font-face を使用して読み込まれたフォントの有効なソースを指定します。FontSrc ディレクティブの詳細は、https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/font-src を参照してください。ConnectSrc ディレクティブは、スクリプトインターフェイスを使用して読み込むことができる URL を制限します。ConnectSrc ディレクティブの詳細は、https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/connect-src を参照してください。

values

array (string)

values は、このディレクティブのコンソールのデフォルトに追加する値の配列を定義します。各 ConsolePlugin は、独自のディレクティブと値を定義できます。これらは、OpenShift Web コンソールのバックエンドによって、Content-Security-Policy ヘッダーの一部として設定されます。配列には最大 16 個の値を含めることができます。各ディレクティブ値の最大長は 1024 文字で、空白、コンマ (,)、セミコロン (;)、一重引用符 (') を含めることはできません。値 '*' は使用できません。配列内の各値は一意である必要があります。

loadType

string

loadType は、プラグインのローカリゼーションリソースをロードする方法を示します。有効な値は、Preload、Lazy、および空の文字列です。Preload に設定すると、プラグインがロードされたときにすべてのローカリゼーションリソースが取得されます。Lazy に設定すると、ローカリゼーションリソースは、コンソールで要求されるときに遅延ロードされます。省略されるか空の文字列が設定されている場合、動作は Lazy タイプと同じになります。

alias

string

alias は、プラグインのプロキシーを識別するプロキシー名です。alias 名は、プラグインごとに一意である必要があります。コンソールバックエンドは次のプロキシーエンドポイントを公開します。

/api/proxy/plugin/<plugin-name>/<proxy-alias>/<request-path>?<optional-query-parameters>

リクエストのサンプルパス:

/api/proxy/plugin/acm/search/pods?namespace=openshift-apiserver

authorization

string

authorization は、プロキシーされたリクエストに含まれる必要がある authorization タイプに関する情報を提供します。

caCertificate

string

caCertificate は、プロキシーされた Service がカスタムサービス CA を使用している場合に備えて、証明書機関の証明書の内容を提供します。デフォルトでは、service-ca Operator によって提供されるサービス CA バンドルが使用されます。

endpoint

object

エンドポイントは、リクエストがプロキシーされるエンドポイントに関する情報を提供します。

service

object

サービスは、プラグインが接続するクラスター内の Service です。この Service は HTTPS を使用する必要があります。コンソールバックエンドは、プラグインと Service 間の通信をプロキシーするためにエンドポイントを公開します。注記: 現在 "Service" タイプのみがサポートされているため、サービスフィールドは必須です。

type

string

type は、コンソールプラグインのプロキシーのタイプです。現在、"Service" のみがサポートされています。

name

string

プラグインが接続する必要のある Service の名前です。

namespace

string

プラグインが接続する必要のある Service の namespace です。

port

integer

プラグインが接続する必要のある Service がリッスンしているポートです。

200 - OK

Status スキーマ

401 - Unauthorized

空白

200 - OK

ConsolePluginList スキーマ

401 - Unauthorized

空白

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

body

ConsolePlugin schema

200 - OK

ConsolePlugin schema

201 - Created

ConsolePlugin schema

202 - Accepted

ConsolePlugin schema

401 - Unauthorized

空白

name

string

ConsolePlugin の名前

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

200 - OK

ConsolePlugin schema

401 - Unauthorized

空白

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

200 - OK

ConsolePlugin schema

401 - Unauthorized

空白

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

body

ConsolePlugin schema

200 - OK

ConsolePlugin schema

201 - Created

ConsolePlugin schema

401 - Unauthorized

空白

accessReviewResources

array

accessReviewResources には、ユーザーがクイックスタートを完了するためにユーザーのアクセスが確認されるリソースのリストが含まれています。アクセスレビューのいずれかが失敗した場合、クイックスタートは非表示になります。

accessReviewResources[]

object

resourceAttributes には、Authorizer インターフェイスへのリソース要求に使用できる許可属性が含まれています

まとめ

string

結論はクイックスタートを要約し、可能な次のステップを提案します。(値下げを含む)

description

string

description は、クイックスタートの説明です。(値下げを含む)

displayName

string

displayName は、クイックスタートの表示名です。

durationMinutes

integer

durationMinutes は、クイックスタートを完了するのにかかるおおよその分数を示します。

icon

string

icon は base64 でエンコードされたイメージで、クイックスタートの表示名の横に表示されます。icon は、簡単に拡大縮小できるようにベクターイメージである必要があります。icon のサイズは 40x40 である必要があります。

概要

string

はじめに、クイックスタートの目を説明します。(値下げを含む)

nextQuickStart

array (string)

nextQuickStart は、次のクイックスタートのリストであり、ユーザーが試すことを推奨します。

前提条件

array (string)

前提条件には、クイックスタートを実行する前に満たす必要のあるすべての前提条件が含まれています。(値下げを含む)

tags

array (string)

タグは、クイックスタートを説明する文字列のリストです。

tasks

array

タスクは、クイックスタートを完了するためにユーザーが実行する必要のあるステップのリストです。

tasks[]

object

ConsoleQuickStartTask は、クイックスタートのシングルステップです。

fieldSelector

object

fieldSelector は、フィールドに基づくアクセスの制限を記述します。アクセスを制限することはできますが、拡大することはできません。

このフィールドはアルファレベルです。このフィールドを使用するには、AuthorizeWithSelectors フィーチャーゲートを有効にする必要があります (デフォルトでは無効)。

group

string

group は、リソースの API グループです。"*" はすべてを意味します。

labelSelector

object

labelSelector は、ラベルに基づくアクセスの制限を記述します。アクセスを制限することはできますが、拡大することはできません。

このフィールドはアルファレベルです。このフィールドを使用するには、AuthorizeWithSelectors フィーチャーゲートを有効にする必要があります (デフォルトでは無効)。

name

string

name は、"取得" のためにリクエストされているリソース、または "削除" のために削除されているリソースの名前です。"" (空) はすべてを意味します。

namespace

string

namespace は、リクエストされているアクションの namespace です。現在、namespace なしとすべての namespace の区別はありません。""(空) は LocalSubjectAccessReviews のデフォルトです。""(空) はクラスタースコープのリソースでは空です。""(空) は SubjectAccessReview または SelfSubjectAccessReview からの namespace スコープのリソースの "すべて" を意味します。

resource

string

resource は、既存のリソースタイプの 1 つです。"*" はすべてを意味します。

subresource

string

subresource は、既存のリソースタイプの 1 つです。"" は何もないことを意味します。

verb

string

verb は、get、list、watch、create、update、delete、proxy などの kubernetes リソース API 動詞です。"*" はすべてを意味します。

version

string

version は、リソースの API バージョンです。"*" はすべてを意味します。

rawSelector

string

rawSelector は、クエリーパラメーターに含まれるフィールドセレクターのシリアル化です。Webhook 実装では、rawSelector を無視することが推奨されます。kube-apiserver の *SubjectAccessReview は、requirements が存在しない限り、rawSelector を解析します。

requirements

array

requirements は、フィールドセレクターの解析された解釈です。リソースインスタンスがセレクターと一致するためには、requirements に含まれるすべての条件が適用される必要があります。Webhook 実装は要件を処理する必要がありますが、それをどのように処理するかは Webhook 次第です。Requirements はリクエストを制限する役割しか持たないため、内容が理解できない場合は、無制限のリクエストとして許可しても問題ありません。

requirements[]

object

FieldSelectorRequirement は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

key

string

key は、要件が適用されるフィールドセレクターキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Operator のリストは、今後増える可能性があります。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。

rawSelector

string

rawSelector は、クエリーパラメーターに含まれるフィールドセレクターのシリアル化です。Webhook 実装では、rawSelector を無視することが推奨されます。kube-apiserver の *SubjectAccessReview は、requirements が存在しない限り、rawSelector を解析します。

requirements

array

requirements は、ラベルセレクターを解析した結果の解釈です。リソースインスタンスがセレクターと一致するためには、requirements に含まれるすべての条件が適用される必要があります。Webhook 実装は要件を処理する必要がありますが、それをどのように処理するかは Webhook 次第です。Requirements はリクエストを制限する役割しか持たないため、内容が理解できない場合は、無制限のリクエストとして許可しても問題ありません。

requirements[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

description

string

説明では、タスクを完了するために必要な手順を説明します。(値下げを含む)

review

object

レビューには、タスクが完了したことを検証するための手順が含まれています。ユーザーは 'Yes' または 'No' を選択します。ステップが正常に完了したを示すラジオボタンを使用します。

summary

object

要約には、渡されたステップに関する情報が含まれています。

title

string

タイトルはタスクを説明し、ステップ見出しとして表示されます。

failedTaskHelp

string

failedTaskHelp には、失敗したタスクレビューの提案が含まれており、タスクの最後に表示されます。(値下げを含む)

手順

string

手順には、タスクを実行した後にユーザーが自分の作業を検証するために実行する必要のある手順が含まれています。(値下げを含む)

failed

string

failed は、失敗したタスクを簡単に説明します。(値下げを含む)

success

string

成功は、正常に渡されたタスクを表します。

200 - OK

Status スキーマ

401 - Unauthorized

空白

200 - OK

ConsoleQuickStartList スキーマ

401 - Unauthorized

空白

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

body

ConsoleQuickStart schema

200 - OK

ConsoleQuickStart schema

201 - Created

ConsoleQuickStart schema

202 - Accepted

ConsoleQuickStart schema

401 - Unauthorized

空白

name

string

ConsoleQuickStart の名前

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

200 - OK

ConsoleQuickStart schema

401 - Unauthorized

空白

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

200 - OK

ConsoleQuickStart schema

401 - Unauthorized

空白

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

body

ConsoleQuickStart schema

200 - OK

ConsoleQuickStart schema

201 - Created

ConsoleQuickStart schema

401 - Unauthorized

空白

abstract

string

abstract はサンプルへの簡単な導入です。

これは必須であり、長さは 100 文字以下である必要があります。

abstract は、タイトルとプロバイダーの下にあるサンプルカードタイルに表示され、コンテンツは 3 行に制限されます。

description

string

description はサンプルの長い説明形式です。

これは必須であり、最大長は 4096 文字です。

追加情報、リンク、前提条件、その他の手順が記載された README.md のようなコンテンツです。これは、改行、リンク、その他の簡単な書式設定を含めることができるように、Markdown としてレンダリングされます。

icon

string

icon はオプションの base64 でエンコードされたイメージで、サンプルのタイトルの横に表示されます。

形式は data: URL 形式に従う必要があり、最大サイズは 10 KB です。

data:[<mediatype>][;base64],<base64 encoded image>

以下に例を示します。

data:image;base64、および base64 でエンコードされたイメージ。

Vector イメージを使用することもできます。SVG アイコンは次の文字で始まる必要があります。

data:image/svg+xml;base64、および base64 でエンコードされた SVG イメージ。

すべてのサンプルカタログアイコンは、白い背景に表示されます (ダークテーマが使用されている場合も同様)。Web コンソールは、さまざまなアスペクト比が正しく機能することを確認します。現在、icon の表面は最大 40x100px です。

データ URL 形式の詳細は、https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs を参照してください。

provider

string

provider は、サンプルの提供者を示すためのオプションのラベルです。

これはオプションで、長さは 50 文字以内である必要があります。

プロバイダーは、"Red Hat" のような企業、または "CNCF" や "Knative" のような組織になります。

現在、プロバイダーは、タイトルの下のサンプルカードタイルに "Provided by "という接頭辞付きでのみ表示されます。

source

object

source は、サンプルサービスのデプロイ元を定義します。このサンプルは、外部の git リポジトリーまたはコンテナーイメージから取得できます。

tags

array (string)

タグは、サンプルカタログ内のサンプルを検索するために使用できるオプションの文字列値です。

一般的なタグの例としては、"Java"、"Quarkus" などが挙げられます。

これらは、サンプルの詳細ページに表示されます。

title

string

title はサンプルの表示名です。

これは必須で、長さは 50 文字以内である必要があります。

type

string

type は複数のサンプルをグループ化するためのオプションのラベルです。

これはオプションで、長さが 20 文字以下である必要があります。

推奨されるのは、"Builder Image"、"Devfile"、または "Serverless Function" などの単数形の用語です。

現在、この type は、右上隅のサンプルカードタイルにバッジとして表示されています。