프로젝트 API

OpenShift Container Platform 4.16

프로젝트 API에 대한 참조 가이드

Red Hat OpenShift Documentation Team

법적 공지

초록

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

1장. 프로젝트 API
링크 복사

1.1. Project [project.openshift.io/v1]
링크 복사

설명

프로젝트는 OpenShift에서 격리 및 협업의 단위입니다. 프로젝트에는 멤버가 한 개 이상, 프로젝트에서 사용할 수 있는 리소스에 대한 할당량 및 프로젝트의 리소스에 대한 보안 제어가 있습니다. 프로젝트 내에서 구성원은 서로 다른 역할을 가질 수 있습니다. 프로젝트 관리자는 멤버십을 설정하고, 편집자는 리소스를 생성 및 관리할 수 있으며, 뷰어는 실행 중인 컨테이너에 액세스할 수 있지만 액세스할 수 없습니다. 일반 클러스터 프로젝트에서 관리자는 클러스터 관리자로 제한되는 할당량을 변경할 수 없습니다.

프로젝트를 나열하거나 보고하면 사용자가 reader 역할이 있는 프로젝트만 반환됩니다.

OpenShift 프로젝트는 Kubernetes 네임스페이스의 대체 표현입니다. 네임스페이스가 없는 동안 프로젝트는 최종 사용자에게 편집 가능한 상태로 노출됩니다. 일반적으로 프로젝트 직접 생성은 관리자로 제한되지만 최종 사용자는 requestproject 리소스를 사용해야 합니다.

호환성 수준 1: 최소 12 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 주요 릴리스 내에서 사용할 수 있습니다.

유형

object

1.2. ProjectRequest [project.openshift.io/v1]
링크 복사

설명

ProjectRequest는 프로젝트 요청을 완전히 충족하는 데 필요한 옵션 세트입니다.

호환성 수준 1: 최소 12 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 주요 릴리스 내에서 사용할 수 있습니다.

유형

object

2장. Project [project.openshift.io/v1]
링크 복사

설명

프로젝트를 나열하거나 보고하면 사용자가 reader 역할이 있는 프로젝트만 반환됩니다.

호환성 수준 1: 최소 12 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 주요 릴리스 내에서 사용할 수 있습니다.

유형

