study.

YAML의 spec과 status 읽기 · Kubernetes

원하는 상태를 적는 부분과 실제 관찰된 상태를 구분해봅니다.

← Kubernetes

진도·퀴즈와 함께 학습하기

먼저, 개념을 잡아볼게요.

리소스의 주소

apiVersion과 kind는 객체 종류를, metadata.name과 namespace는 해당 객체를 구분합니다. 같은 이름도 다른 namespace에서는 별개입니다.

Spec과 status

spec은 요청한 상태입니다. status는 컨트롤러와 노드가 관찰해 기록한 현재 상태이므로, 둘의 차이를 보고 조정이 진행 중인지 판단합니다.

API 스키마

kubectl explain은 연결된 API가 제공하는 필드 설명을 읽습니다. 예제 YAML을 복사하기 전에 필드의 위치와 자료형을 확인하는 데 유용합니다.

왜 필요한가요?

API 객체를 주소와 원하는 상태, 관찰한 상태로 나누어 읽어봅니다. 같은 이름이라도 종류나 namespace가 다르면 별도 객체입니다.

차례대로 이해하기

문서의 각 영역 읽기

apiVersion과 kind는 어떤 스키마를 쓰는지 나타냅니다. metadata는 이름·namespace·label 같은 식별 정보를 담고 spec은 원하는 설정, status는 시스템이 관찰한 결과를 담습니다.

서버 스키마와 대조

kubectl explain으로 필드의 타입과 설명을 확인합니다. 알 수 없는 필드를 넣고 값이 적용됐다고 가정하지 말고, 경고·오류와 서버에 저장된 결과를 확인하세요.

직접 실행하며 익혀보세요.

kubectl과 개인 실습용 Kubernetes 클러스터, POSIX 셸이 필요합니다. 매 실습에서 context를 확인하고 전용 namespace를 사용하세요. 실습별 정리는 해당 namespace의 모든 리소스를 삭제합니다.

전용 namespace에 ConfigMap을 선언하고 API 리소스 목록과 스키마를 읽으세요. ConfigMap은 Pod처럼 실행 상태를 갖는 객체가 아니라 설정 데이터입니다.

kubectl config current-context
kubectl create namespace study-k8s-api --dry-run=client -o yaml | kubectl apply -f -
kubectl apply -n study-k8s-api -f - <<'YAML'
apiVersion: v1
kind: ConfigMap
metadata:
  name: settings
data:
  mode: practice
YAML
kubectl get configmap settings -n study-k8s-api -o yaml
kubectl api-resources --namespaced=true
kubectl explain pod.spec
kubectl explain pod.status

이렇게 확인하세요

ConfigMap의 data에 mode=practice가 있고 namespace가 study-k8s-api인지 확인합니다. Pod 스키마의 spec과 status를 비교해 각각 사용자가 지정할 값과 시스템 관찰값의 예를 하나씩 적으세요.

실습 리소스 정리

결과 확인을 마친 뒤 실행하세요. 이 실습에서 만든 리소스와 보존할 데이터가 없는지 확인합니다.

kubectl delete namespace study-k8s-api

응용해보기

Deployment의 replicas를 바꾸려는데 status.replicas를 수정하면 될까요?

생각해본 뒤 풀이 보기

원하는 수는 spec.replicas에 선언합니다. status.replicas는 컨트롤러가 관찰한 결과라서 사용자가 원하는 상태를 요청하는 위치가 아닙니다. 적용 후 spec과 status가 어떻게 수렴하는지 비교하세요.

잠깐, 이해했는지 확인해볼까요?

Pod에서 컨트롤러가 관찰한 현재 상태를 주로 기록하는 필드는?

  1. metadata.name
  2. status
  3. apiVersion
  4. kind
생각해본 뒤 풀이 보기

status

status는 현재 관찰된 상태를 기록합니다. 원하는 동작은 spec에 선언하며 metadata는 객체 식별 등에 사용됩니다.

공식 문서 · YAML의 spec과 status 읽기