1.12. 관찰 기능 API

1.12.1. 개요

이 문서는 Red Hat Advanced Cluster Management for Kubernetes용 MultiClusterObservability 리소스에 대한 것입니다. MultiClusterObservability 리소스에는 생성, 쿼리, 삭제 및 업데이트의 네 가지 요청이 있습니다.

1.12.1.1. 버전 정보

버전 : 2.12.0

1.12.1.2. URI 스키마

BasePath : /kubernetes/apis
Schemes : HTTPS

1.12.1.3. 태그

observability.open-cluster-management.io : multiclusterobservabilities 생성 및 관리

1.12.2. 경로

1.12.2.1. multiclusterobservability 리소스 생성

POST /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities

1.12.2.1.1. 설명

MultiClusterObservability 리소스를 생성합니다.

1.12.2.1.2. 매개 변수

유형	이름	설명	스키마
헤더	COOKIE 필요	권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다.	string
본문	본문 필요	생성할 MultiClusterObservability 리소스를 설명하는 매개변수입니다.	MultiClusterObservability

1.12.2.1.3. 응답

HTTP 코드	설명	스키마
200	성공	콘텐츠 없음
403	액세스 금지	콘텐츠 없음
404	리소스를 찾을 수 없음	콘텐츠 없음
500	내부 서비스 오류	콘텐츠 없음
503	서비스를 사용할 수 없음	콘텐츠 없음

1.12.2.1.4. 사용

application/yaml

1.12.2.1.5. 태그

observability.apps.open-cluster-management.io

1.12.2.1.6. HTTP 요청의 예

1.12.2.1.6.1. 요청 본문

