웹훅 자동화 만들기

1. 필요한 경우 자동화에 필요한 각 민감한 string(예: 액세스 토큰, 비밀번호, SSH 키)마다 W&B 시크릿을 생성합니다. 시크릿은 팀 settings에서 정의합니다.
2. 웹훅을 생성하여 엔드포인트와 인증 세부 정보를 정의하고, 인테그레이션에 필요한 시크릿에 대한 access 권한을 부여합니다.
3. 자동화를 생성하여 감시할 이벤트와 W&B가 전송하는 페이로드를 정의합니다. 페이로드에 필요한 시크릿에 대한 access 권한을 자동화에 부여합니다.

​

웹훅 만들기

1. W&B에 로그인한 다음 팀 settings 페이지로 이동합니다.
2. Webhooks section에서 New webhook을 클릭합니다.
3. 웹훅 이름을 입력합니다.
4. 웹훅의 엔드포인트 URL을 입력합니다.
5. 웹훅에 Bearer 토큰이 필요하면 Access token을 해당 값을 포함하는 시크릿으로 설정합니다. 웹훅 자동화를 사용할 때 W&B는 Authorization: Bearer HTTP 헤더를 액세스 토큰으로 설정하며, ${ACCESS_TOKEN} 페이로드 변수에서 해당 토큰에 액세스할 수 있습니다. W&B가 웹훅 서비스로 보내는 POST 요청 구조에 대한 자세한 내용은 웹훅 문제 해결을 참고하세요.
6. 웹훅 페이로드에 비밀번호나 기타 민감한 string이 필요하면 Secret을 해당 값을 포함하는 시크릿으로 설정합니다. 웹훅을 사용하는 자동화를 설정할 때 시크릿 이름 앞에 $를 붙여 페이로드 변수로 시크릿에 액세스할 수 있습니다. 웹훅의 액세스 토큰이 시크릿에 저장되어 있다면, 해당 시크릿을 액세스 토큰으로 지정하기 위해 반드시 다음 단계도 완료해야 합니다.
7. W&B가 엔드포인트에 연결하고 인증할 수 있는지 확인하려면:
   1. 필요에 따라 테스트할 페이로드를 입력합니다. 페이로드에서 웹훅이 액세스할 수 있는 시크릿을 참조하려면 이름 앞에 $를 붙입니다. W&B는 이 페이로드를 테스트에만 사용하며 저장하지 않습니다. 자동화의 페이로드는 자동화를 만들 때 설정합니다. 시크릿과 액세스 토큰이 POST 요청에서 어디에 포함되는지에 대한 자세한 내용은 웹훅 문제 해결을 참고하세요.
   2. Test를 클릭합니다. W&B는 설정한 자격 증명을 사용해 웹훅 엔드포인트에 연결을 시도합니다. 페이로드를 입력한 경우 W&B가 이를 전송합니다.
   테스트가 성공하지 않으면 웹훅 설정을 확인한 후 다시 시도하세요. 필요한 경우 웹훅 문제 해결을 참고하세요.

​

자동화 생성

​

자동화 보기 및 관리

​

페이로드 레퍼런스

​

페이로드 변수

​

페이로드 예시

on:
repository_dispatch:
  types: BUILD_AND_DEPLOY

{
  "event_type": "BUILD_AND_DEPLOY",
  "client_payload":
  {
    "event_author": "${event_author}",
    "artifact_version": "${artifact_version}",
    "artifact_version_string": "${artifact_version_string}",
    "artifact_collection_name": "${artifact_collection_name}",
    "project_name": "${project_name}",
    "entity_name": "${entity_name}"
    }
}

${event_type} --> "LINK_ARTIFACT" or "ADD_ARTIFACT_ALIAS"
${event_author} --> "<wandb-user>"
${artifact_version} --> "wandb-artifact://_id/QXJ0aWZhY3Q6NTE3ODg5ODg3"
${artifact_version_string} --> "<entity>/model-registry/<registered_model_name>:<alias>"
${artifact_collection_name} --> "<registered_model_name>"
${project_name} --> "model-registry"
${entity_name} --> "<entity>"

{
"@type": "MessageCard",
"@context": "http://schema.org/extensions",
"summary": "New Notification",
"sections": [
  {
    "activityTitle": "Notification from WANDB",
    "text": "This is an example message sent via Teams webhook.",
    "facts": [
      {
        "name": "Author",
        "value": "${event_author}"
      },
      {
        "name": "Event Type",
        "value": "${event_type}"
      }
    ],
    "markdown": true
  }
]
}

{
    "text": "New alert from WANDB!",
"blocks": [
    {
            "type": "section",
        "text": {
            "type": "mrkdwn",
            "text": "Registry event: ${event_type}"
        }
    },
        {
            "type":"section",
            "text": {
            "type": "mrkdwn",
            "text": "New version: ${artifact_version_string}"
        }
        },
        {
        "type": "divider"
    },
        {
            "type": "section",
        "text": {
            "type": "mrkdwn",
            "text": "Author: ${event_author}"
        }
        }
    ]
}

​

웹훅 문제 해결

#!/bin/bash

# 액세스 토큰 및 시크릿
ACCESS_TOKEN="your_api_key"
SECRET="your_api_secret"

# 웹훅 엔드포인트의 URL
API_ENDPOINT="https://your.webhook.endpoint/path"

# 전송할 데이터(예: JSON 형식)
PAYLOAD='{"key1": "value1", "key2": "value2"}'

# HMAC 서명을 생성합니다. 보안을 위해 W&B는
# 페이로드와 웹훅에 연결된 공유 시크릿을 기반으로 계산한
# X-Wandb-Signature 헤더를 SHA-256 HMAC과 함께 포함합니다.
SIGNATURE=$(echo -n "$PAYLOAD" | openssl dgst -sha256 -hmac "$SECRET" | awk '{print $2}')

# cURL 요청을 보냅니다
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Wandb-Signature: $SIGNATURE" \
  -d "$PAYLOAD" "$API_ENDPOINT"