From de8fbe683451f6e123a4122033dd1932c5c3c4e8 Mon Sep 17 00:00:00 2001 From: arianaw66 Date: Fri, 15 Nov 2024 16:04:09 -0500 Subject: [PATCH] PR comments --- devel/testing/kube-e2e-tests.md | 4 +++- install/helm/gloo/crds/README.md | 10 ++++++++++ 2 files changed, 13 insertions(+), 1 deletion(-) create mode 100644 install/helm/gloo/crds/README.md diff --git a/devel/testing/kube-e2e-tests.md b/devel/testing/kube-e2e-tests.md index 2fb06762e70..664f4b972de 100644 --- a/devel/testing/kube-e2e-tests.md +++ b/devel/testing/kube-e2e-tests.md @@ -22,4 +22,6 @@ These tests are run by a [GitHub action](/.github/workflows/regression-tests.yam If a test fails, you can retry it from a [browser window](https://docs.github.com/en/actions/managing-workflow-runs/re-running-workflows-and-jobs#reviewing-previous-workflow-runs). If you do this, please make sure to comment on the Pull Request with a link to the failed logs for debugging purposes. ## Local Development -See the [kube2e test README](/test/kube2e/README.md) for more details about running these tests. \ No newline at end of file +See the [kubernetes e2e test README](/test/kubernetes/e2e/README.md) and [debugging guide](/test/kubernetes/e2e/debugging.md) for more details about running these tests. + +See the [kube2e test README](/test/kube2e/README.md) for more details about running the legacy tests. \ No newline at end of file diff --git a/install/helm/gloo/crds/README.md b/install/helm/gloo/crds/README.md new file mode 100644 index 00000000000..5ebe5bba873 --- /dev/null +++ b/install/helm/gloo/crds/README.md @@ -0,0 +1,10 @@ +The CRDs in this directory are partially generated by solo-kit. +That implementation is explained [here](https://github.com/solo-io/solo-kit/tree/main/pkg/code-generator/schemagen#implementation). + +It is worth noting that solo-kit only generates the schemas for these CRDs. +Other spec fields such as the `categories` can be updated manually. + +Gloo Gateway CRD `categories`: +- All Gloo Gateway CRDs should include the "gloo-gateway" category. +- Any Gloo Gateway CRDs which are only used by enterprise customers should additionally include the "solo-io" category. + - Currently, these are the AuthConfig, RateLimitConfig, and GraphQLApi CRDs. \ No newline at end of file