7장. ConsoleQuickStart [console.openshift.io/v1]
- 설명
- ConsoleQuickStart는 OpenShift 웹 콘솔의 다양한 워크플로우를 통해 사용자를 안내하는 확장 프로그램입니다. 호환성 수준 2: 주요 릴리스 내에서 최소 9 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 사용할 수 있습니다.
- 유형
-
object - 필수 항목
-
spec
-
7.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 | |
|
|
| ConsoleQuickStartSpec은 원하는 퀵 스타트 구성입니다. |
7.1.1. .spec
- 설명
- ConsoleQuickStartSpec은 원하는 퀵 스타트 구성입니다.
- 유형
-
object - 필수 항목
-
description -
displayName -
durationMinutes -
Introduction -
tasks
-
| 속성 | 유형 | 설명 |
|---|---|---|
|
|
| accessReviewResources에는 사용자가 빠른 시작을 완료하기 위해 사용자 액세스 권한을 검토할 리소스 목록이 포함되어 있습니다. 액세스 검토가 실패하면 빠른 시작이 숨겨집니다. |
|
|
| ResourceAttributes에는 Authorizer 인터페이스에 리소스 요청에 사용할 수 있는 권한 부여 속성이 포함되어 있습니다. |
|
|
| conclusion는 빠른 시작을 요약하고 가능한 다음 단계를 제안합니다. ( 마크다운 포함) |
|
|
| Description is the description of the Quick Start. (includes markdown) |
|
|
| displayName은 빠른 시작의 표시 이름입니다. |
|
|
| durationMinutes는 빠른 시작을 완료하는 데 걸리는 약 몇 분을 설명합니다. |
|
|
| icon은 빠른 시작 표시 이름 옆에 표시되는 base64로 인코딩된 이미지입니다. 아이콘은 쉽게 스케일링할 수 있는 벡터 이미지여야 합니다. 아이콘 크기는 40x40이어야 합니다. |
|
|
| 소개 빠른 시작의 목적을 설명합니다. (표시 표시 포함) |
|
|
| nextQuickStart는 사용자가 시도할 수 있도록 제안된 다음 빠른 시작 목록입니다. |
|
|
| 사전 요구 사항은 빠른 시작을 시작하기 전에 충족해야 하는 모든 사전 요구 사항을 포함합니다. ( 마크다운 포함) |
|
|
| 태그는 빠른 시작을 설명하는 문자열 목록입니다. |
|
|
| tasks는 사용자가 빠른 시작을 완료하기 위해 수행해야 하는 단계 목록입니다. |
|
|
| ConsoleQuickStartTask는 빠른 시작의 단일 단계입니다. |
7.1.2. .spec.accessReviewResources
- 설명
- accessReviewResources에는 사용자가 빠른 시작을 완료하기 위해 사용자 액세스 권한을 검토할 리소스 목록이 포함되어 있습니다. 액세스 검토가 실패하면 빠른 시작이 숨겨집니다.
- 유형
-
array
7.1.3. .spec.accessReviewResources[]
- 설명
- ResourceAttributes에는 Authorizer 인터페이스에 리소스 요청에 사용할 수 있는 권한 부여 속성이 포함되어 있습니다.
- 유형
-
object
| 속성 | 유형 | 설명 |
|---|---|---|
|
|
| group은 리소스의 API 그룹입니다. "*"는 모든 것을 의미합니다. |
|
|
| name은 "get"에 대해 요청되거나 "삭제"에 대해 요청된 리소스의 이름입니다. ""(비어 있음)는 모두 의미합니다. |
|
|
| namespace는 요청된 작업의 네임스페이스입니다. 현재는 LocalSubjectAccessReviews ""(비어 있음)에 대해 네임스페이스와 모든 네임스페이스 ""(빈)가 기본적으로 비어 있는 경우 클러스터 범위 리소스 ""(빈)는 SubjectAccessReview 또는 SelfSubjectAccessReview의 네임스페이스 범위 리소스에 대해 "all"을 의미합니다. |
|
|
| 리소스는 기존 리소스 유형 중 하나입니다. "*"는 모든 것을 의미합니다. |
|
|
| 하위 리소스는 기존 리소스 유형 중 하나입니다. ""는 none을 의미합니다. |
|
|
| 동사는 get, list, watch, create, update, delete, proxy와 같은 kubernetes 리소스 API 동사입니다. "*"는 모든 것을 의미합니다. |
|
|
| 버전은 리소스의 API 버전입니다. "*"는 모든 것을 의미합니다. |
7.1.4. .spec.tasks
- 설명
- tasks는 사용자가 빠른 시작을 완료하기 위해 수행해야 하는 단계 목록입니다.
- 유형
-
array
7.1.5. .spec.tasks[]
- 설명
- ConsoleQuickStartTask는 빠른 시작의 단일 단계입니다.
- 유형
-
object - 필수 항목
-
description -
title
-
| 속성 | 유형 | 설명 |
|---|---|---|
|
|
| Description은 작업을 완료하는 데 필요한 단계를 설명합니다. ( 마크다운 포함) |
|
|
| 검토에는 작업이 완료되었는지 확인하는 지침이 포함되어 있습니다. 사용자가 단계가 성공적으로 완료되었는지 여부를 나타내는 라디오 버튼을 사용하여 '예' 또는 '아니오'를 선택합니다. |
|
|
| 요약에는 전달된 단계에 대한 정보가 포함되어 있습니다. |
|
|
| title은 작업을 설명하고 단계 제목으로 표시됩니다. |
7.1.6. .spec.tasks[].review
- 설명
- 검토에는 작업이 완료되었는지 확인하는 지침이 포함되어 있습니다. 사용자가 단계가 성공적으로 완료되었는지 여부를 나타내는 라디오 버튼을 사용하여 '예' 또는 '아니오'를 선택합니다.
- 유형
-
object - 필수 항목
-
failedTaskHelp -
지침
-
| 속성 | 유형 | 설명 |
|---|---|---|
|
|
| failedTaskHelp에는 실패한 작업 검토에 대한 제안 사항이 포함되어 있으며 작업 끝에 표시됩니다. |
|
|
| 지침에는 작업을 수행한 후 작업의 유효성을 검사하기 위해 사용자가 수행해야 하는 단계가 포함되어 있습니다. ( 마크다운 포함) |
7.1.7. .spec.tasks[].summary
- 설명
- 요약에는 전달된 단계에 대한 정보가 포함되어 있습니다.
- 유형
-
object - 필수 항목
-
failed -
success
-
| 속성 | 유형 | 설명 |
|---|---|---|
|
|
| failed가 성공적으로 통과하지 못한 작업을 간략하게 설명합니다. ( markdown 포함) |
|
|
| success는 매우 통과된 작업을 설명합니다. |
