Cluster Add-on 설치

VPC 환경에서 이용 가능합니다.

특정 클러스터에 하나 이상의 Add-on을 설치합니다.

참고

요청을 검증한 후 설치를 시작합니다. 검증에 실패한 Add-on이 있으면 요청한 모든 Add-on이 설치되지 않습니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
POST	/vnks/v2/clusters/{uuid}/addons (한국 리전)
POST	/vnks/sgn-v2/clusters/{uuid}/addons (싱가포르 리전)
POST	/vnks/jpn-v2/clusters/{uuid}/addons (일본 리전)

요청 헤더

Ncloud Kubernetes Service API에서 공통으로 사용하는 헤더에 대한 정보는 Ncloud Kubernetes Service 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`uuid`	String	Required	클러스터의 UUID Cluster 목록 조회 참조

요청 구문

요청 구문은 다음과 같습니다.

[
  {
    "addonName": "string",
    "version": "string",
    "configurationValues": "string",
    "resolveConflicts": "string"
  }
]

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`[]`	Array	Required	설치할 Add-on 목록
`[].addonName`	String	Required	설치할 Add-on 이름 Add-on 목록 조회 참조
`[].version`	String	Required	설치할 Add-on 버전 Add-on 조회의 `versions[]` 참조 예: `1.0.0`
`[].configurationValues`	String	Optional	Helm values 재정의 값(JSON 객체 문자열) Add-on 버전 조회의 `configurationSchema` 참조 미입력 시 `{}` 적용
`[].resolveConflicts`	String	Optional	클러스터에서 직접 수정된 필드의 처리 방식 `Overwrite`(기본값) \| `Preserve` `Overwrite`: Add-on 설정 값으로 덮어쓰기 `Preserve`: 직접 수정한 값 유지

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request POST 'https://nks.apigw.ntruss.com/vnks/v2/clusters/****a20e-e0fb-4dc9-af1b-97fd3f8d****/addons' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '[
  {
    "addonName": "nks-csi",
    "version": "1.0.0"
  },
  {
    "addonName": "external-dns",
    "version": "1.0.0",
    "configurationValues": "{\"policy\": \"sync\"}",
    "resolveConflicts": "Overwrite"
  }
]'

응답

응답 형식을 설명합니다.

응답 구문

응답 구문은 다음과 같습니다.

{
  "addons": [
    {
      "uuid": "string",
      "clusterUuid": "string",
      "addonName": "string",
      "version": "string",
      "configurationValues": "string",
      "displayName": "string",
      "description": "string",
      "category": "string",
      "status": "string",
      "message": "string",
      "k8sVersion": "string",
      "latestVersion": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "totalCount": "integer"
}

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`addons[]`	Array	-	설치 요청된 Add-on 목록
`totalCount`	Integer	-	설치 요청된 Add-on 개수

addons[]의 각 항목에 대한 설명은 Cluster Add-on 조회의 응답 바디를 참조해 주십시오.

응답 상태 코드

Ncloud Kubernetes Service API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud Kubernetes Service 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "addons": [
        {
            "uuid": "****b3f1-2c4d-4a6e-9f80-1a2b3c4d****",
            "clusterUuid": "****a20e-e0fb-4dc9-af1b-97fd3f8d****",
            "addonName": "nks-csi",
            "version": "1.0.0",
            "configurationValues": "{}",
            "displayName": "NKS Block Storage CSI",
            "description": "NKS managed CSI driver for ncloud Block Storage. Provides dynamic volume provisioning, attachment, snapshot, and resize.",
            "category": "storage",
            "status": "install_in_progress",
            "message": "",
            "k8sVersion": "1.36.2-nks.1",
            "latestVersion": "",
            "createdAt": "2025-06-05T10:15:30.000Z",
            "updatedAt": "2025-06-05T10:15:30.000Z"
        },
        {
            "uuid": "****c4a2-3d5e-4b7f-8a91-2b3c4d5e****",
            "clusterUuid": "****a20e-e0fb-4dc9-af1b-97fd3f8d****",
            "addonName": "external-dns",
            "version": "1.0.0",
            "configurationValues": "{\"policy\": \"sync\"}",
            "displayName": "External DNS (NAVER Cloud)",
            "description": "external-dns with the NAVER Cloud Global DNS webhook provider. Syncs Kubernetes Service/Ingress hostnames to NAVER Cloud Global DNS records via the out-of-tree webhook provider (sidecar).",
            "category": "network",
            "status": "install_in_progress",
            "message": "",
            "k8sVersion": "1.36.2-nks.1",
            "latestVersion": "",
            "createdAt": "2025-06-05T10:15:30.000Z",
            "updatedAt": "2025-06-05T10:15:30.000Z"
        }
    ],
    "totalCount": 2
}

Documentation Index