Configuration Best Practices
This document highlights and consolidates configuration best practices that are introduced throughout the user guide, Getting Started documentation, and examples.
This is a living document. If you think of something that is not on this list but might be useful to others, please don’t hesitate to file an issue or submit a PR.
- General Configuration Tips
- “Naked” Pods vs ReplicaSets, Deployments, and Jobs
- Services
- Using Labels
- Container Images
- Using kubectl
General Configuration Tips
-
When defining configurations, specify the latest stable API version.
-
Configuration files should be stored in version control before being pushed to the cluster. This allows you to quickly roll back a configuration change if necessary. It also aids cluster re-creation and restoration.
-
Write your configuration files using YAML rather than JSON. Though these formats can be used interchangeably in almost all scenarios, YAML tends to be more user-friendly.
-
Group related objects into a single file whenever it makes sense. One file is often easier to manage than several. See the guestbook-all-in-one.yaml file as an example of this syntax.
-
Note also that many
kubectlcommands can be called on a directory. For example, you can callkubectl createon a directory of config files. -
Don’t specify default values unnecessarily: simple, minimal configuration will make errors less likely.
-
Put object descriptions in annotations, to allow better introspection.
“Naked” Pods vs ReplicaSets, Deployments, and Jobs
-
Don’t use naked Pods (that is, Pods not bound to a ReplicaSet or Deployment) if you can avoid it. Naked Pods will not be rescheduled in the event of a node failure.
A Deployment, which both creates a ReplicaSet to ensure that the desired number of Pods is always available, and specifies a strategy to replace Pods (such as RollingUpdate), is almost always preferable to creating Pods directly, except for some explicit
restartPolicy: Neverscenarios. A Job may also be appropriate.
Services
-
Create a Service before its corresponding backend workloads (Deployments or ReplicaSets), and before any workloads that need to access it. When Kubernetes starts a container, it provides environment variables pointing to all the Services which were running when the container was started. For example, if a Service named
fooexists, all containers will get the following variables in their initial environment:FOO_SERVICE_HOST=<the host the Service is running on> FOO_SERVICE_PORT=<the port the Service is running on>If you are writing code that talks to a Service, don’t use these environment variables; use the DNS name of the Service instead. Service environment variables are provided only for older software which can’t be modified to use DNS lookups, and are a much less flexible way of accessing Services.
-
Don’t specify a
hostPortfor a Pod unless it is absolutely necessary. When you bind a Pod to ahostPort, it limits the number of places the Pod can be scheduled, because each <hostIP,hostPort,protocol> combination must be unique. If you don’t specify thehostIPandprotocolexplicitly, Kubernetes will use0.0.0.0as the defaulthostIPandTCPas the defaultprotocol.If you only need access to the port for debugging purposes, you can use the apiserver proxy or
kubectl port-forward.If you explicitly need to expose a Pod’s port on the node, consider using a NodePort Service before resorting to
hostPort. -
Avoid using
hostNetwork, for the same reasons ashostPort. -
Use headless Services (which have a
ClusterIPofNone) for easy service discovery when you don’t needkube-proxyload balancing.
Using Labels
- Define and use labels that identify semantic attributes of your application or Deployment, such as
{ app: myapp, tier: frontend, phase: test, deployment: v3 }. You can use these labels to select the appropriate Pods for other resources; for example, a Service that selects alltier: frontendPods, or allphase: testcomponents ofapp: myapp. See the guestbook app for examples of this approach.
A Service can be made to span multiple Deployments by omitting release-specific labels from its selector. Deployments make it easy to update a running service without downtime.
A desired state of an object is described by a Deployment, and if changes to that spec are applied, the deployment controller changes the actual state to the desired state at a controlled rate.
- You can manipulate labels for debugging. Because Kubernetes controllers (such as ReplicaSet) and Services match to Pods using selector labels, removing the relevant labels from a Pod will stop it from being considered by a controller or from being served traffic by a Service. If you remove the labels of an existing Pod, its controller will create a new Pod to take its place. This is a useful way to debug a previously “live” Pod in a “quarantine” environment. To interactively remove or add labels, use
kubectl label.
Container Images
-
The default imagePullPolicy for a container is
IfNotPresent, which causes the kubelet to pull an image only if it does not already exist locally. If you want the image to be pulled every time Kubernetes starts the container, specifyimagePullPolicy: Always.An alternative, but deprecated way to have Kubernetes always pull the image is to use the
:latesttag, which will implicitly set theimagePullPolicytoAlways.Note: You should avoid using the
:latesttag when deploying containers in production, because this makes it hard to track which version of the image is running and hard to roll back.
- To make sure the container always uses the same version of the image, you can specify its digest (for example
sha256:45b23dee08af5e43a7fea6c4cf9c25ccf269ee113168c19722f87876677c5cb2). This uniquely identifies a specific version of the image, so it will never be updated by Kubernetes unless you change the digest value.
Using kubectl
-
Use
kubectl apply -f <directory>orkubectl create -f <directory>. This looks for Kubernetes configuration in all.yaml,.yml, and.jsonfiles in<directory>and passes it toapplyorcreate. -
Use label selectors for
getanddeleteoperations instead of specific object names. See the sections on label selectors and using labels effectively. -
Use
kubectl runandkubectl exposeto quickly create single-container Deployments and Services. See Use a Service to Access an Application in a Cluster for an example.