Vault CLI를 사용하여 키-값 시크릿 관리
이미 HashiCorp Vault를 사용하는 경우, 명령행 인터페이스(CLI)를 사용하여 IBM Cloud® Secrets Manager과(와) 상호작용하여 키-값 시크릿을 관리할 수 있습니다. 모든 오퍼레이션은 Vault CLI에서 사용 가능한 가이드라인을 따릅니다.
Secrets Manager HashiCorp Vault KV 시크릿 엔진 버전 2 CLI 명령을 지원합니다. KV v2 CLI에 대한 자세한 내용은 Vault KV v2 문서를 참조하세요.
시작하기 전에, Vault 명령을 사용하여 Secrets Manager 인스턴스에 액세스할 수 있도록 Vault CLI를 구성하십시오. Vault CLI 사용에 대해 자세히 알아보려면 Vault 문서를 확인하십시오.
Secrets Manager에 대해 표준 CLI를 사용하려면 Secrets Manager CLI 참조를 확인하십시오.
키-값 시크릿 작성 또는 업데이트
키-값 시크릿의 버전을 작성합니다.
vault kv put [-format=FORMAT] ibmcloud/kv/SECRET_NAME [KEY_VALUE_PAIRS]
사용자 정의 그룹에서 키-값 시크릿의 버전을 작성합니다.
vault kv put [-format=FORMAT] ibmcloud/kv/GROUP_ID/SECRET_NAME [KEY_VALUE_PAIRS]
전제조건
키-값 시크릿을 작성하려면 작성자 서비스 역할이 필요합니다.
명령 옵션
- -format
- 지정한 형식으로 출력을 인쇄합니다. 유효한 형식은
table,json및yaml입니다. 기본값은table입니다.VAULT_FORMAT환경 변수를 사용하여 출력 형식을 설정할 수도 있습니다.
예
키-값 시크릿의 페이로드를 작성하거나 업데이트합니다.
vault kv put ibmcloud/kv/example-kv-secret key1=value1 key2=value2
사용자 정의 그룹에서 키-값 시크릿의 페이로드를 작성하거나 업데이트합니다.
vault kv put ibmcloud/kv/9426e546-83de-4da5-9631-d70c993186c8/example-kv-secret key1=value1 key2=value2
출력
kv 시크릿의 새 버전을 작성하는 명령은 다음 출력을 리턴합니다.
Key Value
--- -----
created_time 2022-03-08T18:32:43.610242127Z
deletion_time n/a
destroyed false
version 2
키-값 시크릿의 버전 읽기
키-값 시크릿의 버전을 가져옵니다. 요청 성공 시 다른 메타데이터와 함께 지정된 시크릿 버전과 연관된 시크릿 데이터를 리턴합니다.
vault kv get [-version=VERSION] [-format=FORMAT] ibmcloud/kv/SECRET_NAME
사용자 정의 그룹에서 키-값 시크릿의 버전을 가져옵니다.
vault kv get [-version=VERSION] [-format=FORMAT] ibmcloud/kv/GROUP_ID/SECRET_NAME
전제조건
키-값 시크릿의 버전을 읽으려면 독자 또는 작성자 서비스 역할이 필요합니다.
명령 옵션
- -version
- 읽으려는 버전입니다. 생략된 경우 최신 버전이 리턴됩니다.
- -format
- 지정한 형식으로 출력을 인쇄합니다. 유효한 형식은
table,json및yaml입니다. 기본값은table입니다.VAULT_FORMAT환경 변수를 사용하여 출력 형식을 설정할 수도 있습니다.
예
키-값 시크릿의 버전을 읽습니다.
vault kv get -version=1 ibmcloud/kv/my-test-kv-secret
사용자 정의 그룹에서 키-값 시크릿의 버전을 읽습니다.
vault kv get -version=1 ibmcloud/kv/9426e546-83de-4da5-9631-d70c993186c8/my-test-kv-secret
출력
kv 시크릿의 버전을 읽는 명령은 다음 출력을 리턴합니다.
====== Metadata ======
Key Value
--- -----
created_time 2022-03-04T17:08:34.406336489Z
deletion_time n/a
destroyed false
version 1
==== Data ====
Key Value
--- -----
key1 value1
키-값 시크릿의 최신 버전 삭제
키-값 시크릿의 최신 버전을 삭제합니다. 삭제 취소 명령을 호출하여 삭제를 실행 취소할 수 있습니다.
vault kv delete [-format=FORMAT] ibmcloud/kv/SECRET_NAME
사용자 정의 그룹에서 키-값 시크릿의 최신 버전을 삭제합니다.
vault kv delete [-format=FORMAT] ibmcloud/kv/GROUP_ID/SECRET_NAME
전제조건
키-값 시크릿을 삭제하려면 관리자 서비스 역할이 필요합니다.
명령 옵션
- -format
- 지정한 형식으로 출력을 인쇄합니다. 유효한 형식은
table,json및yaml입니다. 기본값은table입니다.VAULT_FORMAT환경 변수를 사용하여 출력 형식을 설정할 수도 있습니다.
예
키-값 시크릿의 최신 버전을 삭제합니다.
vault kv delete -format=json ibmcloud/kv/my-test-kv-secret
사용자 정의 그룹에서 키-값 시크릿의 최신 버전을 삭제합니다.
vault kv delete -format=json ibmcloud/kv/9426e546-83de-4da5-9631-d70c993186c8/my-test-kv-secret
출력
kv 시크릿 정보의 최신 버전을 삭제하는 명령은 출력을 리턴하지 않습니다.
키-값 시크릿의 지정된 버전 삭제
키-값 시크릿의 지정된 버전을 삭제합니다. 삭제 취소 명령을 호출하여 삭제를 실행 취소할 수 있습니다.
vault kv delete [-versions=VERSIONS] [-format=FORMAT] ibmcloud/kv/SECRET_NAME
사용자 정의 그룹에서 키-값 시크릿의 지정된 버전을 삭제합니다.
vault kv delete [-versions=VERSIONS] [-format=FORMAT] ibmcloud/kv/GROUP_ID/SECRET_NAME
전제조건
키-값 시크릿을 삭제하려면 관리자 서비스 역할이 필요합니다.
명령 옵션
- -versions
- 삭제하려는 버전입니다.
- -format
- 지정한 형식으로 출력을 인쇄합니다. 유효한 형식은
table,json및yaml입니다. 기본값은table입니다.VAULT_FORMAT환경 변수를 사용하여 출력 형식을 설정할 수도 있습니다.
예
키-값 시크릿의 지정된 버전을 삭제합니다.
vault kv delete -versions=2 ibmcloud/kv/my-test-kv-secret
사용자 정의 그룹에서 키-값 시크릿의 지정된 버전을 삭제합니다.
vault kv delete -versions=2 ibmcloud/kv/9426e546-83de-4da5-9631-d70c993186c8/my-test-kv-secret
출력
kv 시크릿의 지정된 버전을 삭제하는 명령은 출력을 리턴하지 않습니다.
키-값 시크릿 삭제 취소
키-값 시크릿의 이전에 삭제된 버전을 복원합니다.
vault kv undelete [-versions=VERSIONS] [-format=FORMAT] ibmcloud/kv/SECRET_NAME
사용자 정의 그룹에서 키-값 시크릿의 이전에 삭제된 버전을 복원합니다.
vault kv undelete [-versions=VERSIONS] [-format=FORMAT] ibmcloud/kv/GROUP_ID/SECRET_NAME
전제조건
시크릿을 복원하려면 관리자 서비스 역할이 필요합니다.
명령 옵션
- -versions
- 삭제하려는 버전입니다.
- -format
- 지정한 형식으로 출력을 인쇄합니다. 유효한 형식은
table,json및yaml입니다. 기본값은table입니다.VAULT_FORMAT환경 변수를 사용하여 출력 형식을 설정할 수도 있습니다.
예
키-값 시크릿의 지정된 버전을 삭제 취소합니다.
vault kv undelete -versions=2 ibmcloud/kv/my-test-kv-secret
키-값 시크릿의 지정된 버전을 삭제 취소합니다.
vault kv undelete -versions=2 ibmcloud/kv/9426e546-83de-4da5-9631-d70c993186c8/my-test-kv-secret
출력
kv 시크릿의 지정된 버전을 삭제 취소하는 명령은 다음 출력을 리턴합니다.
Success! Data written to: ibmcloud/kv/undelete/my-test-kv-secret
시크릿의 버전 영구 삭제
키-값 시크릿의 지정된 버전을 영구적으로 삭제합니다. 대신 시크릿의 버전을 소프트 삭제하려면 지정된 버전 삭제 명령을 사용하십시오.
vault kv destroy [-versions=VERSIONS] [-format=FORMAT] ibmcloud/kv/SECRET_NAME
사용자 정의 그룹에서 키-값 시크릿의 지정된 버전을 영구 삭제합니다.
vault kv destroy [-versions=VERSIONS] [-format=FORMAT] ibmcloud/kv/GROUP_ID/SECRET_NAME
전제조건
시크릿을 삭제하려면 관리자 서비스 역할이 필요합니다.
명령 옵션
- -versions
- 영구 삭제하려는 버전입니다.
- -format
- 지정한 형식으로 출력을 인쇄합니다. 유효한 형식은
table,json및yaml입니다. 기본값은table입니다.VAULT_FORMAT환경 변수를 사용하여 출력 형식을 설정할 수도 있습니다.
예
키-값 시크릿의 지정된 버전을 영구적으로 삭제합니다.
vault kv destroy -versions=2 ibmcloud/kv/my-test-kv-secret
사용자 정의 그룹에서 키-값 시크릿의 지정된 버전을 영구적으로 삭제합니다.
vault kv destroy -versions=2 ibmcloud/kv/9426e546-83de-4da5-9631-d70c993186c8/my-test-kv-secret
출력
kv 시크릿의 버전을 영구 삭제하는 명령은 다음 출력을 리턴합니다.
Success! Data written to: ibmcloud/kv/undelete/my-test-kv-secret
메타데이터 키-값 비밀 생성 또는 업데이트
키-값 비밀의 메타데이터를 만들거나 업데이트합니다.
vault kv metadata put [-format=FORMAT] [METADATA_KEY_VALUE_PAIRS] ibmcloud/kv/SECRET_NAME
사용자 지정 그룹에서 키-값 비밀의 메타데이터를 만들거나 업데이트합니다.
vault kv metadata put [-format=FORMAT] [METADATA_KEY_VALUE_PAIRS] ibmcloud/kv/GROUP_ID/SECRET_NAME
전제조건
키-값 시크릿을 작성하려면 작성자 서비스 역할이 필요합니다.
명령 옵션
- -format
- 지정한 형식으로 출력을 인쇄합니다. 유효한 형식은
table,json및yaml입니다. 기본값은table입니다.VAULT_FORMAT환경 변수를 사용하여 출력 형식을 설정할 수도 있습니다.
예
키-값 시크릿의 페이로드를 작성하거나 업데이트합니다.
vault kv metadata put -custom-metadata=key1=value1 -custom-metadata=key2=value2 ibmcloud/kv/mysecret
사용자 정의 그룹에서 키-값 시크릿의 페이로드를 작성하거나 업데이트합니다.
vault kv metadata put -custom-metadata=key1=value1 -custom-metadata=key2=value2 ibmcloud/kv/9426e546-83de-4da5-9631-d70c993186c8/mysecret
출력
kv 시크릿의 새 버전을 작성하는 명령은 다음 출력을 리턴합니다.
Key Value
--- -----
created_time 2022-03-08T18:32:43.610242127Z
deletion_time n/a
destroyed false
version 2
키-값 시크릿의 메타데이터 읽기
키-값 시크릿의 메타데이터를 가져옵니다.
vault kv metadata get ibmcloud/kv/SECRET_NAME
사용자 정의 그룹에서 키-값 시크릿의 메타데이터를 가져옵니다.
vault kv metadata get ibmcloud/kv/GROUP_ID/SECRET_NAME
전제조건
키-값 시크릿의 메타데이터를 읽으려면 독자 또는 작성자 서비스 역할이 필요합니다.
명령 옵션
- -format
- 지정한 형식으로 출력을 인쇄합니다. 유효한 형식은
table,json및yaml입니다. 기본값은table입니다.VAULT_FORMAT환경 변수를 사용하여 출력 형식을 설정할 수도 있습니다.
예
키-값 시크릿의 메타데이터를 읽습니다.
vault kv metadata get ibmcloud/kv/my-test-kv-secret
사용자 지정 그룹에서 키-값 비밀의 메타데이터를 읽습니다.
vault kv metadata get ibmcloud/kv/9426e546-83de-4da5-9631-d70c993186c8/my-test-kv-secret
출력
kv 시크릿의 메타데이터를 읽는 명령은 다음 출력을 리턴합니다.
========== Metadata ==========
Key Value
--- -----
cas_required false
created_time 2022-03-04T17:08:34.406336489Z
current_version 3
custom_metadata map[key1:value1 key2:value2]
delete_version_after 0s
max_versions 10
oldest_version 0
updated_time 2022-03-08T20:06:39.585190049Z
====== Version 1 ======
Key Value
--- -----
created_time 2022-03-04T17:08:34.406336489Z
deletion_time n/a
destroyed true
====== Version 2 ======
Key Value
--- -----
created_time 2022-03-08T18:32:43.610242127Z
deletion_time 2022-03-08T20:05:08.850704454Z
destroyed false
====== Version 3 ======
Key Value
--- -----
created_time 2022-03-08T20:06:39.585190049Z
deletion_time n/a
destroyed false
키-값 시크릿의 메타데이터 및 모든 버전 삭제
지정된 키-값 시크릿의 메타데이터 및 모든 버전 데이터를 영구적으로 삭제합니다. 이 명령을 사용하면 모든 버전 히스토리가 제거됩니다.
vault kv metadata delete ibmcloud/kv/SECRET_NAME
vault kv metadata delete ibmcloud/kv/GROUP_ID/SECRET_NAME
전제조건
키-값 시크릿의 메타데이터를 삭제하려면 관리자 서비스 역할이 필요합니다.
명령 옵션
- -format
- 지정한 형식으로 출력을 인쇄합니다. 유효한 형식은
table,json및yaml입니다. 기본값은table입니다.VAULT_FORMAT환경 변수를 사용하여 출력 형식을 설정할 수도 있습니다.
예
키-값 시크릿의 데이터 및 메타데이터를 영구적으로 삭제합니다.
vault kv metadata delete ibmcloud/kv/my-test-kv-secret
사용자 정의 시크릿 그룹에서 키-값 시크릿의 데이터 및 메타데이터를 영구적으로 삭제합니다.
vault kv metadata delete ibmcloud/kv/9426e546-83de-4da5-9631-d70c993186c8/my-test-kv-secret
출력
kv 시크릿의 메타데이터를 삭제하는 명령은 다음 출력을 리턴합니다.
Success! Data deleted (if it existed) at: ibmcloud/kv/metadata/my-test-kv-secret
키-값 시크릿의 키 이름 나열
키-값 시크릿의 키 이름 목록을 가져옵니다. 키 이름에는 민감한 정보를 인코딩하지 마십시오. 키의 값은 이 명령을 사용하여 액세스할 수 없습니다.
vault kv list ibmcloud/kv
사용자 정의 시크릿 그룹에 저장된 키-값 시크릿의 키 이름을 나열합니다.
vault kv list ibmcloud/kv/GROUP_ID
전제조건
키-값 시크릿의 키 이름을 읽으려면 독자 또는 작성자 서비스 역할이 필요합니다.
명령 옵션
- -format
- 지정한 형식으로 출력을 인쇄합니다. 유효한 형식은
table,json및yaml입니다. 기본값은table입니다.VAULT_FORMAT환경 변수를 사용하여 출력 형식을 설정할 수도 있습니다.
예
default 시크릿 그룹에 저장된 키-값 시크릿의 키 이름을 나열합니다.
vault kv list ibmcloud/kv
사용자 정의 시크릿 그룹에 저장된 키-값 시크릿의 키 이름을 나열합니다.
vault kv list ibmcloud/kv/9426e546-83de-4da5-9631-d70c993186c8
출력
kv 시크릿의 키 이름을 나열하는 명령은 다음 출력을 리턴합니다.
Keys
----
my-updated-kv-secret
키-값 시크릿 패치
키-값 비밀의 버전을 패치합니다.
vault kv patch [-format=FORMAT] ibmcloud/kv/SECRET_NAME [KEY_VALUE_PAIRS]
사용자 정의 그룹에서 키-값 시크릿의 버전을 작성합니다.
vault kv patch [-format=FORMAT] ibmcloud/kv/GROUP_ID/SECRET_NAME [KEY_VALUE_PAIRS]
전제조건
키-값 시크릿을 작성하려면 작성자 서비스 역할이 필요합니다.
명령 옵션
- -format
- 지정한 형식으로 출력을 인쇄합니다. 유효한 형식은
table,json및yaml입니다. 기본값은table입니다.VAULT_FORMAT환경 변수를 사용하여 출력 형식을 설정할 수도 있습니다.
예
키-값 시크릿의 페이로드를 작성하거나 업데이트합니다.
vault kv patch ibmcloud/kv/example-kv-secret key1=value1 key2=value2
사용자 정의 그룹에서 키-값 시크릿의 페이로드를 작성하거나 업데이트합니다.
vault kv patch ibmcloud/kv/9426e546-83de-4da5-9631-d70c993186c8/example-kv-secret key1=value1 key2=value2
출력
kv 시크릿의 새 버전을 작성하는 명령은 다음 출력을 리턴합니다.
Key Value
--- -----
created_time 2022-03-08T18:32:43.610242127Z
deletion_time n/a
destroyed false
version 2