Merge pull request kubernetes-retired#298 from zfrhv/doc-for-#295

Documentation for kubernetes-retired#295

Author: k8s-ci-robot

docs/user-guide/concepts.md

@@ -277,11 +277,14 @@ the most restrictive quota always wins.
 This way each individual can fairly and securely distribute their resources across
 their members.
 
+You can create the HRQ `CustomResource` by simply applying a yaml file, and see usage via `kubectl hns hrq` or `kubectl get hrq`. See
+[quickstart example](quickstart.md#hrq) for reference.
+
+
 To implement hierarchical quotas, HNC automatically creates `ResourceQuota` objects in each
 affected namespace. This is a part of the internal implementation and shouldn't be modified or
 inspected. Use the `kubectl hns hrq` command to inspect hierarchical quotas,
-or look at the `HierarchicalResourceQuota` object in the ancestor
-namespaces.
+or look at the `HierarchicalResourceQuota` object in the ancestor namespaces.
 
 Note: Decimal point values cannot be specified in HRQ (you can't do `cpu: 1.5` but you can do `cpu: "1.5"` or `cpu: 1500m`). See [#292](https://github.com/kubernetes-sigs/hierarchical-namespaces/issues/292)
 

docs/user-guide/quickstart.md

@@ -343,8 +343,8 @@ namespaces:
 
 ```bash
 kubectl apply -f - << EOF
-kind: NetworkPolicy
 apiVersion: networking.k8s.io/v1
+kind: NetworkPolicy
 metadata:
   name: deny-from-other-namespaces
   namespace: acme-org
@@ -396,8 +396,8 @@ that is automatically added by the HNC.
 
 ```bash
 kubectl apply -f - << EOF
-kind: NetworkPolicy
 apiVersion: networking.k8s.io/v1
+kind: NetworkPolicy
 metadata:
   name: allow-team-a
   namespace: team-a
@@ -485,8 +485,8 @@ We will demonstrate how it works using services, but you could also limit `cpu`,
 Creating the HRQ:
 ```bash
 kubectl apply -f - << EOF
-kind: HierarchicalResourceQuota
 apiVersion: hnc.x-k8s.io/v1alpha2
+kind: HierarchicalResourceQuota
 metadata:
   name: acme-org-hrq
   namespace: acme-org
@@ -514,16 +514,18 @@ Error from server (Forbidden):
         "acme-org-hrq", requested: services=1, used: services=1, limited: services=1
 ```
 
-To view the HRQ usage, simply run:
+You can view the HRQ usage by running `kubectl hns hrq` or `kubectl get hrq`:
 ```bash
-kubectl hns hrq -n acme-org
+kubectl get hrq -n acme-org
 ```
-You can also view in all namespace:
+Should give:
 ```bash
-kubectl hns hrq --all-namespaces
+NAME       REQUEST         LIMIT
+acme-org   services: 1/1
 ```
+You can also view HRQs in all namespaces by running `kubectl get hrq -A`.
 
-And you can delete the HRQ via simply deleting the CR:
+And finally you can delete the HRQ via simply deleting the CR:
 ```bash
 kubectl delete hrq acme-org-hrq -n acme-org
 ```

test/e2e/quickstart_test.go

@@ -128,8 +128,8 @@ var _ = Describe("Quickstart", func() {
 
 		// create a default network policy in the root namespace that blocks any ingress from other namespaces
 		policy := `# quickstart_test.go: netpol to block access across namespaces
-kind: NetworkPolicy
 apiVersion: networking.k8s.io/v1
+kind: NetworkPolicy
 metadata:
   name: deny-from-other-namespaces
   namespace: acme-org
@@ -169,8 +169,8 @@ spec:
 		// communicate with each other, and wait for it to be propagated to the descendant we want to
 		// test.
 		policy = `# quickstart_test.go: netpol to allow communication within team-a subtree
-kind: NetworkPolicy
 apiVersion: networking.k8s.io/v1
+kind: NetworkPolicy
 metadata:
   name: allow-team-a
   namespace: team-a
@@ -206,8 +206,8 @@ spec:
 
 		// create hrq in parent acme-org
 		hrq:=`# quickstart_test.go: hrq in acme-org
-kind: HierarchicalResourceQuota
 apiVersion: hnc.x-k8s.io/v1alpha2
+kind: HierarchicalResourceQuota
 metadata:
   name: acme-org-hrq
   namespace: acme-org
@@ -223,7 +223,7 @@ spec:
 		MustNotRun("kubectl create service clusterip", nsTeamB + "-svc", "--clusterip=None", "-n", nsTeamB)
 
 		// show hrq usage
-		RunShouldContain("services: 1/1", defTimeout, "kubectl hns hrq", "-n", nsOrg)
+		RunShouldContain("services: 1/1", defTimeout, "kubectl get hrq", "-n", nsOrg)
 
 		MustRun("kubectl delete hrq", nsOrg + "-hrq", "-n", nsOrg)
 	})