API 키 유형
W&B는 사용자와 서비스 계정 모두에 API 키를 발급합니다.API 키 찾기 및 관리
조직 관리자, 팀 관리자, 구성원은 API Keys 탭에서 키를 관리합니다.- Multi-tenant Cloud
- Dedicated Cloud and Self-Managed
- 오른쪽 위의 프로필 아이콘을 클릭한 다음 조직을 선택하세요.
-
https://forge.coreweave.com/account-settings/[ORGANIZATION]/api-keys로 이동하세요.[ORGANIZATION]을 조직 이름으로 바꾸세요. API Keys 탭에는 사용자가 볼 수 있는 권한이 있는 키가 목록으로 표시됩니다.
Multi-tenant Cloud에서 조직 역할이 청구 관리자인 사용자는 API Keys 탭을 볼 수 없습니다. Dedicated Cloud와 Self-Managed에서는 청구 역할에 따라 탭이 제한되지 않습니다.
역할별 키 표시 범위
API Keys 탭에 나열된 키는 역할에 따라 다릅니다:API 키 table 조회
table은 각 키를 다음 column으로 나열합니다:- Key name: 키를 생성할 때 지정한 설명 이름입니다.
- Key ID: 키의 첫 부분으로, 식별에 사용됩니다.
- Owner: 키를 소유한 사용자 또는 서비스 계정입니다.
- Last used: 키가 가장 최근에 request를 인증한 시점입니다.
- Created on: 키가 생성된 시점입니다.
보안을 위해 table은 키 ID만 표시합니다. W&B는 키를 생성할 때 전체 시크릿 키를 한 번만 표시합니다. 키에 대한 전체 시크릿이 더 이상 없으면 키 교체하세요.
API 키 만들기
- API Keys 탭으로 이동하세요.
- New key를 클릭하세요.
- 키에 설명이 포함된 이름을 지정하세요.
- Create를 클릭하세요.
- 키를 즉시 복사하고 안전하게 보관하세요.
API 키 이름 변경
API 키의 용도를 기록하기 위해 이름을 변경하세요. 이렇게 하면 익숙하지 않은 키를 나중에 더 쉽게 트레이스할 수 있습니다. 이름을 변경해도 키의 시크릿은 변경되지 않으며, 키를 사용하는 어떤 것도 중단되지 않습니다.- table에서 키를 찾으세요.
- 키 행 끝에 있는 작업 메뉴를 클릭한 다음 Edit를 클릭하세요.
- 새 이름을 입력한 다음 저장하세요.
API 키 삭제
키가 더 이상 필요하지 않으면 삭제하세요. 키가 노출되었을 가능성이 있다면 즉시 삭제하세요. 키 하나를 삭제하려면 table에서 해당 키를 찾고 행 끝의 작업 메뉴를 클릭한 다음 Delete를 클릭하고 확인하세요. 여러 키를 한 번에 삭제하려면 다음 단계를 따르세요.- 삭제할 각 키 옆의 체크박스를 선택하세요.
- Delete를 클릭하세요. 버튼에 선택한 키의 숫자가 표시됩니다.
- 삭제를 확인하세요.
API 키 교체
보안 정책에 맞는 일정에 따라 키를 교체하고, 키가 노출되었을 가능성이 있는 경우 즉시 교체하세요. 사용 중인 워크로드가 계속 실행되어야 하는 경우 키를 삭제하는 대신 교체하세요. W&B에는 단일 교체 액션이 없습니다. 키의 전체 시크릿은 생성 시에만 표시되므로, 키를 교체하여 교체합니다:- 새 API 키를 생성하세요. 교체할 키와 구분되는 이름을 지정하세요.
- 이전 키를 사용하는 모든 스크립트, 작업 및 저장된 시크릿을 업데이트하세요. 저장소 옵션은 Store and handle API keys securely를 참조하세요.
- 워크로드가 새 키로 인증되는지 확인하세요.
- 이전 키를 Delete하세요.
구성원의 API 키 사용 제한
조직 관리자는 W&B App의 조직 설정에서 키 생성과 사용을 제한할 수 있습니다. 이러한 제한을 통해 조직의 리소스에 접근할 수 있는 키와 새 키를 생성할 수 있는 사용자를 제한합니다. 다음 섹션에서는 배포 유형에 따라 사용 가능한 제한 사항을 설명합니다.조직 범위 API 키 강제 적용
Multi-tenant Cloud에서 Enterprise 조직에 제공됩니다. W&B는 조직별로 이 설정을 활성화합니다. 설정이 보이지 않으면 W&B 계정 팀에 문의하세요. 강제 적용 시 조직 API 키와 조직 내 서비스 계정에 속한 키만 조직의 리소스에 액세스할 수 있습니다. 여러 조직에서 사용하는 개인 API 키는 이 조직에서 더 이상 사용할 수 없으므로, 다른 곳에서 유출된 키가 데이터에 액세스하는 것을 방지합니다. 조직 범위 API 키를 강제 적용하려면 다음 단계를 완료하세요:- 조직 관리자로 로그인하세요.
- 조직 설정을 연 다음 왼쪽 내비게이션에서 Authentication을 선택하세요.
- Enforce organization-scoped API keys 옆에 있는 Enforce를 클릭하세요.
- 조직 이름을 입력하여 확인한 다음 Enforce Organization-Scoped API Keys를 클릭하세요.
API 키 생성 비활성화
Dedicated Cloud 및 Self-Managed v0.84.0 이상에서 사용 가능합니다. 활성화되면 사용자와 팀 서비스 계정은 새 API 키를 생성할 수 없습니다. 조직 서비스 계정은 여전히 키를 생성할 수 있으며, 기존 키는 계속 작동하므로 이 설정을 켜도 실행 중인 작업이 중단되지 않습니다. 조직에서 제어된 프로세스를 통해 키를 발급하고 구성원이 직접 키를 생성하지 못하도록 하려는 경우 이 설정을 사용하세요. API 키 생성을 비활성화하려면 다음 단계를 완료하세요:- 조직 관리자로 로그인하세요.
- 조직 대시보드를 연 다음 왼쪽 내비게이션에서 개인정보 보호를 선택하세요.
- Access Control 섹션에서 Disable API key creation을 켜세요.
GORILLA_DISABLE_TEAM_SERVICE_ACCOUNT_CREATION를 참조하세요. 이 설정은 Dedicated Cloud 및 Self-Managed v0.83.0 이상에서 새로운 팀 범위 서비스 계정 생성을 방지합니다.
가용성
API 키 기능은 배포 유형에 따라 달라지며, Multi-tenant Cloud에서는 구독에 따라 달라집니다. 다음 table은 각 기능의 사용 가능 여부를 요약합니다.API 키를 안전하게 저장하고 처리하기
API 키는 W&B 계정에 액세스할 수 있는 권한을 부여하므로 비밀번호처럼 보호해야 합니다. 다음 섹션에서는 권장 저장 방법, 피해야 할 사항, 코드에 키를 전달하는 방법, 그리고 새 형식의 키를 사용하는 데 필요한 SDK 버전을 설명합니다.권장 저장 방법
다음 방법 중 하나를 사용하여 API 키를 안전하게 저장하세요.- 시크릿 관리자: AWS Secrets Manager, HashiCorp Vault, Azure Key Vault, Google Secret Manager 등 전용 시크릿 관리 시스템을 사용하세요.
- 비밀번호 관리자: 신뢰할 수 있는 비밀번호 관리자 애플리케이션을 사용하세요.
- OS 수준 키체인: macOS Keychain, Windows Credential Manager 또는 Linux secret service에 키를 저장하세요. 프로덕션 환경에서는 권장하지 않습니다.
피해야 할 사항
다음과 같은 방식은 API 키가 노출될 수 있으므로 피하세요.- Git과 같은 버전 관리 시스템에 API 키를 절대 커밋하지 마세요.
- API 키를 일반 텍스트 설정 파일에 저장하지 마세요.
- 명령줄에서 API 키를 전달하지 마세요.
ps와 같은 OS 명령어의 출력에 API 키가 그대로 표시됩니다. - 이메일, 채팅 또는 기타 암호화되지 않은 채널로 API 키를 공유하지 마세요.
- 소스 코드에 API 키를 하드코딩하지 마세요.
환경 변수
코드에서 API 키를 사용할 때는 환경 변수로 전달하세요.SDK 버전 호환성
새 API 키를 사용하는 경우 사용 중인 SDK 버전이 해당 키를 지원하는지 확인하세요. 새 API 키는 레거시 키보다 깁니다. 이전 버전의wandb 또는 weave SDK로 인증하면 API 키 길이 오류가 발생할 수 있습니다.
해결 방법: 최신 SDK 버전으로 업데이트하세요.
-
wandbSDK v0.22.3+ -
weaveSDK v0.52.17+
WANDB_API_KEY 환경 변수를 사용해 API 키를 설정하세요.