콘솔 API


OpenShift Container Platform 4.14

콘솔 API에 대한 참조 가이드

Red Hat OpenShift Documentation Team

초록

이 문서에서는 OpenShift Container Platform 콘솔 API 오브젝트 및 세부 사양에 대해 설명합니다.

1장. 콘솔 API

1.1. ConsoleCLIDownload [console.openshift.io/v1]

설명
ConsoleCLIDownload는 openshift 웹 콘솔 CLI(명령줄 인터페이스) 다운로드를 구성하기 위한 확장 프로그램입니다. 호환성 수준 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. 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. 사양

Expand
속성유형설명

apiVersion

string

APIVersion은 버전이 지정된 이 오브젝트 표현의 스키마를 정의합니다. 서버는 인식된 스키마를 최신 내부 값으로 변환해야 하며, 인식되지 않는 값을 거부할 수 있습니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

kind는 이 오브젝트가 나타내는 REST 리소스에 해당하는 문자열 값입니다. 서버는 클라이언트에서 요청을 제출한 끝점에서 이를 유추할 수 있습니다. CamelCase로 업데이트할 수 없습니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

메타데이터

ObjectMeta

표준 오브젝트의 메타데이터입니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

ConsoleCLIDownloadSpec은 원하는 cli 다운로드 구성입니다.

2.1.1. .spec

설명
ConsoleCLIDownloadSpec은 원하는 cli 다운로드 구성입니다.
유형
object
필수 항목
  • description
  • displayName
  • links
Expand
속성유형설명

description

string

설명은 CLI 다운로드에 대한 설명입니다( 마크다운을 포함할 수 있음).

displayName

string

displayName은 CLI 다운로드의 표시 이름입니다.

links

array

링크는 CLI 다운로드 링크 세부 정보를 제공하는 오브젝트 목록입니다.

links[]

object

 

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

Expand
표 2.1. 글로벌 쿼리 매개변수
매개변수유형설명

string

'true'인 경우 출력이 상당히 인쇄됩니다.

HTTP 방법
DELETE
설명
ConsoleCLIDownload 컬렉션 삭제
Expand
표 2.2. 쿼리 매개변수
매개변수유형설명

allowWatchBookmarks

boolean

AllowWatchkeygenmarks는 "BOOKMARK" 유형의 감시 이벤트를 요청합니다. 북마크를 구현하지 않는 서버는 이 플래그를 무시하고 북마크는 서버의 재량에 따라 전송됩니다. 클라이언트는 특정 간격으로 북마크가 반환된다고 가정해서는 안되며, 세션 중에 서버가 BOOKMARK 이벤트를 전송한다고 가정할 수도 있습니다. 시계가 아닌 경우 이 필드는 무시됩니다.

계속

string

서버에서 더 많은 결과를 검색할 때 continue 옵션을 설정해야 합니다. 이 값은 서버 정의이므로 클라이언트는 동일한 쿼리 매개변수가 있는 이전 쿼리 결과의 continue 값만 사용할 수 있으며(계속 값 제외) 서버는 인식할 수 없는 계속 값을 거부할 수 있습니다. 지정된 continue 값이 만료(일반적으로 5~15분) 또는 서버의 구성 변경으로 인해 지정된 continue 값이 더 이상 유효하지 않으면 서버는 계속 토큰과 함께 410 ResourceExpired 오류로 응답합니다. 클라이언트에 일관된 목록이 필요한 경우 continue 필드 없이 목록을 다시 시작해야 합니다. 그렇지 않으면 클라이언트는 410 오류와 함께 수신된 토큰을 사용하여 다른 목록 요청을 보낼 수 있으며, 서버는 다음 키에서 시작하여 목록으로 응답할 수 있지만 최신 스냅샷에서 생성된 오브젝트는 첫 번째 목록 요청이 "다음 키" 뒤에 포함된 후 생성, 수정 또는 삭제된 오브젝트입니다.

watch가 true인 경우 이 필드는 지원되지 않습니다. 클라이언트는 서버에서 반환한 마지막 resourceVersion 값에서 감시를 시작할 수 있으며 수정 사항을 누락하지 않을 수 있습니다.

fieldSelector

string

반환된 오브젝트 목록을 해당 필드로 제한하는 선택기입니다. 기본값은 모든 것입니다.

labelSelector

string

라벨을 통해 반환된 오브젝트 목록을 제한하는 선택기입니다. 기본값은 모든 것입니다.

limit

integer

제한은 목록 호출에 대해 반환할 최대 응답 수입니다. 더 많은 항목이 있는 경우 서버는 목록 메타데이터의 continue 필드를 동일한 초기 쿼리와 함께 사용하여 다음 결과 집합을 검색할 수 있는 값으로 설정합니다. 제한을 설정하면 모든 요청된 오브젝트가 필터링되는 경우 요청된 양의 항목(최대 0 항목)보다 적은 수를 반환하고 클라이언트는 continue 필드의 존재만 사용하여 더 많은 결과를 사용할 수 있는지 확인해야 합니다. 서버는 limit 인수를 지원하지 않도록 선택할 수 있으며 사용 가능한 모든 결과를 반환합니다. 제한이 지정되고 continue 필드가 비어 있으면 클라이언트는 더 이상 결과를 사용할 수 없다고 가정할 수 있습니다. watch가 true인 경우 이 필드는 지원되지 않습니다.

이 서버는 를 사용할 때 반환된 개체는 제한 없이 단일 목록 호출을 발행하는 것과 동일하며, 첫 번째 요청이 발행된 후 첫 번째 요청이 후속 계속되는 요청에 포함되지 않음을 보장합니다. 이를 일관된 스냅샷이라고 하며 제한을 사용하여 매우 큰 결과의 청크를 수신하는 클라이언트에서 가능한 모든 오브젝트를 확인할 수 있도록 합니다. 청크된 목록 중에 오브젝트가 업데이트되면 첫 번째 목록 결과가 계산될 때 존재하는 오브젝트 버전이 반환됩니다.

resourceVersion

string

resourceVersion은 요청이 제공할 수 있는 리소스 버전에 대한 제약 조건을 설정합니다. 자세한 내용은 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 을 참조하십시오.

기본값이 설정되지 않음

resourceVersionMatch

string

resourceVersionMatch는 resourceVersion이 호출 목록에 적용되는 방식을 결정합니다. 자세한 내용은 resourceVersion이 설정된 목록 호출에 대해 resourceVersionMatch를 설정하는 것이 좋습니다. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

기본값이 설정되지 않음

sendInitialEvents

boolean

sendInitialEvents=truewatch=true 와 함께 설정할 수 있습니다. 이 경우 감시 스트림은 합성 이벤트로 시작하여 컬렉션에 있는 개체의 현재 상태를 생성합니다. 이러한 모든 이벤트가 전송되면 합성 " emailmark" 이벤트가 전송됩니다. 북마크는 오브젝트 세트에 해당하는 ResourceVersion(RV)을 보고하고 "k8s.io/initial-events-end": "true" 주석으로 표시됩니다. 이후 감시 스트림은 정상적으로 진행되어 모니터링되는 오브젝트에 변경(RV에 제출)에 해당하는 감시 이벤트를 보냅니다.

sendInitialEvents 옵션을 설정할 때 resourceVersionMatch 옵션도 설정해야 합니다. 감시 요청의 의미 체계는 다음과 같습니다. - resourceVersionMatch = NotOlderThan은 "제공된 resourceVersion'만큼 새로운 데이터로 해석되며 북마크 이벤트는 상태가 'resourceVersion에 동기화될 때 적어도 ListOptions에서 제공하는 것과 같이 새로운 것으로 전송됩니다. resourceVersion 이 설정되지 않은 경우, 이는 "consistent read"로 해석되고, 요청이 처리되기 시작할 때 상태가 최소한 현재와 동기화될 때 북마크 이벤트는 전송됩니다. - resourceVersionMatch 가 다른 값으로 설정되거나 설정되지 않은 오류를 반환합니다.

resourceVersion="" 또는 resourceVersion="0"( 이전의 호환성 이유로) 및 false인 경우 기본값은 true입니다.

timeoutSeconds

integer

list/watch 호출의 시간 초과입니다. 이렇게 하면 활동 또는 비활성 여부에 관계없이 호출 기간이 제한됩니다.

watch

boolean

설명된 리소스에 대한 변경 사항을 조사하고 알림 추가, 업데이트 및 제거 스트림으로 반환합니다. resourceVersion을 지정합니다.

Expand
표 2.3. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

401 - 무단

HTTP 방법
GET
설명
ConsoleCLIDownload 유형의 오브젝트 나열
Expand
표 2.4. 쿼리 매개변수
매개변수유형설명

allowWatchBookmarks

boolean

AllowWatchkeygenmarks는 "BOOKMARK" 유형의 감시 이벤트를 요청합니다. 북마크를 구현하지 않는 서버는 이 플래그를 무시하고 북마크는 서버의 재량에 따라 전송됩니다. 클라이언트는 특정 간격으로 북마크가 반환된다고 가정해서는 안되며, 세션 중에 서버가 BOOKMARK 이벤트를 전송한다고 가정할 수도 있습니다. 시계가 아닌 경우 이 필드는 무시됩니다.

계속

string

서버에서 더 많은 결과를 검색할 때 continue 옵션을 설정해야 합니다. 이 값은 서버 정의이므로 클라이언트는 동일한 쿼리 매개변수가 있는 이전 쿼리 결과의 continue 값만 사용할 수 있으며(계속 값 제외) 서버는 인식할 수 없는 계속 값을 거부할 수 있습니다. 지정된 continue 값이 만료(일반적으로 5~15분) 또는 서버의 구성 변경으로 인해 지정된 continue 값이 더 이상 유효하지 않으면 서버는 계속 토큰과 함께 410 ResourceExpired 오류로 응답합니다. 클라이언트에 일관된 목록이 필요한 경우 continue 필드 없이 목록을 다시 시작해야 합니다. 그렇지 않으면 클라이언트는 410 오류와 함께 수신된 토큰을 사용하여 다른 목록 요청을 보낼 수 있으며, 서버는 다음 키에서 시작하여 목록으로 응답할 수 있지만 최신 스냅샷에서 생성된 오브젝트는 첫 번째 목록 요청이 "다음 키" 뒤에 포함된 후 생성, 수정 또는 삭제된 오브젝트입니다.

watch가 true인 경우 이 필드는 지원되지 않습니다. 클라이언트는 서버에서 반환한 마지막 resourceVersion 값에서 감시를 시작할 수 있으며 수정 사항을 누락하지 않을 수 있습니다.

fieldSelector

string

반환된 오브젝트 목록을 해당 필드로 제한하는 선택기입니다. 기본값은 모든 것입니다.

labelSelector

string

라벨을 통해 반환된 오브젝트 목록을 제한하는 선택기입니다. 기본값은 모든 것입니다.

limit

integer

제한은 목록 호출에 대해 반환할 최대 응답 수입니다. 더 많은 항목이 있는 경우 서버는 목록 메타데이터의 continue 필드를 동일한 초기 쿼리와 함께 사용하여 다음 결과 집합을 검색할 수 있는 값으로 설정합니다. 제한을 설정하면 모든 요청된 오브젝트가 필터링되는 경우 요청된 양의 항목(최대 0 항목)보다 적은 수를 반환하고 클라이언트는 continue 필드의 존재만 사용하여 더 많은 결과를 사용할 수 있는지 확인해야 합니다. 서버는 limit 인수를 지원하지 않도록 선택할 수 있으며 사용 가능한 모든 결과를 반환합니다. 제한이 지정되고 continue 필드가 비어 있으면 클라이언트는 더 이상 결과를 사용할 수 없다고 가정할 수 있습니다. watch가 true인 경우 이 필드는 지원되지 않습니다.

이 서버는 를 사용할 때 반환된 개체는 제한 없이 단일 목록 호출을 발행하는 것과 동일하며, 첫 번째 요청이 발행된 후 첫 번째 요청이 후속 계속되는 요청에 포함되지 않음을 보장합니다. 이를 일관된 스냅샷이라고 하며 제한을 사용하여 매우 큰 결과의 청크를 수신하는 클라이언트에서 가능한 모든 오브젝트를 확인할 수 있도록 합니다. 청크된 목록 중에 오브젝트가 업데이트되면 첫 번째 목록 결과가 계산될 때 존재하는 오브젝트 버전이 반환됩니다.

resourceVersion

string

resourceVersion은 요청이 제공할 수 있는 리소스 버전에 대한 제약 조건을 설정합니다. 자세한 내용은 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 을 참조하십시오.

기본값이 설정되지 않음

resourceVersionMatch

string

resourceVersionMatch는 resourceVersion이 호출 목록에 적용되는 방식을 결정합니다. 자세한 내용은 resourceVersion이 설정된 목록 호출에 대해 resourceVersionMatch를 설정하는 것이 좋습니다. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

기본값이 설정되지 않음

sendInitialEvents

boolean

sendInitialEvents=truewatch=true 와 함께 설정할 수 있습니다. 이 경우 감시 스트림은 합성 이벤트로 시작하여 컬렉션에 있는 개체의 현재 상태를 생성합니다. 이러한 모든 이벤트가 전송되면 합성 " emailmark" 이벤트가 전송됩니다. 북마크는 오브젝트 세트에 해당하는 ResourceVersion(RV)을 보고하고 "k8s.io/initial-events-end": "true" 주석으로 표시됩니다. 이후 감시 스트림은 정상적으로 진행되어 모니터링되는 오브젝트에 변경(RV에 제출)에 해당하는 감시 이벤트를 보냅니다.

sendInitialEvents 옵션을 설정할 때 resourceVersionMatch 옵션도 설정해야 합니다. 감시 요청의 의미 체계는 다음과 같습니다. - resourceVersionMatch = NotOlderThan은 "제공된 resourceVersion'만큼 새로운 데이터로 해석되며 북마크 이벤트는 상태가 'resourceVersion에 동기화될 때 적어도 ListOptions에서 제공하는 것과 같이 새로운 것으로 전송됩니다. resourceVersion 이 설정되지 않은 경우, 이는 "consistent read"로 해석되고, 요청이 처리되기 시작할 때 상태가 최소한 현재와 동기화될 때 북마크 이벤트는 전송됩니다. - resourceVersionMatch 가 다른 값으로 설정되거나 설정되지 않은 오류를 반환합니다.

resourceVersion="" 또는 resourceVersion="0"( 이전의 호환성 이유로) 및 false인 경우 기본값은 true입니다.

timeoutSeconds

integer

list/watch 호출의 시간 초과입니다. 이렇게 하면 활동 또는 비활성 여부에 관계없이 호출 기간이 제한됩니다.

watch

