Skip to content

Commit 8236732

Browse files
authored
kubectl-{describe, delete, create, taint}: add option placeholders (#17659)
1 parent 0b743d6 commit 8236732

File tree

4 files changed

+17
-17
lines changed

4 files changed

+17
-17
lines changed

pages/common/kubectl-create.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,16 @@
1313

1414
- Create a deployment:
1515

16-
`kubectl create deployment {{deployment_name}} --image={{image}}`
16+
`kubectl create {{[deploy|deployment]}} {{deployment_name}} --image={{image}}`
1717

1818
- Create a deployment with replicas:
1919

20-
`kubectl create deployment {{deployment_name}} --image={{image}} --replicas={{number_of_replicas}}`
20+
`kubectl create {{[deploy|deployment]}} {{deployment_name}} --image={{image}} --replicas={{number_of_replicas}}`
2121

2222
- Create a service:
2323

24-
`kubectl create service {{service_type}} {{service_name}} --tcp={{port}}:{{target_port}}`
24+
`kubectl create {{[svc|service]}} {{service_type}} {{service_name}} --tcp={{port}}:{{target_port}}`
2525

2626
- Create a namespace:
2727

28-
`kubectl create namespace {{namespace_name}}`
28+
`kubectl create {{[ns|namespace]}} {{namespace_name}}`

pages/common/kubectl-delete.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,27 @@
55
66
- Delete a specific pod:
77

8-
`kubectl delete pod {{pod_name}}`
8+
`kubectl delete {{[po|pod]}} {{pod_name}}`
99

1010
- Delete a specific deployment:
1111

12-
`kubectl delete deployment {{deployment_name}}`
12+
`kubectl delete {{[deploy|deployment]}} {{deployment_name}}`
1313

1414
- Delete a specific node:
1515

16-
`kubectl delete node {{node_name}}`
16+
`kubectl delete {{[no|node]}} {{node_name}}`
1717

1818
- Delete all pods in a specified namespace:
1919

20-
`kubectl delete pods --all --namespace {{namespace}}`
20+
`kubectl delete {{[po|pods]}} --all {{[-n|--namespace]}} {{namespace}}`
2121

2222
- Delete all deployments and services in a specified namespace:
2323

24-
`kubectl delete deployments,services --all --namespace {{namespace}}`
24+
`kubectl delete {{[deploy|deployment]}},{{[svcľservices]}} --all {{[-n|--namespace]}} {{namespace}}`
2525

2626
- Delete all nodes:
2727

28-
`kubectl delete nodes --all`
28+
`kubectl delete {{[no|nodes]}} --all`
2929

3030
- Delete resources defined in a YAML manifest:
3131

pages/common/kubectl-describe.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,19 @@
55
66
- Show details of pods in a namespace:
77

8-
`kubectl describe pods {{[-n|--namespace]}} {{namespace}}`
8+
`kubectl describe {{[po|pods]}} {{[-n|--namespace]}} {{namespace}}`
99

1010
- Show details of nodes in a namespace:
1111

12-
`kubectl describe nodes {{[-n|--namespace]}} {{namespace}}`
12+
`kubectl describe {{[no|nodes]}} {{[-n|--namespace]}} {{namespace}}`
1313

1414
- Show the details of a specific pod in a namespace:
1515

16-
`kubectl describe pods {{pod_name}} {{[-n|--namespace]}} {{namespace}}`
16+
`kubectl describe {{[po|pods]}} {{pod_name}} {{[-n|--namespace]}} {{namespace}}`
1717

1818
- Show the details of a specific node in a namespace:
1919

20-
`kubectl describe nodes {{node_name}} {{[-n|--namespace]}} {{namespace}}`
20+
`kubectl describe {{[no|nodes]}} {{node_name}} {{[-n|--namespace]}} {{namespace}}`
2121

2222
- Show details of Kubernetes objects defined in a YAML manifest file:
2323

pages/common/kubectl-taint.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
66
- Apply taint to a node:
77

8-
`kubectl taint nodes {{node_name}} {{label_key}}={{label_value}}:{{effect}}`
8+
`kubectl taint {{[no|nodes]}} {{node_name}} {{label_key}}={{label_value}}:{{effect}}`
99

1010
- Remove taint from a node:
1111

12-
`kubectl taint nodes {{node_name}} {{label_key}}:{{effect}}-`
12+
`kubectl taint {{[no|nodes]}} {{node_name}} {{label_key}}:{{effect}}-`
1313

1414
- Remove all taints from a node:
1515

16-
`kubectl taint nodes {{node_name}} {{label_key}}-`
16+
`kubectl taint {{[no|nodes]}} {{node_name}} {{label_key}}-`

0 commit comments

Comments
 (0)