← Recipes

阅读中文版本

Inject a Sidecar with a Mutating Webhook

Configure a mutating admission webhook so every pod in the namespace gets a proxy sidecar without developers editing specs.

~30 minkubernetessidecarwebhook

Task

Configure kubectl apply -f mutating-webhook.yaml --namespace=mesh-enabled so the cluster enforces the policy at admission time instead of relying on manual review.

When to use this

A developer deploys a pod without kubectl apply -f mutating-webhook.yaml --namespace=mesh-enabled and it disrupts a node, causing evictions on a production cluster.

Prerequisites

  • A Kubernetes cluster with kubectl access
  • Cluster admin or namespace edit RBAC

Steps

1. Configure kubectl apply -f mutating-webhook.yaml --namespace=mesh-enabled in the project configuration file with the recommended defaults.

kubectl apply -f mutating-webhook.yaml --namespace=mesh-enabled

Expected output: The configuration is accepted and kubectl apply -f mutating-webhook.yaml --namespace=mesh-enabled runs without errors on the first invocation.

2. Run the check locally to verify kubectl apply -f mutating-webhook.yaml --namespace=mesh-enabled produces the expected result before pushing.

act -j build  # or: pnpm test

Expected output: Local run matches CI behavior; no surprises after push.

3. Add the gate to the CI pipeline so kubectl apply -f mutating-webhook.yaml --namespace=mesh-enabled blocks merge on failure.

- name: Run add sidecar injection policy
  run: pnpm test

Expected output: Pull requests with failing kubectl apply -f mutating-webhook.yaml --namespace=mesh-enabled are blocked from merging.

Troubleshooting

Problem

The check passes locally but fails in CI

Solution

Pin dependency versions and the runtime to match CI exactly; reproduce with the same Docker image or act.

Problem

Configuration is rejected with a schema error

Solution

Check the tool version matches the config schema; older versions may not support newer fields.

Limitations

  • The gate only runs on events that trigger the workflow; locally pushed commits bypass it.
  • Configuration drift is possible if someone edits settings outside version control.

Enforce at admission

Start by measuring the problem. Configure a mutating admission webhook so every pod in the namespace gets a proxy sidecar without developers editing specs. The most common mistake is adding the gate without first confirming it catches the issue you care about. Run kubectl apply -f mutating-webhook.yaml –namespace=mesh-enabled against the current codebase and inspect the output before wiring it into CI.

kubectl apply -f mutating-webhook.yaml --namespace=mesh-enabled

Verify the policy

Once the gate is in place, make failures actionable. A failing kubectl apply -f mutating-webhook.yaml –namespace=mesh-enabled should point to the exact file and line, not a generic error. Pin the tool version in the lockfile so a upstream release does not silently change behavior. Review the gate output in every pull request just like a test result.