第7章 ConsoleQuickStart [console.openshift.io/v1]


説明
ConsoleQuickStart は、OpenShift Web コンソールのさまざまなワークフローを通じてユーザーをガイドするための拡張機能です。互換性レベル 2: メジャーリリース内で最低 9 カ月間、または 3 つのマイナーリリース (どちらか長い方) で安定しています。
タイプ
object
必須
  • spec

7.1. 仕様

プロパティータイプ説明

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

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

spec

object

ConsoleQuickStartSpec は、必要なクイックスタート設定です。

7.1.1. .spec

説明
ConsoleQuickStartSpec は、必要なクイックスタート設定です。
タイプ
object
必須
  • description
  • displayName
  • durationMinutes
  • 概要
  • tasks
プロパティータイプ説明

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 は、クイックスタートのシングルステップです。

7.1.2. .spec.accessReviewResources

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

7.1.3. .spec.accessReviewResources[]

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

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 バージョンです。"*" はすべてを意味します。

7.1.4. .spec.tasks

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

7.1.5. .spec.tasks[]

説明
ConsoleQuickStartTask は、クイックスタートのシングルステップです。
タイプ
object
必須
  • description
  • title
プロパティータイプ説明

description

string

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

review

object

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

summary

object

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

title

string

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

7.1.6. .spec.tasks[].review

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

failedTaskHelp

string

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

手順

string

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

7.1.7. .spec.tasks[].summary

説明
要約には、渡されたステップに関する情報が含まれています。
タイプ
object
必須
  • failed
  • success
プロパティータイプ説明

failed

string

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

success

string

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

Red Hat logoGithubRedditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

© 2024 Red Hat, Inc.