第5章 Console [operator.openshift.io/v1]

カスタマイズ

object

customization は、必要に応じて少数のカスタマイズオプションを Web コンソールに提供するために使用します。

ingress

object

ingress を使用すると、コンソールの代替 Ingress を設定できます。このフィールドは、Ingress 機能がなく、ルートにアクセスできないクラスターを対象としています。

logLevel

string

logLevel は、コンポーネント全体のインテントベースのログです。きめ細かい制御はできませんが、Operator がオペランドに対して解釈する必要のある粗いロギングの選択を管理する簡単な方法です。

有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal".

managementState

string

managementState は、Operator がコンポーネントを管理する必要があるかどうか、およびその方法を示します

observedConfig

``

observedConfig は、コントローラーがクラスター状態から監視したスパース設定を保持します。Operator のレベルへの入力であるため、仕様に存在します

operatorLogLevel

string

operatorLogLevel は、Operator 自体のインテントベースのログです。きめ細かい制御はできませんが、Operator が自分で解釈しなければならない粗いロギングの選択を管理する簡単な方法です。

有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal".

plugins

array (string)

plugins は、有効なコンソールプラグイン名のリストを定義します。

providers

object

プロバイダーには、特定のサービスプロバイダーを使用するための設定が含まれています。

route

object

ルートには、サービング証明書を含むホスト名とシークレット参照が含まれています。カスタムルートが指定されている場合、指定されたホスト名で新しいルートが作成され、その下でコンソールを使用できます。カスタムホスト名がクラスターのデフォルトのルーティング接尾辞を使用する場合、サービング証明書のシークレット指定は必要ありません。カスタムホスト名が任意のドメインを指している場合は、手動の DNS 設定手順が必要です。カスタムルートが削除された場合、コンソールのデフォルトのホスト名を予約するために、デフォルトのコンソールルートが維持されます。指定しない場合、デフォルトルートが使用されます。非推奨

unsupportedConfigOverrides

``

unsupportedConfigOverrides は、Operator によって計算された最終設定をオーバーライドします。Red Hat はこのフィールドの使用をサポートしていません。このフィールドを誤って使用すると、予期しない動作が発生したり、他の設定オプションと競合したりする可能性があります。このフィールドを使用する前に、Red Hat サポートに問い合わせてください。このプロパティーを使用すると、クラスターのアップグレードがブロックされます。クラスターをアップグレードする前に、このプロパティーを削除する必要があります。

addPage

object

addPage を使用すると、開発者の観点から追加ページのアクションをカスタマイズできます。

brand

string

ブランドは Web コンソールのデフォルトのブランドであり、ブランドフィールドを指定することで上書きできます。特定のブランドオプションの限られたセットがあります。このフィールドは、ロゴなどのコンソールの要素を制御します。値が無効な場合、コンソールのロールアウトが妨げられます。

capabilities

array

capabilities は、コンソール UI で操作できる機能の配列を定義します。各機能には、コンソールで操作して UI にレンダリングできる視覚的な状態を定義します。使用可能な機能は、LightspeedButton と GettingStartedBanner です。使用可能な機能は、それぞれリスト内に 1 つだけ指定できます。

capabilities[]

object

Capabilities には、コンソール UI の UI 機能のセットとその状態を含めます。

customLogoFile

object

customLogoFile は、マストヘッドおよびアバウトダイアログのデフォルトの OpenShift ロゴを置き換えます。これは、openshift-config namespace 内の ConfigMap への参照です。これは、'oc create configmap custom-logo --from-file=/path/to/file -n openshift-config' のようなコマンドで作成できます。ConfigMap サイズの制約により、イメージサイズは 1MB 未満である必要があります。コンソールが正しい MIME タイプでファイルを提供できるように、ConfigMap キーにはファイル拡張子を含める必要があります。推奨されるロゴの仕様: 寸法: 最大高さ 68px、最大幅 200pxSVG 形式を推奨

customProductName

string

customProductName は、通常の OpenShift 製品名の代わりに、ページタイトル、ロゴの代替テキスト、およびバージョン情報ダイアログに表示される名前です。

developerCatalog

object

developerCatalog を使用すると、表示する開発者カタログのカテゴリー (フィルター) とタイプ (サブカタログ) を設定できます。

documentationBaseURL

string

外部ドキュメントへの documentationBaseURL リンクは、Web コンソールのさまざまなセクションに表示されます。documentationBaseURL を指定すると、デフォルトのドキュメント URL が上書きされます。値が無効な場合、コンソールのロールアウトが妨げられます。

perspectives

array

perspectives を使用すると、ユーザーがパースペクティブスイッチャードロップダウンで表示できるパースペクティブを有効/無効にすることができます。

perspectives[]

object

Perspective は、クラスター管理者が表示/非表示にする必要があるパースペクティブスイッチャードロップダウンのパースペクティブを定義します。

projectAccess

object

