6.2. opm CLI 참조
opm CLI(명령줄 인터페이스)는 Operator 카탈로그를 생성하고 유지 관리하는 툴입니다.
opm CLI 구문
$ opm <command> [<subcommand>] [<argument>] [<flags>]
opm CLI는 향후 버전과 호환되지 않습니다. 카탈로그 콘텐츠를 생성하는 데 사용되는 opm CLI 버전은 클러스터의 콘텐츠를 제공하는 데 사용되는 버전보다 작거나 같아야 합니다.
| 플래그 | 설명 |
|---|---|
|
| 번들 또는 인덱스를 가져오는 동안 컨테이너 이미지 레지스트리의 TLS 인증서 확인을 건너뜁니다. |
|
| 번들을 가져올 때 컨테이너 이미지 레지스트리에 일반 HTTP를 사용합니다. |
관련 CLI 명령을 포함한 SQLite 기반 카탈로그 형식은 더 이상 사용되지 않는 기능입니다. 더 이상 사용되지 않는 기능은 여전히 OpenShift Dedicated에 포함되어 있으며 계속 지원됩니다. 그러나 이 기능은 향후 릴리스에서 제거될 예정이므로 새 배포에는 사용하지 않는 것이 좋습니다.
6.2.1. generate
선언적 구성 인덱스에 대한 다양한 아티팩트를 생성합니다.
명령 구문
$ opm generate <subcommand> [<flags>]
| 하위 명령 | 설명 |
|---|---|
|
| 선언적 구성 인덱스에 대한 Dockerfile을 생성합니다. |
| 플래그 | 설명 |
|---|---|
|
| generate에 대한 도움말입니다. |
6.2.1.1. dockerfile
선언적 구성 인덱스에 대한 Dockerfile을 생성합니다.
이 명령은 인덱스를 빌드하는 데 사용되는 < dcRootDir > (< dcDirName>.Dockerfile)과 동일한 디렉터리에 Dockerfile을 생성합니다. 동일한 이름의 Dockerfile이 이미 존재하는 경우 이 명령이 실패합니다.
추가 레이블을 지정할 때 중복 키가 있는 경우 각 중복 키의 마지막 값만 생성된 Dockerfile에 추가됩니다.
명령 구문
$ opm generate dockerfile <dcRootDir> [<flags>]
| 플래그 | 설명 |
|---|---|
|
|
카탈로그를 빌드할 이미지입니다. 기본값은 |
|
|
생성된 Dockerfile에 포함할 추가 레이블입니다. 레이블에는 |
|
| Dockerfile에 대한 도움말 |
공식 Red Hat 이미지로 빌드하려면 -i 플래그와 함께 registry.redhat.io/openshift4/ose-operator-registry:v4 값을 사용합니다.
6.2.2. 인덱스
SQLite 데이터베이스 형식의 Operator 인덱스를 기존 Operator 번들에서 생성합니다.
OpenShift Dedicated 4.11부터 파일 기반 카탈로그 형식의 기본 Red Hat 제공 Operator 카탈로그 릴리스입니다. 더 이상 사용되지 않는 SQLite 데이터베이스 형식으로 릴리스된 OpenShift Dedicated 4.6 through 4.10의 기본 Red Hat 제공 Operator 카탈로그입니다.
SQLite 데이터베이스 형식과 관련된 opm 하위 명령, 플래그 및 기능도 더 이상 사용되지 않으며 향후 릴리스에서 제거됩니다. 기능은 계속 지원되며 더 이상 사용되지 않는 SQLite 데이터베이스 형식을 사용하는 카탈로그에 사용해야 합니다.
과 같은 SQLite 데이터베이스 형식을 사용하기 위한 opm 하위 명령 및 플래그의 대부분은 파일 기반 카탈로그 형식과 함께 작동하지 않습니다.
opm index prune
명령 구문
$ opm index <subcommand> [<flags>]
| 하위 명령 | 설명 |
|---|---|
|
| 인덱스에 Operator 번들을 추가합니다. |
|
| 지정되지 않은 모든 패키지의 인덱스를 정리합니다. |
|
| 특정 이미지와 연결되지 않은 번들인 stranded 번들의 인덱스를 정리합니다. |
|
| 인덱스에서 전체 Operator를 삭제합니다. |
6.2.2.1. add
인덱스에 Operator 번들을 추가합니다.
명령 구문
$ opm index add [<flags>]
| 플래그 | 설명 |
|---|---|
|
|
on-image |
|
|
컨테이너 이미지를 빌드하는 툴: |
|
| 추가할 번들의 쉼표로 구분된 목록입니다. |
|
|
저장 및 빌드(예: |
|
| 추가할 이전 인덱스입니다. |
|
| 활성화하면 Dockerfile만 생성하여 로컬 디스크에 저장합니다. |
|
|
채널 그래프의 업데이트 방법을 정의하는 그래프 업데이트 모드(기본값), |
|
| 선택 사항: Dockerfile을 생성하는 경우 파일 이름을 지정합니다. |
|
| 레지스트리 로드 오류를 허용합니다. |
|
|
컨테이너 이미지를 가져오는 툴: |
|
| 빌드 중인 컨테이너 이미지에 대한 사용자 정의 태그입니다. |
6.2.2.2. prune
지정되지 않은 모든 패키지의 인덱스를 정리합니다.
명령 구문
$ opm index prune [<flags>]
| 플래그 | 설명 |
|---|---|
|
|
on-image |
|
|
저장 및 빌드(예: |
|
| 정리할 인덱스입니다. |
|
| 활성화하면 Dockerfile만 생성하여 로컬 디스크에 저장합니다. |
|
| 선택 사항: Dockerfile을 생성하는 경우 파일 이름을 지정합니다. |
|
| 쉼표로 구분된 보관할 패키지 목록입니다. |
|
| 레지스트리 로드 오류를 허용합니다. |
|
| 빌드 중인 컨테이너 이미지에 대한 사용자 정의 태그입니다. |
6.2.2.3. prune-stranded
특정 이미지와 연결되지 않은 번들인 stranded 번들의 인덱스를 정리합니다.
명령 구문
$ opm index prune-stranded [<flags>]
| 플래그 | 설명 |
|---|---|
|
|
on-image |
|
|
저장 및 빌드(예: |
|
| 정리할 인덱스입니다. |
|
| 활성화하면 Dockerfile만 생성하여 로컬 디스크에 저장합니다. |
|
| 선택 사항: Dockerfile을 생성하는 경우 파일 이름을 지정합니다. |
|
| 쉼표로 구분된 보관할 패키지 목록입니다. |
|
| 레지스트리 로드 오류를 허용합니다. |
|
| 빌드 중인 컨테이너 이미지에 대한 사용자 정의 태그입니다. |
6.2.2.4. rm
인덱스에서 전체 Operator를 삭제합니다.
명령 구문
$ opm index rm [<flags>]
| 플래그 | 설명 |
|---|---|
|
|
on-image |
|
|
컨테이너 이미지를 빌드하는 툴: |
|
|
저장 및 빌드(예: |
|
| 삭제할 이전 인덱스입니다. |
|
| 활성화하면 Dockerfile만 생성하여 로컬 디스크에 저장합니다. |
|
| 삭제할 Operator의 쉼표로 구분된 목록입니다. |
|
| 선택 사항: Dockerfile을 생성하는 경우 파일 이름을 지정합니다. |
|
| 쉼표로 구분된 보관할 패키지 목록입니다. |
|
| 레지스트리 로드 오류를 허용합니다. |
|
|
컨테이너 이미지를 가져오는 툴: |
|
| 빌드 중인 컨테이너 이미지에 대한 사용자 정의 태그입니다. |
6.2.3. init
olm.package 선언적 구성 Blob을 생성합니다.
명령 구문
$ opm init <package_name> [<flags>]
| 플래그 | 설명 |
|---|---|
|
| 서브스크립션이 지정되지 않은 경우 기본값으로 설정할 채널입니다. |
|
|
Operator의 |
|
| 패키지 아이콘 경로입니다. |
|
|
출력 형식: |
6.2.4. migrate
SQLite 데이터베이스 형식 인덱스 이미지 또는 데이터베이스 파일을 파일 기반 카탈로그로 마이그레이션합니다.
관련 CLI 명령을 포함한 SQLite 기반 카탈로그 형식은 더 이상 사용되지 않는 기능입니다. 더 이상 사용되지 않는 기능은 여전히 OpenShift Dedicated에 포함되어 있으며 계속 지원됩니다. 그러나 이 기능은 향후 릴리스에서 제거될 예정이므로 새 배포에는 사용하지 않는 것이 좋습니다.
명령 구문
$ opm migrate <index_ref> <output_dir> [<flags>]
| 플래그 | 설명 |
|---|---|
|
|
출력 형식: |
6.2.5. 렌더
제공된 인덱스 이미지, 번들 이미지 및 SQLite 데이터베이스 파일에서 선언적 구성 Blob을 생성합니다.
명령 구문
$ opm render <index_image | bundle_image | sqlite_file> [<flags>]
| 플래그 | 설명 |
|---|---|
|
|
출력 형식: |
6.2.6. serve
GRPC 서버를 통해 선언적 구성을 제공합니다.
선언적 구성 디렉터리는 시작 시 serve 명령으로 로드됩니다. 이 명령이 시작된 후 선언적 구성 변경 사항은 제공된 콘텐츠에 반영되지 않습니다.
명령 구문
$ opm serve <source_path> [<flags>]
| 플래그 | 설명 |
|---|---|
|
| 이 플래그가 설정되면 서버 캐시 디렉터리를 동기화하고 유지합니다. |
|
|
캐시가 없거나 유효하지 않은 경우 오류와 함께 종료됩니다. |
|
| 서비스 캐시를 동기화하고 서비스하지 않고 종료합니다. |
|
| 디버그 로깅을 활성화합니다. |
|
| 서빙에 대한 도움말입니다. |
|
|
서비스의 포트 번호입니다. 기본값은 |
|
|
시작 프로파일링 끝점의 주소입니다. 형식은 |
|
|
컨테이너 종료 로그 파일의 경로입니다. 기본값은 |
6.2.7. 검증
지정된 디렉터리에서 선언적 구성 JSON 파일을 검증합니다.
명령 구문
$ opm validate <directory> [<flags>]