boolean

설명된 리소스에 대한 변경 사항을 조사하고 알림 추가, 업데이트 및 제거 스트림으로 반환합니다. resourceVersion을 지정합니다.

Expand
표 2.5. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ConsoleCLIDownloadList 스키마

401 - 무단

HTTP 방법
POST
설명
ConsoleCLIDownload 생성
Expand
표 2.6. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldManager

string

Fieldmanager는 이러한 변경을 수행하는 작업자 또는 엔티티와 연결된 이름입니다. 값은 https://golang.org/pkg/unicode/#IsPrint 에서 정의한 대로 인쇄 가능한 문자만 포함하거나 128자 미만이어야 합니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 2.7. 본문 매개변수
매개변수유형설명

body

ConsoleCLIDownload 스키마

 
Expand
표 2.8. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ConsoleCLIDownload 스키마

201 - 생성됨

ConsoleCLIDownload 스키마

202 - 승인됨

ConsoleCLIDownload 스키마

401 - 무단

2.2.2. /apis/console.openshift.io/v1/consoleclidownloads/{name}

Expand
표 2.9. 글로벌 경로 매개변수
매개변수유형설명

name

string

ConsoleCLIDownload 이름

Expand
표 2.10. 글로벌 쿼리 매개변수
매개변수유형설명

string

'true'인 경우 출력이 상당히 인쇄됩니다.

HTTP 방법
DELETE
설명
ConsoleCLIDownload 삭제
Expand
표 2.11. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

gracePeriodSeconds

integer

오브젝트를 삭제하기 전의 기간(초)입니다. 값은 음수가 아닌 정수여야 합니다. 값 0은 즉시 삭제됨을 나타냅니다. 이 값이 nil이면 지정된 유형의 기본 유예 기간이 사용됩니다. 지정하지 않으면 오브젝트당 기본값은 기본값입니다. 0은 즉시 삭제됨을 의미합니다.

orphanDependents

boolean

더 이상 사용되지 않음: PropagationPolicy를 사용하십시오. 이 필드는 1.7에서 더 이상 사용되지 않습니다. 종속 오브젝트를 분리해야 합니다. true/false인 경우 "orphan" 종료자가 오브젝트의 종료자 목록에 추가/제거됩니다. 이 필드 또는 PropagationPolicy는 설정할 수 있지만 둘 다 설정할 수는 없습니다.

propagationPolicy

string

가비지 컬렉션이 수행되는지 여부 및 방법. 이 필드 또는 OrphanDependents는 설정할 수 있지만 둘 다 설정할 수는 없습니다. 기본 정책은 metadata.finalizers에 설정된 기존 종료자 및 리소스별 기본 정책에 의해 결정됩니다. 허용 가능한 값은 다음과 같습니다. 'Orphan' - 종속 항목을 분리합니다. 'Back place' - 가비지 수집기에서 백그라운드에서 종속 항목을 삭제할 수 있습니다. 'Forefield' - 전경에서 모든 종속 항목을 삭제하는 계단식 정책입니다.

Expand
표 2.12. 본문 매개변수
매개변수유형설명

body

DeleteOptions 스키마

 
Expand
표 2.13. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

202 - 승인됨

상태 스키마

401 - 무단

HTTP 방법
GET
설명
지정된 ConsoleCLIDownload 읽기
Expand
표 2.14. 쿼리 매개변수
매개변수유형설명

resourceVersion

string

resourceVersion은 요청이 제공할 수 있는 리소스 버전에 대한 제약 조건을 설정합니다. 자세한 내용은 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 을 참조하십시오.

기본값이 설정되지 않음

Expand
표 2.15. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ConsoleCLIDownload 스키마

401 - 무단

HTTP 방법
PATCH
설명
지정된 ConsoleCLIDownload를 부분적으로 업데이트
Expand
표 2.16. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldManager

string

Fieldmanager는 이러한 변경을 수행하는 작업자 또는 엔티티와 연결된 이름입니다. 값은 https://golang.org/pkg/unicode/#IsPrint 에서 정의한 대로 인쇄 가능한 문자만 포함하거나 128자 미만이어야 합니다. 이 필드는 적용 요청(application/apply-patch)에 필요하지만 적용되지 않는 패치 유형(JsonPatch, CryostatPatch, strategicMergePatch)의 경우 선택 사항입니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

force

boolean

강제 적용 요청을 "적용"합니다. 즉, 사용자는 다른 사용자가 소유한 충돌하는 필드를 다시 수집해야 합니다. 강제 플래그는 적용되지 않은 패치 요청에 대해 설정되지 않아야 합니다.

Expand
표 2.17. 본문 매개변수
매개변수유형설명

body

패치 스키마

 
Expand
표 2.18. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ConsoleCLIDownload 스키마

401 - 무단

HTTP 방법
PUT
설명
지정된 ConsoleCLIDownload를 교체
Expand
표 2.19. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldManager

string

Fieldmanager는 이러한 변경을 수행하는 작업자 또는 엔티티와 연결된 이름입니다. 값은 https://golang.org/pkg/unicode/#IsPrint 에서 정의한 대로 인쇄 가능한 문자만 포함하거나 128자 미만이어야 합니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 2.20. 본문 매개변수
매개변수유형설명

body

ConsoleCLIDownload 스키마

 
Expand
표 2.21. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ConsoleCLIDownload 스키마

201 - 생성됨

ConsoleCLIDownload 스키마

401 - 무단

2.2.3. /apis/console.openshift.io/v1/consoleclidownloads/{name}/status

Expand
표 2.22. 글로벌 경로 매개변수
매개변수유형설명

name

string

ConsoleCLIDownload 이름

Expand
표 2.23. 글로벌 쿼리 매개변수
매개변수유형설명

string

'true'인 경우 출력이 상당히 인쇄됩니다.

HTTP 방법
GET
설명
지정된 ConsoleCLIDownload의 읽기 상태
Expand
표 2.24. 쿼리 매개변수
매개변수유형설명

resourceVersion

string

resourceVersion은 요청이 제공할 수 있는 리소스 버전에 대한 제약 조건을 설정합니다. 자세한 내용은 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 을 참조하십시오.

기본값이 설정되지 않음

Expand
표 2.25. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ConsoleCLIDownload 스키마

401 - 무단

HTTP 방법
PATCH
설명
지정된 ConsoleCLIDownload의 부분적으로 업데이트 상태
Expand
표 2.26. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldManager

string

Fieldmanager는 이러한 변경을 수행하는 작업자 또는 엔티티와 연결된 이름입니다. 값은 https://golang.org/pkg/unicode/#IsPrint 에서 정의한 대로 인쇄 가능한 문자만 포함하거나 128자 미만이어야 합니다. 이 필드는 적용 요청(application/apply-patch)에 필요하지만 적용되지 않는 패치 유형(JsonPatch, CryostatPatch, strategicMergePatch)의 경우 선택 사항입니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

force

boolean

강제 적용 요청을 "적용"합니다. 즉, 사용자는 다른 사용자가 소유한 충돌하는 필드를 다시 수집해야 합니다. 강제 플래그는 적용되지 않은 패치 요청에 대해 설정되지 않아야 합니다.

Expand
표 2.27. 본문 매개변수
매개변수유형설명

body

패치 스키마

 
Expand
표 2.28. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ConsoleCLIDownload 스키마

401 - 무단

HTTP 방법
PUT
설명
지정된 ConsoleCLIDownload의 상태 교체
Expand
표 2.29. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldManager

string

Fieldmanager는 이러한 변경을 수행하는 작업자 또는 엔티티와 연결된 이름입니다. 값은 https://golang.org/pkg/unicode/#IsPrint 에서 정의한 대로 인쇄 가능한 문자만 포함하거나 128자 미만이어야 합니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 2.30. 본문 매개변수
매개변수유형설명

body

ConsoleCLIDownload 스키마

 
Expand
표 2.31. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ConsoleCLIDownload 스키마

201 - 생성됨

ConsoleCLIDownload 스키마

401 - 무단

5장. ConsoleNotification [console.openshift.io/v1]

설명
ConsoleNotification은 openshift 웹 콘솔 알림을 구성하는 확장 프로그램입니다. 호환성 수준 2: 주요 릴리스 내에서 최소 9 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 사용할 수 있습니다.
유형
object
필수 항목
  • spec

5.1. 사양

Expand
속성유형설명

apiVersion

string

APIVersion은 버전이 지정된 이 오브젝트 표현의 스키마를 정의합니다. 서버는 인식된 스키마를 최신 내부 값으로 변환해야 하며, 인식되지 않는 값을 거부할 수 있습니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

kind는 이 오브젝트가 나타내는 REST 리소스에 해당하는 문자열 값입니다. 서버는 클라이언트에서 요청을 제출한 끝점에서 이를 유추할 수 있습니다. CamelCase로 업데이트할 수 없습니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

메타데이터

ObjectMeta

표준 오브젝트의 메타데이터입니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

ConsoleNotificationSpec은 원하는 콘솔 알림 구성입니다.

5.1.1. .spec

설명
ConsoleNotificationSpec은 원하는 콘솔 알림 구성입니다.
유형
object
필수 항목
  • text
Expand
속성유형설명

backgroundColor

string

background Cryostat는 CSS 데이터 유형 색상으로 알림의 배경색입니다.

color

string

색상은 CSS 데이터 유형 색상으로 알림에 대한 텍스트의 색상입니다.

link

object

Link는 알림 링크 세부 정보를 보유하는 오브젝트입니다.

위치

string

location은 콘솔에 있는 알림의 위치입니다. 유효한 값은 "BannerTop", "BannerBottom", "BannerTopBottom"입니다.

text

string

텍스트는 알림의 표시 텍스트입니다.

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

Expand
표 5.1. 글로벌 쿼리 매개변수
매개변수유형설명

string

'true'인 경우 출력이 상당히 인쇄됩니다.

HTTP 방법
DELETE
설명
ConsoleNotification의 컬렉션 삭제
Expand
표 5.2. 쿼리 매개변수
매개변수유형설명

allowWatchBookmarks

boolean

AllowWatchkeygenmarks는 "BOOKMARK" 유형의 감시 이벤트를 요청합니다. 북마크를 구현하지 않는 서버는 이 플래그를 무시하고 북마크는 서버의 재량에 따라 전송됩니다. 클라이언트는 특정 간격으로 북마크가 반환된다고 가정해서는 안되며, 세션 중에 서버가 BOOKMARK 이벤트를 전송한다고 가정할 수도 있습니다. 시계가 아닌 경우 이 필드는 무시됩니다.

계속

string

서버에서 더 많은 결과를 검색할 때 continue 옵션을 설정해야 합니다. 이 값은 서버 정의이므로 클라이언트는 동일한 쿼리 매개변수가 있는 이전 쿼리 결과의 continue 값만 사용할 수 있으며(계속 값 제외) 서버는 인식할 수 없는 계속 값을 거부할 수 있습니다. 지정된 continue 값이 만료(일반적으로 5~15분) 또는 서버의 구성 변경으로 인해 지정된 continue 값이 더 이상 유효하지 않으면 서버는 계속 토큰과 함께 410 ResourceExpired 오류로 응답합니다. 클라이언트에 일관된 목록이 필요한 경우 continue 필드 없이 목록을 다시 시작해야 합니다. 그렇지 않으면 클라이언트는 410 오류와 함께 수신된 토큰을 사용하여 다른 목록 요청을 보낼 수 있으며, 서버는 다음 키에서 시작하여 목록으로 응답할 수 있지만 최신 스냅샷에서 생성된 오브젝트는 첫 번째 목록 요청이 "다음 키" 뒤에 포함된 후 생성, 수정 또는 삭제된 오브젝트입니다.

watch가 true인 경우 이 필드는 지원되지 않습니다. 클라이언트는 서버에서 반환한 마지막 resourceVersion 값에서 감시를 시작할 수 있으며 수정 사항을 누락하지 않을 수 있습니다.

fieldSelector

string

반환된 오브젝트 목록을 해당 필드로 제한하는 선택기입니다. 기본값은 모든 것입니다.

labelSelector

string

라벨을 통해 반환된 오브젝트 목록을 제한하는 선택기입니다. 기본값은 모든 것입니다.

limit

integer

제한은 목록 호출에 대해 반환할 최대 응답 수입니다. 더 많은 항목이 있는 경우 서버는 목록 메타데이터의 continue 필드를 동일한 초기 쿼리와 함께 사용하여 다음 결과 집합을 검색할 수 있는 값으로 설정합니다. 제한을 설정하면 모든 요청된 오브젝트가 필터링되는 경우 요청된 양의 항목(최대 0 항목)보다 적은 수를 반환하고 클라이언트는 continue 필드의 존재만 사용하여 더 많은 결과를 사용할 수 있는지 확인해야 합니다. 서버는 limit 인수를 지원하지 않도록 선택할 수 있으며 사용 가능한 모든 결과를 반환합니다. 제한이 지정되고 continue 필드가 비어 있으면 클라이언트는 더 이상 결과를 사용할 수 없다고 가정할 수 있습니다. watch가 true인 경우 이 필드는 지원되지 않습니다.

이 서버는 를 사용할 때 반환된 개체는 제한 없이 단일 목록 호출을 발행하는 것과 동일하며, 첫 번째 요청이 발행된 후 첫 번째 요청이 후속 계속되는 요청에 포함되지 않음을 보장합니다. 이를 일관된 스냅샷이라고 하며 제한을 사용하여 매우 큰 결과의 청크를 수신하는 클라이언트에서 가능한 모든 오브젝트를 확인할 수 있도록 합니다. 청크된 목록 중에 오브젝트가 업데이트되면 첫 번째 목록 결과가 계산될 때 존재하는 오브젝트 버전이 반환됩니다.

resourceVersion

string

resourceVersion은 요청이 제공할 수 있는 리소스 버전에 대한 제약 조건을 설정합니다. 자세한 내용은 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 을 참조하십시오.

기본값이 설정되지 않음

resourceVersionMatch

string

resourceVersionMatch는 resourceVersion이 호출 목록에 적용되는 방식을 결정합니다. 자세한 내용은 resourceVersion이 설정된 목록 호출에 대해 resourceVersionMatch를 설정하는 것이 좋습니다. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

기본값이 설정되지 않음

sendInitialEvents

boolean

sendInitialEvents=truewatch=true 와 함께 설정할 수 있습니다. 이 경우 감시 스트림은 합성 이벤트로 시작하여 컬렉션에 있는 개체의 현재 상태를 생성합니다. 이러한 모든 이벤트가 전송되면 합성 " emailmark" 이벤트가 전송됩니다. 북마크는 오브젝트 세트에 해당하는 ResourceVersion(RV)을 보고하고 "k8s.io/initial-events-end": "true" 주석으로 표시됩니다. 이후 감시 스트림은 정상적으로 진행되어 모니터링되는 오브젝트에 변경(RV에 제출)에 해당하는 감시 이벤트를 보냅니다.

