metrics: update testdata including iterating the example-metrics.txt

Author: chrischdi

pkg/metrics/testdata/README.md

@@ -10,46 +10,55 @@ If there are intended changes this file needs to get regenerated to make the tes
 This could be done via:
 
 ```sh
-go run generate \
-  ./pkg/customresourcestate/generate/generator/testdata/ \
-  > ./pkg/customresourcestate/generate/generator/testdata/foo-config.yaml
+go run ./cmd/controller-gen metrics crd \
+    paths=./pkg/metrics/testdata \
+    output:dir=./pkg/metrics/testdata
 ```
 
 Or by using the go:generate marker inside [foo_types.go](foo_types.go):
 
 ```sh
-go generate ./pkg/customresourcestate/generate/generator/testdata/
+go generate ./pkg/metrics/testdata/
 ```
 
-## Example files: foo-cr-example.yaml and foo-cr-example-metrics.txt
+## Example files: metrics.yaml, rbac.yaml and example-metrics.txt
 
-There is also an example CR ([foo-cr-example.yaml](foo-cr-example.yaml)) and resulting example metrics ([foo-cr-example-metrics.txt](foo-cr-example-metrics.txt)).
+There is also an example CR ([example-foo.yaml](example-foo.yaml)) and resulting example metrics ([example-metrics.txt](example-metrics.txt)).
 
 The example metrics file got created by:
 
-1. Generating a CustomResourceDefinition yaml by using [controller-gen](https://github.com/kubernetes-sigs/kubebuilder/blob/master/docs/book/src/reference/controller-gen.md):
+1. Generating a CustomResourceDefinition and Kube-State-Metrics configration file:
 
     ```sh
-    controller-gen crd paths=./pkg/customresourcestate/generate/generator/testdata/ output:dir=./pkg/customresourcestate/generate/generator/testdata/
+    go generate ./pkg/metrics/testdata/
     ```
 
 2. Creating a cluster using [kind](https://kind.sigs.k8s.io/)
+
+    ```sh
+    kind create cluster
+    ```
+
 3. Applying the CRD and example CR to the cluster:
 
     ```sh
-    kubectl apply -f /pkg/customresourcestate/generate/generator/testdata/bar.example.com_foos.yaml
-    kubectl apply -f /pkg/customresourcestate/generate/generator/testdata/foo-cr-example.yaml
+    kubectl apply -f ./pkg/metrics/testdata/bar.example.com_foos.yaml
+    kubectl apply -f ./pkg/metrics/testdata/example-foo.yaml
     ```
 
 4. Running kube-state-metrics with the provided configuration file:
 
     ```sh
-    go run ./ --kubeconfig $HOME/.kube/config --custom-resource-state-only \
-    --custom-resource-state-config-file pkg/customresourcestate/generate/generator/testdata/foo-config.yaml
+    docker run --net=host -ti --rm \
+        -v $HOME/.kube/config:/config \
+        -v $(pwd):/data \
+        registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.13.0 \
+        --kubeconfig /config --custom-resource-state-only \
+        --custom-resource-state-config-file /data/pkg/metrics/testdata/foo-config.yaml
     ```
 
 5. Querying the metrics endpoint in a second terminal:
 
     ```sh
-    curl localhost:8080/metrics > ./pkg/customresourcestate/generate/generator/testdata/foo-cr-example-metrics.txt
+    curl localhost:8080/metrics > ./pkg/metrics/testdata/foo-cr-example-metrics.txt
     ```

pkg/metrics/testdata/bar.example.com_foos.yaml

@@ -3,8 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.8.0
-  creationTimestamp: null
+    controller-gen.kubebuilder.io/version: (devel)
   name: foos.bar.example.com
 spec:
   group: bar.example.com
@@ -21,14 +20,19 @@ spec:
         description: Foo is a test object.
         properties:
           apiVersion:
-            description: 'APIVersion defines the versioned schema of this representation
-              of an object. Servers should convert recognized schemas to the latest
-              internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+            description: |-
+              APIVersion defines the versioned schema of this representation of an object.
+              Servers should convert recognized schemas to the latest internal value, and
+              may reject unrecognized values.
+              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
             type: string
           kind:
-            description: 'Kind is a string value representing the REST resource this
-              object represents. Servers may infer this from the endpoint the client
-              submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+            description: |-
+              Kind is a string value representing the REST resource this object represents.
+              Servers may infer this from the endpoint the client submits requests to.
+              Cannot be updated.
+              In CamelCase.
+              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
             type: string
           metadata:
             type: object
@@ -68,9 +72,3 @@ spec:
         type: object
     served: true
     storage: true
-status:
-  acceptedNames:
-    kind: ""
-    plural: ""
-  conditions: []
-  storedVersions: []

pkg/metrics/testdata/foo-cr-example.yaml renamed to pkg/metrics/testdata/example-foo.yaml

@@ -1,6 +1,6 @@
 # HELP foo_created Unix creation timestamp.
 # TYPE foo_created gauge
-foo_created{customresource_group="bar.example.com",customresource_kind="Foo",customresource_version="foo",name="bar"} 1.697543739e+09
+foo_created{customresource_group="bar.example.com",customresource_kind="Foo",customresource_version="foo",name="bar"} 1.724940463e+09
 # HELP foo_owner Owner references.
 # TYPE foo_owner info
 foo_owner{customresource_group="bar.example.com",customresource_kind="Foo",customresource_version="foo",name="bar",owner_is_controller="true",owner_kind="foo",owner_name="foo",owner_uid="someuid"} 1

pkg/metrics/testdata/foo-cr-example-metrics.txt renamed to pkg/metrics/testdata/example-metrics.txt

@@ -19,8 +19,7 @@ limitations under the License.
 // The below marker can be used to regenerate the `foo-config.yaml` file by running
 // the following command:
 // $ go generate ./pkg/customresourcestate/generate/generator/testdata
-//go:generate sh -c "go run ../../../cmd/controller-gen metrics output:metrics:dir=. paths=./"
-//go:generate sh -c "controller-gen crd paths=./ output:stdout > foo-crd.yaml"
+//go:generate sh -c "go run ../../../cmd/controller-gen crd metrics paths=./ output:dir=."
 
 // +groupName=bar.example.com
 package foo