시크릿 적용

Key Protect 도구 통합이 구성되고 나면, 이를 사용하여 도구 체인에서 필요한 모든 위치에 시크릿을 적용할 수 있습니다. 다음 예제는 Key Protect에 저장되는 시크릿을 파이프라인 도구 통합에서 필요한 IBM Cloud API 키에 적용합니다. 동일한 단계에 따라 시크릿 값이 필요한 Continuous Delivery 도구 통합에 시크릿을 적용할 수 있습니다.

새 도구 체인을 작성하기 전에 Slack 웹 훅 또는 Artifactory API 토큰과 같은 서드파티 시크릿을 Key Protect에 저장해야 합니다. 도구 체인에 대해 작업하는 동안 IBM Cloud API 키와 같은 IBM 관리 시크릿만 만들어 Key Protect에 저장할 수 있습니다.

1. Key Protect API 키용 IBM Cloud와 같은 보안 스토리지에서 시크릿을 검색하려면 키 아이콘을 클릭하십시오.

2. 저장소 필드에, 도구 체인 시크릿을 관리하는 데 사용하는 Key Protect 도구 통합의 이름 및 제공자를 지정하십시오. 예를 들어, Key Protect 도구 통합을 사용하려면 Key Project: ibm-keyprotect-secrets-1을 선택하십시오. 다른 제공자를 사용하여 Hashicorp Vault와 같은 도구 체인 시크릿을 관리할 수 있습니다.

3. 시크릿 이름을 선택하고 확인을 클릭하여 저장된 시크릿을 연관된 필드에 저장하십시오.

선택하는 시크릿의 이름이 캡슐 양식에 표시됩니다. 인라인으로 시크릿 이름을 편집할 수는 없지만, 을 클릭하여 이름을 삭제할 수는 있습니다. 시크릿 선택도구 제어를 다시 사용하여 시크릿 이름을 대체할 수도 있습니다. 시크릿 이름을 시크릿 필드에 수동으로 입력하거나 붙여넣는 경우에는 다른 형식으로 표시됩니다.

시크릿이 표시되는 형식은 값이 백엔드 Vault에 저장되는 시크릿을 참조하는지 또는 도구 체인에 저장되는 시크릿인지를 표시합니다. Key Protect와 같은 시크릿 제공자가 관리하는 시크릿에 대한 참조를 사용하면 시크릿 값이 단일 위치에 중앙 집중화되며 안전하게 저장됩니다. 이 접근 방식은 시크릿 스프롤 및 확산을 해결하며, 이는 도구 체인을 업데이트하지 않고 시크릿을 업데이트할 수 있음을 의미합니다. 시크릿 참조를 사용하는 경우 Key Protect에서 동적으로 검색하여 도구 체인을 실행할 때 실제 시크릿 값이 분석됩니다. 이 접근 방식은 도구 체인 시크릿의 값을 주기적으로 회전시켜야 하는 경우 유용합니다.

Key Protect 도구 통합을 도구 체인 템플리트에 추가

서비스 정의를 템플리트 저장소의 toolchain.yml 파일에 추가하여 Key Protect 도구 통합을 도구 체인 템플리트에 추가할 수 있습니다. 이 파일은 도구 체인을 위한 디자인 블루프린트이며 해당 템플리트를 기반으로 도구 체인 인스턴스를 작성하는 경우 사용 가능한 모든 도구 체인을 포함합니다. Key Protect 도구 통합을 포함하도록 기존 도구 체인 템플리트를 사용자 정의하려면, YAML 정의를 삽입하십시오.

  kp-tool:
    service_id: keyprotect
    parameters:
      name: kp-compliance-secrets
      region: us-south
      resource-group: default
      instance-name: ffs-secrets
      setup-authorization-type: create

특정 시나리오에서는 도구 체인을 작성하는 동안 동적으로 Key Protect 도구 통합을 추가할 수 있습니다. 예를 들어, 새로 작성을 클릭하여 새 API 키를 만드는 경우 재사용을 위해 이 키를 시크릿 저장소에 저장 선택 상자를 선택하여 API 키를 Key Protect 인스턴스에 저장한 후 나중에 다시 사용할 수 있습니다. 아직 Key Protect 인스턴스가 없는 경우 새 인스턴스가 작성됩니다.

시크릿에 액세스하기 위해 도구 체인에 권한 부여

Key Protect에 저장되는 시크릿에 대한 참조는 도구 체인이 실행될 때 자동으로 분석됩니다. 필수 시크릿에 액세스하려면, Key Protect 인스턴스에 액세스하기 위해 도구 체인에 권한을 부여해야 합니다. 템플리트에서 도구 체인을 작성하는 경우 Key Protect 통합을 구성할 때 권한 유형 드롭 다운을 사용하십시오. Key Protect 통합을 기존 도구 체인에 추가하는 경우 권한 작성 단추를 사용하십시오.

IBM Cloud의 권한을 확인하려면 다음 단계를 완료하십시오.

1. IBM Cloud 콘솔에서 [ 관리 ] > [액세스(IAM) ]을 클릭합니다.
2. 권한을 클릭하십시오.

또한 ‘권한 관리 ’ 페이지에서 본인의 권한을 확인할 수 있습니다.

필요한 경우 권한을 수동으로 작성할 수 있습니다. 시크릿 참조를 분석하려면, Key Protect 서비스 인스턴스를 수정하기 위해 도구 체인 인스턴스에 Viewer 및 ReaderPlus 액세스가 둘 다 있어야 합니다.

API를 사용하여 Key Protect 구성하기

Key Protect 도구 통합은 도구 통합을 만들고, 읽고, 업데이트할 때 Toolchain HTTP API 및 SDK와 함께 사용할 수 있는 다음 구성 매개변수를 지원합니다.

keyprotect 값을 사용하여 요청 본문에서 tool_type_id 특성을 지정해야 합니다.

Key Protect에 대해 자세히 알아보기

Key Protect에 대해 자세히 알아보려면 서비스 개요를 참조하십시오.