sendInitialEvents 옵션을 설정할 때 resourceVersionMatch 옵션도 설정해야 합니다. 감시 요청의 의미 체계는 다음과 같습니다. - resourceVersionMatch = NotOlderThan은 "제공된 resourceVersion'만큼 새로운 데이터로 해석되며 북마크 이벤트는 상태가 'resourceVersion에 동기화될 때 적어도 ListOptions에서 제공하는 것과 같이 새로운 것으로 전송됩니다. resourceVersion 이 설정되지 않은 경우, 이는 "consistent read"로 해석되고, 요청이 처리되기 시작할 때 상태가 최소한 현재와 동기화될 때 북마크 이벤트는 전송됩니다. - resourceVersionMatch 가 다른 값으로 설정되거나 설정되지 않은 오류를 반환합니다.

resourceVersion="" 또는 resourceVersion="0"( 이전의 호환성 이유로) 및 false인 경우 기본값은 true입니다.

timeoutSeconds

integer

list/watch 호출의 시간 초과입니다. 이렇게 하면 활동 또는 비활성 여부에 관계없이 호출 기간이 제한됩니다.

watch

boolean

설명된 리소스에 대한 변경 사항을 조사하고 알림 추가, 업데이트 및 제거 스트림으로 반환합니다. resourceVersion을 지정합니다.

Expand
표 5.3. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

401 - 무단

HTTP 방법
GET
설명
ConsoleNotification 유형의 오브젝트 나열
Expand
표 5.4. 쿼리 매개변수
매개변수유형설명

allowWatchBookmarks

boolean

AllowWatchkeygenmarks는 "BOOKMARK" 유형의 감시 이벤트를 요청합니다. 북마크를 구현하지 않는 서버는 이 플래그를 무시하고 북마크는 서버의 재량에 따라 전송됩니다. 클라이언트는 특정 간격으로 북마크가 반환된다고 가정해서는 안되며, 세션 중에 서버가 BOOKMARK 이벤트를 전송한다고 가정할 수도 있습니다. 시계가 아닌 경우 이 필드는 무시됩니다.

계속

string

서버에서 더 많은 결과를 검색할 때 continue 옵션을 설정해야 합니다. 이 값은 서버 정의이므로 클라이언트는 동일한 쿼리 매개변수가 있는 이전 쿼리 결과의 continue 값만 사용할 수 있으며(계속 값 제외) 서버는 인식할 수 없는 계속 값을 거부할 수 있습니다. 지정된 continue 값이 만료(일반적으로 5~15분) 또는 서버의 구성 변경으로 인해 지정된 continue 값이 더 이상 유효하지 않으면 서버는 계속 토큰과 함께 410 ResourceExpired 오류로 응답합니다. 클라이언트에 일관된 목록이 필요한 경우 continue 필드 없이 목록을 다시 시작해야 합니다. 그렇지 않으면 클라이언트는 410 오류와 함께 수신된 토큰을 사용하여 다른 목록 요청을 보낼 수 있으며, 서버는 다음 키에서 시작하여 목록으로 응답할 수 있지만 최신 스냅샷에서 생성된 오브젝트는 첫 번째 목록 요청이 "다음 키" 뒤에 포함된 후 생성, 수정 또는 삭제된 오브젝트입니다.

watch가 true인 경우 이 필드는 지원되지 않습니다. 클라이언트는 서버에서 반환한 마지막 resourceVersion 값에서 감시를 시작할 수 있으며 수정 사항을 누락하지 않을 수 있습니다.

fieldSelector

string

반환된 오브젝트 목록을 해당 필드로 제한하는 선택기입니다. 기본값은 모든 것입니다.

labelSelector

string

라벨을 통해 반환된 오브젝트 목록을 제한하는 선택기입니다. 기본값은 모든 것입니다.

limit

integer

제한은 목록 호출에 대해 반환할 최대 응답 수입니다. 더 많은 항목이 있는 경우 서버는 목록 메타데이터의 continue 필드를 동일한 초기 쿼리와 함께 사용하여 다음 결과 집합을 검색할 수 있는 값으로 설정합니다. 제한을 설정하면 모든 요청된 오브젝트가 필터링되는 경우 요청된 양의 항목(최대 0 항목)보다 적은 수를 반환하고 클라이언트는 continue 필드의 존재만 사용하여 더 많은 결과를 사용할 수 있는지 확인해야 합니다. 서버는 limit 인수를 지원하지 않도록 선택할 수 있으며 사용 가능한 모든 결과를 반환합니다. 제한이 지정되고 continue 필드가 비어 있으면 클라이언트는 더 이상 결과를 사용할 수 없다고 가정할 수 있습니다. watch가 true인 경우 이 필드는 지원되지 않습니다.

이 서버는 를 사용할 때 반환된 개체는 제한 없이 단일 목록 호출을 발행하는 것과 동일하며, 첫 번째 요청이 발행된 후 첫 번째 요청이 후속 계속되는 요청에 포함되지 않음을 보장합니다. 이를 일관된 스냅샷이라고 하며 제한을 사용하여 매우 큰 결과의 청크를 수신하는 클라이언트에서 가능한 모든 오브젝트를 확인할 수 있도록 합니다. 청크된 목록 중에 오브젝트가 업데이트되면 첫 번째 목록 결과가 계산될 때 존재하는 오브젝트 버전이 반환됩니다.

resourceVersion

string

resourceVersion은 요청이 제공할 수 있는 리소스 버전에 대한 제약 조건을 설정합니다. 자세한 내용은 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 을 참조하십시오.

기본값이 설정되지 않음

resourceVersionMatch

string

resourceVersionMatch는 resourceVersion이 호출 목록에 적용되는 방식을 결정합니다. 자세한 내용은 resourceVersion이 설정된 목록 호출에 대해 resourceVersionMatch를 설정하는 것이 좋습니다. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

기본값이 설정되지 않음

sendInitialEvents

boolean

sendInitialEvents=truewatch=true 와 함께 설정할 수 있습니다. 이 경우 감시 스트림은 합성 이벤트로 시작하여 컬렉션에 있는 개체의 현재 상태를 생성합니다. 이러한 모든 이벤트가 전송되면 합성 " emailmark" 이벤트가 전송됩니다. 북마크는 오브젝트 세트에 해당하는 ResourceVersion(RV)을 보고하고 "k8s.io/initial-events-end": "true" 주석으로 표시됩니다. 이후 감시 스트림은 정상적으로 진행되어 모니터링되는 오브젝트에 변경(RV에 제출)에 해당하는 감시 이벤트를 보냅니다.

sendInitialEvents 옵션을 설정할 때 resourceVersionMatch 옵션도 설정해야 합니다. 감시 요청의 의미 체계는 다음과 같습니다. - resourceVersionMatch = NotOlderThan은 "제공된 resourceVersion'만큼 새로운 데이터로 해석되며 북마크 이벤트는 상태가 'resourceVersion에 동기화될 때 적어도 ListOptions에서 제공하는 것과 같이 새로운 것으로 전송됩니다. resourceVersion 이 설정되지 않은 경우, 이는 "consistent read"로 해석되고, 요청이 처리되기 시작할 때 상태가 최소한 현재와 동기화될 때 북마크 이벤트는 전송됩니다. - resourceVersionMatch 가 다른 값으로 설정되거나 설정되지 않은 오류를 반환합니다.

resourceVersion="" 또는 resourceVersion="0"( 이전의 호환성 이유로) 및 false인 경우 기본값은 true입니다.

timeoutSeconds

integer

list/watch 호출의 시간 초과입니다. 이렇게 하면 활동 또는 비활성 여부에 관계없이 호출 기간이 제한됩니다.

watch

boolean

설명된 리소스에 대한 변경 사항을 조사하고 알림 추가, 업데이트 및 제거 스트림으로 반환합니다. resourceVersion을 지정합니다.

Expand
표 5.5. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ConsoleNotificationList 스키마

401 - 무단

HTTP 방법
POST
설명
ConsoleNotification 생성
Expand
표 5.6. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldManager

string

Fieldmanager는 이러한 변경을 수행하는 작업자 또는 엔티티와 연결된 이름입니다. 값은 https://golang.org/pkg/unicode/#IsPrint 에서 정의한 대로 인쇄 가능한 문자만 포함하거나 128자 미만이어야 합니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 5.7. 본문 매개변수
매개변수유형설명

body

ConsoleNotification 스키마

 
Expand
표 5.8. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ConsoleNotification 스키마

201 - 생성됨

ConsoleNotification 스키마

202 - 승인됨

ConsoleNotification 스키마

401 - 무단

5.2.2. /apis/console.openshift.io/v1/consolenotifications/{name}

Expand
표 5.9. 글로벌 경로 매개변수
매개변수유형설명

name

string

ConsoleNotification의 이름

Expand
표 5.10. 글로벌 쿼리 매개변수
매개변수유형설명

string

'true'인 경우 출력이 상당히 인쇄됩니다.

HTTP 방법
DELETE
설명
ConsoleNotification 삭제
Expand
표 5.11. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

gracePeriodSeconds

integer

오브젝트를 삭제하기 전의 기간(초)입니다. 값은 음수가 아닌 정수여야 합니다. 값 0은 즉시 삭제됨을 나타냅니다. 이 값이 nil이면 지정된 유형의 기본 유예 기간이 사용됩니다. 지정하지 않으면 오브젝트당 기본값은 기본값입니다. 0은 즉시 삭제됨을 의미합니다.

orphanDependents

boolean

더 이상 사용되지 않음: PropagationPolicy를 사용하십시오. 이 필드는 1.7에서 더 이상 사용되지 않습니다. 종속 오브젝트를 분리해야 합니다. true/false인 경우 "orphan" 종료자가 오브젝트의 종료자 목록에 추가/제거됩니다. 이 필드 또는 PropagationPolicy는 설정할 수 있지만 둘 다 설정할 수는 없습니다.

propagationPolicy

string

가비지 컬렉션이 수행되는지 여부 및 방법. 이 필드 또는 OrphanDependents는 설정할 수 있지만 둘 다 설정할 수는 없습니다. 기본 정책은 metadata.finalizers에 설정된 기존 종료자 및 리소스별 기본 정책에 의해 결정됩니다. 허용 가능한 값은 다음과 같습니다. 'Orphan' - 종속 항목을 분리합니다. 'Back place' - 가비지 수집기에서 백그라운드에서 종속 항목을 삭제할 수 있습니다. 'Forefield' - 전경에서 모든 종속 항목을 삭제하는 계단식 정책입니다.

Expand
표 5.12. 본문 매개변수
매개변수유형설명

body

DeleteOptions 스키마

 
Expand
표 5.13. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

202 - 승인됨

상태 스키마

401 - 무단

HTTP 방법
GET
설명
지정된 ConsoleNotification 읽기
Expand
표 5.14. 쿼리 매개변수
매개변수유형설명

resourceVersion

string

resourceVersion은 요청이 제공할 수 있는 리소스 버전에 대한 제약 조건을 설정합니다. 자세한 내용은 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 을 참조하십시오.

기본값이 설정되지 않음

Expand
표 5.15. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ConsoleNotification 스키마

401 - 무단

HTTP 방법
PATCH
설명
지정된 ConsoleNotification을 부분적으로 업데이트
Expand
표 5.16. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldManager

string

Fieldmanager는 이러한 변경을 수행하는 작업자 또는 엔티티와 연결된 이름입니다. 값은 https://golang.org/pkg/unicode/#IsPrint 에서 정의한 대로 인쇄 가능한 문자만 포함하거나 128자 미만이어야 합니다. 이 필드는 적용 요청(application/apply-patch)에 필요하지만 적용되지 않는 패치 유형(JsonPatch, CryostatPatch, strategicMergePatch)의 경우 선택 사항입니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

force

boolean

강제 적용 요청을 "적용"합니다. 즉, 사용자는 다른 사용자가 소유한 충돌하는 필드를 다시 수집해야 합니다. 강제 플래그는 적용되지 않은 패치 요청에 대해 설정되지 않아야 합니다.

Expand
표 5.17. 본문 매개변수
매개변수유형설명

body

패치 스키마

 
Expand
표 5.18. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ConsoleNotification 스키마

401 - 무단

HTTP 방법
PUT
설명
지정된 ConsoleNotification을 교체
Expand
표 5.19. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldManager

string

Fieldmanager는 이러한 변경을 수행하는 작업자 또는 엔티티와 연결된 이름입니다. 값은 https://golang.org/pkg/unicode/#IsPrint 에서 정의한 대로 인쇄 가능한 문자만 포함하거나 128자 미만이어야 합니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 5.20. 본문 매개변수
매개변수유형설명

body

ConsoleNotification 스키마

 
Expand
표 5.21. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ConsoleNotification 스키마

201 - 생성됨

ConsoleNotification 스키마

401 - 무단

5.2.3. /apis/console.openshift.io/v1/consolenotifications/{name}/status

Expand
표 5.22. 글로벌 경로 매개변수
매개변수유형설명

name

string

ConsoleNotification의 이름

Expand
표 5.23. 글로벌 쿼리 매개변수
매개변수유형설명

string

'true'인 경우 출력이 상당히 인쇄됩니다.

HTTP 방법
GET
설명
지정된 ConsoleNotification의 상태 확인
Expand
표 5.24. 쿼리 매개변수
매개변수유형설명

resourceVersion

string

resourceVersion은 요청이 제공할 수 있는 리소스 버전에 대한 제약 조건을 설정합니다. 자세한 내용은 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 을 참조하십시오.

기본값이 설정되지 않음

Expand
표 5.25. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ConsoleNotification 스키마

401 - 무단

HTTP 방법
PATCH
설명
지정된 ConsoleNotification의 부분 업데이트 상태
Expand
표 5.26. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldManager

string

Fieldmanager는 이러한 변경을 수행하는 작업자 또는 엔티티와 연결된 이름입니다. 값은 https://golang.org/pkg/unicode/#IsPrint 에서 정의한 대로 인쇄 가능한 문자만 포함하거나 128자 미만이어야 합니다. 이 필드는 적용 요청(application/apply-patch)에 필요하지만 적용되지 않는 패치 유형(JsonPatch, CryostatPatch, strategicMergePatch)의 경우 선택 사항입니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

force

boolean

강제 적용 요청을 "적용"합니다. 즉, 사용자는 다른 사용자가 소유한 충돌하는 필드를 다시 수집해야 합니다. 강제 플래그는 적용되지 않은 패치 요청에 대해 설정되지 않아야 합니다.

