4장. ClusterExtension [olm.operatorframework.io/v1]

설치

object

install은 pre-flight 검사 구성과 같은 ClusterExtension의 설치 옵션을 구성하는 데 사용되는 선택적 필드입니다.

네임스페이스

string

네임스페이스는 Kubernetes 네임스페이스에 대한 참조입니다. 제공된 ServiceAccount가 있어야 하는 네임스페이스입니다. 또한 확장에 대한 네임스페이스 범위 리소스가 클러스터에 적용되는 기본 네임스페이스를 지정합니다. 일부 확장 기능에는 다른 네임스페이스에 적용할 네임스페이스 범위 리소스가 포함될 수 있습니다. 이 네임스페이스가 있어야 합니다.

네임스페이스는 필수이고 변경 불가능하며 [RFC 1123]에 정의된 대로 DNS 레이블 표준을 따릅니다. 소문자 영숫자(-)만 포함하고 영숫자 문자로 시작 및 끝하며 63자를 초과해서는 안 됩니다.

[RFC 1123]: https://tools.ietf.org/html/rfc1123

serviceAccount

object

ServiceAccount는 확장을 관리하는 데 필요한 클러스터와의 모든 상호 작용을 수행하는 데 사용되는 ServiceAccount에 대한 참조입니다. 이러한 상호 작용을 수행하는 데 필요한 권한으로 ServiceAccount를 구성해야 합니다. ServiceAccount는 사양에서 참조된 네임스페이스에 있어야 합니다. serviceAccount가 필요합니다.

소스

object

source는 이 ClusterExtension에 대한 콘텐츠 설치 소스를 선택하는 필수 필드입니다. select는 sourceType을 설정하여 수행됩니다.

카탈로그는 현재 유일하게 구현된 sourceType이며 sourcetype을 "Catalog"로 설정하려면 catalog 필드도 정의해야 합니다.

다음은 소스 정의의 최소 예입니다(yaml).

source: sourceType: Catalog catalog: packageName: example-package

preflight

object

preflight는 packageName 필드에 지정된 패키지의 콘텐츠를 설치하거나 업그레이드하기 전에 실행되는 검사를 구성하는 데 사용할 수 있는 선택적 필드입니다.

지정된 경우 설치/업그레이드 작업의 기본 preflight 구성이 교체됩니다. 지정하지 않으면 기본 구성이 사용됩니다.

crdUpgradeSafety

object

crdUpgradeSafety는 설치된 콘텐츠를 업그레이드하기 전에 실행되는 CRD Upgrade safety pre-flight 검사를 구성하는 데 사용됩니다.

CRD Upgrade safety pre-flight는 데이터 손실과 같은 CRD 업그레이드의 의도하지 않은 결과로부터 보호됩니다.

적용

string

시행은 CRD 업그레이드 전 검사 상태를 구성하는 데 사용되는 필수 필드입니다.

허용되는 값은 "없음" 또는 "간단"입니다. 기본값은 "Stailt"입니다.

"없음"으로 설정하면 업그레이드 작업을 수행할 때 CRD 업그레이드 pre-flight 검사가 건너뜁니다. 데이터 손실과 같은 의도하지 않은 결과가 발생할 수 있으므로 주의해야 합니다.

"Salt"로 설정하면 업그레이드 작업을 수행할 때 CRD Upgrade safety pre-flight 검사가 실행됩니다.

name

string

name은 packageName 필드에 지정된 패키지의 콘텐츠 설치 및 관리에 사용할 ServiceAccount 이름에 대한 변경 불가능한 참조입니다.

이 ServiceAccount는 installNamespace에 있어야 합니다.

name은 [RFC 1123]에 정의된 대로 DNS 하위 도메인 표준을 따릅니다. 소문자 영숫자, 하이픈(-) 또는 마침표(.)만 포함해야 하며 영숫자 문자로 시작 및 끝나며 253자를 초과할 수 없습니다.

유효한 값의 몇 가지 예는 다음과 같습니다. - some-serviceaccount - 123-serviceaccount - 1-serviceaccount-2 - someserviceaccount - some.serviceaccount

잘못된 값의 몇 가지 예는 -some-serviceaccount - some-serviceaccount-입니다.

[RFC 1123]: https://tools.ietf.org/html/rfc1123

catalog

object

카탈로그는 카탈로그에서 정보를 제공하는 방법을 구성하는 데 사용됩니다. 이 필드는 sourceType이 "Catalog"이고 달리 금지될 때 필요합니다.

sourceType

string

sourceType은 설치 소스 유형에 대한 필수 참조입니다.

허용되는 값은 "Catalog"입니다.

