8장. ConsoleSample [console.openshift.io/v1]

abstract

string

추상은 샘플에 대한 간략한 소개입니다. 필수이며 길이가 100자를 초과할 수 없습니다. 요약은 제목 및 공급자 아래의 샘플 카드 타일에 표시되며 3 줄의 콘텐츠로 제한됩니다.

description

string

설명은 샘플에 대한 긴 설명입니다. 필수이며 최대 4096 자의 길이를 가질 수 있습니다. 추가 정보, 링크, 사전 조건 및 기타 지침은 README.md와 같은 내용입니다. 줄 바꿈, 링크 및 기타 간단한 형식을 포함할 수 있도록 마크다운으로 렌더링됩니다.

icon

string

icon은 base64로 인코딩된 이미지이며 샘플 제목 옆에 표시됩니다. 형식은 URL 형식이어야 하며 최대 크기가 10KB 여야 합니다. data:[<mediatype>][;base64],<base64 인코딩 이미지> 예: data:image;base64 및 base64 인코딩 이미지입니다. 벡터 이미지도 사용할 수 있습니다. SVG 아이콘은 data:image/svg+xml;base64와 base64로 인코딩된 SVG 이미지로 시작해야 합니다. 모든 샘플 카탈로그 아이콘은 흰색 배경(크기 테마 사용 시)에 표시됩니다. 웹 콘솔을 사용하면 다양한 측면 비율이 올바르게 작동합니다. 현재 아이콘의 표면은 최대 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 "" 접두사가 있는 제목 아래의 샘플 카드 타일에만 표시됩니다.

소스

object

source는 샘플 서비스를 배포할 위치를 정의합니다. 샘플은 외부 Git 리포지토리 또는 컨테이너 이미지에서 소싱할 수 있습니다.

tags

배열(문자열)

태그는 샘플 카탈로그에서 샘플을 찾는 데 사용할 수 있는 선택적 문자열 값입니다. 일반적인 태그의 예로는 "Java", "Quarkus" 등이 있을 수 있습니다. 샘플 세부 정보 페이지에 표시됩니다.

title

string

이름은 샘플의 표시 이름입니다. 필수이며 50자를 초과해서는 안 됩니다.

type

string

type은 여러 샘플을 그룹화하는 선택적 레이블입니다. 이는 선택 사항이며 20자 이상이어야 합니다. 권장 사항은 "Builder Image", "Devfile" 또는 "Serverless Function"와 같은 단일 용어입니다. 현재 유형에는 오른쪽 상단에 있는 샘플 카드 타일에 배지가 표시됩니다.

containerImport

object

containerImport를 사용하면 컨테이너 이미지를 가져올 수 있습니다.

gitImport

object

gitImport를 사용하면 Git 리포지토리에서 코드를 가져올 수 있습니다.

type

string

현재 지원되는 샘플 유형: "GitImport";"ContainerImport"

image

string

HTTP 서비스를 제공하는 컨테이너 이미지에 대한 참조입니다. port 필드로 달리 구성하지 않는 한 기본 포트(8080)에 서비스를 노출해야 합니다. 지원되는 형식: - <repository-name>/<image-name> - docker.io/<repository-name>/<image-name> - quay.io/<repository-name>/<image-name>/<image-name>/<image-name>@sha256:<image hash> - quay.io/<repository-name>:<tag>:<tag>

서비스

object

서비스에는 이 샘플에 대해 생성된 서비스 리소스에 대한 구성이 포함되어 있습니다.

targetPort

integer

targetPort는 서비스가 HTTP 요청을 수신 대기하는 포트입니다. 이 포트는 이 샘플에 대해 생성된 서비스 및 경로에 사용됩니다. 포트는 1~65535 범위에 있어야 합니다. 기본 포트는 8080입니다.

리포지토리

object

리포지토리에는 실제 Git 리포지토리에 대한 참조가 포함되어 있습니다.

서비스

object

서비스에는 이 샘플에 대해 생성된 서비스 리소스에 대한 구성이 포함되어 있습니다.

contextDir

string

contextDir은 구성 요소를 빌드할 리포지토리 내에서 디렉터리를 지정하는 데 사용됩니다. / 로 시작해야 하며 최대 256자 길이를 가져야 합니다. 생략하면 기본값은 리포지토리의 루트에서 빌드하는 것입니다.

버전

string

개정 버전은 git 리포지토리를 복제할 Git 버전이며 특정 분기, 태그 또는 커밋 SHA를 복제하는 데 사용할 수 있습니다. 최대 256자 이상이어야 합니다. 리포지토리의 기본 분기를 생략하면 사용됩니다.

url

string

HTTP 서비스가 포함된 Git 리포지토리의 URL입니다. port 필드로 달리 구성하지 않는 한 HTTP 서비스는 기본 포트(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 요청을 수신 대기하는 포트입니다. 이 포트는 이 샘플에 대해 생성된 서비스에 사용됩니다. 포트는 1~65535 범위에 있어야 합니다. 기본 포트는 8080입니다.