Expand
표 5.27. 본문 매개변수
매개변수유형설명

body

패치 스키마

 
Expand
표 5.28. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ConsoleNotification 스키마

401 - 무단

HTTP 방법
PUT
설명
지정된 ConsoleNotification의 상태 교체
Expand
표 5.29. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldManager

string

Fieldmanager는 이러한 변경을 수행하는 작업자 또는 엔티티와 연결된 이름입니다. 값은 https://golang.org/pkg/unicode/#IsPrint 에서 정의한 대로 인쇄 가능한 문자만 포함하거나 128자 미만이어야 합니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 5.30. 본문 매개변수
매개변수유형설명

body

ConsoleNotification 스키마

 
Expand
표 5.31. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ConsoleNotification 스키마

201 - 생성됨

ConsoleNotification 스키마

401 - 무단

6장. ConsolePlugin [console.openshift.io/v1]

설명
ConsolePlugin은 클러스터에서 실행되는 다른 서비스에서 코드를 동적으로 로드하여 OpenShift 웹 콘솔을 사용자 정의하는 확장 프로그램입니다. 호환성 수준 1: 최소 12 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 주요 릴리스 내에서 사용할 수 있습니다.
유형
object
필수 항목
  • 메타데이터
  • spec

6.1. 사양

Expand
속성유형설명

apiVersion

string

APIVersion은 버전이 지정된 이 오브젝트 표현의 스키마를 정의합니다. 서버는 인식된 스키마를 최신 내부 값으로 변환해야 하며, 인식되지 않는 값을 거부할 수 있습니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

kind는 이 오브젝트가 나타내는 REST 리소스에 해당하는 문자열 값입니다. 서버는 클라이언트에서 요청을 제출한 끝점에서 이를 유추할 수 있습니다. CamelCase로 업데이트할 수 없습니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

메타데이터

ObjectMeta

표준 오브젝트의 메타데이터입니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

ConsolePluginSpec은 원하는 플러그인 구성입니다.

6.1.1. .spec

설명
ConsolePluginSpec은 원하는 플러그인 구성입니다.
유형
object
필수 항목
  • 백엔드
  • displayName
Expand
속성유형설명

백엔드

object

백엔드에는 콘솔의 플러그인을 제공하는 백엔드 구성이 있습니다.

displayName

string

displayName은 플러그인의 표시 이름입니다. dispalyName은 1~128자 사이여야 합니다.

i18n

object

i18n은 플러그인의 현지화 리소스의 구성입니다.

proxy

array

proxy는 플러그인이 연결해야 하는 다양한 서비스 유형을 설명하는 프록시 목록입니다.

proxy[]

object

ConsolePluginProxy는 콘솔의 백엔드가 플러그인의 요청을 프록시하는 다양한 서비스 유형에 대한 정보를 보유합니다.

6.1.2. .spec.backend

설명
백엔드에는 콘솔의 플러그인을 제공하는 백엔드 구성이 있습니다.
유형
object
필수 항목
  • type
Expand
속성유형설명

서비스

object

서비스는 HTTP 서버와의 배포를 사용하여 플러그인을 노출하는 Kubernetes 서비스입니다. 서비스는 HTTPS 및 서비스 제공 인증서를 사용해야 합니다. 콘솔 백엔드는 서비스 CA 번들을 사용하여 서비스에서 플러그인 자산을 프록시합니다.

type

string

type은 콘솔의 플러그인에 있는 서버의 백엔드 유형입니다. 현재 "서비스"만 지원됩니다. ---

6.1.3. .spec.backend.service

설명
서비스는 HTTP 서버와의 배포를 사용하여 플러그인을 노출하는 Kubernetes 서비스입니다. 서비스는 HTTPS 및 서비스 제공 인증서를 사용해야 합니다. 콘솔 백엔드는 서비스 CA 번들을 사용하여 서비스에서 플러그인 자산을 프록시합니다.
유형
object
필수 항목
  • name
  • 네임스페이스
  • port
Expand
속성유형설명

basePath

string

basePath는 플러그인 자산의 경로입니다. 주요 자산은 플러그인 및 확장에 대한 메타데이터가 포함된 JSON 문서인 plugin-manifest.json 이라는 매니페스트 파일입니다.

name

string

플러그인 자산을 제공하는 서비스 이름입니다.

네임스페이스

string

플러그인 자산을 제공하는 서비스의 네임스페이스입니다.

port

integer

플러그인을 제공하는 서비스가 수신 대기하는 포트입니다.

6.1.4. .spec.i18n

설명
i18n은 플러그인의 현지화 리소스의 구성입니다.
유형
object
필수 항목
  • loadType
Expand
속성유형설명

loadType

string

loadType은 플러그인의 로컬라이제이션 리소스를 로드하는 방법을 나타냅니다. 유효한 값은 Preload, Lazy 및 빈 문자열입니다. Preload로 설정하면 플러그인이 로드될 때 모든 로컬라이제이션 리소스를 가져옵니다. Lazy로 설정하면 현지화 리소스가 콘솔에 필요한 대로 로드됩니다. 생략하거나 빈 문자열로 설정하면 동작은 Lazy 유형과 동일합니다.

6.1.5. .spec.proxy

설명
proxy는 플러그인이 연결해야 하는 다양한 서비스 유형을 설명하는 프록시 목록입니다.
유형
array

6.1.6. .spec.proxy[]

설명
ConsolePluginProxy는 콘솔의 백엔드가 플러그인의 요청을 프록시하는 다양한 서비스 유형에 대한 정보를 보유합니다.
유형
object
필수 항목
  • 별칭
  • endpoint
Expand
속성유형설명

별칭

string

alias는 플러그인의 프록시를 식별하는 프록시 이름입니다. 별칭 이름은 플러그인당 고유해야 합니다. 콘솔 백엔드는 프록시 끝점에 따라 노출됩니다. /api/proxy/plugin/<plugin-name>/<proxy-alias>/<request-path>?<optional-query-parameters> 요청 예 경로: /api/proxy/plugin/acm/search/pods?namespace=openshift-apiserver

권한 부여

string

권한 부여는 프록시 요청이 포함되어야 하는 권한 부여 유형에 대한 정보를 제공합니다.

caCertificate

string

caCertificate는 프록시 서비스에서 사용자 정의 서비스 CA를 사용하는 경우 인증 기관 인증서 콘텐츠를 제공합니다. 기본적으로 service-ca Operator에서 제공하는 서비스 CA 번들이 사용됩니다.

endpoint

object

엔드포인트는 요청이 프록시되는 끝점에 대한 정보를 제공합니다.

6.1.7. .spec.proxy[].endpoint

설명
엔드포인트는 요청이 프록시되는 끝점에 대한 정보를 제공합니다.
유형
object
필수 항목
  • type
Expand
속성유형설명

서비스

object

서비스는 플러그인이 연결할 클러스터 내 서비스입니다. 서비스는 HTTPS를 사용해야 합니다. 콘솔 백엔드는 플러그인과 서비스 간의 통신을 프록시하기 위해 끝점을 노출합니다. 참고: 현재 "Service" 유형만 지원되므로 현재 service 필드가 필요합니다.

type

string

type은 콘솔 플러그인의 프록시 유형입니다. 현재 "서비스"만 지원됩니다. ---

6.1.8. .spec.proxy[].endpoint.service

설명
서비스는 플러그인이 연결할 클러스터 내 서비스입니다. 서비스는 HTTPS를 사용해야 합니다. 콘솔 백엔드는 플러그인과 서비스 간의 통신을 프록시하기 위해 끝점을 노출합니다. 참고: 현재 "Service" 유형만 지원되므로 현재 service 필드가 필요합니다.
유형
object
필수 항목
  • name
  • 네임스페이스
  • port
Expand
속성유형설명

name

string

플러그인에 연결해야 하는 서비스 이름입니다.

네임스페이스

string

플러그인이 연결해야 하는 서비스의 네임스페이스

port

integer

플러그인이 연결해야 하는 서비스가 수신 대기 중인 포트입니다.

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

Expand
표 6.1. 글로벌 쿼리 매개변수
매개변수유형설명

string

'true'인 경우 출력이 상당히 인쇄됩니다.

HTTP 방법
DELETE
설명
ConsolePlugin 컬렉션 삭제
Expand
표 6.2. 쿼리 매개변수
매개변수유형설명

allowWatchBookmarks

boolean

AllowWatchkeygenmarks는 "BOOKMARK" 유형의 감시 이벤트를 요청합니다. 북마크를 구현하지 않는 서버는 이 플래그를 무시하고 북마크는 서버의 재량에 따라 전송됩니다. 클라이언트는 특정 간격으로 북마크가 반환된다고 가정해서는 안되며, 세션 중에 서버가 BOOKMARK 이벤트를 전송한다고 가정할 수도 있습니다. 시계가 아닌 경우 이 필드는 무시됩니다.

계속

string

서버에서 더 많은 결과를 검색할 때 continue 옵션을 설정해야 합니다. 이 값은 서버 정의이므로 클라이언트는 동일한 쿼리 매개변수가 있는 이전 쿼리 결과의 continue 값만 사용할 수 있으며(계속 값 제외) 서버는 인식할 수 없는 계속 값을 거부할 수 있습니다. 지정된 continue 값이 만료(일반적으로 5~15분) 또는 서버의 구성 변경으로 인해 지정된 continue 값이 더 이상 유효하지 않으면 서버는 계속 토큰과 함께 410 ResourceExpired 오류로 응답합니다. 클라이언트에 일관된 목록이 필요한 경우 continue 필드 없이 목록을 다시 시작해야 합니다. 그렇지 않으면 클라이언트는 410 오류와 함께 수신된 토큰을 사용하여 다른 목록 요청을 보낼 수 있으며, 서버는 다음 키에서 시작하여 목록으로 응답할 수 있지만 최신 스냅샷에서 생성된 오브젝트는 첫 번째 목록 요청이 "다음 키" 뒤에 포함된 후 생성, 수정 또는 삭제된 오브젝트입니다.

watch가 true인 경우 이 필드는 지원되지 않습니다. 클라이언트는 서버에서 반환한 마지막 resourceVersion 값에서 감시를 시작할 수 있으며 수정 사항을 누락하지 않을 수 있습니다.

fieldSelector

string

반환된 오브젝트 목록을 해당 필드로 제한하는 선택기입니다. 기본값은 모든 것입니다.

labelSelector

string

라벨을 통해 반환된 오브젝트 목록을 제한하는 선택기입니다. 기본값은 모든 것입니다.

limit

integer

제한은 목록 호출에 대해 반환할 최대 응답 수입니다. 더 많은 항목이 있는 경우 서버는 목록 메타데이터의 continue 필드를 동일한 초기 쿼리와 함께 사용하여 다음 결과 집합을 검색할 수 있는 값으로 설정합니다. 제한을 설정하면 모든 요청된 오브젝트가 필터링되는 경우 요청된 양의 항목(최대 0 항목)보다 적은 수를 반환하고 클라이언트는 continue 필드의 존재만 사용하여 더 많은 결과를 사용할 수 있는지 확인해야 합니다. 서버는 limit 인수를 지원하지 않도록 선택할 수 있으며 사용 가능한 모든 결과를 반환합니다. 제한이 지정되고 continue 필드가 비어 있으면 클라이언트는 더 이상 결과를 사용할 수 없다고 가정할 수 있습니다. watch가 true인 경우 이 필드는 지원되지 않습니다.

이 서버는 를 사용할 때 반환된 개체는 제한 없이 단일 목록 호출을 발행하는 것과 동일하며, 첫 번째 요청이 발행된 후 첫 번째 요청이 후속 계속되는 요청에 포함되지 않음을 보장합니다. 이를 일관된 스냅샷이라고 하며 제한을 사용하여 매우 큰 결과의 청크를 수신하는 클라이언트에서 가능한 모든 오브젝트를 확인할 수 있도록 합니다. 청크된 목록 중에 오브젝트가 업데이트되면 첫 번째 목록 결과가 계산될 때 존재하는 오브젝트 버전이 반환됩니다.

resourceVersion

string

resourceVersion은 요청이 제공할 수 있는 리소스 버전에 대한 제약 조건을 설정합니다. 자세한 내용은 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 을 참조하십시오.

기본값이 설정되지 않음

resourceVersionMatch

string

resourceVersionMatch는 resourceVersion이 호출 목록에 적용되는 방식을 결정합니다. 자세한 내용은 resourceVersion이 설정된 목록 호출에 대해 resourceVersionMatch를 설정하는 것이 좋습니다. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

기본값이 설정되지 않음

sendInitialEvents

boolean

sendInitialEvents=truewatch=true 와 함께 설정할 수 있습니다. 이 경우 감시 스트림은 합성 이벤트로 시작하여 컬렉션에 있는 개체의 현재 상태를 생성합니다. 이러한 모든 이벤트가 전송되면 합성 " emailmark" 이벤트가 전송됩니다. 북마크는 오브젝트 세트에 해당하는 ResourceVersion(RV)을 보고하고 "k8s.io/initial-events-end": "true" 주석으로 표시됩니다. 이후 감시 스트림은 정상적으로 진행되어 모니터링되는 오브젝트에 변경(RV에 제출)에 해당하는 감시 이벤트를 보냅니다.

sendInitialEvents 옵션을 설정할 때 resourceVersionMatch 옵션도 설정해야 합니다. 감시 요청의 의미 체계는 다음과 같습니다. - resourceVersionMatch = NotOlderThan은 "제공된 resourceVersion'만큼 새로운 데이터로 해석되며 북마크 이벤트는 상태가 'resourceVersion에 동기화될 때 적어도 ListOptions에서 제공하는 것과 같이 새로운 것으로 전송됩니다. resourceVersion 이 설정되지 않은 경우, 이는 "consistent read"로 해석되고, 요청이 처리되기 시작할 때 상태가 최소한 현재와 동기화될 때 북마크 이벤트는 전송됩니다. - resourceVersionMatch 가 다른 값으로 설정되거나 설정되지 않은 오류를 반환합니다.

resourceVersion="" 또는 resourceVersion="0"( 이전의 호환성 이유로) 및 false인 경우 기본값은 true입니다.

timeoutSeconds

integer

list/watch 호출의 시간 초과입니다. 이렇게 하면 활동 또는 비활성 여부에 관계없이 호출 기간이 제한됩니다.

watch

boolean

설명된 리소스에 대한 변경 사항을 조사하고 알림 추가, 업데이트 및 제거 스트림으로 반환합니다. resourceVersion을 지정합니다.

Expand
표 6.3. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

401 - 무단