projectAccess を使用すると、開発者パースペクティブのプロジェクトアクセスページで利用可能な ClusterRoles のリストをカスタマイズできます。このページは、プロジェクト管理者が他のユーザーにロールを指定したり、プロジェクト内のアクセスを制限したりするために使用できます。設定されている場合、リストはデフォルトの ClusterRole オプションに置き換わります。

quickStarts

object

quickStarts を使用すると、コンソールで使用可能な ConsoleQuickStart リソースをカスタマイズできます。

disabledActions

array (string)

disabledActions は、ユーザーに表示されないアクションのリストです。リスト内の各アクションは、その ID で表されます。

name

string

name は、機能の一意の名前です。使用可能な機能は、LightspeedButton と GettingStartedBanner です。

visibility

object

visibility は、機能の表示状態を定義します。

state

string

state は、コンソール UI で機能を有効にするか無効にするかを定義します。コンソール UI で機能を有効にするには、"Enabled" 値を指定します。コンソール UI で機能を無効にするには、"Disabled" 値を指定します。

key

string

キーを使用すると、設定マップ内の特定のキー/値を指すことができます。これは、論理ファイルの参照に役立ちます。

name

string

categories

array

開発者カタログに表示されているカテゴリー。

categories[]

object

開発者コンソールカタログの DeveloperConsoleCatalogCategory。

types

object

types を使用すると、開発者カタログでユーザーが表示できるサブカタログタイプを有効または無効にすることができます。省略すると、すべてのサブカタログタイプが表示されます。

id

string

ID は、コンソールでディープリンクを有効にするために URL で使用される識別子です。ID は必須であり、1〜32 の URL セーフ (AZ、az、0〜9、-、および _) 文字が必要です。

ラベル

string

label は、カテゴリー表示ラベルを定義します。必須であり、1〜64 文字である必要があります。

subcategories

array

サブカテゴリーは、子カテゴリーのリストを定義します。

subcategories[]

object

DeveloperConsoleCatalogCategoryMeta は、開発者カタログカテゴリーの主要な識別子です。

tags

array (string)

タグは、カテゴリーに一致する文字列のリストです。選択したカテゴリーには、カテゴリーとアイテムの間に少なくとも 1 つの重複するタグがあるすべてのアイテムが表示されます。

id

string

ID は、コンソールでディープリンクを有効にするために URL で使用される識別子です。ID は必須であり、1〜32 の URL セーフ (AZ、az、0〜9、-、および _) 文字が必要です。

ラベル

string

label は、カテゴリー表示ラベルを定義します。必須であり、1〜64 文字である必要があります。

tags

array (string)

タグは、カテゴリーに一致する文字列のリストです。選択したカテゴリーには、カテゴリーとアイテムの間に少なくとも 1 つの重複するタグがあるすべてのアイテムが表示されます。

disabled

array (string)

disabled は、ユーザーに表示されない開発者カタログのタイプ (サブカタログ ID) のリストです。タイプ (サブカタログ) は、コンソールプラグインを介して追加されます。使用可能なタイプ (サブカタログ ID) は、コンソールのクラスター設定ページ、またはコンソールで YAML を編集するときに使用できます。たとえば、"Devfile"、"HelmChart"、"BuilderImage" です。リストが空の場合、または使用可能なサブカタログタイプがすべて追加されている場合は、開発者カタログ全体が非表示になります。

enabled

array (string)

enabled は、ユーザーに表示される開発者カタログのタイプ (サブカタログ ID) のリストです。タイプ (サブカタログ) は、コンソールプラグインを介して追加されます。使用可能なタイプ (サブカタログ ID) は、コンソールのクラスター設定ページ、またはコンソールで YAML を編集するときに使用できます。たとえば、"Devfile"、"HelmChart"、"BuilderImage" です。リストが空でない場合、新しいタイプはリストに追加されるまでユーザーに表示されません。リストが空の場合、開発者カタログ全体が表示されます。

state

string

state は、カタログタイプのリストを有効にするか無効にするかを定義します。

id

string

id は、パースペクティブの ID を定義します。たとえば、"dev"、"admin" です。利用可能なパースペクティブ ID は、yaml エディターの横にあるコードスニペットセクションにあります。不正確または不明な ID は無視されます。

pinnedResources

array

pinnedResources は、ユーザーが固定されたリソースを自分でカスタマイズしていない場合に、パースペクティブナビゲーションでユーザーに表示されるデフォルトの固定されたリソースのリストを定義します。利用可能な Kubernetes リソースのリストは、kubectl api-resources を介して読み取ることができます。また、コンソールが提供する設定 UI と YAML スニペットに、ナビゲーションに固定できる利用可能なリソースがリスト表示されます。不正確または不明なリソースは無視されます。

pinnedResources[]

object

PinnedResourceReference には、リソースのグループ、バージョン、タイプを含めます。

visibility

object

