Create static Pods
Kubernetes Docs · نسخهٔ f284a9e7c87f · CC BY 4.0 برای مستندات و مجوزهای همراه
<!-- overview -->
This page shows you how to create _static Pods_ on a node. For an overview of what static Pods are and when to use them, see Static Pods.
{{% heading "prerequisites" %}}
{{< include "task-tutorial-prereqs.md" >}} {{< version-check >}}
This page assumes you're using {{< glossary_tooltip term_id="cri-o" >}} to run Pods, and that your nodes are running the Fedora operating system. Instructions for other distributions or Kubernetes installations may vary.
<!-- steps -->
Create a static pod {#static-pod-creation}
You can configure a static Pod with either a file system hosted configuration file or a web hosted configuration file.
Filesystem-hosted static Pod manifest {#configuration-files}
Manifests are standard Pod definitions in JSON or YAML format in a specific directory. Use the staticPodPath: <the directory> field in the kubelet configuration file, which periodically scans the directory and creates/deletes static Pods as YAML/JSON files appear/disappear there. Note that the kubelet will ignore files starting with dots when scanning the specified directory.
{{< caution >}} The kubelet processes all files not starting with a dot in the static Pod directory — there is no filtering by file extension. For example, if you create a backup of a manifest by running cp kube-apiserver.yaml kube-apiserver.yaml.backup, the kubelet will read both files and attempt to create a static Pod from each. When two files define a Pod with the same name, the resulting behavior is undefined and can cause the backup's outdated spec to silently take effect instead of the current manifest. If you do create a backup, store it outside the static Pod directory (for example, in /etc/kubernetes/backup/). {{< /caution >}}
For example, this is how to start a simple web server as a static Pod:
- Choose a node where you want to run the static Pod. In this example, it's
my-node1.
ssh my-node1- Choose a directory, say
/etc/kubernetes/manifestsand place a web server
Pod definition there, for example /etc/kubernetes/manifests/static-web.yaml:
# Run this command on the node where kubelet is running
mkdir -p /etc/kubernetes/manifests/
cat <<EOF >/etc/kubernetes/manifests/static-web.yaml
apiVersion: v1
kind: Pod
metadata:
name: static-web
labels:
role: myrole
spec:
containers:
- name: web
image: nginx
ports:
- name: web
containerPort: 80
protocol: TCP
EOF- Configure the kubelet on that node to set a
staticPodPathvalue in the
kubelet configuration file. See Set Kubelet Parameters Via A Configuration File for more information.
An alternative and deprecated method is to configure the kubelet on that node to look for static Pod manifests locally, using a command line argument. To use the deprecated approach, start the kubelet with the --pod-manifest-path=/etc/kubernetes/manifests/ argument.
- Restart the kubelet. On Fedora, you would run:
# Run this command on the node where the kubelet is running
systemctl restart kubeletWeb-hosted static pod manifest {#pods-created-via-http}
Kubelet periodically downloads a file specified by --manifest-url=<URL> argument and interprets it as a JSON/YAML file that contains Pod definitions. Similar to how filesystem-hosted manifests work, the kubelet refetches the manifest on a schedule. If there are changes to the list of static Pods, the kubelet applies them.
To use this approach:
- Create a YAML file and store it on a web server so that you can pass the URL of that file to the kubelet.
apiVersion: v1
kind: Pod
metadata:
name: static-web
labels:
role: myrole
spec:
containers:
- name: web
image: nginx
ports:
- name: web
containerPort: 80
protocol: TCP- Configure the kubelet on your selected node to use this web manifest by
updating your kubelet configuration file to include the staticPodURL field:
apiVersion: kubelet.config.k8s.io/v1beta1
kind: KubeletConfiguration
staticPodURL: "<manifest-url>"- Restart the kubelet. On Fedora, you would run:
# Run this command on the node where the kubelet is running
systemctl restart kubeletObserve static pod behavior {#behavior-of-static-pods}
When the kubelet starts, it automatically starts all defined static Pods. As you have defined a static Pod and restarted the kubelet, the new static Pod should already be running.
You can view running containers (including static Pods) by running (on the node):
# Run this command on the node where the kubelet is running
crictl psThe output might be something like:
CONTAINER IMAGE CREATED STATE NAME ATTEMPT POD ID
129fd7d382018 docker.io/library/nginx@sha256:... 11 minutes ago Running web 0 34533c6729106{{< note >}} crictl outputs the image URI and SHA-256 checksum. NAME will look more like: docker.io/library/nginx@sha256:0d17b565c37bcbd895e9d92315a05c1c3c9a29f762b011a10c54a66cd53c9b31. {{< /note >}}
You can see the mirror Pod on the API server:
kubectl get podsNAME READY STATUS RESTARTS AGE
static-web-my-node1 1/1 Running 0 2m{{< note >}} Make sure the kubelet has permission to create the mirror Pod in the API server. If not, the creation request is rejected by the API server. {{< /note >}}
{{< glossary_tooltip term_id="label" text="Labels" >}} from the static Pod are propagated into the mirror Pod. You can use those labels as normal via {{< glossary_tooltip term_id="selector" text="selectors" >}}, etc.
If you try to use kubectl to delete the mirror Pod from the API server, the kubelet _doesn't_ remove the static Pod:
kubectl delete pod static-web-my-node1pod "static-web-my-node1" deletedYou can see that the Pod is still running:
kubectl get podsNAME READY STATUS RESTARTS AGE
static-web-my-node1 1/1 Running 0 4sBack on your node where the kubelet is running, you can try to stop the container manually. You'll see that, after a time, the kubelet will notice and will restart the Pod automatically:
# Run these commands on the node where the kubelet is running
crictl stop 129fd7d382018 # replace with the ID of your container
sleep 20
crictl psCONTAINER IMAGE CREATED STATE NAME ATTEMPT POD ID
89db4553e1eeb docker.io/library/nginx@sha256:... 19 seconds ago Running web 1 34533c6729106Once you identify the right container, you can get the logs for that container with crictl:
# Run these commands on the node where the container is running
crictl logs <container_id>10.240.0.48 - - [16/Nov/2022:12:45:49 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.47.0" "-"
10.240.0.48 - - [16/Nov/2022:12:45:50 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.47.0" "-"
10.240.0.48 - - [16/Nove/2022:12:45:51 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.47.0" "-"To find more about how to debug using crictl, please visit _Debugging Kubernetes nodes with crictl_.
Dynamic addition and removal of static pods
The running kubelet periodically scans the configured directory (/etc/kubernetes/manifests in our example) for changes and adds/removes Pods as files appear/disappear in this directory.
# This assumes you are using filesystem-hosted static Pod configuration
# Run these commands on the node where the container is running
mv /etc/kubernetes/manifests/static-web.yaml /tmp
sleep 20
crictl ps
# You see that no nginx container is running
mv /tmp/static-web.yaml /etc/kubernetes/manifests/
sleep 20
crictl psCONTAINER IMAGE CREATED STATE NAME ATTEMPT POD ID
f427638871c35 docker.io/library/nginx@sha256:... 19 seconds ago Running web 1 34533c6729106{{% heading "whatsnext" %}}
- Static Pods
- Generate static Pod manifests for control plane components
- Generate static Pod manifest for local etcd
- [Debugging Kubernetes nodes with
crictl](/docs/tasks/debug/debug-cluster/crictl/) - [Learn more about
crictl](https://github.com/kubernetes-sigs/cri-tools) - Set up etcd instances as static pods managed by a kubelet