HTTP 방법
GET
설명
ConsolePlugin 유형의 오브젝트 나열
Expand
표 6.4. 쿼리 매개변수
매개변수유형설명

allowWatchBookmarks

boolean

AllowWatchkeygenmarks는 "BOOKMARK" 유형의 감시 이벤트를 요청합니다. 북마크를 구현하지 않는 서버는 이 플래그를 무시하고 북마크는 서버의 재량에 따라 전송됩니다. 클라이언트는 특정 간격으로 북마크가 반환된다고 가정해서는 안되며, 세션 중에 서버가 BOOKMARK 이벤트를 전송한다고 가정할 수도 있습니다. 시계가 아닌 경우 이 필드는 무시됩니다.

계속

string

서버에서 더 많은 결과를 검색할 때 continue 옵션을 설정해야 합니다. 이 값은 서버 정의이므로 클라이언트는 동일한 쿼리 매개변수가 있는 이전 쿼리 결과의 continue 값만 사용할 수 있으며(계속 값 제외) 서버는 인식할 수 없는 계속 값을 거부할 수 있습니다. 지정된 continue 값이 만료(일반적으로 5~15분) 또는 서버의 구성 변경으로 인해 지정된 continue 값이 더 이상 유효하지 않으면 서버는 계속 토큰과 함께 410 ResourceExpired 오류로 응답합니다. 클라이언트에 일관된 목록이 필요한 경우 continue 필드 없이 목록을 다시 시작해야 합니다. 그렇지 않으면 클라이언트는 410 오류와 함께 수신된 토큰을 사용하여 다른 목록 요청을 보낼 수 있으며, 서버는 다음 키에서 시작하여 목록으로 응답할 수 있지만 최신 스냅샷에서 생성된 오브젝트는 첫 번째 목록 요청이 "다음 키" 뒤에 포함된 후 생성, 수정 또는 삭제된 오브젝트입니다.

watch가 true인 경우 이 필드는 지원되지 않습니다. 클라이언트는 서버에서 반환한 마지막 resourceVersion 값에서 감시를 시작할 수 있으며 수정 사항을 누락하지 않을 수 있습니다.

fieldSelector

string

반환된 오브젝트 목록을 해당 필드로 제한하는 선택기입니다. 기본값은 모든 것입니다.

labelSelector

string

라벨을 통해 반환된 오브젝트 목록을 제한하는 선택기입니다. 기본값은 모든 것입니다.

limit

integer

제한은 목록 호출에 대해 반환할 최대 응답 수입니다. 더 많은 항목이 있는 경우 서버는 목록 메타데이터의 continue 필드를 동일한 초기 쿼리와 함께 사용하여 다음 결과 집합을 검색할 수 있는 값으로 설정합니다. 제한을 설정하면 모든 요청된 오브젝트가 필터링되는 경우 요청된 양의 항목(최대 0 항목)보다 적은 수를 반환하고 클라이언트는 continue 필드의 존재만 사용하여 더 많은 결과를 사용할 수 있는지 확인해야 합니다. 서버는 limit 인수를 지원하지 않도록 선택할 수 있으며 사용 가능한 모든 결과를 반환합니다. 제한이 지정되고 continue 필드가 비어 있으면 클라이언트는 더 이상 결과를 사용할 수 없다고 가정할 수 있습니다. watch가 true인 경우 이 필드는 지원되지 않습니다.

이 서버는 를 사용할 때 반환된 개체는 제한 없이 단일 목록 호출을 발행하는 것과 동일하며, 첫 번째 요청이 발행된 후 첫 번째 요청이 후속 계속되는 요청에 포함되지 않음을 보장합니다. 이를 일관된 스냅샷이라고 하며 제한을 사용하여 매우 큰 결과의 청크를 수신하는 클라이언트에서 가능한 모든 오브젝트를 확인할 수 있도록 합니다. 청크된 목록 중에 오브젝트가 업데이트되면 첫 번째 목록 결과가 계산될 때 존재하는 오브젝트 버전이 반환됩니다.

resourceVersion

string

resourceVersion은 요청이 제공할 수 있는 리소스 버전에 대한 제약 조건을 설정합니다. 자세한 내용은 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 을 참조하십시오.

기본값이 설정되지 않음

resourceVersionMatch

string

resourceVersionMatch는 resourceVersion이 호출 목록에 적용되는 방식을 결정합니다. 자세한 내용은 resourceVersion이 설정된 목록 호출에 대해 resourceVersionMatch를 설정하는 것이 좋습니다. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

기본값이 설정되지 않음

sendInitialEvents

boolean

sendInitialEvents=truewatch=true 와 함께 설정할 수 있습니다. 이 경우 감시 스트림은 합성 이벤트로 시작하여 컬렉션에 있는 개체의 현재 상태를 생성합니다. 이러한 모든 이벤트가 전송되면 합성 " emailmark" 이벤트가 전송됩니다. 북마크는 오브젝트 세트에 해당하는 ResourceVersion(RV)을 보고하고 "k8s.io/initial-events-end": "true" 주석으로 표시됩니다. 이후 감시 스트림은 정상적으로 진행되어 모니터링되는 오브젝트에 변경(RV에 제출)에 해당하는 감시 이벤트를 보냅니다.

sendInitialEvents 옵션을 설정할 때 resourceVersionMatch 옵션도 설정해야 합니다. 감시 요청의 의미 체계는 다음과 같습니다. - resourceVersionMatch = NotOlderThan은 "제공된 resourceVersion'만큼 새로운 데이터로 해석되며 북마크 이벤트는 상태가 'resourceVersion에 동기화될 때 적어도 ListOptions에서 제공하는 것과 같이 새로운 것으로 전송됩니다. resourceVersion 이 설정되지 않은 경우, 이는 "consistent read"로 해석되고, 요청이 처리되기 시작할 때 상태가 최소한 현재와 동기화될 때 북마크 이벤트는 전송됩니다. - resourceVersionMatch 가 다른 값으로 설정되거나 설정되지 않은 오류를 반환합니다.

resourceVersion="" 또는 resourceVersion="0"( 이전의 호환성 이유로) 및 false인 경우 기본값은 true입니다.

timeoutSeconds

integer

list/watch 호출의 시간 초과입니다. 이렇게 하면 활동 또는 비활성 여부에 관계없이 호출 기간이 제한됩니다.

watch

boolean

설명된 리소스에 대한 변경 사항을 조사하고 알림 추가, 업데이트 및 제거 스트림으로 반환합니다. resourceVersion을 지정합니다.

Expand
표 6.5. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ConsolePluginList 스키마

401 - 무단

HTTP 방법
POST
설명
ConsolePlugin 생성
Expand
표 6.6. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldManager

string

Fieldmanager는 이러한 변경을 수행하는 작업자 또는 엔티티와 연결된 이름입니다. 값은 https://golang.org/pkg/unicode/#IsPrint 에서 정의한 대로 인쇄 가능한 문자만 포함하거나 128자 미만이어야 합니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 6.7. 본문 매개변수
매개변수유형설명

body

ConsolePlugin 스키마

 
Expand
표 6.8. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ConsolePlugin 스키마

201 - 생성됨

ConsolePlugin 스키마

202 - 승인됨

ConsolePlugin 스키마

401 - 무단

6.2.2. /apis/console.openshift.io/v1/consoleplugins/{name}

Expand
표 6.9. 글로벌 경로 매개변수
매개변수유형설명

name

string

ConsolePlugin의 이름

Expand
표 6.10. 글로벌 쿼리 매개변수
매개변수유형설명

string

'true'인 경우 출력이 상당히 인쇄됩니다.

HTTP 방법
DELETE
설명
ConsolePlugin 삭제
Expand
표 6.11. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

gracePeriodSeconds

integer

오브젝트를 삭제하기 전의 기간(초)입니다. 값은 음수가 아닌 정수여야 합니다. 값 0은 즉시 삭제됨을 나타냅니다. 이 값이 nil이면 지정된 유형의 기본 유예 기간이 사용됩니다. 지정하지 않으면 오브젝트당 기본값은 기본값입니다. 0은 즉시 삭제됨을 의미합니다.

orphanDependents

boolean

더 이상 사용되지 않음: PropagationPolicy를 사용하십시오. 이 필드는 1.7에서 더 이상 사용되지 않습니다. 종속 오브젝트를 분리해야 합니다. true/false인 경우 "orphan" 종료자가 오브젝트의 종료자 목록에 추가/제거됩니다. 이 필드 또는 PropagationPolicy는 설정할 수 있지만 둘 다 설정할 수는 없습니다.

propagationPolicy

string

가비지 컬렉션이 수행되는지 여부 및 방법. 이 필드 또는 OrphanDependents는 설정할 수 있지만 둘 다 설정할 수는 없습니다. 기본 정책은 metadata.finalizers에 설정된 기존 종료자 및 리소스별 기본 정책에 의해 결정됩니다. 허용 가능한 값은 다음과 같습니다. 'Orphan' - 종속 항목을 분리합니다. 'Back place' - 가비지 수집기에서 백그라운드에서 종속 항목을 삭제할 수 있습니다. 'Forefield' - 전경에서 모든 종속 항목을 삭제하는 계단식 정책입니다.

Expand
표 6.12. 본문 매개변수
매개변수유형설명

body

DeleteOptions 스키마

 
Expand
표 6.13. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

202 - 승인됨

상태 스키마

401 - 무단

HTTP 방법
GET
설명
지정된 ConsolePlugin 읽기
Expand
표 6.14. 쿼리 매개변수
매개변수유형설명

resourceVersion

string

resourceVersion은 요청이 제공할 수 있는 리소스 버전에 대한 제약 조건을 설정합니다. 자세한 내용은 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 을 참조하십시오.

기본값이 설정되지 않음

Expand
표 6.15. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ConsolePlugin 스키마

401 - 무단

HTTP 방법
PATCH
설명
지정된 ConsolePlugin을 부분적으로 업데이트
Expand
표 6.16. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldManager

string

Fieldmanager는 이러한 변경을 수행하는 작업자 또는 엔티티와 연결된 이름입니다. 값은 https://golang.org/pkg/unicode/#IsPrint 에서 정의한 대로 인쇄 가능한 문자만 포함하거나 128자 미만이어야 합니다. 이 필드는 적용 요청(application/apply-patch)에 필요하지만 적용되지 않는 패치 유형(JsonPatch, CryostatPatch, strategicMergePatch)의 경우 선택 사항입니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

force

boolean

강제 적용 요청을 "적용"합니다. 즉, 사용자는 다른 사용자가 소유한 충돌하는 필드를 다시 수집해야 합니다. 강제 플래그는 적용되지 않은 패치 요청에 대해 설정되지 않아야 합니다.

Expand
표 6.17. 본문 매개변수
매개변수유형설명

body

패치 스키마

 
Expand
표 6.18. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ConsolePlugin 스키마

401 - 무단

HTTP 방법
PUT
설명
지정된 ConsolePlugin을 교체
Expand
표 6.19. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldManager

string

Fieldmanager는 이러한 변경을 수행하는 작업자 또는 엔티티와 연결된 이름입니다. 값은 https://golang.org/pkg/unicode/#IsPrint 에서 정의한 대로 인쇄 가능한 문자만 포함하거나 128자 미만이어야 합니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 6.20. 본문 매개변수
매개변수유형설명

body

ConsolePlugin 스키마

 
Expand
표 6.21. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ConsolePlugin 스키마

201 - 생성됨

ConsolePlugin 스키마

401 - 무단

7장. ConsoleQuickStart [console.openshift.io/v1]

설명
ConsoleQuickStart는 OpenShift 웹 콘솔의 다양한 워크플로우를 통해 사용자를 안내하는 확장 프로그램입니다. 호환성 수준 2: 주요 릴리스 내에서 최소 9 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 사용할 수 있습니다.
유형
object
필수 항목
  • spec

7.1. 사양

Expand
속성유형설명

apiVersion

string

APIVersion은 버전이 지정된 이 오브젝트 표현의 스키마를 정의합니다. 서버는 인식된 스키마를 최신 내부 값으로 변환해야 하며, 인식되지 않는 값을 거부할 수 있습니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

kind는 이 오브젝트가 나타내는 REST 리소스에 해당하는 문자열 값입니다. 서버는 클라이언트에서 요청을 제출한 끝점에서 이를 유추할 수 있습니다. CamelCase로 업데이트할 수 없습니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

메타데이터

ObjectMeta

표준 오브젝트의 메타데이터입니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

ConsoleQuickStartSpec은 원하는 퀵 스타트 구성입니다.

7.1.1. .spec

설명
ConsoleQuickStartSpec은 원하는 퀵 스타트 구성입니다.
유형
object
필수 항목
  • description
  • displayName
  • durationMinutes
  • Introduction
  • tasks
Expand
속성유형설명

accessReviewResources

array

accessReviewResources에는 사용자가 빠른 시작을 완료하기 위해 사용자 액세스 권한을 검토할 리소스 목록이 포함되어 있습니다. 액세스 검토가 실패하면 빠른 시작이 숨겨집니다.

accessReviewResources[]

object

ResourceAttributes에는 Authorizer 인터페이스에 리소스 요청에 사용할 수 있는 권한 부여 속성이 포함되어 있습니다.

conclusion

string

conclusion는 빠른 시작을 요약하고 가능한 다음 단계를 제안합니다. ( 마크다운 포함)

description

string

Description is the description of the Quick Start. (includes markdown)

displayName

string

displayName은 빠른 시작의 표시 이름입니다.

durationMinutes

integer

durationMinutes는 빠른 시작을 완료하는 데 걸리는 약 몇 분을 설명합니다.

icon

string

icon은 빠른 시작 표시 이름 옆에 표시되는 base64로 인코딩된 이미지입니다. 아이콘은 쉽게 스케일링할 수 있는 벡터 이미지여야 합니다. 아이콘 크기는 40x40이어야 합니다.

Introduction

string

소개 빠른 시작의 목적을 설명합니다. (표시 표시 포함)

nextQuickStart

배열(문자열)

nextQuickStart는 사용자가 시도할 수 있도록 제안된 다음 빠른 시작 목록입니다.

사전 요구 사항

배열(문자열)

사전 요구 사항은 빠른 시작을 시작하기 전에 충족해야 하는 모든 사전 요구 사항을 포함합니다. ( 마크다운 포함)

tags

배열(문자열)

태그는 빠른 시작을 설명하는 문자열 목록입니다.

tasks

array

tasks는 사용자가 빠른 시작을 완료하기 위해 수행해야 하는 단계 목록입니다.

tasks[]

object

ConsoleQuickStartTask는 빠른 시작의 단일 단계입니다.

7.1.2. .spec.accessReviewResources

