Skip to content

Commit c48ace2

Browse files
authored
Merge pull request #7133 from tzneal/update-running-locally
update running locally instructions
2 parents cf74cf0 + 538c027 commit c48ace2

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

contributors/devel/running-locally.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,8 @@ Set the endpoint for container runtime e.g. containerd
7171
export CONTAINER_RUNTIME_ENDPOINT="unix:///run/containerd/containerd.sock"
7272
```
7373

74+
Optionally set any other environment variables as needed to change the cluster configuration. The possible options are listed at the top of the `./hack/local-up-cluster.sh` script.
75+
7476
In a separate tab of your terminal, run the following:
7577

7678
```sh
@@ -100,7 +102,11 @@ print the commands to run to point kubectl at the local cluster.
100102

101103
Your cluster is running, and you want to start running containers!
102104

103-
You can now use any of the cluster/kubectl.sh commands to interact with your local setup.
105+
You can now use any of the cluster/kubectl.sh commands to interact with your local setup after setting your KUBECONFIG
106+
107+
```sh
108+
export KUBECONFIG=/var/run/kubernetes/admin.kubeconfig
109+
```
104110

105111
```sh
106112
./cluster/kubectl.sh get pods
@@ -112,10 +118,11 @@ You can now use any of the cluster/kubectl.sh commands to interact with your loc
112118
While waiting for the provisioning to complete, you can monitor progress in another terminal with these commands.
113119

114120
```sh
115-
docker images
116-
# To watch the process pull the nginx image
117-
docker ps
118-
# To watch all Docker processes.
121+
# containerd
122+
# To list images
123+
ctr --namespace k8s.io image ls
124+
# To list containers
125+
ctr --namespace k8s.io containers ls
119126
```
120127

121128
Once provisioning is complete, you can use the following commands for Kubernetes introspection.
@@ -181,3 +188,11 @@ KUBE_DNS_NAME="cluster.local"
181188
```
182189

183190
To know more on DNS service you can check out the [docs](http://kubernetes.io/docs/admin/dns/).
191+
192+
### All pod fail to start with a cgroups error of `expected cgroupsPath to be of format "slice:prefix:name" for systemd cgroups`
193+
194+
Your container runtime is using the systemd cgroup driver, but by default `./hack/local-up-cluster.sh` uses cgroupfs. To correct the mismatch, set the `CGROUP_DRIVER` environment variable to systemd as well.
195+
196+
```sh
197+
export CGROUP_DRIVER=systemd
198+
```

0 commit comments

Comments
 (0)