Skip to content

Commit

Permalink
add document on kubectl's behavior regarding initializers (#5505)
Browse files Browse the repository at this point in the history
  • Loading branch information
dixudx authored and steveperry-53 committed Sep 19, 2017
1 parent 9f590be commit 675765f
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 6 deletions.
10 changes: 6 additions & 4 deletions docs/user-guide/kubectl-cheatsheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@ $ kubectl get services # List all services in the names
$ kubectl get pods --all-namespaces # List all pods in all namespaces
$ kubectl get pods -o wide # List all pods in the namespace, with more details
$ kubectl get deployment my-dep # List a particular deployment
$ kubectl get pods --include-uninitialized # List all pods in the namespace, including uninitialized ones

# Describe commands with verbose output
$ kubectl describe nodes my-node
Expand Down Expand Up @@ -193,10 +194,11 @@ $ kubectl scale --replicas=5 rc/foo rc/bar rc/baz # Scale mult
## Deleting Resources

```console
$ kubectl delete -f ./pod.json # Delete a pod using the type and name specified in pod.json
$ kubectl delete pod,service baz foo # Delete pods and services with same names "baz" and "foo"
$ kubectl delete pods,services -l name=myLabel # Delete pods and services with label name=myLabel
$ kubectl -n my-ns delete po,svc --all # Delete all pods and services in namespace my-ns
$ kubectl delete -f ./pod.json # Delete a pod using the type and name specified in pod.json
$ kubectl delete pod,service baz foo # Delete pods and services with same names "baz" and "foo"
$ kubectl delete pods,services -l name=myLabel # Delete pods and services with label name=myLabel
$ kubectl delete pods,services -l name=myLabel --include-uninitialized # Delete pods and services, including uninitialized ones, with label name=myLabel
$ kubectl -n my-ns delete po,svc --all # Delete all pods and services, including uninitialized ones, in namespace my-ns,
```

## Interacting with running Pods
Expand Down
13 changes: 11 additions & 2 deletions docs/user-guide/kubectl-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -238,9 +238,12 @@ $ kubectl get replicationcontroller <rc-name>

// List all replication controllers and services together in plain-text output format.
$ kubectl get rc,services

// List all daemon sets, including uninitialized ones, in plain-text output format.
$ kubectl get ds --include-uninitialized
```

`kubectl describe` - Display detailed state of one or more resources.
`kubectl describe` - Display detailed state of one or more resources, including the uninitialized ones by default.

```shell
// Display the details of the node with name <node-name>.
Expand All @@ -252,6 +255,9 @@ $ kubectl describe pods/<pod-name>
// Display the details of all the pods that are managed by the replication controller named <rc-name>.
// Remember: Any pods that are created by the replication controller get prefixed with the name of the replication controller.
$ kubectl describe pods <rc-name>

// Describe all pods, not including uninitialized ones
$ kubectl describe pods --include-uninitialized=false
```

`kubectl delete` - Delete resources either from a file, stdin, or specifying label selectors, names, resource selectors, or resources.
Expand All @@ -263,7 +269,10 @@ $ kubectl delete -f pod.yaml
// Delete all the pods and services that have the label name=<label-name>.
$ kubectl delete pods,services -l name=<label-name>

// Delete all pods.
// Delete all the pods and services that have the label name=<label-name>, including uninitialized ones.
$ kubectl delete pods,services -l name=<label-name> --include-uninitialized

// Delete all pods, including uninitialized ones.
$ kubectl delete pods --all
```

Expand Down

0 comments on commit 675765f

Please sign in to comment.