【実務・中級編】Kubernetesマニフェストファイル完全入門:YAMLの書き方からベストプラクティスまで – インフラ構成管理(IaC)活用バイブル

Kubernetesマニフェスト完全制覇:YAML地獄から脱却し、チームのデプロイ速度を極限まで引き上げる実践ガイド

テックリードの私たちが日々頭を悩ませる問題、それは「Kubernetesマニフェストの肥大化とカオス」だ。
「動くには動くが、誰が書いたか分からない数千行のYAML」「リソース制限の欠落による本番環境でのOOM Killer祭り」「APIバージョンの非推奨化(Deprecation)による突然のデプロイ失敗」。

これらは、Kubernetesを導入したチームが必ず通る「YAML地獄」の初期症状である。

本記事では、単なるYAMLの構文解説にとどまらない。「開発スピードを劇的に落とさないためのエディタ設定」「ミスを物理的に排除するCI/CDパイプラインの思想」「明日からそのまま使えるプロダクション品質のベストプラクティス構成例」を、現場の最前線で戦うエンジニアに向けて余すところなく伝授する。

—

1. マニフェストファイルの役割と基本構造

Kubernetesマニフェストの本質は、「あるべき状態(Desired State)」の宣言である。命令型のコマンド(`kubectl run`など)を排除し、すべてをGitでバージョン管理されたYAMLとしてコード化する(GitOps)ことで、インフラの冪等性(Idempotency)を担保する。

しかし、このYAMLというフォーマットは、インデントの崩れや型のエラーをコンパイル時に検知しにくいため、開発者の認知負荷を高める元凶になりやすい。

開発スピードを劇的に高めるVS Codeキーボードショートカット & 拡張機能

素手でKubernetesのYAMLを書くのは、素手で火口を触るようなものだ。以下のツールとショートカットをチーム標準に強制せよ。

  • 必須拡張機能: `Red Hatによる Kubernetes (vscode-kubernetes-tools)`
  • APIスキーマに基づいたIntelliSense(入力補完)を提供。これなしでYAMLを書くのは不可能。
  • 必須拡張機能: `YAML by Red Hat`
  • JSON Schemaバリデーションと、インデントの視覚化。
  • 神ショートカット(macOS)
  • `Cmd + Shift + P` -> `YAML: Format Document`(フォーマットの統一。セーブ時自動フォーマットを`.vscode/settings.json`で強制せよ)
  • ドキュメント区切り(`—`)の挿入:スニペット登録を推奨。

—

2. APIバージョンとキンド(Kind)の種類

Kubernetesを使いこなす上で最も罠なのが、APIバージョンのライフサイクルだ。
`extensions/v1beta1` や `apps/v1beta1` といった古いAPIは、Kubernetesのバージョンアップ(例: v1.16やv1.22での削除)によって突如としてデプロイ不能になる。

プロダクションでの鉄則

1. 常に最新かつ安定したAPIを使う

  • DeploymentやStatefulSetは `apps/v1` を使う(`v1beta1` は過去の遺物だ)。

2. Kubeconform や Pluto をCIに組み込む

  • クラスターのバージョンアップに追従するため、静的解析ツールで非推奨APIの利用を検知する仕組みをパイプラインの初段に置け。

—

3. リクエストとリミット(リソース管理)の重要性

「とりあえず動くから」と `resources` ブロックを省略するジュニアエンジニアが後を絶たない。これはクラスターに対するテロ行為に等しい。

  • requests(要求値): スケジューラがPodをどのノードに配置するか(Node Placement)の判断基準。
  • limits(上限値): cgroupによってハードリミットされる値。これを超えるとCPUスロットリングが発生するか、メモリの場合は容赦なく OOM Killerによりプロセスが強制終了(Exit Code 137) される。

ベストプラクティス:LimitRange と ResourceQuota

開発者任せにするな。Namespaceレベルでデフォルト値を強制しろ。

チーム標準: Namespaceデフォルトリソース制限の強制 (LimitRange)
apiVersion: v1
kind: LimitRange
metadata:
name: core-app-limit-range
namespace: production
spec:
limits:

  • default:

cpu: “500m”
memory: “512Mi”
defaultRequest:
cpu: “100m”
memory: “128Mi”
type: Container

—

4. 可読性と保守性を高めるYAML記述のコツ & 実用的なベストプラクティス構成

チーム開発において、YAMLがスパゲッティ化するのを防ぐには、「責務の分離」と「Kustomizeによる DRY(Don’t Repeat Yourself)原則の徹底」が不可欠だ。素のYAMLをコピペで増殖させる文化は今すぐ捨てよう。