설명
accessReviewResources에는 사용자가 빠른 시작을 완료하기 위해 사용자 액세스 권한을 검토할 리소스 목록이 포함되어 있습니다. 액세스 검토가 실패하면 빠른 시작이 숨겨집니다.
유형
array

7.1.3. .spec.accessReviewResources[]

설명
ResourceAttributes에는 Authorizer 인터페이스에 리소스 요청에 사용할 수 있는 권한 부여 속성이 포함되어 있습니다.
유형
object
Expand
속성유형설명

group

string

group은 리소스의 API 그룹입니다. "*"는 모든 것을 의미합니다.

name

string

name은 "get"에 대해 요청되거나 "삭제"에 대해 요청된 리소스의 이름입니다. ""(비어 있음)는 모두 의미합니다.

네임스페이스

string

namespace는 요청된 작업의 네임스페이스입니다. 현재는 LocalSubjectAccessReviews ""(비어 있음)에 대해 네임스페이스와 모든 네임스페이스 ""(빈)가 기본적으로 비어 있는 경우 클러스터 범위 리소스 ""(빈)는 SubjectAccessReview 또는 SelfSubjectAccessReview의 네임스페이스 범위 리소스에 대해 "all"을 의미합니다.

resource

string

리소스는 기존 리소스 유형 중 하나입니다. "*"는 모든 것을 의미합니다.

하위 리소스

string

하위 리소스는 기존 리소스 유형 중 하나입니다. ""는 none을 의미합니다.

verb

string

동사는 get, list, watch, create, update, delete, proxy와 같은 kubernetes 리소스 API 동사입니다. "*"는 모든 것을 의미합니다.

version

string

버전은 리소스의 API 버전입니다. "*"는 모든 것을 의미합니다.

7.1.4. .spec.tasks

설명
tasks는 사용자가 빠른 시작을 완료하기 위해 수행해야 하는 단계 목록입니다.
유형
array

7.1.5. .spec.tasks[]

설명
ConsoleQuickStartTask는 빠른 시작의 단일 단계입니다.
유형
object
필수 항목
  • description
  • title
Expand
속성유형설명

description

string

Description은 작업을 완료하는 데 필요한 단계를 설명합니다. ( 마크다운 포함)

검토

object

검토에는 작업이 완료되었는지 확인하는 지침이 포함되어 있습니다. 사용자가 단계가 성공적으로 완료되었는지 여부를 나타내는 라디오 버튼을 사용하여 '예' 또는 '아니오'를 선택합니다.

summary

object

요약에는 전달된 단계에 대한 정보가 포함되어 있습니다.

title

string

title은 작업을 설명하고 단계 제목으로 표시됩니다.

7.1.6. .spec.tasks[].review

설명
검토에는 작업이 완료되었는지 확인하는 지침이 포함되어 있습니다. 사용자가 단계가 성공적으로 완료되었는지 여부를 나타내는 라디오 버튼을 사용하여 '예' 또는 '아니오'를 선택합니다.
유형
object
필수 항목
  • failedTaskHelp
  • 지침
Expand
속성유형설명

failedTaskHelp

string

failedTaskHelp에는 실패한 작업 검토에 대한 제안 사항이 포함되어 있으며 작업 끝에 표시됩니다.

지침

string

지침에는 작업을 수행한 후 작업의 유효성을 검사하기 위해 사용자가 수행해야 하는 단계가 포함되어 있습니다. ( 마크다운 포함)

7.1.7. .spec.tasks[].summary

설명
요약에는 전달된 단계에 대한 정보가 포함되어 있습니다.
유형
object
필수 항목
  • failed
  • success
Expand
속성유형설명

failed

string

failed가 성공적으로 통과하지 못한 작업을 간략하게 설명합니다. ( markdown 포함)

success

string

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

Expand
표 7.1. 글로벌 쿼리 매개변수
매개변수유형설명

string

'true'인 경우 출력이 상당히 인쇄됩니다.

HTTP 방법
DELETE
설명
ConsoleQuickStart의 컬렉션 삭제
Expand
표 7.2. 쿼리 매개변수
매개변수유형설명

allowWatchBookmarks

boolean

AllowWatchkeygenmarks는 "BOOKMARK" 유형의 감시 이벤트를 요청합니다. 북마크를 구현하지 않는 서버는 이 플래그를 무시하고 북마크는 서버의 재량에 따라 전송됩니다. 클라이언트는 특정 간격으로 북마크가 반환된다고 가정해서는 안되며, 세션 중에 서버가 BOOKMARK 이벤트를 전송한다고 가정할 수도 있습니다. 시계가 아닌 경우 이 필드는 무시됩니다.

계속

string

서버에서 더 많은 결과를 검색할 때 continue 옵션을 설정해야 합니다. 이 값은 서버 정의이므로 클라이언트는 동일한 쿼리 매개변수가 있는 이전 쿼리 결과의 continue 값만 사용할 수 있으며(계속 값 제외) 서버는 인식할 수 없는 계속 값을 거부할 수 있습니다. 지정된 continue 값이 만료(일반적으로 5~15분) 또는 서버의 구성 변경으로 인해 지정된 continue 값이 더 이상 유효하지 않으면 서버는 계속 토큰과 함께 410 ResourceExpired 오류로 응답합니다. 클라이언트에 일관된 목록이 필요한 경우 continue 필드 없이 목록을 다시 시작해야 합니다. 그렇지 않으면 클라이언트는 410 오류와 함께 수신된 토큰을 사용하여 다른 목록 요청을 보낼 수 있으며, 서버는 다음 키에서 시작하여 목록으로 응답할 수 있지만 최신 스냅샷에서 생성된 오브젝트는 첫 번째 목록 요청이 "다음 키" 뒤에 포함된 후 생성, 수정 또는 삭제된 오브젝트입니다.

watch가 true인 경우 이 필드는 지원되지 않습니다. 클라이언트는 서버에서 반환한 마지막 resourceVersion 값에서 감시를 시작할 수 있으며 수정 사항을 누락하지 않을 수 있습니다.

fieldSelector

string

반환된 오브젝트 목록을 해당 필드로 제한하는 선택기입니다. 기본값은 모든 것입니다.

labelSelector

string

라벨을 통해 반환된 오브젝트 목록을 제한하는 선택기입니다. 기본값은 모든 것입니다.

limit

integer

제한은 목록 호출에 대해 반환할 최대 응답 수입니다. 더 많은 항목이 있는 경우 서버는 목록 메타데이터의 continue 필드를 동일한 초기 쿼리와 함께 사용하여 다음 결과 집합을 검색할 수 있는 값으로 설정합니다. 제한을 설정하면 모든 요청된 오브젝트가 필터링되는 경우 요청된 양의 항목(최대 0 항목)보다 적은 수를 반환하고 클라이언트는 continue 필드의 존재만 사용하여 더 많은 결과를 사용할 수 있는지 확인해야 합니다. 서버는 limit 인수를 지원하지 않도록 선택할 수 있으며 사용 가능한 모든 결과를 반환합니다. 제한이 지정되고 continue 필드가 비어 있으면 클라이언트는 더 이상 결과를 사용할 수 없다고 가정할 수 있습니다. watch가 true인 경우 이 필드는 지원되지 않습니다.

이 서버는 를 사용할 때 반환된 개체는 제한 없이 단일 목록 호출을 발행하는 것과 동일하며, 첫 번째 요청이 발행된 후 첫 번째 요청이 후속 계속되는 요청에 포함되지 않음을 보장합니다. 이를 일관된 스냅샷이라고 하며 제한을 사용하여 매우 큰 결과의 청크를 수신하는 클라이언트에서 가능한 모든 오브젝트를 확인할 수 있도록 합니다. 청크된 목록 중에 오브젝트가 업데이트되면 첫 번째 목록 결과가 계산될 때 존재하는 오브젝트 버전이 반환됩니다.

resourceVersion

string

resourceVersion은 요청이 제공할 수 있는 리소스 버전에 대한 제약 조건을 설정합니다. 자세한 내용은 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 을 참조하십시오.

기본값이 설정되지 않음

resourceVersionMatch

string

resourceVersionMatch는 resourceVersion이 호출 목록에 적용되는 방식을 결정합니다. 자세한 내용은 resourceVersion이 설정된 목록 호출에 대해 resourceVersionMatch를 설정하는 것이 좋습니다. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

기본값이 설정되지 않음

sendInitialEvents

boolean

sendInitialEvents=truewatch=true 와 함께 설정할 수 있습니다. 이 경우 감시 스트림은 합성 이벤트로 시작하여 컬렉션에 있는 개체의 현재 상태를 생성합니다. 이러한 모든 이벤트가 전송되면 합성 " emailmark" 이벤트가 전송됩니다. 북마크는 오브젝트 세트에 해당하는 ResourceVersion(RV)을 보고하고 "k8s.io/initial-events-end": "true" 주석으로 표시됩니다. 이후 감시 스트림은 정상적으로 진행되어 모니터링되는 오브젝트에 변경(RV에 제출)에 해당하는 감시 이벤트를 보냅니다.

sendInitialEvents 옵션을 설정할 때 resourceVersionMatch 옵션도 설정해야 합니다. 감시 요청의 의미 체계는 다음과 같습니다. - resourceVersionMatch = NotOlderThan은 "제공된 resourceVersion'만큼 새로운 데이터로 해석되며 북마크 이벤트는 상태가 'resourceVersion에 동기화될 때 적어도 ListOptions에서 제공하는 것과 같이 새로운 것으로 전송됩니다. resourceVersion 이 설정되지 않은 경우, 이는 "consistent read"로 해석되고, 요청이 처리되기 시작할 때 상태가 최소한 현재와 동기화될 때 북마크 이벤트는 전송됩니다. - resourceVersionMatch 가 다른 값으로 설정되거나 설정되지 않은 오류를 반환합니다.

resourceVersion="" 또는 resourceVersion="0"( 이전의 호환성 이유로) 및 false인 경우 기본값은 true입니다.

timeoutSeconds

integer

list/watch 호출의 시간 초과입니다. 이렇게 하면 활동 또는 비활성 여부에 관계없이 호출 기간이 제한됩니다.

watch

boolean

설명된 리소스에 대한 변경 사항을 조사하고 알림 추가, 업데이트 및 제거 스트림으로 반환합니다. resourceVersion을 지정합니다.

Expand
표 7.3. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

401 - 무단

HTTP 방법
GET
설명
ConsoleQuickStart 유형의 오브젝트 나열
Expand
표 7.4. 쿼리 매개변수
매개변수유형설명

allowWatchBookmarks

boolean

AllowWatchkeygenmarks는 "BOOKMARK" 유형의 감시 이벤트를 요청합니다. 북마크를 구현하지 않는 서버는 이 플래그를 무시하고 북마크는 서버의 재량에 따라 전송됩니다. 클라이언트는 특정 간격으로 북마크가 반환된다고 가정해서는 안되며, 세션 중에 서버가 BOOKMARK 이벤트를 전송한다고 가정할 수도 있습니다. 시계가 아닌 경우 이 필드는 무시됩니다.

계속

string

서버에서 더 많은 결과를 검색할 때 continue 옵션을 설정해야 합니다. 이 값은 서버 정의이므로 클라이언트는 동일한 쿼리 매개변수가 있는 이전 쿼리 결과의 continue 값만 사용할 수 있으며(계속 값 제외) 서버는 인식할 수 없는 계속 값을 거부할 수 있습니다. 지정된 continue 값이 만료(일반적으로 5~15분) 또는 서버의 구성 변경으로 인해 지정된 continue 값이 더 이상 유효하지 않으면 서버는 계속 토큰과 함께 410 ResourceExpired 오류로 응답합니다. 클라이언트에 일관된 목록이 필요한 경우 continue 필드 없이 목록을 다시 시작해야 합니다. 그렇지 않으면 클라이언트는 410 오류와 함께 수신된 토큰을 사용하여 다른 목록 요청을 보낼 수 있으며, 서버는 다음 키에서 시작하여 목록으로 응답할 수 있지만 최신 스냅샷에서 생성된 오브젝트는 첫 번째 목록 요청이 "다음 키" 뒤에 포함된 후 생성, 수정 또는 삭제된 오브젝트입니다.

watch가 true인 경우 이 필드는 지원되지 않습니다. 클라이언트는 서버에서 반환한 마지막 resourceVersion 값에서 감시를 시작할 수 있으며 수정 사항을 누락하지 않을 수 있습니다.

fieldSelector

string

반환된 오브젝트 목록을 해당 필드로 제한하는 선택기입니다. 기본값은 모든 것입니다.

labelSelector

string

라벨을 통해 반환된 오브젝트 목록을 제한하는 선택기입니다. 기본값은 모든 것입니다.

limit

integer

제한은 목록 호출에 대해 반환할 최대 응답 수입니다. 더 많은 항목이 있는 경우 서버는 목록 메타데이터의 continue 필드를 동일한 초기 쿼리와 함께 사용하여 다음 결과 집합을 검색할 수 있는 값으로 설정합니다. 제한을 설정하면 모든 요청된 오브젝트가 필터링되는 경우 요청된 양의 항목(최대 0 항목)보다 적은 수를 반환하고 클라이언트는 continue 필드의 존재만 사용하여 더 많은 결과를 사용할 수 있는지 확인해야 합니다. 서버는 limit 인수를 지원하지 않도록 선택할 수 있으며 사용 가능한 모든 결과를 반환합니다. 제한이 지정되고 continue 필드가 비어 있으면 클라이언트는 더 이상 결과를 사용할 수 없다고 가정할 수 있습니다. watch가 true인 경우 이 필드는 지원되지 않습니다.

이 서버는 를 사용할 때 반환된 개체는 제한 없이 단일 목록 호출을 발행하는 것과 동일하며, 첫 번째 요청이 발행된 후 첫 번째 요청이 후속 계속되는 요청에 포함되지 않음을 보장합니다. 이를 일관된 스냅샷이라고 하며 제한을 사용하여 매우 큰 결과의 청크를 수신하는 클라이언트에서 가능한 모든 오브젝트를 확인할 수 있도록 합니다. 청크된 목록 중에 오브젝트가 업데이트되면 첫 번째 목록 결과가 계산될 때 존재하는 오브젝트 버전이 반환됩니다.

resourceVersion

string

resourceVersion은 요청이 제공할 수 있는 리소스 버전에 대한 제약 조건을 설정합니다. 자세한 내용은 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 을 참조하십시오.

기본값이 설정되지 않음

resourceVersionMatch

string

resourceVersionMatch는 resourceVersion이 호출 목록에 적용되는 방식을 결정합니다. 자세한 내용은 resourceVersion이 설정된 목록 호출에 대해 resourceVersionMatch를 설정하는 것이 좋습니다. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

