콘솔 API
콘솔 API에 대한 참조 가이드
초록
1장. 콘솔 API
1.1. ConsoleCLIDownload [console.openshift.io/v1]
- 설명
- ConsoleCLIDownload는 openshift 웹 콘솔 CLI(명령줄 인터페이스) 다운로드를 구성하기 위한 확장 프로그램입니다. 호환성 수준 2: 주요 릴리스 내에서 최소 9 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 사용할 수 있습니다.
- 유형
-
object
1.2. ConsoleExternalLogLink [console.openshift.io/v1]
- 설명
- ConsoleExternalLogLink는 OpenShift 웹 콘솔 로그 링크를 사용자 정의하는 확장 프로그램입니다. 호환성 수준 2: 주요 릴리스 내에서 최소 9 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 사용할 수 있습니다.
- 유형
-
object
1.3. ConsoleLink [console.openshift.io/v1]
- 설명
- ConsoleLink는 OpenShift 웹 콘솔 링크를 사용자 정의하는 확장 프로그램입니다. 호환성 수준 2: 주요 릴리스 내에서 최소 9 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 사용할 수 있습니다.
- 유형
-
object
1.4. ConsoleNotification [console.openshift.io/v1]
- 설명
- ConsoleNotification은 openshift 웹 콘솔 알림을 구성하는 확장 프로그램입니다. 호환성 수준 2: 주요 릴리스 내에서 최소 9 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 사용할 수 있습니다.
- 유형
-
object
1.5. ConsolePlugin [console.openshift.io/v1]
- 설명
- ConsolePlugin은 클러스터에서 실행되는 다른 서비스에서 코드를 동적으로 로드하여 OpenShift 웹 콘솔을 사용자 정의하는 확장 프로그램입니다. 호환성 수준 1: 최소 12 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 주요 릴리스 내에서 사용할 수 있습니다.
- 유형
-
object
1.6. ConsoleQuickStart [console.openshift.io/v1]
- 설명
- ConsoleQuickStart는 OpenShift 웹 콘솔의 다양한 워크플로우를 통해 사용자를 안내하는 확장 프로그램입니다. 호환성 수준 2: 주요 릴리스 내에서 최소 9 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 사용할 수 있습니다.
- 유형
-
object
1.7. ConsoleSample [console.openshift.io/v1]
- 설명
- ConsoleSample은 샘플을 추가하여 OpenShift 웹 콘솔을 사용자 정의하는 확장 프로그램입니다. 호환성 수준 1: 최소 12 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 주요 릴리스 내에서 사용할 수 있습니다.
- 유형
-
object
1.8. ConsoleYAMLSample [console.openshift.io/v1]
- 설명
- ConsoleYAMLSample은 OpenShift 웹 콘솔 YAML 샘플을 사용자 정의하는 확장 프로그램입니다. 호환성 수준 2: 주요 릴리스 내에서 최소 9 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 사용할 수 있습니다.
- 유형
-
object
2장. ConsoleCLIDownload [console.openshift.io/v1]
- 설명
- ConsoleCLIDownload는 openshift 웹 콘솔 CLI(명령줄 인터페이스) 다운로드를 구성하기 위한 확장 프로그램입니다. 호환성 수준 2: 주요 릴리스 내에서 최소 9 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 사용할 수 있습니다.
- 유형
-
object
- 필수 항목
-
spec
-
2.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 | |
|
| ConsoleCLIDownloadSpec은 원하는 cli 다운로드 구성입니다. |
2.1.1. .spec
- 설명
- ConsoleCLIDownloadSpec은 원하는 cli 다운로드 구성입니다.
- 유형
-
object
- 필수 항목
-
description
-
displayName
-
links
-
속성 | 유형 | 설명 |
---|---|---|
|
| 설명은 CLI 다운로드에 대한 설명입니다( 마크다운을 포함할 수 있음). |
|
| displayName은 CLI 다운로드의 표시 이름입니다. |
|
| 링크는 CLI 다운로드 링크 세부 정보를 제공하는 오브젝트 목록입니다. |
|
|
2.1.2. .spec.links
- 설명
- 링크는 CLI 다운로드 링크 세부 정보를 제공하는 오브젝트 목록입니다.
- 유형
-
array
2.1.3. .spec.links[]
- 설명
- 유형
-
object
- 필수 항목
-
href
-
속성 | 유형 | 설명 |
---|---|---|
|
| href는 링크의 절대 보안 URL입니다(https를 사용해야 함) |
|
| 텍스트는 링크의 표시 텍스트입니다. |
2.2. API 끝점
다음 API 끝점을 사용할 수 있습니다.
/apis/console.openshift.io/v1/consoleclidownloads
-
DELETE
: ConsoleCLIDownload 컬렉션 삭제 -
GET
: 종류의 ConsoleCLIDownload 오브젝트 나열 -
POST
: ConsoleCLIDownload 생성
-
/apis/console.openshift.io/v1/consoleclidownloads/{name}
-
DELETE
: ConsoleCLIDownload 삭제 -
GET
: 지정된 ConsoleCLIDownload 읽기 -
PATCH
: 지정된 ConsoleCLIDownload를 부분적으로 업데이트 -
PUT
: 지정된 ConsoleCLIDownload를 교체합니다.
-
/apis/console.openshift.io/v1/consoleclidownloads/{name}/status
-
GET
: 지정된 ConsoleCLIDownload의 읽기 상태 -
PATCH
: 지정된 ConsoleCLIDownload의 부분 업데이트 상태 -
PUT
: 지정된 ConsoleCLIDownload의 상태
-
2.2.1. /apis/console.openshift.io/v1/consoleclidownloads
- HTTP 방법
-
DELETE
- 설명
- ConsoleCLIDownload 컬렉션 삭제
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
GET
- 설명
- ConsoleCLIDownload 유형의 오브젝트 나열
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
401 - 무단 | 빈 |
- HTTP 방법
-
POST
- 설명
- ConsoleCLIDownload 생성
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
201 - 생성됨 | |
202 - 승인됨 | |
401 - 무단 | 빈 |
2.2.2. /apis/console.openshift.io/v1/consoleclidownloads/{name}
매개변수 | 유형 | 설명 |
---|---|---|
|
| ConsoleCLIDownload 이름 |
- HTTP 방법
-
DELETE
- 설명
- ConsoleCLIDownload 삭제
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
202 - 승인됨 |
|
401 - 무단 | 빈 |
- HTTP 방법
-
GET
- 설명
- 지정된 ConsoleCLIDownload 읽기
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
401 - 무단 | 빈 |
- HTTP 방법
-
PATCH
- 설명
- 지정된 ConsoleCLIDownload를 부분적으로 업데이트
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
401 - 무단 | 빈 |
- HTTP 방법
-
PUT
- 설명
- 지정된 ConsoleCLIDownload를 교체
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
201 - 생성됨 | |
401 - 무단 | 빈 |
2.2.3. /apis/console.openshift.io/v1/consoleclidownloads/{name}/status
매개변수 | 유형 | 설명 |
---|---|---|
|
| ConsoleCLIDownload 이름 |
- HTTP 방법
-
GET
- 설명
- 지정된 ConsoleCLIDownload의 읽기 상태
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
401 - 무단 | 빈 |
- HTTP 방법
-
PATCH
- 설명
- 지정된 ConsoleCLIDownload의 부분적으로 업데이트 상태
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
401 - 무단 | 빈 |
- HTTP 방법
-
PUT
- 설명
- 지정된 ConsoleCLIDownload의 상태 교체
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
201 - 생성됨 | |
401 - 무단 | 빈 |
3장. ConsoleExternalLogLink [console.openshift.io/v1]
- 설명
- ConsoleExternalLogLink는 OpenShift 웹 콘솔 로그 링크를 사용자 정의하는 확장 프로그램입니다. 호환성 수준 2: 주요 릴리스 내에서 최소 9 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 사용할 수 있습니다.
- 유형
-
object
- 필수 항목
-
spec
-
3.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 | |
|
| ConsoleExternalLogLinkSpec은 원하는 로그 링크 구성입니다. Pod 세부 정보 페이지의 로그 탭에 로그 링크가 표시됩니다. |
3.1.1. .spec
- 설명
- ConsoleExternalLogLinkSpec은 원하는 로그 링크 구성입니다. Pod 세부 정보 페이지의 로그 탭에 로그 링크가 표시됩니다.
- 유형
-
object
- 필수 항목
-
hrefTemplate
-
text
-
속성 | 유형 | 설명 |
---|---|---|
|
|
hrefTemplate은 교체할 변수를 포함하여 로그 링크에 대해 절대 보안 URL(https를 사용해야 함)입니다. 변수는 ${variableName} 형식의 URL에 지정됩니다(예: ${containerName}), 리소스의 해당 값으로 대체됩니다. 리소스는 포드입니다. 지원되는 변수는 다음과 같습니다. - ${resourceName} - 로그를 포함하는 리소스의 이름 - ${resourceUID} - 로그를 포함하는 리소스의 UID - 예를 들면 다음과 같습니다. |
|
|
namespaceFilter는 일치하는 네임스페이스 집합(예: |
|
| 텍스트는 링크의 표시 텍스트입니다. |
3.2. API 끝점
다음 API 끝점을 사용할 수 있습니다.
/apis/console.openshift.io/v1/consoleexternalloglinks
-
DELETE
: ConsoleExternalLogLink의 컬렉션 삭제 -
GET
: ConsoleExternalLogLink 유형의 오브젝트 나열 -
POST
: ConsoleExternalLogLink 생성
-
/apis/console.openshift.io/v1/consoleexternalloglinks/{name}
-
DELETE
: delete a ConsoleExternalLogLink -
GET
: 지정된 ConsoleExternalLogLink 읽기 -
PATCH
: 지정된 ConsoleExternalLogLink를 부분적으로 업데이트 -
PUT
: 지정된 ConsoleExternalLogLink를 교체합니다.
-
/apis/console.openshift.io/v1/consoleexternalloglinks/{name}/status
-
GET
: 지정된 ConsoleExternalLogLink의 읽기 상태 -
PATCH
: 지정된 ConsoleExternalLogLink의 부분 업데이트 상태 -
PUT
: 지정된 ConsoleExternalLogLink의 상태 교체
-
3.2.1. /apis/console.openshift.io/v1/consoleexternalloglinks
- HTTP 방법
-
DELETE
- 설명
- ConsoleExternalLogLink의 컬렉션 삭제
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
GET
- 설명
- ConsoleExternalLogLink 유형의 오브젝트 나열
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
POST
- 설명
- ConsoleExternalLogLink 생성
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
201 - 생성됨 | |
202 - 승인됨 | |
401 - 무단 | 빈 |
3.2.2. /apis/console.openshift.io/v1/consoleexternalloglinks/{name}
매개변수 | 유형 | 설명 |
---|---|---|
|
| ConsoleExternalLogLink 이름 |
- HTTP 방법
-
DELETE
- 설명
- delete a ConsoleExternalLogLink
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
202 - 승인됨 |
|
401 - 무단 | 빈 |
- HTTP 방법
-
GET
- 설명
- 지정된 ConsoleExternalLogLink 읽기
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
401 - 무단 | 빈 |
- HTTP 방법
-
PATCH
- 설명
- 지정된 ConsoleExternalLogLink를 부분적으로 업데이트
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
401 - 무단 | 빈 |
- HTTP 방법
-
PUT
- 설명
- 지정된 ConsoleExternalLogLink를 교체합니다.
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
201 - 생성됨 | |
401 - 무단 | 빈 |
3.2.3. /apis/console.openshift.io/v1/consoleexternalloglinks/{name}/status
매개변수 | 유형 | 설명 |
---|---|---|
|
| ConsoleExternalLogLink 이름 |
- HTTP 방법
-
GET
- 설명
- 지정된 ConsoleExternalLogLink의 상태 확인
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
401 - 무단 | 빈 |
- HTTP 방법
-
PATCH
- 설명
- 지정된 ConsoleExternalLogLink의 부분 업데이트 상태
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
401 - 무단 | 빈 |
- HTTP 방법
-
PUT
- 설명
- 지정된 ConsoleExternalLogLink의 상태 교체
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
201 - 생성됨 | |
401 - 무단 | 빈 |
4장. ConsoleLink [console.openshift.io/v1]
- 설명
- ConsoleLink는 OpenShift 웹 콘솔 링크를 사용자 정의하는 확장 프로그램입니다. 호환성 수준 2: 주요 릴리스 내에서 최소 9 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 사용할 수 있습니다.
- 유형
-
object
- 필수 항목
-
spec
-
4.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 | |
|
| ConsoleLinkSpec은 원하는 콘솔 링크 구성입니다. |
4.1.1. .spec
- 설명
- ConsoleLinkSpec은 원하는 콘솔 링크 구성입니다.
- 유형
-
object
- 필수 항목
-
href
-
위치
-
text
-
속성 | 유형 | 설명 |
---|---|---|
|
| ApplicationMenu는 애플리케이션 메뉴의 링크에 사용되는 섹션 및 아이콘에 대한 정보를 보유하고 있으며 위치가 ApplicationMenu로 설정된 경우에만 적용됩니다. |
|
| href는 링크의 절대 보안 URL입니다(https를 사용해야 함) |
|
| location은 링크가 추가할 콘솔의 위치를 결정합니다(ApplicationMenu, HelpMenu, UserMenu, NamespaceDashboard). |
|
| NamespaceDashboard에는 대시보드 링크가 표시되어야 하는 네임스페이스에 대한 정보가 있으며, 위치가 NamespaceDashboard로 설정된 경우에만 적용할 수 있습니다. 지정하지 않으면 모든 네임스페이스에 링크가 표시됩니다. |
|
| 텍스트는 링크의 표시 텍스트입니다. |
4.1.3. .spec.namespaceDashboard
- 설명
- NamespaceDashboard에는 대시보드 링크가 표시되어야 하는 네임스페이스에 대한 정보가 있으며, 위치가 NamespaceDashboard로 설정된 경우에만 적용할 수 있습니다. 지정하지 않으면 모든 네임스페이스에 링크가 표시됩니다.
- 유형
-
object
속성 | 유형 | 설명 |
---|---|---|
|
| namespaceSelector는 레이블별로 대시보드 링크를 포함해야 하는 네임스페이스를 선택하는 데 사용됩니다. 네임스페이스 라벨이 일치하면 네임스페이스에 대한 대시보드 링크가 표시됩니다. |
|
| 네임스페이스는 대시보드 링크가 표시되어야 하는 네임스페이스 이름 배열입니다. |
4.1.4. .spec.namespaceDashboard.namespaceSelector
- 설명
- namespaceSelector는 레이블별로 대시보드 링크를 포함해야 하는 네임스페이스를 선택하는 데 사용됩니다. 네임스페이스 라벨이 일치하면 네임스페이스에 대한 대시보드 링크가 표시됩니다.
- 유형
-
object
속성 | 유형 | 설명 |
---|---|---|
|
| matchExpressions는 라벨 선택기 요구 사항 목록입니다. 요구 사항은 AND로 설정됩니다. |
|
| 레이블 선택기 요구 사항은 값, 키 및 키와 관련된 연산자를 포함하는 선택기입니다. |
|
| matchLabels는 {key,value} 쌍으로 구성된 맵입니다. matchLabels 맵의 단일 {key,value}는 키 필드가 "key"이고, 연산자는 "In"이고, values 배열에는 "value"만 포함된 matchExpressions 요소와 동일합니다. 요구 사항은 AND로 설정됩니다. |
4.1.5. .spec.namespaceDashboard.namespaceSelector.matchExpressions
- 설명
- matchExpressions는 라벨 선택기 요구 사항 목록입니다. 요구 사항은 AND로 설정됩니다.
- 유형
-
array
4.1.6. .spec.namespaceDashboard.namespaceSelector.matchExpressions[]
- 설명
- 레이블 선택기 요구 사항은 값, 키 및 키와 관련된 연산자를 포함하는 선택기입니다.
- 유형
-
object
- 필수 항목
-
key
-
operator
-
속성 | 유형 | 설명 |
---|---|---|
|
| key는 선택기가 적용되는 라벨 키입니다. |
|
| Operator는 일련의 값과의 키 관계를 나타냅니다. 유효한 연산자는 In, NotIn, Exists 및 DoesNotExist입니다. |
|
| 값은 문자열 값의 배열입니다. 연산자가 In 또는 NotIn인 경우 값 배열은 비어 있지 않아야 합니다. 연산자가 Exists 또는 DoesNotExist인 경우 값 배열은 비어 있어야 합니다. 이 배열은 전략적 병합 패치 중에 교체됩니다. |
4.2. API 끝점
다음 API 끝점을 사용할 수 있습니다.
/apis/console.openshift.io/v1/consolelinks
-
DELETE
: ConsoleLink의 컬렉션 삭제 -
GET
: 종류의 ConsoleLink의 오브젝트 나열 -
POST
: ConsoleLink 생성
-
/apis/console.openshift.io/v1/consolelinks/{name}
-
DELETE
: ConsoleLink 삭제 -
GET
: 지정된 ConsoleLink 읽기 -
PATCH
: 지정된 ConsoleLink를 부분적으로 업데이트 -
PUT
: 지정된 ConsoleLink를 교체합니다.
-
/apis/console.openshift.io/v1/consolelinks/{name}/status
-
GET
: 지정된 ConsoleLink의 읽기 상태 -
PATCH
: 지정된 ConsoleLink의 부분 업데이트 상태 -
PUT
: 지정된 ConsoleLink의 상태
-
4.2.1. /apis/console.openshift.io/v1/consolelinks
- HTTP 방법
-
DELETE
- 설명
- ConsoleLink 컬렉션 삭제
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
GET
- 설명
- ConsoleLink 유형의 오브젝트 나열
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
POST
- 설명
- 콘솔 링크 만들기
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
201 - 생성됨 |
|
202 - 승인됨 |
|
401 - 무단 | 빈 |
4.2.2. /apis/console.openshift.io/v1/consolelinks/{name}
매개변수 | 유형 | 설명 |
---|---|---|
|
| ConsoleLink 이름 |
- HTTP 방법
-
DELETE
- 설명
- 콘솔 링크 삭제
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
202 - 승인됨 |
|
401 - 무단 | 빈 |
- HTTP 방법
-
GET
- 설명
- 지정된 ConsoleLink 읽기
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
PATCH
- 설명
- 지정된 ConsoleLink를 부분적으로 업데이트
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
PUT
- 설명
- 지정된 ConsoleLink를 교체
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
201 - 생성됨 |
|
401 - 무단 | 빈 |
4.2.3. /apis/console.openshift.io/v1/consolelinks/{name}/status
매개변수 | 유형 | 설명 |
---|---|---|
|
| ConsoleLink 이름 |
- HTTP 방법
-
GET
- 설명
- 지정된 ConsoleLink의 상태 보기
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
PATCH
- 설명
- 지정된 ConsoleLink의 상태를 부분적으로 업데이트
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
PUT
- 설명
- 지정된 ConsoleLink의 상태 교체
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
201 - 생성됨 |
|
401 - 무단 | 빈 |
5장. ConsoleNotification [console.openshift.io/v1]
- 설명
- ConsoleNotification은 openshift 웹 콘솔 알림을 구성하는 확장 프로그램입니다. 호환성 수준 2: 주요 릴리스 내에서 최소 9 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 사용할 수 있습니다.
- 유형
-
object
- 필수 항목
-
spec
-
5.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 | |
|
| ConsoleNotificationSpec은 원하는 콘솔 알림 구성입니다. |
5.1.1. .spec
- 설명
- ConsoleNotificationSpec은 원하는 콘솔 알림 구성입니다.
- 유형
-
object
- 필수 항목
-
text
-
속성 | 유형 | 설명 |
---|---|---|
|
| background Cryostat는 CSS 데이터 유형 색상으로 알림의 배경색입니다. |
|
| 색상은 CSS 데이터 유형 색상으로 알림에 대한 텍스트의 색상입니다. |
|
| Link는 알림 링크 세부 정보를 보유하는 오브젝트입니다. |
|
| location은 콘솔에 있는 알림의 위치입니다. 유효한 값은 "BannerTop", "BannerBottom", "BannerTopBottom"입니다. |
|
| 텍스트는 알림의 표시 텍스트입니다. |
5.1.2. .spec.link
- 설명
- Link는 알림 링크 세부 정보를 보유하는 오브젝트입니다.
- 유형
-
object
- 필수 항목
-
href
-
text
-
속성 | 유형 | 설명 |
---|---|---|
|
| href는 링크의 절대 보안 URL입니다(https를 사용해야 함) |
|
| 텍스트는 링크의 표시 텍스트입니다. |
5.2. API 끝점
다음 API 끝점을 사용할 수 있습니다.
/apis/console.openshift.io/v1/consolenotifications
-
DELETE
: ConsoleNotification의 컬렉션 삭제 -
GET
: ConsoleNotification 유형의 오브젝트 나열 -
POST
: ConsoleNotification 생성
-
/apis/console.openshift.io/v1/consolenotifications/{name}
-
DELETE
: ConsoleNotification 삭제 -
GET
: 지정된 ConsoleNotification 읽기 -
PATCH
: 지정된 ConsoleNotification을 부분적으로 업데이트 -
PUT
: 지정된 ConsoleNotification을 교체합니다.
-
/apis/console.openshift.io/v1/consolenotifications/{name}/status
-
GET
: 지정된 ConsoleNotification의 읽기 상태 -
PATCH
: 지정된 ConsoleNotification의 부분 업데이트 상태 -
PUT
: 지정된 ConsoleNotification의 상태 교체
-
5.2.1. /apis/console.openshift.io/v1/consolenotifications
- HTTP 방법
-
DELETE
- 설명
- ConsoleNotification의 컬렉션 삭제
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
GET
- 설명
- ConsoleNotification 유형의 오브젝트 나열
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
401 - 무단 | 빈 |
- HTTP 방법
-
POST
- 설명
- ConsoleNotification 생성
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
201 - 생성됨 | |
202 - 승인됨 | |
401 - 무단 | 빈 |
5.2.2. /apis/console.openshift.io/v1/consolenotifications/{name}
매개변수 | 유형 | 설명 |
---|---|---|
|
| ConsoleNotification의 이름 |
- HTTP 방법
-
DELETE
- 설명
- ConsoleNotification 삭제
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
202 - 승인됨 |
|
401 - 무단 | 빈 |
- HTTP 방법
-
GET
- 설명
- 지정된 ConsoleNotification 읽기
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
401 - 무단 | 빈 |
- HTTP 방법
-
PATCH
- 설명
- 지정된 ConsoleNotification을 부분적으로 업데이트
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
401 - 무단 | 빈 |
- HTTP 방법
-
PUT
- 설명
- 지정된 ConsoleNotification을 교체
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
201 - 생성됨 | |
401 - 무단 | 빈 |
5.2.3. /apis/console.openshift.io/v1/consolenotifications/{name}/status
매개변수 | 유형 | 설명 |
---|---|---|
|
| ConsoleNotification의 이름 |
- HTTP 방법
-
GET
- 설명
- 지정된 ConsoleNotification의 상태 확인
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
401 - 무단 | 빈 |
- HTTP 방법
-
PATCH
- 설명
- 지정된 ConsoleNotification의 부분 업데이트 상태
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
401 - 무단 | 빈 |
- HTTP 방법
-
PUT
- 설명
- 지정된 ConsoleNotification의 상태 교체
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
201 - 생성됨 | |
401 - 무단 | 빈 |
6장. ConsolePlugin [console.openshift.io/v1]
- 설명
- ConsolePlugin은 클러스터에서 실행되는 다른 서비스에서 코드를 동적으로 로드하여 OpenShift 웹 콘솔을 사용자 정의하는 확장 프로그램입니다. 호환성 수준 1: 최소 12 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 주요 릴리스 내에서 사용할 수 있습니다.
- 유형
-
object
- 필수 항목
-
메타데이터
-
spec
-
6.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 | |
|
| ConsolePluginSpec은 원하는 플러그인 구성입니다. |
6.1.1. .spec
- 설명
- ConsolePluginSpec은 원하는 플러그인 구성입니다.
- 유형
-
object
- 필수 항목
-
백엔드
-
displayName
-
속성 | 유형 | 설명 |
---|---|---|
|
| 백엔드에는 콘솔의 플러그인을 제공하는 백엔드 구성이 있습니다. |
|
| displayName은 플러그인의 표시 이름입니다. dispalyName은 1~128자 사이여야 합니다. |
|
| i18n은 플러그인의 현지화 리소스의 구성입니다. |
|
| proxy는 플러그인이 연결해야 하는 다양한 서비스 유형을 설명하는 프록시 목록입니다. |
|
| ConsolePluginProxy는 콘솔의 백엔드가 플러그인의 요청을 프록시하는 다양한 서비스 유형에 대한 정보를 보유합니다. |
6.1.2. .spec.backend
- 설명
- 백엔드에는 콘솔의 플러그인을 제공하는 백엔드 구성이 있습니다.
- 유형
-
object
- 필수 항목
-
type
-
속성 | 유형 | 설명 |
---|---|---|
|
| 서비스는 HTTP 서버와의 배포를 사용하여 플러그인을 노출하는 Kubernetes 서비스입니다. 서비스는 HTTPS 및 서비스 제공 인증서를 사용해야 합니다. 콘솔 백엔드는 서비스 CA 번들을 사용하여 서비스에서 플러그인 자산을 프록시합니다. |
|
| type은 콘솔의 플러그인에 있는 서버의 백엔드 유형입니다. 현재 "서비스"만 지원됩니다. --- |
6.1.3. .spec.backend.service
- 설명
- 서비스는 HTTP 서버와의 배포를 사용하여 플러그인을 노출하는 Kubernetes 서비스입니다. 서비스는 HTTPS 및 서비스 제공 인증서를 사용해야 합니다. 콘솔 백엔드는 서비스 CA 번들을 사용하여 서비스에서 플러그인 자산을 프록시합니다.
- 유형
-
object
- 필수 항목
-
name
-
네임스페이스
-
port
-
속성 | 유형 | 설명 |
---|---|---|
|
|
basePath는 플러그인 자산의 경로입니다. 주요 자산은 플러그인 및 확장에 대한 메타데이터가 포함된 JSON 문서인 |
|
| 플러그인 자산을 제공하는 서비스 이름입니다. |
|
| 플러그인 자산을 제공하는 서비스의 네임스페이스입니다. |
|
| 플러그인을 제공하는 서비스가 수신 대기하는 포트입니다. |
6.1.4. .spec.i18n
- 설명
- i18n은 플러그인의 현지화 리소스의 구성입니다.
- 유형
-
object
- 필수 항목
-
loadType
-
속성 | 유형 | 설명 |
---|---|---|
|
| loadType은 플러그인의 로컬라이제이션 리소스를 로드하는 방법을 나타냅니다. 유효한 값은 Preload, Lazy 및 빈 문자열입니다. Preload로 설정하면 플러그인이 로드될 때 모든 로컬라이제이션 리소스를 가져옵니다. Lazy로 설정하면 현지화 리소스가 콘솔에 필요한 대로 로드됩니다. 생략하거나 빈 문자열로 설정하면 동작은 Lazy 유형과 동일합니다. |
6.1.5. .spec.proxy
- 설명
- proxy는 플러그인이 연결해야 하는 다양한 서비스 유형을 설명하는 프록시 목록입니다.
- 유형
-
array
6.1.6. .spec.proxy[]
- 설명
- ConsolePluginProxy는 콘솔의 백엔드가 플러그인의 요청을 프록시하는 다양한 서비스 유형에 대한 정보를 보유합니다.
- 유형
-
object
- 필수 항목
-
별칭
-
endpoint
-
속성 | 유형 | 설명 |
---|---|---|
|
| alias는 플러그인의 프록시를 식별하는 프록시 이름입니다. 별칭 이름은 플러그인당 고유해야 합니다. 콘솔 백엔드는 프록시 끝점에 따라 노출됩니다. /api/proxy/plugin/<plugin-name>/<proxy-alias>/<request-path>?<optional-query-parameters> 요청 예 경로: /api/proxy/plugin/acm/search/pods?namespace=openshift-apiserver |
|
| 권한 부여는 프록시 요청이 포함되어야 하는 권한 부여 유형에 대한 정보를 제공합니다. |
|
| caCertificate는 프록시 서비스에서 사용자 정의 서비스 CA를 사용하는 경우 인증 기관 인증서 콘텐츠를 제공합니다. 기본적으로 service-ca Operator에서 제공하는 서비스 CA 번들이 사용됩니다. |
|
| 엔드포인트는 요청이 프록시되는 끝점에 대한 정보를 제공합니다. |
6.1.7. .spec.proxy[].endpoint
- 설명
- 엔드포인트는 요청이 프록시되는 끝점에 대한 정보를 제공합니다.
- 유형
-
object
- 필수 항목
-
type
-
속성 | 유형 | 설명 |
---|---|---|
|
| 서비스는 플러그인이 연결할 클러스터 내 서비스입니다. 서비스는 HTTPS를 사용해야 합니다. 콘솔 백엔드는 플러그인과 서비스 간의 통신을 프록시하기 위해 끝점을 노출합니다. 참고: 현재 "Service" 유형만 지원되므로 현재 service 필드가 필요합니다. |
|
| type은 콘솔 플러그인의 프록시 유형입니다. 현재 "서비스"만 지원됩니다. --- |
6.1.8. .spec.proxy[].endpoint.service
- 설명
- 서비스는 플러그인이 연결할 클러스터 내 서비스입니다. 서비스는 HTTPS를 사용해야 합니다. 콘솔 백엔드는 플러그인과 서비스 간의 통신을 프록시하기 위해 끝점을 노출합니다. 참고: 현재 "Service" 유형만 지원되므로 현재 service 필드가 필요합니다.
- 유형
-
object
- 필수 항목
-
name
-
네임스페이스
-
port
-
속성 | 유형 | 설명 |
---|---|---|
|
| 플러그인에 연결해야 하는 서비스 이름입니다. |
|
| 플러그인이 연결해야 하는 서비스의 네임스페이스 |
|
| 플러그인이 연결해야 하는 서비스가 수신 대기 중인 포트입니다. |
6.2. API 끝점
다음 API 끝점을 사용할 수 있습니다.
/apis/console.openshift.io/v1/consoleplugins
-
DELETE
: ConsolePlugin의 컬렉션 삭제 -
GET
: 종류의 ConsolePlugin의 오브젝트 나열 -
POST
: ConsolePlugin 생성
-
/apis/console.openshift.io/v1/consoleplugins/{name}
-
DELETE
: ConsolePlugin 삭제 -
GET
: 지정된 ConsolePlugin 읽기 -
PATCH
: 지정된 ConsolePlugin을 부분적으로 업데이트 -
PUT
: 지정된 ConsolePlugin을 바꿉니다.
-
6.2.1. /apis/console.openshift.io/v1/consoleplugins
- HTTP 방법
-
DELETE
- 설명
- ConsolePlugin 컬렉션 삭제
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
GET
- 설명
- ConsolePlugin 유형의 오브젝트 나열
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
401 - 무단 | 빈 |
- HTTP 방법
-
POST
- 설명
- ConsolePlugin 생성
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
201 - 생성됨 |
|
202 - 승인됨 |
|
401 - 무단 | 빈 |
6.2.2. /apis/console.openshift.io/v1/consoleplugins/{name}
매개변수 | 유형 | 설명 |
---|---|---|
|
| ConsolePlugin의 이름 |
- HTTP 방법
-
DELETE
- 설명
- ConsolePlugin 삭제
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
202 - 승인됨 |
|
401 - 무단 | 빈 |
- HTTP 방법
-
GET
- 설명
- 지정된 ConsolePlugin 읽기
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
PATCH
- 설명
- 지정된 ConsolePlugin을 부분적으로 업데이트
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
PUT
- 설명
- 지정된 ConsolePlugin을 교체
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
201 - 생성됨 |
|
401 - 무단 | 빈 |
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는 매우 통과된 작업을 설명합니다. |
7.2. API 끝점
다음 API 끝점을 사용할 수 있습니다.
/apis/console.openshift.io/v1/consolequickstarts
-
DELETE
: ConsoleQuickStart의 컬렉션 삭제 -
GET
: 종류의 ConsoleQuickStart의 오브젝트 나열 -
POST
: ConsoleQuickStart 생성
-
/apis/console.openshift.io/v1/consolequickstarts/{name}
-
DELETE
: ConsoleQuickStart 삭제 -
GET
: 지정된 ConsoleQuickStart 읽기 -
PATCH
: 지정된 ConsoleQuickStart를 부분적으로 업데이트 -
PUT
: 지정된 ConsoleQuickStart를 교체합니다.
-
7.2.1. /apis/console.openshift.io/v1/consolequickstarts
- HTTP 방법
-
DELETE
- 설명
- ConsoleQuickStart의 컬렉션 삭제
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
GET
- 설명
- ConsoleQuickStart 유형의 오브젝트 나열
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
401 - 무단 | 빈 |
- HTTP 방법
-
POST
- 설명
- ConsoleQuickStart 생성
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
201 - 생성됨 | |
202 - 승인됨 | |
401 - 무단 | 빈 |
7.2.2. /apis/console.openshift.io/v1/consolequickstarts/{name}
매개변수 | 유형 | 설명 |
---|---|---|
|
| ConsoleQuickStart의 이름 |
- HTTP 방법
-
DELETE
- 설명
- ConsoleQuickStart 삭제
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
202 - 승인됨 |
|
401 - 무단 | 빈 |
- HTTP 방법
-
GET
- 설명
- 지정된 ConsoleQuickStart 읽기
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
401 - 무단 | 빈 |
- HTTP 방법
-
PATCH
- 설명
- 지정된 ConsoleQuickStart를 부분적으로 업데이트
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
401 - 무단 | 빈 |
- HTTP 방법
-
PUT
- 설명
- 지정된 ConsoleQuickStart를 교체
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
201 - 생성됨 | |
401 - 무단 | 빈 |
8장. ConsoleSample [console.openshift.io/v1]
- 설명
- ConsoleSample은 샘플을 추가하여 OpenShift 웹 콘솔을 사용자 정의하는 확장 프로그램입니다. 호환성 수준 1: 최소 12 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 주요 릴리스 내에서 사용할 수 있습니다.
- 유형
-
object
- 필수 항목
-
메타데이터
-
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
-
소스
-
title
-
속성 | 유형 | 설명 |
---|---|---|
|
| 추상은 샘플에 대한 간략한 소개입니다. 필수이며 길이가 100자를 초과할 수 없습니다. 요약은 제목 및 공급자 아래의 샘플 카드 타일에 표시되며 3 줄의 콘텐츠로 제한됩니다. |
|
| 설명은 샘플에 대한 긴 설명입니다. 필수이며 최대 4096 자의 길이를 가질 수 있습니다. 추가 정보, 링크, 사전 조건 및 기타 지침은 README.md와 같은 내용입니다. 줄 바꿈, 링크 및 기타 간단한 형식을 포함할 수 있도록 마크다운으로 렌더링됩니다. |
|
| 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는 샘플을 제공하는 사용자를 준수하기 위한 선택적 레이블입니다. 이는 선택 사항이며 길이가 50자를 넘지 않아야 합니다. 공급자는 "Red Hat"과 같은 회사이거나 "CNCF" 또는 "Knative"와 같은 조직일 수 있습니다. 현재 공급자는 "Provided by "" 접두사가 있는 제목 아래의 샘플 카드 타일에만 표시됩니다. |
|
| source는 샘플 서비스를 배포할 위치를 정의합니다. 샘플은 외부 Git 리포지토리 또는 컨테이너 이미지에서 소싱할 수 있습니다. |
|
| 태그는 샘플 카탈로그에서 샘플을 찾는 데 사용할 수 있는 선택적 문자열 값입니다. 일반적인 태그의 예로는 "Java", "Quarkus" 등이 있을 수 있습니다. 샘플 세부 정보 페이지에 표시됩니다. |
|
| 이름은 샘플의 표시 이름입니다. 필수이며 50자를 초과해서는 안 됩니다. |
|
| type은 여러 샘플을 그룹화하는 선택적 레이블입니다. 이는 선택 사항이며 20자 이상이어야 합니다. 권장 사항은 "Builder Image", "Devfile" 또는 "Serverless Function"와 같은 단일 용어입니다. 현재 유형에는 오른쪽 상단에 있는 샘플 카드 타일에 배지가 표시됩니다. |
8.1.2. .spec.source
- 설명
- source는 샘플 서비스를 배포할 위치를 정의합니다. 샘플은 외부 Git 리포지토리 또는 컨테이너 이미지에서 소싱할 수 있습니다.
- 유형
-
object
- 필수 항목
-
type
-
속성 | 유형 | 설명 |
---|---|---|
|
| containerImport를 사용하면 컨테이너 이미지를 가져올 수 있습니다. |
|
| gitImport를 사용하면 Git 리포지토리에서 코드를 가져올 수 있습니다. |
|
| 현재 지원되는 샘플 유형: "GitImport";"ContainerImport" |
8.1.3. .spec.source.containerImport
- 설명
- containerImport를 사용하면 컨테이너 이미지를 가져올 수 있습니다.
- 유형
-
object
- 필수 항목
-
image
-
속성 | 유형 | 설명 |
---|---|---|
|
| 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> |
|
| 서비스에는 이 샘플에 대해 생성된 서비스 리소스에 대한 구성이 포함되어 있습니다. |
8.1.4. .spec.source.containerImport.service
- 설명
- 서비스에는 이 샘플에 대해 생성된 서비스 리소스에 대한 구성이 포함되어 있습니다.
- 유형
-
object
속성 | 유형 | 설명 |
---|---|---|
|
| targetPort는 서비스가 HTTP 요청을 수신 대기하는 포트입니다. 이 포트는 이 샘플에 대해 생성된 서비스 및 경로에 사용됩니다. 포트는 1~65535 범위에 있어야 합니다. 기본 포트는 8080입니다. |
8.1.5. .spec.source.gitImport
- 설명
- gitImport를 사용하면 Git 리포지토리에서 코드를 가져올 수 있습니다.
- 유형
-
object
- 필수 항목
-
리포지토리
-
속성 | 유형 | 설명 |
---|---|---|
|
| 리포지토리에는 실제 Git 리포지토리에 대한 참조가 포함되어 있습니다. |
|
| 서비스에는 이 샘플에 대해 생성된 서비스 리소스에 대한 구성이 포함되어 있습니다. |
8.1.6. .spec.source.gitImport.repository
- 설명
- 리포지토리에는 실제 Git 리포지토리에 대한 참조가 포함되어 있습니다.
- 유형
-
object
- 필수 항목
-
url
-
속성 | 유형 | 설명 |
---|---|---|
|
|
contextDir은 구성 요소를 빌드할 리포지토리 내에서 디렉터리를 지정하는 데 사용됩니다. |
|
| 개정 버전은 git 리포지토리를 복제할 Git 버전이며 특정 분기, 태그 또는 커밋 SHA를 복제하는 데 사용할 수 있습니다. 최대 256자 이상이어야 합니다. 리포지토리의 기본 분기를 생략하면 사용됩니다. |
|
| 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자여야 합니다. |
8.1.7. .spec.source.gitImport.service
- 설명
- 서비스에는 이 샘플에 대해 생성된 서비스 리소스에 대한 구성이 포함되어 있습니다.
- 유형
-
object
속성 | 유형 | 설명 |
---|---|---|
|
| targetPort는 서비스가 HTTP 요청을 수신 대기하는 포트입니다. 이 포트는 이 샘플에 대해 생성된 서비스에 사용됩니다. 포트는 1~65535 범위에 있어야 합니다. 기본 포트는 8080입니다. |
8.2. API 끝점
다음 API 끝점을 사용할 수 있습니다.
/apis/console.openshift.io/v1/consolesamples
-
DELETE
: ConsoleSample의 컬렉션 삭제 -
GET
: 종류의 ConsoleSample 오브젝트 나열 -
POST
: ConsoleSample 생성
-
/apis/console.openshift.io/v1/consolesamples/{name}
-
DELETE
: ConsoleSample 삭제 -
GET
: 지정된 ConsoleSample을 읽습니다. -
PATCH
: 지정된 ConsoleSample을 부분적으로 업데이트 -
PUT
: 지정된 ConsoleSample을 교체합니다.
-
8.2.1. /apis/console.openshift.io/v1/consolesamples
- HTTP 방법
-
DELETE
- 설명
- ConsoleSample 컬렉션 삭제
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
GET
- 설명
- ConsoleSample 유형의 오브젝트 나열
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
401 - 무단 | 빈 |
- HTTP 방법
-
POST
- 설명
- ConsoleSample 생성
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
201 - 생성됨 |
|
202 - 승인됨 |
|
401 - 무단 | 빈 |
8.2.2. /apis/console.openshift.io/v1/consolesamples/{name}
매개변수 | 유형 | 설명 |
---|---|---|
|
| ConsoleSample의 이름 |
- HTTP 방법
-
DELETE
- 설명
- 콘솔Sample 삭제
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
202 - 승인됨 |
|
401 - 무단 | 빈 |
- HTTP 방법
-
GET
- 설명
- 지정된 ConsoleSample 읽기
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
PATCH
- 설명
- 지정된 ConsoleSample을 부분적으로 업데이트
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
PUT
- 설명
- 지정된 ConsoleSample을 바꿉니다.
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
201 - 생성됨 |
|
401 - 무단 | 빈 |
9장. ConsoleYAMLSample [console.openshift.io/v1]
- 설명
- ConsoleYAMLSample은 OpenShift 웹 콘솔 YAML 샘플을 사용자 정의하는 확장 프로그램입니다. 호환성 수준 2: 주요 릴리스 내에서 최소 9 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 사용할 수 있습니다.
- 유형
-
object
- 필수 항목
-
메타데이터
-
spec
-
9.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 | |
|
| ConsoleYAMLSampleSpec은 원하는 YAML 샘플 구성입니다. 샘플은 웹 콘솔에서 리소스를 생성할 때 샘플 사이드바에 설명과 함께 표시됩니다. |
9.1.1. .spec
- 설명
- ConsoleYAMLSampleSpec은 원하는 YAML 샘플 구성입니다. 샘플은 웹 콘솔에서 리소스를 생성할 때 샘플 사이드바에 설명과 함께 표시됩니다.
- 유형
-
object
- 필수 항목
-
description
-
targetResource
-
title
-
yaml
-
속성 | 유형 | 설명 |
---|---|---|
|
| YAML 샘플에 대한 설명입니다. |
|
| 스니펫은 YAML 샘플이 전체 YAML 리소스 정의가 아니라 사용자 커서의 기존 YAML 문서에 삽입할 수 있는 조각을 나타냅니다. |
|
| targetResource에는 apiVersion 및 kind of resource YAML 샘플이 포함되어 있습니다. |
|
| YAML 샘플의 이름입니다. |
|
| YAML은 표시할 YAML 샘플입니다. |
9.1.2. .spec.targetResource
- 설명
- targetResource에는 apiVersion 및 kind of resource YAML 샘플이 포함되어 있습니다.
- 유형
-
object
속성 | 유형 | 설명 |
---|---|---|
|
| 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 |
9.2. API 끝점
다음 API 끝점을 사용할 수 있습니다.
/apis/console.openshift.io/v1/consoleyamlsamples
-
DELETE
: ConsoleYAMLSample의 컬렉션 삭제 -
GET
: ConsoleYAMLSample 유형의 오브젝트 나열 -
POST
: ConsoleYAMLSample 생성
-
/apis/console.openshift.io/v1/consoleyamlsamples/{name}
-
DELETE
: ConsoleYAMLSample 삭제 -
GET
: 지정된 ConsoleYAMLSample을 읽습니다. -
PATCH
: 지정된 ConsoleYAMLSample을 부분적으로 업데이트합니다. -
PUT
: 지정된 ConsoleYAMLSample을 교체합니다.
-
9.2.1. /apis/console.openshift.io/v1/consoleyamlsamples
- HTTP 방법
-
DELETE
- 설명
- ConsoleYAMLSample 컬렉션 삭제
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
401 - 무단 | 빈 |
- HTTP 방법
-
GET
- 설명
- ConsoleYAMLSample 유형의 오브젝트 나열
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
401 - 무단 | 빈 |
- HTTP 방법
-
POST
- 설명
- ConsoleYAMLSample 생성
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
201 - 생성됨 | |
202 - 승인됨 | |
401 - 무단 | 빈 |
9.2.2. /apis/console.openshift.io/v1/consoleyamlsamples/{name}
매개변수 | 유형 | 설명 |
---|---|---|
|
| ConsoleYAMLSample 이름 |
- HTTP 방법
-
DELETE
- 설명
- ConsoleYAMLSample 삭제
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK |
|
202 - 승인됨 |
|
401 - 무단 | 빈 |
- HTTP 방법
-
GET
- 설명
- 지정된 ConsoleYAMLSample 읽기
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
401 - 무단 | 빈 |
- HTTP 방법
-
PATCH
- 설명
- 지정된 ConsoleYAMLSample을 부분적으로 업데이트
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
401 - 무단 | 빈 |
- HTTP 방법
-
PUT
- 설명
- 지정된 ConsoleYAMLSample을 교체합니다.
매개변수 | 유형 | 설명 |
---|---|---|
|
| 존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다. |
|
| FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다. |
매개변수 | 유형 | 설명 |
---|---|---|
|
HTTP 코드 | 리포지토리 본문 |
---|---|
200 - OK | |
201 - 생성됨 | |
401 - 무단 | 빈 |
Legal Notice
Copyright © 2024 Red Hat, Inc.
OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).
Modified versions must remove all Red Hat trademarks.
Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.
Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.