object

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`	ProjectSpec은 프로젝트의 특성을 설명합니다.
`status`	`object`	ProjectStatus는 프로젝트의 현재 상태에 대한 정보입니다.

2.1.1. .spec
링크 복사

설명: ProjectSpec은 프로젝트의 특성을 설명합니다.
유형: object

Expand

속성	유형	설명
`종료자`	`배열(문자열)`	종료자는 스토리지에서 오브젝트를 영구적으로 제거하려면 비어 있어야 하는 불투명 값 목록입니다.

2.1.2. .status
링크 복사

설명: ProjectStatus는 프로젝트의 현재 상태에 대한 정보입니다.
유형: object

Expand

속성 유형 설명

속성	유형	설명
`conditions`	`배열(NamespaceCondition)`	현재 프로젝트의 사용 가능한 최신 관찰을 나타냅니다.
`phase`	`string`	단계는 프로젝트의 현재 라이프사이클 단계입니다. 가능한 enum 값: - `"Active"` 는 시스템에서 사용할 수 있는 네임스페이스를 의미합니다 - `"Terminating"` 은 네임스페이스가 정상 종료를 수행 중임을 의미합니다.

conditions

배열(NamespaceCondition)

현재 프로젝트의 사용 가능한 최신 관찰을 나타냅니다.

phase

string

단계는 프로젝트의 현재 라이프사이클 단계입니다.

가능한 enum 값: - "Active" 는 시스템에서 사용할 수 있는 네임스페이스를 의미합니다 - "Terminating" 은 네임스페이스가 정상 종료를 수행 중임을 의미합니다.

2.2. API 끝점
링크 복사

다음 API 끝점을 사용할 수 있습니다.

/apis/project.openshift.io/v1/projects
- GET: Project 유형의 오브젝트 목록 또는 감시
- POST: 프로젝트를 생성
/apis/project.openshift.io/v1/watch/projects
- GET: Project. deprecated 목록에 대한 개별 변경 사항을 확인합니다. 대신 목록 작업과 함께 'watch' 매개변수를 사용합니다.
/apis/project.openshift.io/v1/projects/{name}
- DELETE: 프로젝트 삭제
- GET: 지정된 프로젝트 읽기
- PATCH: 지정된 프로젝트를 부분적으로 업데이트
- PUT: 지정된 프로젝트를 교체
/apis/project.openshift.io/v1/watch/projects/{name}
- GET: 더 이상 사용되지 않는 유형의 오브젝트를 감시합니다. 대신 'fieldSelector' 매개변수가 있는 단일 항목으로 필터링된 목록 작업과 함께 'watch' 매개변수를 사용합니다.

2.2.1. /apis/project.openshift.io/v1/projects
링크 복사

HTTP 방법: GET
설명: Project 유형의 오브젝트 나열 또는 감시

Expand

표 2.1. HTTP 응답
HTTP 코드	리포지토리 본문
200 - OK	`ProjectList` 스키마
401 - 무단	빈

HTTP 방법: POST
설명: 프로젝트 생성

Expand

표 2.2. 쿼리 매개변수
매개변수	유형	설명
`dryRun`	`string`	존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.
`fieldValidation`	`string`	FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand

표 2.3. 본문 매개변수
매개변수	유형	설명
`body`	`프로젝트` 스키마

Expand

표 2.4. HTTP 응답
HTTP 코드	리포지토리 본문
200 - OK	`프로젝트` 스키마
201 - 생성됨	`프로젝트` 스키마
202 - 승인됨	`프로젝트` 스키마
401 - 무단	빈

2.2.2. /apis/project.openshift.io/v1/watch/projects
링크 복사

HTTP 방법: GET
설명: Project. deprecated 목록에 대한 개별 변경 사항을 확인합니다. 대신 목록 작업과 함께 'watch' 매개변수를 사용합니다.

Expand

표 2.5. HTTP 응답
HTTP 코드	리포지토리 본문
200 - OK	`WatchEvent` 스키마
401 - 무단	빈

2.2.3. /apis/project.openshift.io/v1/projects/{name}
링크 복사

Expand

표 2.6. 글로벌 경로 매개변수
매개변수	유형	설명
`name`	`string`	프로젝트 이름

HTTP 방법: DELETE
설명: 프로젝트 삭제

Expand

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

Expand

표 2.8. HTTP 응답
HTTP 코드	리포지토리 본문
200 - OK	`상태` 스키마
202 - 승인됨	`상태` 스키마
401 - 무단	빈

HTTP 방법: GET
설명: 지정된 프로젝트 읽기

Expand

표 2.9. HTTP 응답
HTTP 코드	리포지토리 본문
200 - OK	`프로젝트` 스키마
401 - 무단	빈

HTTP 방법: PATCH
설명: 지정된 프로젝트를 부분적으로 업데이트

Expand

표 2.10. 쿼리 매개변수
매개변수	유형	설명
`dryRun`	`string`	존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.
`fieldValidation`	`string`	FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand

표 2.11. HTTP 응답
HTTP 코드	리포지토리 본문
200 - OK	`프로젝트` 스키마
201 - 생성됨	`프로젝트` 스키마
401 - 무단	빈

HTTP 방법: PUT
설명: 지정된 프로젝트를 교체

Expand

표 2.12. 쿼리 매개변수
매개변수	유형	설명
`dryRun`	`string`	존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.
`fieldValidation`	`string`	FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand

표 2.13. 본문 매개변수
매개변수	유형	설명
`body`	`프로젝트` 스키마

Expand

표 2.14. HTTP 응답
HTTP 코드	리포지토리 본문
200 - OK	`프로젝트` 스키마
201 - 생성됨	`프로젝트` 스키마
401 - 무단	빈

2.2.4. /apis/project.openshift.io/v1/watch/projects/{name}
링크 복사

Expand

표 2.15. 글로벌 경로 매개변수
매개변수	유형	설명
`name`	`string`	프로젝트 이름

HTTP 방법: GET
설명: 더 이상 사용되지 않는 유형의 오브젝트를 감시합니다. 대신 'fieldSelector' 매개변수가 있는 단일 항목으로 필터링된 목록 작업과 함께 'watch' 매개변수를 사용합니다.

Expand

표 2.16. HTTP 응답
HTTP 코드	리포지토리 본문
200 - OK	`WatchEvent` 스키마
401 - 무단	빈

3장. ProjectRequest [project.openshift.io/v1]
링크 복사

설명

ProjectRequest는 프로젝트 요청을 완전히 충족하는 데 필요한 옵션 세트입니다.

호환성 수준 1: 최소 12 개월 또는 3 개의 마이너 릴리스 (더 긴 버전) 동안 주요 릴리스 내에서 사용할 수 있습니다.

유형

object

3.1. 사양
링크 복사

Expand

속성	유형	설명
`apiVersion`	`string`	APIVersion은 버전이 지정된 이 오브젝트 표현의 스키마를 정의합니다. 서버는 인식된 스키마를 최신 내부 값으로 변환해야 하며, 인식되지 않는 값을 거부할 수 있습니다. 자세한 내용은 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`description`	`string`	Description is the description to apply to a project
`displayName`	`string`	displayName은 프로젝트에 적용할 표시 이름입니다.
`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

