summaryrefslogtreecommitdiff
path: root/kubernetes_cheat_sheet.md
blob: 65b738a206bd8a724e0b470ee7bfc67c53f02718 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
# Kubernetes Cheat Sheet

## kubectl CLI

### Context

|                                      |                             |
|--------------------------------------|-----------------------------|
|`kubectl config current-context`      |Get the current context      |
|`kubectl config get-contexts`         |List all context             |
|`kubectl config use-context [contextName]`|Set the current context  |
|`kubectl config delete-context [contextName]`|Delete a context from the config file|

### Namespace

|                                      |                             |
|--------------------------------------|-----------------------------|
|`kubectl get namespace`               |List all namespaces          |
|`kubectl get ns`                      |Shortcut                     |
|`kubectl config set-context --current --namespace=[namespaceName]`|Set the current context to use a namespace|
|`kubectl create ns`                   |Create a namespace           |
|`kubectl delete ns`                   |Delete a namespace           |
|`kubectl get pods --all-namespaces`   |List all pods in all namespaces|

### Nodes

|                                      |                             |
|--------------------------------------|-----------------------------|
|`kubectl get nodes`                   |Get a list of all the installed nodes|
|`kubectl describe node [NAME]`        |Get some info about a node   |        

### Pod

|                                      |                             |
|--------------------------------------|-----------------------------|
|`kubectl create -f [pod-definition.yml]`|Create a pod               |
|`kubectl run [podname] --image=busybox -- /bin/sh -c "sleep 3600"`|Run a pod (example)| 
|`kubectl get pods`                    |List the running pods        |
|`kubectl get pods -o wide`            |Same but with more info      |
|`kubectl describe pod [podname]`      |Show pod info                |
|`kubectl get pod [podname] -o yaml > file.yaml`|Extract the pod definition in YAML and save it to a file|
|`kubectl exec -it [podname] -- sh`    |Interactive mode             |
|`kubectl exec -it [podname] -c [containername] -- sh`|Exec into a pod|
|`kubectl delete -f [pod-definition.yml]`|Delete a pod               |
|`kubectl delete pod [podname]`        |Same using the pod's name    |
|`kubectl logs [podname] -c [containername]`|Get the logs for a container|

### ReplicaSets

|                                      |                             |
|--------------------------------------|-----------------------------|
|`kubectl apply -f [definition.yaml]`  |Create a ReplicaSet          |
|`kubectl get rs`                      |List ReplicaSets             |
|`kubectl describe rs [rsName]`        |Get info                     |
|`kubectl delete -f [definition.yaml]` |Delete a ReplicaSet          |
|`kubectl delete rs [rsName]`          |Same but using the ReplicaSet name|

### Deployments

|                                      |                             |
|--------------------------------------|-----------------------------|
|`kubectl create deploy [deploymentName] --image=busybox --replicas=3 --port=80`|The imperative way|
|`kubectl apply -f [definition.yaml]`  |Create a deployment          |
|`kubectl get deploy`                  |List deployments             |
|`kubectl describe deploy [deploymentName]`|Get info                 |
|`kubectl get rs`                      |List replicasets             |
|`kubectl delete -f [definition.yaml]` |Delete a deployment          |
|`kubectl delete deploy [deploymentName]`|Same but using the deployment name|

### DaemonSets

|                                      |                             |
|--------------------------------------|-----------------------------|
|`kubectl apply -f [definition.yaml]`  |Create a DaemonSet           |
|`kubectl get ds`                      |List DaemonSets              |
|`kubectl describe ds [rsName]`        |Get info                     |
|`kubectl delete -f [definition.yaml]` |Delete a DaemonSet           |
|`kubectl delete ds [rsName]`          |Same but using the DaemonSet name|

### StatefulSets

|                                      |                             |
|--------------------------------------|-----------------------------|
|`kubectl apply -f [definition.yaml]`  |Create a StatefulSet         |
|`kubectl get sts`                     |List StatefulSets            |
|`kubectl describe sts [rsName]`       |Get info                     |
|`kubectl delete -f [definition.yaml]` |Delete a StatefulSet         |
|`kubectl delete sts [rsName]`         |Same but using the StatefulSet name|

### Jobs

|                                      |                             |
|--------------------------------------|-----------------------------|
|`kubectl create job [jobName] --image=busybox`|The imperative way   |
|`kubectl apply -f [definition.yaml]`  |Create a Job                 |
|`kubectl get job`                     |List jobs                    |
|`kubectl describe job [jobName]`      |Get info                     |
|`kubectl delete -f [definition.yaml]` |Delete a job                 |
|`kubectl delete job [jobName]`        |Same but using the Job name  |