以下に、実戦で通用するプロダクション品質のKustomizeベースのディレクトリ構造とマニフェストの模範解答を示す。

ディレクトリ構造のベストプラクティス

deploy/
├── base/ # 全環境共通のベースマニフェスト
│ ├── deployment.yaml
│ ├── service.yaml
│ └── kustomization.yaml
└── overlays/ # 環境ごとの差分パッチ
├── staging/
│ ├── kustomization.yaml
│ └── replicas-patch.yaml
└── production/
├── kustomization.yaml
└── resources-patch.yaml

実践設定ファイル例:Production向け Deployment

以下のコードは、セキュリティ、可用性、オブザーバビリティの観点で「そのまま本番に投入できる」最高峰の品質を持つ。

apiVersion: apps/v1
kind: Deployment
metadata:
name: payment-api
namespace: production
labels:
app.kubernetes.io/name: payment-api
app.kubernetes.io/part-of: fintech-core
app.kubernetes.io/managed-by: kustomize
spec:
# 可用性担保のため最低2レプリカ
replicas: 3
selector:
matchLabels:
app.kubernetes.io/name: payment-api
strategy:
type: RollingUpdate
rollingUpdate:
maxSurge: 1 # ローリングアップデート時に許容する最大超過Pod数
maxUnavailable: 0 # ゼロダウンタイムデプロイの担保(unavailableを0にする)
template:
metadata:
labels:
app.kubernetes.io/name: payment-api
spec:
# セキュリティ: ルート権限でのコンテナ実行を禁止
securityContext:
runAsNonRoot: true
runAsUser: 10001
fsGroup: 10001
containers:

  • name: api

image: ghcr.io/your-org/payment-api:v1.4.2
imagePullPolicy: IfNotPresent
ports:

  • containerPort: 8080

name: http

# 【重要】リソース制限の明示(OOM防止とスケジューリング最適化)
resources:
requests:
cpu: “250m”
memory: “256Mi”
limits:
cpu: “1000m”
memory: “1Gi”

# 【重要】ライフサイクルプローブの設定(死活監視とトラフィック制御)
livenessProbe:
httpGet:
path: /healthz
port: http
initialDelaySeconds: 10
periodSeconds: 15
timeoutSeconds: 3
failureThreshold: 3

readinessProbe:
httpGet:
path: /readyz
port: http
initialDelaySeconds: 5
periodSeconds: 5
timeoutSeconds: 2
successThreshold: 1
failureThreshold: 2

# セキュリティ強化: コンテナ自体の特権昇格を禁止
securityContext:
allowPrivilegeEscalation: false
readOnlyRootFilesystem: true
capabilities:
drop:

  • ALL

# 設定値の注入(ConfigMap/Secretの参照)
envFrom:

  • configMapRef:

name: payment-api-config

  • secretRef:

name: payment-api-secret

# 一時ストレージの割り当て(readOnlyRootFilesystem: true対策)
volumeMounts:

  • name: tmp-dir

mountPath: /tmp

volumes:

  • name: tmp-dir

emptyDir: {}

# ノードの偏りを防ぎ、可用性を最大化するトポロジー分散制約
topologySpreadConstraints:

  • maxSkew: 1

topologyKey: kubernetes.io/hostname
whenUnsatisfiable: DoNotSchedule
labelSelector:
matchLabels:
app.kubernetes.io/name: payment-api

—

チーム開発のための共有化ルール(テックリードからの提言)

1. 「野良YAML」の直接applyを禁止する

  • 開発者が手元のPCから `kubectl apply -f` を本番環境に対して実行することをKubernetesのRBAC(権限管理)レベルで禁止せよ。すべての変更はGitHubを経由し、ArgoCDやFluxなどのCDツール、あるいはGitHub Actionsによるパイプライン経由で行う。

2. Conftest / OPA (Open Policy Agent) によるポリシーのコード化

  • 「`latest` タグのイメージを使用していないか」「`securityContext` が適切に設定されているか」を、CIのパイプラインで機械的にチェックする仕組みを導入しろ。レビューイの負担を減らし、レビュワーの精神的健康を守る特効薬となる。

Kubernetesマニフェストの美しさは、そのままそのチームのエンジニアリングの成熟度を映し出す鏡だ。
規律正しいYAMLの運用を通じて、デプロイの恐怖を過去のものにし、プロダクトの価値提供速度を限界まで加速させよう。

タイトルとURLをコピーしました