← Recipes

阅读中文版本

Hot Reload ConfigMap Changes Without Restart

Mount the ConfigMap as a projected volume and watch for changes so the app picks up config updates without a rolling restart.

~25 minkubernetesconfigmaphot-reload

Task

Configure kubectl set volume deploy/api --add --name=config -m /config -t configmap --configmap-name=app-config 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 set volume deploy/api --add --name=config -m /config -t configmap --configmap-name=app-config 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 set volume deploy/api --add --name=config -m /config -t configmap --configmap-name=app-config in the project configuration file with the recommended defaults.

kubectl set volume deploy/api --add --name=config -m /config -t configmap --configmap-name=app-config

Expected output: The configuration is accepted and kubectl set volume deploy/api --add --name=config -m /config -t configmap --configmap-name=app-config runs without errors on the first invocation.

2. Run the check locally to verify kubectl set volume deploy/api --add --name=config -m /config -t configmap --configmap-name=app-config produces the expected result before pushing.

pnpm test

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

3. Add the gate to the CI pipeline so kubectl set volume deploy/api --add --name=config -m /config -t configmap --configmap-name=app-config blocks merge on failure.

- name: Run add configmap hot reload
  run: pnpm test

Expected output: Pull requests with failing kubectl set volume deploy/api --add --name=config -m /config -t configmap --configmap-name=app-config 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. Mount the ConfigMap as a projected volume and watch for changes so the app picks up config updates without a rolling restart. The most common mistake is adding the gate without first confirming it catches the issue you care about. Run kubectl set volume deploy/api –add –name=config -m /config -t configmap –configmap-name=app-config against the current codebase and inspect the output before wiring it into CI.

kubectl set volume deploy/api --add --name=config -m /config -t configmap --configmap-name=app-config

Verify the policy

Once the gate is in place, make failures actionable. A failing kubectl set volume deploy/api –add –name=config -m /config -t configmap –configmap-name=app-config 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.