第8章 ConsoleSample [console.openshift.io/v1]
- 説明
- ConsoleSample は、サンプルを追加して OpenShift Web コンソールをカスタマイズするエクステンションです。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object - 必須
-
metadata -
spec
-
8.1. 仕様
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| APIVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これを更新することはできません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
|
| spec には、コンソールサンプルの設定が含まれます。 |
8.1.1. .spec
- 説明
- spec には、コンソールサンプルの設定が含まれます。
- 型
-
object - 必須
-
abstract -
description -
source -
title
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| abstract はサンプルへの簡単な導入です。これは必須であり、長さは 100 文字以下である必要があります。abstract は、タイトルとプロバイダーの下にあるサンプルカードタイルに表示され、コンテンツは 3 行に制限されます。 |
|
|
| description はサンプルの長い説明形式です。これは必須であり、最大長は 4096 文字です。追加情報、リンク、前提条件、その他の手順が記載された README.md のようなコンテンツです。これは、改行、リンク、その他の簡単な書式設定を含めることができるように、Markdown としてレンダリングされます。 |
|
|
| icon はオプションの base64 でエンコードされたイメージで、サンプルのタイトルの横に表示されます。形式は data: URL 形式に従う必要があり、最大サイズは 10 KB です。data:[<mediatype>][;base64],<base64 encoded image> (例: data:image;base64 に base64) でエンコードされたイメージが加わります。Vector イメージを使用することもできます。SVG icon は、data:image/svg+xml;base64 で始まり、base64 でエンコードされた SVG イメージが続く必要があります。すべてのサンプルカタログ icon は、白い背景に表示されます (ダークテーマが使用されている場合も同様)。Web コンソールは、さまざまなアスペクト比が正しく機能することを確認します。現在、icon の表面は最大 40x100px です。データ URL 形式の詳細は、https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs を参照してください。 |
|
|
| provider は、サンプルの提供者を示すためのオプションのラベルです。これはオプションで、長さは 50 文字以内である必要があります。プロバイダーは、"Red Hat" のような企業、または "CNCF" や "Knative" のような組織になります。現在、プロバイダーは、タイトルの下のサンプルカードタイルに "Provided by "という接頭辞付きでのみ表示されます。 |
|
|
| source は、サンプルサービスのデプロイ元を定義します。このサンプルは、外部の git リポジトリーまたはコンテナーイメージから取得できます。 |
|
|
| タグは、サンプルカタログ内のサンプルを検索するために使用できるオプションの文字列値です。一般的なタグの例としては、"Java"、"Quarkus" などが挙げられます。これらは、サンプルの詳細ページに表示されます。 |
|
|
| title はサンプルの表示名です。これは必須で、長さは 50 文字以内である必要があります。 |
|
|
| type は複数のサンプルをグループ化するためのオプションのラベルです。これはオプションで、長さが 20 文字以下である必要があります。推奨されるのは、"Builder Image"、"Devfile"、または "Serverless Function" などの単数形の用語です。現在、この type は、右上隅のサンプルカードタイルにバッジとして表示されています。 |
8.1.2. .spec.source
- 説明
- source は、サンプルサービスのデプロイ元を定義します。このサンプルは、外部の git リポジトリーまたはコンテナーイメージから取得できます。
- 型
-
object - 必須
-
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| containerImport により、ユーザーはコンテナーイメージをインポートできます。 |
|
|
| gitImport を使用すると、ユーザーは git リポジトリーからコードをインポートできます。 |
|
|
| 現在サポートされているサンプルの type : "GitImport";"ContainerImport" |
8.1.3. .spec.source.containerImport
- 説明
- containerImport により、ユーザーはコンテナーイメージをインポートできます。
- 型
-
object - 必須
-
image
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| HTTP サービスを提供するコンテナーイメージへの参照です。ポートフィールドで別途設定されていない限り、サービスはデフォルトポート (8080) で公開される必要があります。サポートされている形式: - <repository-name>/<image-name> - docker.io/<repository-name>/<image-name> - quay.io/<repository-name>/<image-name> - quay.io/<repository-name>/<image-name>@sha256:<image hash> - quay.io/<repository-name>/<image-name>:<tag> |
|
|
| サービスには、このサンプル用に作成された Service リソースの設定が含まれます。 |
8.1.4. .spec.source.containerImport.service
- 説明
- サービスには、このサンプル用に作成された Service リソースの設定が含まれます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| targetPort は、サービスが HTTP リクエストをリッスンするポートです。このポートは、このサンプル用に作成された Service と Route に使用されます。port は 1 から 65535 までの範囲である必要があります。デフォルトのポートは 8080 です。 |
8.1.5. .spec.source.gitImport
- 説明
- gitImport を使用すると、ユーザーは git リポジトリーからコードをインポートできます。
- 型
-
object - 必須
-
repository
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| リポジトリーには、実際の Git リポジトリーへの参照が含まれます。 |
|
|
| サービスには、このサンプル用に作成された Service リソースの設定が含まれます。 |
8.1.6. .spec.source.gitImport.repository
- 説明
- リポジトリーには、実際の Git リポジトリーへの参照が含まれます。
- 型
-
object - 必須
-
url
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
|
contextDir は、コンポーネントをビルドするためのリポジトリー内のディレクトリーを指定するために使用されます。 |
|
|
| リビジョンは、git リポジトリーをクローンする git リビジョンです。特定のブランチ、タグ、またはコミット SHA をクローンするために使用できます。最大長は 256 文字にする必要があります。省略した場合は、リポジトリーのデフォルトのブランチが使用されます。 |
|
|
| HTTP サービスを含む Git リポジトリーの url。HTTP サービスは、port フィールドで特に設定されていない限り、デフォルトポート (8080) で公開する必要があります。現在、GitHub、GitLab、および Bitbucket の公開リポジトリーのみがサポートされています: - https://github.com/<org>/<repository> - https://gitlab.com/<org>/<repository> - https://bitbucket.org/<org>/<repository> url の最大長は 256 文字にする必要があります。 |
8.1.7. .spec.source.gitImport.service
- 説明
- サービスには、このサンプル用に作成された Service リソースの設定が含まれます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| targetPort は、サービスが HTTP リクエストをリッスンするポートです。このポートは、このサンプル用に作成された Service に使用されます。port は 1 から 65535 までの範囲である必要があります。デフォルトのポートは 8080 です。 |
