ClusterProfile API 개요

1 개요

ClusterProfile API 개요

https://multicluster.sigs.k8s.io/concepts/cluster-profile-api/

이 문서는 ClusterProfile API에 대한 개요를 제공합니다.

클러스터 프로필(Cluster Profile)은 네임스페이스 수준의 리소스로, 클러스터의 개별 멤버를 나타내며 클러스터의 속성과 상태를 자세히 설명합니다. 이 API는 다른 플랫폼과 구현 전반에 걸쳐 클러스터 정보를 제공하고 상호 작용하는 방법을 정의하는 표준화된 인터페이스를 제안합니다.

API에 대한 더 많은 정보를 KEP-4322에서 볼 수 있습니다.

2 용어

클러스터 인벤토리(Cluster Inventory): 클러스터의 모음에 관한 개념적 용어입니다. 클러스터 인벤토리는 클러스터 세트(ClusterSet)를 나타낼 수도 아닐 수도 있습니다. 모든 구성원 클러스터가 네임스페이스 동일성 원칙을 준수할 경우, 클러스터 인벤토리는 클러스터 세트로 간주됩니다.
클러스터 매니저(Cluster Manager): 구성원 클러스터당 ClusterProfile API 객체를 생성하고, 그들의 상태를 최신 상태로 유지하는 주체입니다. 각 클러스터 관리자는 고유한 이름으로 식별되어야 합니다.

각 ClusterProfile 리소스는 단일 클러스터 매니저에 의해 관리되어야 합니다. 클러스터 관리자는 구성원 클러스터에 접근하여 정보를 가져올 수 있는 충분한 권한을 가지고 있어야 하며, 이 정보를 사용하여 ClusterProfile API 리소스의 상태를 업데이트할 수 있어야 합니다.

ClusterProfile API 소비자: 클러스터 매니저를 운영하는 사람이나 워크로드 배포, 운영 관리 등의 목적으로 클러스터 매니저를 위한 확장기능을 개발하는 사람입니다.

3 API 예제

CRD 정의

apiVersion: multicluster.x-k8s.io/v1alpha1
kind: ClusterProfile
metadata:
  name: some-cluster-name
  namespace: fleet-system
  labels:
    x-k8s.io/cluster-manager: some-cluster-manager
spec:
  displayName: some-cluster
  clusterManager:
    name: some-cluster-manager
status:
  version:
    kubernetes: 1.28.0
  properties:
    - name: clusterset.k8s.io
      value: some-clusterset
    - name: location
      value: apac
  conditions:
    - type: ControlPlaneHealthy
      status: True
      lastTransitionTime: "2023-05-08T07:56:55Z"
      message: ""
    - type: Joined
      status: True
      lastTransitionTime: "2023-05-08T07:58:55Z"
      message: ""