### CronJobs

|                                      |                             |
|--------------------------------------|-----------------------------|
|`kubectl create cronjob [jobName] --image=busybox --schedule="*/1 * * * *" -- bin/sh -c "date;"`|The imperative way|
|`kubectl apply -f [definition.yaml]`  |Create a CronJob             |
|`kubectl get cj`                      |List CronJobs                |
|`kubectl describe cj [jobName]`       |Get info                     |
|`kubectl delete -f [definition.yaml]` |Delete a CronJob             |
|`kubectl delete cj [jobName]`         |Same but using the CronJob name|

### RollingUpdate

|                                      |                             |
|--------------------------------------|-----------------------------|
|`kubectl apply -f [definition.yaml]`  |Update a deployment          |
|`kubectl rollout status`              |Get the progress of the update|
|`kubectl rollout history deployment [deploymentname]`|Get the history of the deployment|
|`kubectl rollout undo [deploymentname]`|Rollback a deployment       |
|`kubectl rollout undo [deploymentname] --to-revision=[revision#]`|Rollback to a revision number|

### ClusterIP

|                                      |                             |
|--------------------------------------|-----------------------------|
|`kubectl expose po [podName] --port=80 --target-port=8080 --name=frontend|Create a service to expose a pod|
|`kubectl expose deploy [deployName] --port=80 --target-port=8080`|Create a service to expose a deployment|
|`kubectl apply -f [definition.yaml]`  |Deploy the service           |
|`kubectl get svc`                     |Get the services list        |
|`kubectl get svc -o wide`             |Get extra info               |
|`kubectl describe svc [serviceName]`  |Describe the service         |
|`kubectl delete -f [definition.yaml]` |Delete the service           |
|`kubectl delete svc [serviceName]`    |Delete the service using it's name|

### NodePort

|                                      |                             |
|--------------------------------------|-----------------------------|
|`kubectl expose po [podName] --port=80 --target-port=8080 --type=NodePort`|Create a service to expose a pod|
|`kubectl expose deploy [deployName] --port=80 --target-port=8080 --type=NodePort --name=frontend`|Create a service to expose a deployment|
|`kubectl apply -f [definition.yaml]`  |Deploy the service           |
|`kubectl get svc`                     |Get the services list        |
|`kubectl get svc -o wide`             |Get extra info               |
|`kubectl describe svc [serviceName]`  |Describe the service         |
|`kubectl delete -f [definition.yaml]` |Delete the service           |
|`kubectl delete svc [serviceName]`    |Delete the service using it's name|

### Misc.

|                                      |                             |
|--------------------------------------|-----------------------------|
|`kubectl create -f [YAML file]`       |Create an object using YAML  |

---

### `kubectx`

- Separate program that acts as an alias for `kubectl config use-context`
    - *Fast way to switch between clusters and namespaces in kubectl*

---

### Declarative vs Imperative

#### Declarative Example - YAML File

```yaml
apiVersion: v1
kind: Pod
metadata:
  name: myapp-pod
  labels:
    app: myapp
    type: front-end
spec:
  containers:
    name: nginx-container
    image: nginx
```

#### Imperative Example - Series of commands

```sh
kubectl run mynginx --image=nginx --port=80

kubectl create deploy mynginx --image=nginx --port=80 --replicas=3

kubectl create service nodeport myservice --targetPort=8080

kubectl delete pod nginx
```

### Pod definition - required properties

- Root level required properties
    - `apiVersion`
        - Api version of the object
    - `kind`
        - type of object
    - `metadata.name`
        - unique name for the object
    - `metadata.namespace`
        - scoped environment name (will default to current)
    - `spec`
        - object specifications or desired state

---

### Namespace Example

Namespace definition:

```yaml
apiVersion: v1
kind: Namespace
metadata:
  name: prod
```

Pod definition:

```yaml
apiVersion: v1
# Object type
kind: Pod
metadata:
  name: myapp-pod
  namespace: prod
  # Labels are used to identify, describe and group related sets of objects or resources together
  labels:
    app: myapp
    type: front-end
spec:
  containers:
  - name: nginx-container
    image: nginx
    ports:
      # Listening port
    - containerPort: 80
      name: http
      protocol: TCP
    # Environment Variables
    env:
    - name: DBCON
      value: connectionstring
    # Equiv to Docker ENTRYPOINT
    command: ["/bin/sh", "-c"]
    args: ["echo ${DBCON}"]
```

---

### Other kinds of YAML definitions

#### NetworkPolicy Example

```yaml
kind: NetworkPolicy
apiVersion: networking.k8s.io/v1
metadata:
  namespace: clientb
  name: deny-from-other-namespaces