visibility は、パースペクティブの状態と、アクセスレビューチェック (そのパースペクティブに必要な場合) を定義します。

group

string

group は、リソースの API グループです。コアグループの場合は、空の文字列を入力します。この値は、小文字の英数字、ハイフン、ピリオドのみで構成する必要があります。たとえば、""、"apps"、"build.openshift.io" です。

resource

string

resource は、参照されるタイプです。通常、リソースの種類の複数形を小文字で表記したものです。この値は、小文字の英数字とハイフンのみで構成する必要があります。たとえば、"deployments"、"deploymentconfigs"、"pods" です。

version

string

version は、リソースの API バージョンです。この値は小文字の英数字のみで構成する必要があります。たとえば、"v1"、"v1beta1" です。

accessReview

object

accessReview は、必要なアクセスレビューチェックと不足しているアクセスレビューチェックを定義します。

state

string

state は、パースペクティブが有効か無効か、またはアクセスレビューチェックが必要かどうかを定義します。

missing

array

missing は、権限チェックのリストを定義します。1 つ以上のチェックが失敗した場合にのみ、パースペクティブが表示されます。省略すると、アクセスレビューがスキップされ、必要なアクセスレビューのリストの設定によって要求されない限り、パースペクティブは表示されません。

missing[]

object

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

required

array

required は、権限チェックのリストを定義します。すべてのチェックが成功した場合にのみ、パースペクティブが表示されます。省略すると、アクセスレビューがスキップされ、不足しているアクセスレビューのリストの設定によって要求されない限り、パースペクティブは表示されません。

required[]

object

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

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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

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 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

availableClusterRoles

array (string)

availableClusterRoles は、プロジェクトアクセスタブを介してユーザーに割り当てることができる ClusterRole 名のリストです。

disabled

array (string)

無効は、ユーザーに表示されない ConsoleQuickStart リソース名のリストです。

clientDownloadsURL

string

clientDownloadsURL は、クライアントバイナリーをダウンロードするためのアドレスとして使用される URL です。指定されていない場合、ダウンロードルートのホスト名が使用されます。このフィールドは、Ingress 機能がなく、ルートにアクセスできないクラスターに必要です。この URL はコンソール Operator によって監視されます。URL に長期間アクセスできない場合、コンソール Operator がデグレード状態になる可能性があります。HTTPS スキームを使用する必要があります。

consoleURL

string

consoleURL は、ベースコンソールアドレスとして使用される URL です。指定されていない場合、コンソールルートのホスト名が使用されます。このフィールドは、Ingress 機能がなく、ルートにアクセスできないクラスターに必要です。この URL に適切な Ingress が設定されていることを確認してください。この URL はコンソール Operator によって監視されます。URL に長期間アクセスできない場合、コンソール Operator がデグレード状態になる可能性があります。HTTPS スキームを使用する必要があります。

statuspage

object

statuspage には、ステータス情報を提供する statuspage.io ページの ID が含まれています。

pageID

string

pageID は、Statuspage によってページに割り当てられた一意の ID です。これは公開ページである必要があります。

hostname

string

ホスト名は、コンソールを使用できる目的のカスタムドメインです。

secret

object

secret は、カスタムの証明書と鍵が含まれる openshift-config namespace 内のシークレットを参照します。シークレットはクラスター管理者が手動で作成する必要があります。参照されるシークレットには、次のキー値のペアが含まれている必要があります。- "tls.crt" - カスタム証明書を指定します。- "tls.key" - カスタム証明書の秘密鍵を指定します。カスタムホスト名がクラスターのデフォルトのルーティング接尾辞を使用する場合、サービング証明書のシークレット仕様は必要ありません。

name

string

name は、参照されるシークレットの metadata.name です。

conditions

array

conditions は、状態とそのステータスのリストです。

conditions[]

object

OperatorCondition は、標準の状態フィールドです。

generations

array

generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。

generations[]

object

GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。

latestAvailableRevision

integer

latestAvailableRevision は、最新のデプロイメントの deploymentID です。

observedGeneration

integer

observedGeneration はあなたが扱った最後の世代の変更です

readyReplicas

integer

readyReplicas は、準備ができて目的の状態にあるレプリカの数を示します

version

string

バージョンは、この可用性が適用されるレベルです

lastTransitionTime

string

lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。

message

string

reason

string

status

string

条件のステータス、True、False、Unknown のいずれか。

type

string

CamelCase または foo.example.com/CamelCase の条件のタイプ。

group

string

group は追跡対象のグループです。

hash

string

hash は、シークレットや configmap など、機密性の高いコンテンツを含む生成されないリソースに設定される任意のフィールドです。

lastGeneration

integer

lastGeneration は関連するワークロードコントローラーの最後の生成です。

name

string

name は追跡対象の名前です。

namespace

string

namespace は追跡対象の場所です。

resource

string

resource は追跡対象のリソースタイプです。