이 필드를 "Catalog"로 설정하면 설치할 적절한 콘텐츠 번들을 결정하는 데 필요한 정보가 클러스터에 존재하는 ClusterCatalog 리소스에서 가져옵니다. Catalog sourceType을 사용하는 경우 catalog 필드도 설정해야 합니다.

채널

배열(문자열)

채널은 packageName 필드에 지정된 패키지에 속하는 채널 세트에 대한 선택적 참조입니다.

"채널"은 확장에 대한 패키지 작성자가 정의된 업데이트 스트림입니다.

목록의 각 채널은 [RFC 1123]에 정의된 대로 DNS 하위 도메인 표준을 따라야 합니다. 소문자 영숫자, 하이픈(-) 또는 마침표(.)만 포함해야 하며 영숫자 문자로 시작 및 끝나며 253자를 초과할 수 없습니다. 256개 이상의 채널을 지정할 수 없습니다.

지정하면 설치 가능한 번들 세트와 자동화된 업그레이드 경로를 제한하는 데 사용됩니다. 이 제약 조건은 version 필드를 사용하는 AND 작업입니다. 예를 들어 - Given 채널은 "foo"로 설정됩니다 - Given 버전은 ">=1.0.0, <1.5.0"로 설정됩니다. 채널 "foo"에 존재하는 번들만 있고 버전 범위 비교는 installable으로 간주됩니다. 자동 업그레이드는 선택한 채널에서 정의한 에지를 업그레이드하도록 제한됩니다.

지정되지 않은 경우 모든 채널의 업그레이드 에지가 유효한 자동 업그레이드 경로를 식별하는 데 사용됩니다.

유효한 값의 몇 가지 예는 다음과 같습니다. - 1.1.x - alpha - stable - stable-v1 - v1-stable - dev-preview - Preview - community

잘못된 값의 몇 가지 예는 다음과 같습니다. -some-channel - some-channel- - thisisallylongchannelname thatisgreaterthanthemaximumlength - original_40 - --default-channel

[RFC 1123]: https://tools.ietf.org/html/rfc1123

packageName

string

PACKAGENAME은 설치할 패키지 이름에 대한 참조이며 카탈로그의 콘텐츠를 필터링하는 데 사용됩니다.

PACKAGENAME은 필수적이고 변경 불가능하며 [RFC 1123]에 정의된 대로 DNS 하위 도메인 표준을 따릅니다. 소문자 영숫자, 하이픈(-) 또는 마침표(.)만 포함해야 하며 영숫자 문자로 시작 및 끝나며 253자를 초과할 수 없습니다.

유효한 값의 몇 가지 예는 다음과 같습니다. - some-package - 123-package - 1-package-2 - somepackage

잘못된 값의 몇 가지 예는 다음과 같습니다. -some-package - some-package- - thisisallylongpackagename thatisgreaterthanthemaximumlength - some.package

[RFC 1123]: https://tools.ietf.org/html/rfc1123

선택기

object

selector는 번들 선택 프로세스에 사용되는 ClusterCatalog 집합을 필터링하는 데 사용할 수 있는 선택적 필드입니다.

지정되지 않은 경우 번들 선택 프로세스에서 모든 ClusterCatalogs가 사용됩니다.

upgradeConstraintPolicy

string

upgradeConstraintPolicy는 카탈로그에 정의된 업그레이드 경로가 packageName 필드에서 참조되는 패키지에 적용되는지 여부를 제어하는 선택적 필드입니다.

허용되는 값은 "CatalogProvided" 또는 "SelfCertified" 또는 생략입니다.

이 필드를 "CatalogProvided"로 설정하면 패키지 작성자가 지정한 업그레이드 제약 조건이 충족될 때만 자동 업그레이드가 수행됩니다.

이 필드가 "SelfCertified"로 설정되면 패키지 작성자가 지정한 업그레이드 제약 조건이 무시됩니다. 이를 통해 모든 패키지 버전으로 업그레이드 및 다운그레이드할 수 있습니다. 이는 데이터 손실과 같은 알 수 없고 잠재적으로 치명적인 결과를 초래할 수 있으므로 위험한 작업으로 간주됩니다. 이 옵션을 사용할 때 사용자가 독립적으로 변경 사항을 확인했다고 가정합니다.

이 필드를 생략하면 기본값은 "CatalogProvided"입니다.

version

string

version은 선택적 semver 제약 조건입니다(특정 버전 또는 버전 범위). 지정되지 않은 경우 사용 가능한 최신 버전이 설치됩니다.