기본값이 설정되지 않음

sendInitialEvents

boolean

sendInitialEvents=truewatch=true 와 함께 설정할 수 있습니다. 이 경우 감시 스트림은 합성 이벤트로 시작하여 컬렉션에 있는 개체의 현재 상태를 생성합니다. 이러한 모든 이벤트가 전송되면 합성 " emailmark" 이벤트가 전송됩니다. 북마크는 오브젝트 세트에 해당하는 ResourceVersion(RV)을 보고하고 "k8s.io/initial-events-end": "true" 주석으로 표시됩니다. 이후 감시 스트림은 정상적으로 진행되어 모니터링되는 오브젝트에 변경(RV에 제출)에 해당하는 감시 이벤트를 보냅니다.

sendInitialEvents 옵션을 설정할 때 resourceVersionMatch 옵션도 설정해야 합니다. 감시 요청의 의미 체계는 다음과 같습니다. - resourceVersionMatch = NotOlderThan은 "제공된 resourceVersion'만큼 새로운 데이터로 해석되며 북마크 이벤트는 상태가 'resourceVersion에 동기화될 때 적어도 ListOptions에서 제공하는 것과 같이 새로운 것으로 전송됩니다. resourceVersion 이 설정되지 않은 경우, 이는 "consistent read"로 해석되고, 요청이 처리되기 시작할 때 상태가 최소한 현재와 동기화될 때 북마크 이벤트는 전송됩니다. - resourceVersionMatch 가 다른 값으로 설정되거나 설정되지 않은 오류를 반환합니다.

resourceVersion="" 또는 resourceVersion="0"( 이전의 호환성 이유로) 및 false인 경우 기본값은 true입니다.

timeoutSeconds

integer

list/watch 호출의 시간 초과입니다. 이렇게 하면 활동 또는 비활성 여부에 관계없이 호출 기간이 제한됩니다.

watch

boolean

설명된 리소스에 대한 변경 사항을 조사하고 알림 추가, 업데이트 및 제거 스트림으로 반환합니다. resourceVersion을 지정합니다.

Expand
표 7.5. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ConsoleQuickStartList 스키마

401 - 무단

HTTP 방법
POST
설명
ConsoleQuickStart 생성
Expand
표 7.6. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldManager

string

Fieldmanager는 이러한 변경을 수행하는 작업자 또는 엔티티와 연결된 이름입니다. 값은 https://golang.org/pkg/unicode/#IsPrint 에서 정의한 대로 인쇄 가능한 문자만 포함하거나 128자 미만이어야 합니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 7.7. 본문 매개변수
매개변수유형설명

body

ConsoleQuickStart 스키마

 
Expand
표 7.8. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ConsoleQuickStart 스키마

201 - 생성됨

ConsoleQuickStart 스키마

202 - 승인됨

ConsoleQuickStart 스키마

401 - 무단

7.2.2. /apis/console.openshift.io/v1/consolequickstarts/{name}

Expand
표 7.9. 글로벌 경로 매개변수
매개변수유형설명

name

string

ConsoleQuickStart의 이름

Expand
표 7.10. 글로벌 쿼리 매개변수
매개변수유형설명

string

'true'인 경우 출력이 상당히 인쇄됩니다.

HTTP 방법
DELETE
설명
ConsoleQuickStart 삭제
Expand
표 7.11. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

gracePeriodSeconds

integer

오브젝트를 삭제하기 전의 기간(초)입니다. 값은 음수가 아닌 정수여야 합니다. 값 0은 즉시 삭제됨을 나타냅니다. 이 값이 nil이면 지정된 유형의 기본 유예 기간이 사용됩니다. 지정하지 않으면 오브젝트당 기본값은 기본값입니다. 0은 즉시 삭제됨을 의미합니다.

orphanDependents

boolean

더 이상 사용되지 않음: PropagationPolicy를 사용하십시오. 이 필드는 1.7에서 더 이상 사용되지 않습니다. 종속 오브젝트를 분리해야 합니다. true/false인 경우 "orphan" 종료자가 오브젝트의 종료자 목록에 추가/제거됩니다. 이 필드 또는 PropagationPolicy는 설정할 수 있지만 둘 다 설정할 수는 없습니다.

propagationPolicy

string

가비지 컬렉션이 수행되는지 여부 및 방법. 이 필드 또는 OrphanDependents는 설정할 수 있지만 둘 다 설정할 수는 없습니다. 기본 정책은 metadata.finalizers에 설정된 기존 종료자 및 리소스별 기본 정책에 의해 결정됩니다. 허용 가능한 값은 다음과 같습니다. 'Orphan' - 종속 항목을 분리합니다. 'Back place' - 가비지 수집기에서 백그라운드에서 종속 항목을 삭제할 수 있습니다. 'Forefield' - 전경에서 모든 종속 항목을 삭제하는 계단식 정책입니다.

Expand
표 7.12. 본문 매개변수
매개변수유형설명

body

DeleteOptions 스키마

 
Expand
표 7.13. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

202 - 승인됨

상태 스키마

401 - 무단

HTTP 방법
GET
설명
지정된 ConsoleQuickStart 읽기
Expand
표 7.14. 쿼리 매개변수
매개변수유형설명

resourceVersion

string

resourceVersion은 요청이 제공할 수 있는 리소스 버전에 대한 제약 조건을 설정합니다. 자세한 내용은 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 을 참조하십시오.

기본값이 설정되지 않음

Expand
표 7.15. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ConsoleQuickStart 스키마

401 - 무단

HTTP 방법
PATCH
설명
지정된 ConsoleQuickStart를 부분적으로 업데이트
Expand
표 7.16. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldManager

string

Fieldmanager는 이러한 변경을 수행하는 작업자 또는 엔티티와 연결된 이름입니다. 값은 https://golang.org/pkg/unicode/#IsPrint 에서 정의한 대로 인쇄 가능한 문자만 포함하거나 128자 미만이어야 합니다. 이 필드는 적용 요청(application/apply-patch)에 필요하지만 적용되지 않는 패치 유형(JsonPatch, CryostatPatch, strategicMergePatch)의 경우 선택 사항입니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

force

boolean

강제 적용 요청을 "적용"합니다. 즉, 사용자는 다른 사용자가 소유한 충돌하는 필드를 다시 수집해야 합니다. 강제 플래그는 적용되지 않은 패치 요청에 대해 설정되지 않아야 합니다.

Expand
표 7.17. 본문 매개변수
매개변수유형설명

body

패치 스키마

 
Expand
표 7.18. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ConsoleQuickStart 스키마

401 - 무단

HTTP 방법
PUT
설명
지정된 ConsoleQuickStart를 교체
Expand
표 7.19. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldManager

string

Fieldmanager는 이러한 변경을 수행하는 작업자 또는 엔티티와 연결된 이름입니다. 값은 https://golang.org/pkg/unicode/#IsPrint 에서 정의한 대로 인쇄 가능한 문자만 포함하거나 128자 미만이어야 합니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 7.20. 본문 매개변수
매개변수유형설명

body

ConsoleQuickStart 스키마

 
Expand
표 7.21. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ConsoleQuickStart 스키마

201 - 생성됨

ConsoleQuickStart 스키마

401 - 무단

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

설명
ConsoleYAMLSample은 OpenShift 웹 콘솔 YAML 샘플을 사용자 정의하는 확장 프로그램입니다. 호환성 수준 2: 주요 릴리스 내에서 최소 9 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 사용할 수 있습니다.
유형
object
필수 항목
  • 메타데이터
  • spec

8.1. 사양

Expand
속성유형설명

apiVersion

string

APIVersion은 버전이 지정된 이 오브젝트 표현의 스키마를 정의합니다. 서버는 인식된 스키마를 최신 내부 값으로 변환해야 하며, 인식되지 않는 값을 거부할 수 있습니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

kind는 이 오브젝트가 나타내는 REST 리소스에 해당하는 문자열 값입니다. 서버는 클라이언트에서 요청을 제출한 끝점에서 이를 유추할 수 있습니다. CamelCase로 업데이트할 수 없습니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

메타데이터

ObjectMeta

표준 오브젝트의 메타데이터입니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

ConsoleYAMLSampleSpec은 원하는 YAML 샘플 구성입니다. 샘플은 웹 콘솔에서 리소스를 생성할 때 샘플 사이드바에 설명과 함께 표시됩니다.

8.1.1. .spec

설명
ConsoleYAMLSampleSpec은 원하는 YAML 샘플 구성입니다. 샘플은 웹 콘솔에서 리소스를 생성할 때 샘플 사이드바에 설명과 함께 표시됩니다.
유형
object
필수 항목
  • description
  • targetResource
  • title
  • yaml
Expand
속성유형설명

description

string

YAML 샘플에 대한 설명입니다.

snippet

boolean

스니펫은 YAML 샘플이 전체 YAML 리소스 정의가 아니라 사용자 커서의 기존 YAML 문서에 삽입할 수 있는 조각을 나타냅니다.

targetResource

object

targetResource에는 apiVersion 및 kind of resource YAML 샘플이 포함되어 있습니다.

title

string

YAML 샘플의 이름입니다.

yaml

string

YAML은 표시할 YAML 샘플입니다.

8.1.2. .spec.targetResource

설명
targetResource에는 apiVersion 및 kind of resource YAML 샘플이 포함되어 있습니다.
유형
object
Expand
속성유형설명

apiVersion

string

APIVersion은 버전이 지정된 이 오브젝트 표현의 스키마를 정의합니다. 서버는 인식된 스키마를 최신 내부 값으로 변환해야 하며, 인식되지 않는 값을 거부할 수 있습니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

kind는 이 오브젝트가 나타내는 REST 리소스에 해당하는 문자열 값입니다. 서버는 클라이언트에서 요청을 제출한 끝점에서 이를 유추할 수 있습니다. CamelCase로 업데이트할 수 없습니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

8.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을 교체합니다.

8.2.1. /apis/console.openshift.io/v1/consoleyamlsamples

Expand
표 8.1. 글로벌 쿼리 매개변수
매개변수유형설명

string

'true'인 경우 출력이 상당히 인쇄됩니다.

HTTP 방법
DELETE
설명
ConsoleYAMLSample 컬렉션 삭제
Expand
표 8.2. 쿼리 매개변수
매개변수유형설명

allowWatchBookmarks

boolean

AllowWatchkeygenmarks는 "BOOKMARK" 유형의 감시 이벤트를 요청합니다. 북마크를 구현하지 않는 서버는 이 플래그를 무시하고 북마크는 서버의 재량에 따라 전송됩니다. 클라이언트는 특정 간격으로 북마크가 반환된다고 가정해서는 안되며, 세션 중에 서버가 BOOKMARK 이벤트를 전송한다고 가정할 수도 있습니다. 시계가 아닌 경우 이 필드는 무시됩니다.

계속

string

서버에서 더 많은 결과를 검색할 때 continue 옵션을 설정해야 합니다. 이 값은 서버 정의이므로 클라이언트는 동일한 쿼리 매개변수가 있는 이전 쿼리 결과의 continue 값만 사용할 수 있으며(계속 값 제외) 서버는 인식할 수 없는 계속 값을 거부할 수 있습니다. 지정된 continue 값이 만료(일반적으로 5~15분) 또는 서버의 구성 변경으로 인해 지정된 continue 값이 더 이상 유효하지 않으면 서버는 계속 토큰과 함께 410 ResourceExpired 오류로 응답합니다. 클라이언트에 일관된 목록이 필요한 경우 continue 필드 없이 목록을 다시 시작해야 합니다. 그렇지 않으면 클라이언트는 410 오류와 함께 수신된 토큰을 사용하여 다른 목록 요청을 보낼 수 있으며, 서버는 다음 키에서 시작하여 목록으로 응답할 수 있지만 최신 스냅샷에서 생성된 오브젝트는 첫 번째 목록 요청이 "다음 키" 뒤에 포함된 후 생성, 수정 또는 삭제된 오브젝트입니다.

watch가 true인 경우 이 필드는 지원되지 않습니다. 클라이언트는 서버에서 반환한 마지막 resourceVersion 값에서 감시를 시작할 수 있으며 수정 사항을 누락하지 않을 수 있습니다.

fieldSelector

string

반환된 오브젝트 목록을 해당 필드로 제한하는 선택기입니다. 기본값은 모든 것입니다.

labelSelector

string

라벨을 통해 반환된 오브젝트 목록을 제한하는 선택기입니다. 기본값은 모든 것입니다.

limit

integer

제한은 목록 호출에 대해 반환할 최대 응답 수입니다. 더 많은 항목이 있는 경우 서버는 목록 메타데이터의 continue 필드를 동일한 초기 쿼리와 함께 사용하여 다음 결과 집합을 검색할 수 있는 값으로 설정합니다. 제한을 설정하면 모든 요청된 오브젝트가 필터링되는 경우 요청된 양의 항목(최대 0 항목)보다 적은 수를 반환하고 클라이언트는 continue 필드의 존재만 사용하여 더 많은 결과를 사용할 수 있는지 확인해야 합니다. 서버는 limit 인수를 지원하지 않도록 선택할 수 있으며 사용 가능한 모든 결과를 반환합니다. 제한이 지정되고 continue 필드가 비어 있으면 클라이언트는 더 이상 결과를 사용할 수 없다고 가정할 수 있습니다. watch가 true인 경우 이 필드는 지원되지 않습니다.

이 서버는 를 사용할 때 반환된 개체는 제한 없이 단일 목록 호출을 발행하는 것과 동일하며, 첫 번째 요청이 발행된 후 첫 번째 요청이 후속 계속되는 요청에 포함되지 않음을 보장합니다. 이를 일관된 스냅샷이라고 하며 제한을 사용하여 매우 큰 결과의 청크를 수신하는 클라이언트에서 가능한 모든 오브젝트를 확인할 수 있도록 합니다. 청크된 목록 중에 오브젝트가 업데이트되면 첫 번째 목록 결과가 계산될 때 존재하는 오브젝트 버전이 반환됩니다.

resourceVersion

string

resourceVersion은 요청이 제공할 수 있는 리소스 버전에 대한 제약 조건을 설정합니다. 자세한 내용은 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 을 참조하십시오.

기본값이 설정되지 않음

resourceVersionMatch

string

resourceVersionMatch는 resourceVersion이 호출 목록에 적용되는 방식을 결정합니다. 자세한 내용은 resourceVersion이 설정된 목록 호출에 대해 resourceVersionMatch를 설정하는 것이 좋습니다. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

기본값이 설정되지 않음

sendInitialEvents

boolean