spec:
  podSelector:
    matchLabels:
  ingress:
  - from:
    - podSelector: {}
```

#### ResourceQuota Example

```yaml
apiVersion: v1
kind: ResourceQuota
metadata:
  name: compute-quota
  namespace: prod
spec:
  hard:
    pods: "10"
    limits.cpu: "5"
    limits.memory: 10Gi
```

#### Pod definition

---

### Pod state

|                              |                                        |
|------------------------------|----------------------------------------|
|Pending                       |Accepted but not yet created            |
|Running                       |Bound to a node                         |
|Succeeded                     |Exited with status 0                    |
|Failed                        |All containers exit and at least one exited with non-zero status|
|Unknown                       |Communication issues with the pod       |
|CrashLoopBackOff              |Started crashed, started again, and then crashed again|

---

### Init Containers

Example pod definition that uses init containers

```yaml
apiVersion: v1
kind: Pod
metadata:
  name: myapp-pod
  labels:
    app: myapp
spec:
  # App container
  containers:
  - name: myapp-container
    image: busybox
  # Init containers (these will run before the app container)
  initContainers:
  - name: init-myservice
    image: busybox:1.28
    command: ['sh', '-c', "until nslookup mysvc.namespace.svc.cluster.local; do echo waiting for my service; sleep 2; done"]
  - name: init-mydb
    image: busybox:1.28
    command: ['sh', '-c', "until lookup mydb.namespace.svc.cluster.local; do echo waiting for mydb; sleep 2; done"]
```

---

### Multi-Containers Pods

Example of defining multiple containers in a single pod definition

```yaml
apiVersion: v1
kind: Pod
metadata:
  name: two-containers
spec:
  restartPolicy: Always
  containers:
  # Container #1
  - name: mynginx
    image: nginx
    ports:
      - containerPort: 80
  # Container #2
  - name: mybox
    image: busybox
    ports:
      - containerPort: 81
    command:
      - sleep
      - "3600"
```

---

### ReplicaSets

Example ReplicaSet definition

```yaml
apiVersion: apps/v1
kind: ReplicaSet
metadata:
  name: rs-example
spec:
  replicas: 3 # desired number of instances
  selector:
    matchLabels:
      app: nginx
      env: front-end
  template:
    metadata:
      labels:
        app: nginx
        type: front-end
    spec:
      containers:
      - name: nginx
        image: nginx:stable-alpine
        ports:
        - containerPort: 80
```

- Top section is specific to ReplicaSets
- Section under `template:` specifies the pods you want to run

---

### Deployments

Example Deployment definition

```yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: deploy-example
spec:
  replicas: 3 # number of pod instances
  revisionHistoryLimit: 3 # number of previous iterations to keep
  selector:
    matchLabels:
      app: nginx
      env: prod
  strategy:
    # Possible strategies are RollingUpdate and Recreate
    type: RollingUpdate
    rollingUpdate:
      maxSurge: 1
      maxUnavailable: 1
  template:
    metadata:
      labels:
        app: nginx
        type: prod
    spec:
      containers:
      - name: nginx
        image: nginx:stable-alpine
        ports:
        - containerPort: 80
```

- Like with ReplicaSets, the section under `template:` specifies the pods you want to run

---

### DaemonSet

Example DaemonSet definition

```yaml
apiVersion: apps/v1
kind: DaemonSet
metadata:
  name: daemonset-example
  labels:
    app: daemonset-example
spec:
  selector:
    matchLabels:
      app: daemonset-example
  template:
    metadata:
      labels:
        app: daemonset-example
    spec:
      tolerations:
      - key: node-role.kubernetes.io/master
        effect: NoSchedule
      containers:
      - name: busybox
        image: busybox
        args:
        - sleep
        - "10000"
```

---

### Job

Example Job definition

```yaml
apiVersion: batch/v1
kind: Job
metadata:
  name: pi
spec:
  activeDeadlineSeconds 30 # Max seconds to run
  parallelism: 3 # How many pods should run in parallel
  completions: 3 # How many successful pod completions are needed to mark a job completed
  template:
    spec:
      containers:
      - name: pi
        image: perl
        command: ["perl", "-Mbignum=bpi", "-wle", "print bpi(2000)"]
      restartPolicy: Never # Default is Always
```

---

### CronJob

Example CronJob definition

```yaml
apiVersion: batch/v1beta1
kind: CronJob
metadata:
  name: hello-cron
spec:
  schedule: "* * * * *" # Cron format string
  jobTemplate:
    spec:
      template:
        spec:
          containers:
          - name: busybox
            image: busybox
            command: ["echo", "Hello from the CronJob"]
          restartPolicy: Never
```