{
  "apiVersion": "observability.open-cluster-management.io/v1beta2",
  "kind": "MultiClusterObservability",
  "metadata": {
    "name": "example"
  },
  "spec": {
    "observabilityAddonSpec": {}
    "storageConfig": {
      "metricObjectStorage": {
        "name": "thanos-object-storage",
        "key": "thanos.yaml"
      "writeStorage": {
        - "key": " ",
          "name" : " "
        - "key": " ",
          "name" : " "
         }
       }
   }
}

1.12.2.2. 모든 multiclusterobservabilities 쿼리

GET /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities

1.12.2.2.1. 설명

자세한 내용은 MultiClusterObservability 리소스를 쿼리합니다.

1.12.2.2.2. 매개 변수

유형	이름	설명	스키마
헤더	COOKIE 필요	권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다.	string

1.12.2.2.3. 응답

HTTP 코드	설명	스키마
200	성공	콘텐츠 없음
403	액세스 금지	콘텐츠 없음
404	리소스를 찾을 수 없음	콘텐츠 없음
500	내부 서비스 오류	콘텐츠 없음
503	서비스를 사용할 수 없음	콘텐츠 없음

1.12.2.2.4. 사용

application/yaml

1.12.2.2.5. 태그

observability.apps.open-cluster-management.io

1.12.2.3. 단일 multiclusterobservability 쿼리

GET /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities/{multiclusterobservability_name}

1.12.2.3.1. 설명

자세한 내용은 단일 MultiClusterObservability 리소스를 쿼리합니다.

1.12.2.3.2. 매개 변수

유형	이름	설명	스키마
헤더	COOKIE 필요	권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다.	string
경로	multiclusterobservability_name required	쿼리할 multiclusterobservability의 이름입니다.	string

1.12.2.3.3. 응답

HTTP 코드	설명	스키마
200	성공	콘텐츠 없음
403	액세스 금지	콘텐츠 없음
404	리소스를 찾을 수 없음	콘텐츠 없음
500	내부 서비스 오류	콘텐츠 없음
503	서비스를 사용할 수 없음	콘텐츠 없음

1.12.2.3.4. 태그

observability.apps.open-cluster-management.io

1.12.2.4. multiclusterobservability 리소스 삭제

DELETE /apis/observability.open-cluster-management.io/v1beta2/multiclusterobservabilities/{multiclusterobservability_name}

1.12.2.4.1. 매개 변수

유형	이름	설명	스키마
헤더	COOKIE 필요	권한 부여: Bearer {ACCESS_TOKEN}; ACCESS_TOKEN은 사용자 액세스 토큰입니다.	string
경로	multiclusterobservability_name required	삭제할 multiclusterobservability의 이름입니다.	string

1.12.2.4.2. 응답

HTTP 코드	설명	스키마
200	성공	콘텐츠 없음
403	액세스 금지	콘텐츠 없음
404	리소스를 찾을 수 없음	콘텐츠 없음
500	내부 서비스 오류	콘텐츠 없음
503	서비스를 사용할 수 없음	콘텐츠 없음

1.12.2.4.3. 태그

observability.apps.open-cluster-management.io

1.12.3. 정의

1.12.3.1. MultiClusterObservability

이름	설명	스키마
apiVersion 필요	MultiClusterObservability의 버전이 지정된 스키마입니다.	string
종류 필요	REST 리소스 MultiClusterObservability를 나타내는 문자열 값입니다.	string
메타데이터 필요	정책을 정의하는 규칙을 설명합니다.	object

spec

이름	설명	스키마
enableDownsampling optional	downsample을 활성화하거나 비활성화합니다. 기본값은 `true` 입니다. Downsample 데이터가 없으면 쿼리를 사용할 수 없습니다.	boolean
imagePullPolicy optional	MultiClusterObservability 이미지의 가져오기 정책입니다. 기본값은 `Always`입니다.	corev1.PullPolicy
imagePullSecret optional	MultiClusterObservability 이미지의 시크릿을 가져옵니다. 기본값은 `multiclusterhub-operator-pull-secret`입니다.	string
nodeSelector optional	노드 선택기의 사양입니다.	map[string]string
observabilityAddonSpec required	관찰 기능 애드온이 설치된 모든 관리 클러스터에 대한 글로벌 설정입니다.	observabilityAddonSpec
StorageConfig 필요	관찰 기능에서 사용할 스토리지 구성을 지정합니다.	StorageConfig
허용 오차 선택 사항	모든 구성 요소가 모든 테인트를 허용할 수 있는 기능이 제공됨.	[]corev1.Toleration
고급 선택 사항	관찰을 위한 고급 구성 설정입니다.	고급
리소스 선택 사항	MultiClusterObservability에 필요한 컴퓨팅 리소스	corev1.ResourceRequirements
복제본 선택 사항	MultiClusterObservability의 복제본입니다.	integer

storageConfig

이름	설명	스키마
alertmanagerStorageSize optional	alertmanager stateful 세트에 적용되는 스토리지 양입니다. 기본값은 `1Gi` 입니다.	string
compactStorageSize optional	thanos 컴팩트 상태 저장 세트에 적용되는 스토리지의 양입니다. 기본값은 `100Gi` 입니다.	string
metricObjectStorage required	메트릭에 대한 시크릿을 구성하는 오브젝트 저장소입니다.	metricObjectStorage
receiveStorageSize optional	thanos에 적용되는 스토리지 양은 상태 저장 세트를 수신합니다. 기본값은 `100Gi` 입니다.	string
ruleStorageSize optional	thanos 규칙 상태 저장 세트에 적용되는 스토리지의 양입니다. 기본값은 `1Gi` 입니다.	string
storageClass optional	`storageClass` stateful 세트를 지정합니다. 운영 체제가 스토리지를 생성하도록 `metricObjectStorage` 가 구성된 경우 이 스토리지는 오브젝트 스토리지에 사용됩니다. 기본값은 `gp2` 입니다.	string
storeStorageSize optional	thanos 저장소 상태 저장 세트에 적용되는 스토리지의 양입니다. 기본값은 `10Gi` 입니다.	string
writeStorage optional	엔드포인트 액세스 정보 목록입니다.	[ ]WriteStorage

writeStorage

이름	설명	스키마
이름 필요	엔드포인트 액세스 정보가 포함된 시크릿의 이름입니다.	string
키 필요	선택할 시크릿의 키입니다.	string

metricObjectStorage

이름	설명	스키마
키 필요	선택할 시크릿의 키입니다. 유효한 시크릿 키여야 합니다. Thanos 설명서를 참조하십시오.	string
이름 필요	`metricObjectStorage` 의 이름입니다. 자세한 내용은 Kubernetes 이름을 참조하십시오.	string

observabilityAddonSpec

이름	설명	스키마
enableMetrics optional	관찰 기능 애드온이 허브 클러스터로 지표를 전송하는지 여부를 나타냅니다. 기본값은 `true` 입니다.	boolean
간격 선택 사항	관찰 기능 애드온에서 허브 클러스터로 메트릭을 전송하는 때의 간격입니다. 기본값은 300초(`300s`)입니다.	integer
리소스 선택 사항	지표 수집기 리소스 요구 사항에 대한 리소스입니다. 기본 CPU 요청은 `100m` 이고 메모리 요청은 `100Mi` 입니다.	corev1.ResourceRequirements

고급

이름	설명	스키마
retentionConfig optional	관찰 기능에서 사용할 데이터 보존 구성을 지정합니다.	`RetentionConfig`
rbacQueryProxy optional	rbac-query-proxy 배포의 복제본 및 리소스를 지정합니다.	CommonSpec
Grafana 선택 사항	grafana 배포의 복제본 및 리소스를 지정합니다.	CommonSpec
Alertmanager 선택 사항	alertmanager statefulset의 복제본 및 리소스를 지정합니다.	CommonSpec
observatoriumAPI optional	`observatorium-api` 배포에 대한 복제본 및 리소스를 지정합니다.	CommonSpec
queryFrontend 선택 사항	query-frontend 배포의 복제본 및 리소스를 지정합니다.	CommonSpec
쿼리선택 사항	쿼리 배포에 대한 복제본 및 리소스를 지정합니다.	CommonSpec
선택 사항 수신	수신 상태 저장 세트의 복제본 및 리소스를 지정합니다.	CommonSpec
규칙 선택 사항	규칙 상태 저장 세트의 복제본 및 리소스를 지정합니다.	CommonSpec
저장 선택 사항	저장소 상태 저장 세트의 복제본 및 리소스를 지정합니다.	CommonSpec
CompactSpec optional	컴팩트한 상태 저장 세트의 리소스를 지정합니다.	compact
StoreMemcached 선택 사항	store-memcached의 복제본, 리소스 등을 지정합니다.	storeMemcached
queryFrontendMemcached optional	query-frontend-memcached의 replicas, resources 등을 지정합니다.	CacheConfig

retentionConfig

이름	설명	스키마
블록 기간 선택 사항	시계열 데이터베이스(TSDB) 블록의 기간을 차단하는 시간입니다. 기본값은 `2h` 입니다.	string
deleteDelay optional	삭제로 표시된 블록이 버킷에서 삭제될 때까지의 시간입니다. 기본값은 `48h` 입니다.	string
retentionInLocal optional	로컬 스토리지의 원시 샘플을 유지하는 시간입니다. 기본값은 `24h` 입니다.	string
retentionResolutionRaw 선택 사항	버킷에서 원시 해상도 샘플을 유지하는 시간입니다. 기본값은 365일(`365`일)입니다.	string
retentionResolution5m optional	버킷에서 해상도 1(5분)의 샘플을 유지하는 시간입니다. 기본값은 365일(24`d`)입니다.	string
retentionResolution1h optional	버킷에서 해상도 2(1시간)의 샘플을 유지하는 시간입니다. 기본값은 365일(24`d`)입니다.	string

CompactSpec

이름	설명	스키마
리소스 선택 사항	thanos 컴팩트에 필요한 컴퓨팅 리소스.	corev1.ResourceRequirements
serviceAccountAnnotations optional	주석은 컴팩트 서비스 계정으로 저장된 구조화되지 않은 키 값 맵입니다.	map[string]string

storeMemcached

이름	설명	스키마
리소스 선택 사항	MultiCLusterObservability에 필요한 컴퓨팅 리소스	corev1.ResourceRequirements
복제본 선택 사항	MultiClusterObservability의 복제본입니다.	integer
memoryLimitMb optional	Memcached 메가바이트의 메모리 제한입니다.	integer
maxItemSize optional	Memcached의 최대 항목 크기입니다. 기본값은 `1m, min:1k, max:1024m` 입니다.	string
connectionLimit optional	Memcached의 최대 동시 연결입니다. 기본값은	integer

status

이름	설명	스키마
상태 선택 사항	상태에는 MultiClusterObservability의 다른 조건 상태가 포함됩니다.	metav1.Condition

CommonSpec

이름	설명	스키마
리소스 선택 사항	구성 요소에 필요한 컴퓨팅 리소스입니다.	corev1.ResourceRequirements
복제본 선택 사항	구성 요소의 복제본입니다.	integer

QuerySpec

이름	설명	스키마
CommonSpec optional	쿼리 배포에 대한 복제본 및 리소스를 지정합니다.	CommonSpec
serviceAccountAnnotations optional	주석은 쿼리 서비스 계정으로 저장된 구조화되지 않은 키 값 맵입니다.	map[string]string

ReceiveSpec

이름	설명	스키마
CommonSpec optional	쿼리 배포에 대한 복제본 및 리소스를 지정합니다.	CommonSpec
serviceAccountAnnotations optional	주석은 쿼리 서비스 계정으로 저장된 구조화되지 않은 키 값 맵입니다.	map[string]string

StoreSpec

이름	설명	스키마
CommonSpec optional	쿼리 배포에 대한 복제본 및 리소스를 지정합니다.	CommonSpec
serviceAccountAnnotations optional	주석은 쿼리 서비스 계정으로 저장된 구조화되지 않은 키 값 맵입니다.	map[string]string

RuleSpec

이름	설명	스키마
CommonSpec optional	쿼리 배포에 대한 복제본 및 리소스를 지정합니다.	CommonSpec
evalInterval optional	규칙의 평가 간격을 지정합니다.	string
serviceAccountAnnotations optional	주석은 쿼리 서비스 계정으로 저장된 구조화되지 않은 키 값 맵입니다.	map[string]string