sendInitialEvents=truewatch=true 와 함께 설정할 수 있습니다. 이 경우 감시 스트림은 합성 이벤트로 시작하여 컬렉션에 있는 개체의 현재 상태를 생성합니다. 이러한 모든 이벤트가 전송되면 합성 " emailmark" 이벤트가 전송됩니다. 북마크는 오브젝트 세트에 해당하는 ResourceVersion(RV)을 보고하고 "k8s.io/initial-events-end": "true" 주석으로 표시됩니다. 이후 감시 스트림은 정상적으로 진행되어 모니터링되는 오브젝트에 변경(RV에 제출)에 해당하는 감시 이벤트를 보냅니다.

sendInitialEvents 옵션을 설정할 때 resourceVersionMatch 옵션도 설정해야 합니다. 감시 요청의 의미 체계는 다음과 같습니다. - resourceVersionMatch = NotOlderThan은 "제공된 resourceVersion'만큼 새로운 데이터로 해석되며 북마크 이벤트는 상태가 'resourceVersion에 동기화될 때 적어도 ListOptions에서 제공하는 것과 같이 새로운 것으로 전송됩니다. resourceVersion 이 설정되지 않은 경우, 이는 "consistent read"로 해석되고, 요청이 처리되기 시작할 때 상태가 최소한 현재와 동기화될 때 북마크 이벤트는 전송됩니다. - resourceVersionMatch 가 다른 값으로 설정되거나 설정되지 않은 오류를 반환합니다.

resourceVersion="" 또는 resourceVersion="0"( 이전의 호환성 이유로) 및 false인 경우 기본값은 true입니다.

timeoutSeconds

integer

list/watch 호출의 시간 초과입니다. 이렇게 하면 활동 또는 비활성 여부에 관계없이 호출 기간이 제한됩니다.

watch

boolean

설명된 리소스에 대한 변경 사항을 조사하고 알림 추가, 업데이트 및 제거 스트림으로 반환합니다. resourceVersion을 지정합니다.

Expand
표 8.3. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

401 - 무단

HTTP 방법
GET
설명
ConsoleYAMLSample 유형의 오브젝트 나열
Expand
표 8.4. 쿼리 매개변수
매개변수유형설명

allowWatchBookmarks

boolean

AllowWatchkeygenmarks는 "BOOKMARK" 유형의 감시 이벤트를 요청합니다. 북마크를 구현하지 않는 서버는 이 플래그를 무시하고 북마크는 서버의 재량에 따라 전송됩니다. 클라이언트는 특정 간격으로 북마크가 반환된다고 가정해서는 안되며, 세션 중에 서버가 BOOKMARK 이벤트를 전송한다고 가정할 수도 있습니다. 시계가 아닌 경우 이 필드는 무시됩니다.

계속

string

서버에서 더 많은 결과를 검색할 때 continue 옵션을 설정해야 합니다. 이 값은 서버 정의이므로 클라이언트는 동일한 쿼리 매개변수가 있는 이전 쿼리 결과의 continue 값만 사용할 수 있으며(계속 값 제외) 서버는 인식할 수 없는 계속 값을 거부할 수 있습니다. 지정된 continue 값이 만료(일반적으로 5~15분) 또는 서버의 구성 변경으로 인해 지정된 continue 값이 더 이상 유효하지 않으면 서버는 계속 토큰과 함께 410 ResourceExpired 오류로 응답합니다. 클라이언트에 일관된 목록이 필요한 경우 continue 필드 없이 목록을 다시 시작해야 합니다. 그렇지 않으면 클라이언트는 410 오류와 함께 수신된 토큰을 사용하여 다른 목록 요청을 보낼 수 있으며, 서버는 다음 키에서 시작하여 목록으로 응답할 수 있지만 최신 스냅샷에서 생성된 오브젝트는 첫 번째 목록 요청이 "다음 키" 뒤에 포함된 후 생성, 수정 또는 삭제된 오브젝트입니다.

watch가 true인 경우 이 필드는 지원되지 않습니다. 클라이언트는 서버에서 반환한 마지막 resourceVersion 값에서 감시를 시작할 수 있으며 수정 사항을 누락하지 않을 수 있습니다.

fieldSelector

string

반환된 오브젝트 목록을 해당 필드로 제한하는 선택기입니다. 기본값은 모든 것입니다.

labelSelector

string

라벨을 통해 반환된 오브젝트 목록을 제한하는 선택기입니다. 기본값은 모든 것입니다.

limit

integer

제한은 목록 호출에 대해 반환할 최대 응답 수입니다. 더 많은 항목이 있는 경우 서버는 목록 메타데이터의 continue 필드를 동일한 초기 쿼리와 함께 사용하여 다음 결과 집합을 검색할 수 있는 값으로 설정합니다. 제한을 설정하면 모든 요청된 오브젝트가 필터링되는 경우 요청된 양의 항목(최대 0 항목)보다 적은 수를 반환하고 클라이언트는 continue 필드의 존재만 사용하여 더 많은 결과를 사용할 수 있는지 확인해야 합니다. 서버는 limit 인수를 지원하지 않도록 선택할 수 있으며 사용 가능한 모든 결과를 반환합니다. 제한이 지정되고 continue 필드가 비어 있으면 클라이언트는 더 이상 결과를 사용할 수 없다고 가정할 수 있습니다. watch가 true인 경우 이 필드는 지원되지 않습니다.

이 서버는 를 사용할 때 반환된 개체는 제한 없이 단일 목록 호출을 발행하는 것과 동일하며, 첫 번째 요청이 발행된 후 첫 번째 요청이 후속 계속되는 요청에 포함되지 않음을 보장합니다. 이를 일관된 스냅샷이라고 하며 제한을 사용하여 매우 큰 결과의 청크를 수신하는 클라이언트에서 가능한 모든 오브젝트를 확인할 수 있도록 합니다. 청크된 목록 중에 오브젝트가 업데이트되면 첫 번째 목록 결과가 계산될 때 존재하는 오브젝트 버전이 반환됩니다.

resourceVersion

string

resourceVersion은 요청이 제공할 수 있는 리소스 버전에 대한 제약 조건을 설정합니다. 자세한 내용은 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 을 참조하십시오.

기본값이 설정되지 않음

resourceVersionMatch

string

resourceVersionMatch는 resourceVersion이 호출 목록에 적용되는 방식을 결정합니다. 자세한 내용은 resourceVersion이 설정된 목록 호출에 대해 resourceVersionMatch를 설정하는 것이 좋습니다. https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

기본값이 설정되지 않음

sendInitialEvents

boolean

sendInitialEvents=truewatch=true 와 함께 설정할 수 있습니다. 이 경우 감시 스트림은 합성 이벤트로 시작하여 컬렉션에 있는 개체의 현재 상태를 생성합니다. 이러한 모든 이벤트가 전송되면 합성 " emailmark" 이벤트가 전송됩니다. 북마크는 오브젝트 세트에 해당하는 ResourceVersion(RV)을 보고하고 "k8s.io/initial-events-end": "true" 주석으로 표시됩니다. 이후 감시 스트림은 정상적으로 진행되어 모니터링되는 오브젝트에 변경(RV에 제출)에 해당하는 감시 이벤트를 보냅니다.

sendInitialEvents 옵션을 설정할 때 resourceVersionMatch 옵션도 설정해야 합니다. 감시 요청의 의미 체계는 다음과 같습니다. - resourceVersionMatch = NotOlderThan은 "제공된 resourceVersion'만큼 새로운 데이터로 해석되며 북마크 이벤트는 상태가 'resourceVersion에 동기화될 때 적어도 ListOptions에서 제공하는 것과 같이 새로운 것으로 전송됩니다. resourceVersion 이 설정되지 않은 경우, 이는 "consistent read"로 해석되고, 요청이 처리되기 시작할 때 상태가 최소한 현재와 동기화될 때 북마크 이벤트는 전송됩니다. - resourceVersionMatch 가 다른 값으로 설정되거나 설정되지 않은 오류를 반환합니다.

resourceVersion="" 또는 resourceVersion="0"( 이전의 호환성 이유로) 및 false인 경우 기본값은 true입니다.

timeoutSeconds

integer

list/watch 호출의 시간 초과입니다. 이렇게 하면 활동 또는 비활성 여부에 관계없이 호출 기간이 제한됩니다.

watch

boolean

설명된 리소스에 대한 변경 사항을 조사하고 알림 추가, 업데이트 및 제거 스트림으로 반환합니다. resourceVersion을 지정합니다.

Expand
표 8.5. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ConsoleYAMLSampleList 스키마

401 - 무단

HTTP 방법
POST
설명
ConsoleYAMLSample 생성
Expand
표 8.6. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldManager

string

Fieldmanager는 이러한 변경을 수행하는 작업자 또는 엔티티와 연결된 이름입니다. 값은 https://golang.org/pkg/unicode/#IsPrint 에서 정의한 대로 인쇄 가능한 문자만 포함하거나 128자 미만이어야 합니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 8.7. 본문 매개변수
매개변수유형설명

body

ConsoleYAMLSample 스키마

 
Expand
표 8.8. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ConsoleYAMLSample 스키마

201 - 생성됨

ConsoleYAMLSample 스키마

202 - 승인됨

ConsoleYAMLSample 스키마

401 - 무단

8.2.2. /apis/console.openshift.io/v1/consoleyamlsamples/{name}

Expand
표 8.9. 글로벌 경로 매개변수
매개변수유형설명

name

string

ConsoleYAMLSample 이름

Expand
표 8.10. 글로벌 쿼리 매개변수
매개변수유형설명

string

'true'인 경우 출력이 상당히 인쇄됩니다.

HTTP 방법
DELETE
설명
ConsoleYAMLSample 삭제
Expand
표 8.11. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

gracePeriodSeconds

integer

오브젝트를 삭제하기 전의 기간(초)입니다. 값은 음수가 아닌 정수여야 합니다. 값 0은 즉시 삭제됨을 나타냅니다. 이 값이 nil이면 지정된 유형의 기본 유예 기간이 사용됩니다. 지정하지 않으면 오브젝트당 기본값은 기본값입니다. 0은 즉시 삭제됨을 의미합니다.

orphanDependents

boolean

더 이상 사용되지 않음: PropagationPolicy를 사용하십시오. 이 필드는 1.7에서 더 이상 사용되지 않습니다. 종속 오브젝트를 분리해야 합니다. true/false인 경우 "orphan" 종료자가 오브젝트의 종료자 목록에 추가/제거됩니다. 이 필드 또는 PropagationPolicy는 설정할 수 있지만 둘 다 설정할 수는 없습니다.

propagationPolicy

string

가비지 컬렉션이 수행되는지 여부 및 방법. 이 필드 또는 OrphanDependents는 설정할 수 있지만 둘 다 설정할 수는 없습니다. 기본 정책은 metadata.finalizers에 설정된 기존 종료자 및 리소스별 기본 정책에 의해 결정됩니다. 허용 가능한 값은 다음과 같습니다. 'Orphan' - 종속 항목을 분리합니다. 'Back place' - 가비지 수집기에서 백그라운드에서 종속 항목을 삭제할 수 있습니다. 'Forefield' - 전경에서 모든 종속 항목을 삭제하는 계단식 정책입니다.

Expand
표 8.12. 본문 매개변수
매개변수유형설명

body

DeleteOptions 스키마

 
Expand
표 8.13. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

상태 스키마

202 - 승인됨

상태 스키마

401 - 무단

HTTP 방법
GET
설명
지정된 ConsoleYAMLSample 읽기
Expand
표 8.14. 쿼리 매개변수
매개변수유형설명

resourceVersion

string

resourceVersion은 요청이 제공할 수 있는 리소스 버전에 대한 제약 조건을 설정합니다. 자세한 내용은 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 을 참조하십시오.

기본값이 설정되지 않음

Expand
표 8.15. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ConsoleYAMLSample 스키마

401 - 무단

HTTP 방법
PATCH
설명
지정된 ConsoleYAMLSample을 부분적으로 업데이트
Expand
표 8.16. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldManager

string

Fieldmanager는 이러한 변경을 수행하는 작업자 또는 엔티티와 연결된 이름입니다. 값은 https://golang.org/pkg/unicode/#IsPrint 에서 정의한 대로 인쇄 가능한 문자만 포함하거나 128자 미만이어야 합니다. 이 필드는 적용 요청(application/apply-patch)에 필요하지만 적용되지 않는 패치 유형(JsonPatch, CryostatPatch, strategicMergePatch)의 경우 선택 사항입니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

force

boolean

강제 적용 요청을 "적용"합니다. 즉, 사용자는 다른 사용자가 소유한 충돌하는 필드를 다시 수집해야 합니다. 강제 플래그는 적용되지 않은 패치 요청에 대해 설정되지 않아야 합니다.

Expand
표 8.17. 본문 매개변수
매개변수유형설명

body

패치 스키마

 
Expand
표 8.18. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ConsoleYAMLSample 스키마

401 - 무단

HTTP 방법
PUT
설명
지정된 ConsoleYAMLSample을 교체합니다.
Expand
표 8.19. 쿼리 매개변수
매개변수유형설명

dryRun

string

존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.

fieldManager

string

Fieldmanager는 이러한 변경을 수행하는 작업자 또는 엔티티와 연결된 이름입니다. 값은 https://golang.org/pkg/unicode/#IsPrint 에서 정의한 대로 인쇄 가능한 문자만 포함하거나 128자 미만이어야 합니다.

fieldValidation

string

FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand
표 8.20. 본문 매개변수
매개변수유형설명

body

ConsoleYAMLSample 스키마

 
Expand
표 8.21. HTTP 응답
HTTP 코드리포지토리 본문

200 - OK

ConsoleYAMLSample 스키마

201 - 생성됨

ConsoleYAMLSample 스키마

401 - 무단

Legal Notice

Copyright © 2025 Red Hat

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.

맨 위로 이동
Red Hat logoGithubredditYoutubeTwitter

자세한 정보

평가판, 구매 및 판매

커뮤니티

Red Hat 문서 정보

Red Hat을 사용하는 고객은 신뢰할 수 있는 콘텐츠가 포함된 제품과 서비스를 통해 혁신하고 목표를 달성할 수 있습니다. 최신 업데이트를 확인하세요.

보다 포괄적 수용을 위한 오픈 소스 용어 교체

Red Hat은 코드, 문서, 웹 속성에서 문제가 있는 언어를 교체하기 위해 최선을 다하고 있습니다. 자세한 내용은 다음을 참조하세요.Red Hat 블로그.

Red Hat 소개

Red Hat은 기업이 핵심 데이터 센터에서 네트워크 에지에 이르기까지 플랫폼과 환경 전반에서 더 쉽게 작업할 수 있도록 강화된 솔루션을 제공합니다.

Theme

© 2025 Red Hat