summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavanum Srinivas <davanum@gmail.com>2016-07-14 07:48:32 -0400
committerDavanum Srinivas <davanum@gmail.com>2016-09-19 13:01:59 -0400
commit19d5af9961ab07c650aeabfd0e65a8a73e7fd893 (patch)
tree667373d80ea6de1672cd4987bb04d71f68c30b27
parenteea3d12f23ff4ffb87bd7cc054519ce45f85c35a (diff)
Extend all to more resources
Added more things from the list here: https://github.com/kubernetes/kubernetes/blob/master/pkg/kubectl/cmd/cmd.go#L159 Update the devel/kubectl-conventions.md with the rules mentioned by a few folks on which resources could be added to the special 'all' alias
-rw-r--r--kubectl-conventions.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/kubectl-conventions.md b/kubectl-conventions.md
index 29316407..fe2e51a1 100644
--- a/kubectl-conventions.md
+++ b/kubectl-conventions.md
@@ -43,6 +43,7 @@ Updated: 8/27/2015
- [Principles](#principles)
- [Command conventions](#command-conventions)
- [Create commands](#create-commands)
+ - [Rules for extending special resource alias - "all"](#rules-for-extending-special-resource-alias---all)
- [Flag conventions](#flag-conventions)
- [Output conventions](#output-conventions)
- [Documentation conventions](#documentation-conventions)
@@ -118,6 +119,21 @@ creating tls secrets. You create these as separate commands to get distinct
flags and separate help that is tailored for the particular usage.
+### Rules for extending special resource alias - "all"
+
+Here are the rules to add a new resource to the `kubectl get all` output.
+
+* No cluster scoped resources
+
+* No namespace admin level resources (limits, quota, policy, authorization
+rules)
+
+* No resources that are potentially unrecoverable (secrets and pvc)
+
+* Resources that are considered "similar" to #3 should be grouped
+the same (configmaps)
+
+
## Flag conventions
* Flags are all lowercase, with words separated by hyphens