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

カスタマイズ

object

カスタマイズは、オプションで 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 が自分で解釈しなければならない粗いロギングの選択を管理する簡単な方法です。有効な値は、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 コンソールのデフォルトのブランドであり、ブランドフィールドを指定することで上書きできます。特定のブランドオプションの限られたセットがあります。このフィールドは、ロゴなどのコンソールの要素を制御します。値が無効な場合、コンソールのロールアウトが妨げられます。

customLogoFile

object

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

customProductName

string

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

developerCatalog

object

developerCatalog を使用すると、表示される開発者カタログカテゴリー（フィルター）およびタイプ（サブカタログ）を設定できます。

documentationBaseURL

string

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

perspectives

array

パースペクティブを使用すると、ユーザーがパースペクティブのドロップダウンで表示できるパースペクティブの有効化/無効化が可能になります。

perspectives[]

object

パースペクティブは、クラスター管理者がパースペクティブスイッチャーのドロップダウンで表示/非表示したいパースペクティブを定義します

projectAccess

object

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

quickStarts

object

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

disabledActions

array (string)

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

key

string

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

name

string

categories

array

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

categories[]

object

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

types

object

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

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)

無効は、ユーザーに表示されない開発者カタログタイプ（サブカタログ 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 には、リソースのグループ、バージョン、およびタイプが含まれます

可視性

object

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

group

string

group は、リソースの API グループです。コアグループには空の文字列を入力します。この値は、小文字の英数字、ハイフン、およびピリオドのみで設定する必要があります。Example: "", "apps", "build.openshift.io", etc.

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[]

object

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

group

string

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

name

string

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

namespace

string

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

resource

string

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

subresource

string

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

verb

string

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

version

string

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

group

string

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

name

string

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

namespace

string

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

resource

string

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

subresource

string

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

verb

string

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

version

string

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

availableClusterRoles

array (string)

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

disabled

array (string)

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

clientDownloadsURL

string

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

consoleURL

string

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

statuspage

object

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

pageID

string

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

hostname

string

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

secret

object

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

name

string

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

conditions

array

条件は、条件とそのステータスのリストです

conditions[]

object

OperatorCondition は、単なる標準の条件フィールドです。

generations

array

世代は、アイテムを調整する必要がある場合、または反応が必要な方法で変更された場合を判別するために使用されます。

generations[]

object

GenerationStatus は、特定のリソースの生成を追跡するため、強制更新に関する決定を行うことができます。

observedGeneration

integer

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

readyReplicas

integer

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

version

string

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

lastTransitionTime

string

message

string

reason

string

status

string

type

string

group

string

グループはあなたが追跡しているもののグループです

ハッシュ

string

ハッシュは、シークレットや設定マップのようにコンテンツに依存する、生成されないリソース用に設定されたオプションのフィールドです。

lastGeneration

integer

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

name

string

name は、追跡しているものの名前です

namespace

string

名前空間は、追跡しているものがどこにあるかです

resource

string

リソースは、追跡しているもののリソースタイプです