허용되는 버전 범위는 64자 미만입니다. 버전 범위는 비교 문자열이라는 쉼표 또는 공백으로 구분된 값과 하나 이상의 비교 연산자로 구성됩니다. OR 연산자(||)를 사용하여 추가 비교 문자열을 추가할 수 있습니다.

# 범위 비교

버전 범위를 지정하려면 ">=3.0, <3.6"과 같은 비교 문자열을 사용할 수 있습니다. 범위를 지정하면 해당 범위 내에서 자동 업데이트가 수행됩니다. 예제 비교 문자열은 "3.0.0보다 크거나 같지만 3.6.0보다 작은 버전을 설치"한다는 것을 의미합니다. 또한 초기 설치 후 버전 범위 내에서 업그레이드할 수 있는 경우 해당 업그레이드를 자동으로 수행해야 합니다.

# 고정된 버전

정확한 버전을 지정하려면 특정 버전에 대한 "핀" 버전 범위를 사용할 수 있습니다. 특정 버전을 고정하면 자동 업데이트가 수행되지 않습니다. 고정된 버전 범위의 예로는 "0.6.0"이 있습니다. 이는 "버전 0.6.0만 설치하고 이 버전에서 업그레이드하지 않음"을 의미합니다.

# 기본 비교 Operator

기본 비교 연산자와 그 의미는 다음과 같습니다 - "=", equal (not aliased to an operator) - "!=", not equal - "<", less than - ">", greater than - ">=", greater than - ">=", equal to or equal to or equal to or equal to or equal to or equal to or equal to or equal to or equal to

# 와일드카드 비교

모든 비교 작업에서 "x", "X" 및 "" 문자를 와일드카드 문자로 사용할 수 있습니다. 와일드카드 문자를 사용하는 일부 예: - "1.2.x", "1.2.X", "1.2.X" 및 "1.2."는 ">=1.2.0, < 1.3.0" - ">= 1.2.x", ">= 1.2.X"와 동일합니다.">= 1.2.0" - "management 2.x"와 동일합니다. " = 2.x" 및 "Cryostat 2"는 "< 3" - "x", "X" 및 "*"는 ">= 0.0.0"과 동일합니다.

# 패치 릴리스 비교

다음 주요 버전으로 마이너 버전을 지정하려면 "~" 문자를 사용하여 패치 비교를 수행할 수 있습니다. 일부 예: - "~1.2.3"은 ">=1.2.3, <1.3.0" - "~1" 및 "~1.x"와 동일합니다 ">=1, <2" - "~2.3"은 ">=2.3, <2.4" - "~1.2.x"는 ">=1.2.0, <1.3.0"과 동일합니다.

# 주요 릴리스 비교

"^" 문자를 사용하면 안정적인 1.0.0 버전이 게시된 후 주요 릴리스를 비교할 수 있습니다. 안정적인 버전이 게시되지 않은 경우 마이너 버전은 안정성 수준을 정의합니다. "^1.2.3"은 ">=1.2.3, <2.0.0" - "^1.2.x"는 ">=1.2.0, <2.0.0"과 동일합니다. "^2.3"은 ">=2.3, <3" - "^2.x"는 ">=2.0.0과 동일합니다. <3" - "^0.2.3"은 ">=0.2.3, <0.3.0" - "^0.3.0" - "0.3.0" - "^0.0.3"과 동일합니다. "^0.0.3"은 ">=0.0.3, <0.0.4" - "^0.0.4"는 ">=0.0.0.0.0과 동일합니다. <0.1.0" - "^0"은 ">=0.0.0, <1.0.0"과 동일합니다.

# 또는 Comparisons "||" 문자를 사용하여 버전 범위에서 OR 작업을 나타낼 수 있습니다. 몇 가지 예: - ">=1.2.3, <2.0.0 || >3.0.0" - "^0 || ^3 || ^5"

semver에 대한 자세한 내용은 https://semver.org/에서 참조하십시오.

matchExpressions

array

matchExpressions는 라벨 선택기 요구 사항 목록입니다. 요구 사항은 AND로 설정됩니다.

matchExpressions[]

object

레이블 선택기 요구 사항은 값, 키 및 키와 관련된 연산자를 포함하는 선택기입니다.

matchLabels

오브젝트(문자열)

matchLabels는 {key,value} 쌍으로 구성된 맵입니다. matchLabels 맵의 단일 {key,value}는 키 필드가 "key"이고, 연산자는 "In"이고, values 배열에는 "value"만 포함된 matchExpressions 요소와 동일합니다. 요구 사항은 AND로 설정됩니다.

key

string

key는 선택기가 적용되는 라벨 키입니다.

operator

string

