Merge pull request #23 from Kuadrant/release-0.2.0

Move examples into config dir for easier release process

README.md

@@ -7,15 +7,15 @@ To use the CustomResourceState, see the [configuration information](https://gith
 configure an existing or separate kube-state-metrics instance with a custom
 resource configuration.
 
-The CustomResourceState is available at [./custom-resource-state.yaml](./custom-resource-state.yaml)
+The CustomResourceState is available at [./config/default/custom-resource-state.yaml](./config/default/custom-resource-state.yaml)
 
 For easier consumption via kustomize, a [./kustomization.yaml](./kustomization.yaml)
 is available that generates a ConfigMap named `custom-resource-state` with the
 CustomResourceState data in a key called `custom-resource-state.yaml`.
 
 ## Kube Prometheus Example
 
-An example of how to use this with kube-promethues in shown in [./examples/kube-prometheus](./examples/kube-prometheus)
+An example of how to use this with kube-promethues in shown in [./config/examples/kube-prometheus](./config/examples/kube-prometheus)
 The kustomization config does the following:
 
 - mounts the ConfigMap as a volume in the kube-state-metrics Deployment
@@ -28,7 +28,7 @@ and the various Gateway API resources in the `gateway.networking.k8s.io` apiGrou
 
 ## Dashboards
 
-A set of Grafana dashboards are available in [./examples/dashboards](./examples/dashboards)
+A set of Grafana dashboards are available in [./config/examples/dashboards](./config/examples/dashboards)
 and on [grafana.com](https://grafana.com/grafana/dashboards/?search=Gateway+API+State)
 You can import them directly into Grafana and modify as needed.
 The dashboards are divided by resources (GatewayClasses, Gateways and HTTPRoutes),
@@ -46,7 +46,7 @@ https://grafana.com/grafana/dashboards/19434
 
 ## Alerts
 
-A set of example Alerts are available in [./examples/rules](./examples/rules).
+A set of example Alerts are available in [./config/examples/rules](./config/examples/rules).
 You can create the PrometheusRule resource directly or modify it as needed.
 
 ## Metrics

RELEASE.md

@@ -1,10 +1,7 @@
 # Releasing
 
-- Checkout `main`
-- Update the ref in examples/kube-prometheus/kustomization.yaml to the new release number.
-  - e.g. `github.com/kuadrant/gateway-api-state-metrics?ref=0.1.0` for release `0.1.0`
-- Add and commit the change
-- Tag the commit with the release number e.g. `git tag 0.1.0`
-- Push the commit and tag with `git push origin main && git push origin 0.1.0`
-- Create a release in Github at https://github.com/Kuadrant/gateway-api-state-metrics/releases/new, using the tag
+- Checkout a new branch from `main`, e.g. `release-0.2.0`
+- Update the bundle yaml files as per instructions in [./config/examples/kube-prometheus/bundle-README.md](./config/examples/kube-prometheus/bundle-README.md)
+- Create a new PR with the change
+- After merging, create a release in Github at https://github.com/Kuadrant/gateway-api-state-metrics/releases/new from `main`, specifying a release tag e.g. `0.2.0`
   - Title can be the release nubmer. Description can include any important changes

config/default/kustomization.yaml

@@ -0,0 +1,11 @@
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+
+generatorOptions:
+  disableNameSuffixHash: true
+
+configMapGenerator:
+- name: custom-resource-state
+  namespace: monitoring
+  files:
+  - custom-resource-state.yaml

examples/enterprise/README.md → config/examples/enterprise/README.md

@@ -71,12 +71,11 @@ There are 3 Gateways with various services attached.
 
 ```bash
 kind create cluster
-kubectl create -f ../../config/gateway-api/crd/standard/
+kubectl create -f ../../gateway-api/crd/standard/
 kubectl create -f ./all.yaml
 kubectl replace --subresource=status -f ./all.yaml
 kubectl apply --server-side -f ../kube-prometheus/bundle_crd.yaml
 kubectl apply -f ../kube-prometheus/bundle.yaml
-
 kubectl -n monitoring wait --timeout=5m deployment/grafana --for=condition=Available
 kubectl -n monitoring port-forward service/grafana 3000:3000 > /dev/null &
 kubectl -n monitoring rollout status --watch --timeout=5m statefulset/prometheus-k8s

examples/kube-prometheus/bundle.yaml → config/examples/kube-prometheus/bundle.yaml

@@ -1106,6 +1106,14 @@ data:
                 labelsFromPath:
                   type: ["type"]
                 valueFrom: ["status"]
+          - name: "status_supported_features"
+            help: "List of supported features for the GatewayClass"
+            each:
+              type: Info
+              info:
+                path: [status, supportedFeatures]
+                labelsFromPath:
+                  features: []
         - groupVersionKind:
             group: gateway.networking.k8s.io
             kind: "HTTPRoute"

examples/kube-prometheus/kustomization.yaml → config/examples/kube-prometheus/kustomization.yaml

@@ -3,7 +3,10 @@ kind: Kustomization
 
 resources:
   - github.com/prometheus-operator/kube-prometheus?ref=release-0.11
-  - github.com/kuadrant/gateway-api-state-metrics?ref=0.1.0
+# Use the github url instead of the relative path if using this outside the repo
+#  - github.com/kuadrant/gateway-api-state-metrics?ref=<release>
+  - ../../default
+# Include the example dashboars and rules if you want
   - ../dashboards
   - ../rules
 

kustomization.yaml

@@ -1,11 +1,5 @@
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
 
-generatorOptions:
-  disableNameSuffixHash: true
-
-configMapGenerator:
-- name: custom-resource-state
-  namespace: monitoring
-  files:
-  - custom-resource-state.yaml
+resources:
+  - ./config/default

tests/e2e.sh

@@ -43,7 +43,7 @@ function finish() {
     echo "calling cleanup function"
     # kill kubectl proxy in background
     kill %1 || true
-    kubectl delete -f examples/kube-state-metrics/ || true
+    kubectl delete -f config/examples/kube-state-metrics/ || true
     kubectl delete -f tests/manifests/ || true
 }
 
@@ -132,17 +132,17 @@ trap finish EXIT
 kubectl create -f ./config/gateway-api/crd/standard/
 
 # create gateway-api customresourcestatemetrics configmap
-kubectl create configmap custom-resource-state --from-file=./custom-resource-state.yaml --dry-run=client -o yaml | kubectl -n kube-system apply -f -
+kubectl create configmap custom-resource-state --from-file=./config/default/custom-resource-state.yaml --dry-run=client -o yaml | kubectl -n kube-system apply -f -
 
 # set up kube-state-metrics manifests
-kubectl create -f ./examples/kube-state-metrics/service-account.yaml
+kubectl create -f ./config/examples/kube-state-metrics/service-account.yaml
 
-kubectl create -f ./examples/kube-state-metrics/cluster-role.yaml
-kubectl create -f ./examples/kube-state-metrics/cluster-role-binding.yaml
+kubectl create -f ./config/examples/kube-state-metrics/cluster-role.yaml
+kubectl create -f ./config/examples/kube-state-metrics/cluster-role-binding.yaml
 
-kubectl create -f ./examples/kube-state-metrics/deployment.yaml
+kubectl create -f ./config/examples/kube-state-metrics/deployment.yaml
 
-kubectl create -f ./examples/kube-state-metrics/service.yaml
+kubectl create -f ./config/examples/kube-state-metrics/service.yaml
 
 # Create test Gateway API resources
 kubectl create -f ./tests/manifests/