第8章 ConsoleSample [console.openshift.io/v1]

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 は、右上隅のサンプルカードタイルにバッジとして表示されています。

containerImport

object

containerImport により、ユーザーはコンテナーイメージをインポートできます。

gitImport

object

gitImport を使用すると、ユーザーは git リポジトリーからコードをインポートできます。

type

string

現在サポートされているサンプルの type : "GitImport";"ContainerImport"

image

string

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

object

サービスには、このサンプル用に作成された Service リソースの設定が含まれます。

targetPort

integer

targetPort は、サービスが HTTP リクエストをリッスンするポートです。このポートは、このサンプル用に作成された Service と Route に使用されます。port は 1 から 65535 までの範囲である必要があります。デフォルトのポートは 8080 です。

repository

object

リポジトリーには、実際の Git リポジトリーへの参照が含まれます。

service

object

サービスには、このサンプル用に作成された Service リソースの設定が含まれます。

contextDir

string

contextDir は、コンポーネントをビルドするためのリポジトリー内のディレクトリーを指定するために使用されます。/ で始まり、最大長は 256 文字である必要があります。省略した場合、デフォルト値はリポジトリーのルートからビルドされます。

revision

string

リビジョンは、git リポジトリーをクローンする git リビジョンです。特定のブランチ、タグ、またはコミット SHA をクローンするために使用できます。最大長は 256 文字にする必要があります。省略した場合は、リポジトリーのデフォルトのブランチが使用されます。

url

string

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 文字にする必要があります。

targetPort

integer

targetPort は、サービスが HTTP リクエストをリッスンするポートです。このポートは、このサンプル用に作成された Service に使用されます。port は 1 から 65535 までの範囲である必要があります。デフォルトのポートは 8080 です。