Operator는 일련의 값과의 키 관계를 나타냅니다. 유효한 연산자는 In, NotIn, Exists 및 DoesNotExist입니다.

값

배열(문자열)

값은 문자열 값의 배열입니다. 연산자가 In 또는 NotIn인 경우 값 배열은 비어 있지 않아야 합니다. 연산자가 Exists 또는 DoesNotExist인 경우 값 배열은 비어 있어야 합니다. 이 배열은 전략적 병합 패치 중에 교체됩니다.

conditions

array

모든 spec.source 변형에 적용되는 조건 유형 세트는 설치 및 진행 중입니다.

Installed 조건은 이 ClusterExtension에 대해 번들이 설치되었는지 여부를 나타냅니다. Installed가 True이고 Reason이 Succeeded인 경우 번들이 성공적으로 설치되었습니다. Installed가 False이고 Reason is Failed인 경우 번들을 설치하지 못했습니다.

Progressing 조건은 ClusterExtension이 새 상태로 진행 중인지 여부를 나타냅니다. Progressing이 True이고 Reason이 Succeeded인 경우 ClusterExtension이 새 상태로 진행됩니다. Progressing이 True이고 Reason is Retrying인 경우 ClusterExtension에 후속 조정 시도에서 해결할 수 있는 오류가 발생했습니다. Progressing이 False이고 Reason이 Blocked인 경우 ClusterExtension에 복구에 대한 수동 개입이 필요한 오류가 발생했습니다.

카탈로그에서 ClusterExtension을 소싱하는 경우 사용 중단 조건을 전달할 수도 있습니다. 다음은 특정 패키지, 채널 또는 번들에서 사용자를 안내하기 위해 패키지 소유자의 표시입니다. 요청된 번들 버전이 카탈로그에 더 이상 사용되지 않는 것으로 표시되면 BundleDeprecated가 설정됩니다. 요청된 채널이 카탈로그에 더 이상 사용되지 않는 것으로 표시되면 ChannelDeprecated가 설정됩니다. 요청된 패키지가 카탈로그에 더 이상 사용되지 않는 것으로 표시되면 PackageDeprecated가 설정됩니다. 더 이상 사용되지 않는 조건은 더 이상 사용되지 않는 조건이 있을 때 발생하는 롤업 조건입니다.

conditions[]

object

condition에는 이 API 리소스의 현재 상태에 대한 한 가지 측면에 대한 세부 정보가 포함되어 있습니다.

설치

object

install은 이 ClusterExtension의 현재 설치 상태를 나타냅니다.

lastTransitionTime

string

lastTransitionTime은 마지막으로 한 상태에서 다른 상태로 전환된 시간입니다. 기본 조건이 변경된 경우여야 합니다. 이를 알 수 없는 경우 API 필드가 변경된 시간을 사용합니다.

message

string

message는 변환에 대한 세부 정보를 나타내는 사람이 읽을 수 있는 메시지입니다. 빈 문자열일 수 있습니다.

observedGeneration

integer

observedGeneration은 조건에 따라 설정된 .metadata.generation을 나타냅니다. 예를 들어 .metadata.generation이 현재 12이지만 .status.conditions[x].observedGeneration이 9인 경우 현재 인스턴스 상태와 관련된 조건이 최신 상태가 아닙니다.

reason

string

이유에는 조건의 마지막 전환 이유를 나타내는 프로그래밍 식별자가 포함되어 있습니다. 특정 조건 유형의 생산자는 이 필드에 예상되는 값과 의미를 정의할 수 있으며 값이 보장된 API로 간주되는지 여부를 정의할 수 있습니다. 값은 CamelCase 문자열이어야 합니다. 이 필드는 비어 있지 않을 수 있습니다.

status

string

조건의 상태, True, False, 알 수 없음.

type

string

CamelCase 또는 foo.example.com/CamelCase의 조건 유형입니다.

번들

object

bundle은 번들의 식별 속성을 나타내는 필수 필드입니다.

"번들"은 패키지를 설치하기 위해 클러스터에 적용해야 하는 리소스를 나타내는 버전 지정된 콘텐츠 집합입니다.

name

string

이름은 필수이며 [RFC 1123]에 정의된 대로 DNS 하위 도메인 표준을 따릅니다. 소문자 영숫자, 하이픈(-) 또는 마침표(.)만 포함해야 하며 영숫자 문자로 시작 및 끝나며 253자를 초과할 수 없습니다.

version

string

version은 필수 필드이며 이 번들이 https://semver.org/ 에 정의된 대로 의미 체계 버전 관리 표준을 따르는 버전에 대한 참조입니다.