3.2. API 끝점
링크 복사

다음 API 끝점을 사용할 수 있습니다.

/apis/project.openshift.io/v1/projectrequests
- GET: ProjectRequest 유형의 오브젝트 나열
- POST: ProjectRequest 생성

3.2.1. /apis/project.openshift.io/v1/projectrequests
링크 복사

HTTP 방법: GET
설명: ProjectRequest 유형의 오브젝트 나열

Expand

표 3.1. HTTP 응답
HTTP 코드	리포지토리 본문
200 - OK	`상태` 스키마
401 - 무단	빈

HTTP 방법: POST
설명: ProjectRequest 생성

Expand

표 3.2. 쿼리 매개변수
매개변수	유형	설명
`dryRun`	`string`	존재하는 경우 수정 사항이 유지되지 않아야 함을 나타냅니다. 유효하지 않거나 인식할 수 없는 dryRun 지시문으로 인해 오류 응답이 발생하고 요청을 추가로 처리하지 않습니다. 유효한 값은 다음과 같습니다. - 모두: 모든 시험 실행 단계가 처리됩니다.
`fieldValidation`	`string`	FieldValidation은 알 수 없거나 중복된 필드가 포함된 요청(POST/PUT/PATCH)의 오브젝트를 처리하는 방법에 대해 서버에 지시합니다. 유효한 값은 다음과 같습니다. - 무시: 이는 오브젝트에서 자동으로 삭제된 알 수 없는 필드를 무시하고 디코더가 직면하는 마지막 중복 필드를 제외한 모든 필드를 무시합니다. v1.23 이전의 기본 동작입니다. - warn: 오브젝트에서 삭제된 각 알 수 없는 각 필드에 대한 표준 경고 응답 헤더와 발생하는 각 중복 필드에 대해 경고를 보냅니다. 다른 오류가 없는 경우에도 요청이 성공하고 중복 필드의 마지막 부분만 유지됩니다. v1.23+ - Strict: 알 수 없는 필드가 오브젝트에서 삭제되거나 중복 필드가 있는 경우 BadRequest 오류와 함께 요청이 실패합니다. 서버에서 반환된 오류에는 모든 알 수 없거나 중복된 필드가 포함됩니다.

Expand

표 3.3. 본문 매개변수
매개변수	유형	설명
`body`	`ProjectRequest` 스키마

Expand

표 3.4. HTTP 응답
HTTP 코드	리포지토리 본문
200 - OK	`ProjectRequest` 스키마
201 - 생성됨	`ProjectRequest` 스키마
202 - 승인됨	`ProjectRequest` 스키마
401 - 무단	빈

Legal Notice
링크 복사

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.

프로젝트 API