feat(conformance): Add test execution instruction to the guide. #878
Conversation
k8s-ci-robot
added
the
cncf-cla: yes
✅ Deploy Preview for gateway-api-inference-extension ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: SinaChavoshi The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
needs-ok-to-test
|
Hi @SinaChavoshi. Thanks for your PR. I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
k8s-ci-robot
added
the
size/M
|
@SinaChavoshi thanks for creating these conformance docs. The docs need to be in site-src to get published to the docs site. Consider adding your readme here: https://gateway-api-inference-extension.sigs.k8s.io/guides/implementers/#conformance-tests. See these Make targets for building and locally serving the docs to review your changes. |
|
|
||
| This document provides steps to run the Gateway API Inference Extension conformance tests. | ||
|
|
||
| ## Prerequisites: External Istio/Envoy Setup |
There was a problem hiding this comment.
Replace Prerequisites: External Istio/Envoy Setup with Prerequisites
|
|
||
| ## Prerequisites: External Istio/Envoy Setup | ||
|
|
||
| Before running the conformance tests, you need a Kubernetes cluster (e.g., GKE) with [LoadBalancer](https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer) support. Refer to [The Quickstart Guide](https://gateway-api-inference-extension.sigs.k8s.io/guides/) for more details. |
There was a problem hiding this comment.
- Running the EPP or EPP mock is a prerequisite. See Conformance: Add Mock EPP #893 for details. Leave this prerequisite as a TODO with a link to the issue so we can merge this PR.
Since this section will contain multiple prerequisites, consider using a numbered list.
|
|
||
| Before running the conformance tests, you need a Kubernetes cluster (e.g., GKE) with [LoadBalancer](https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer) support. Refer to [The Quickstart Guide](https://gateway-api-inference-extension.sigs.k8s.io/guides/) for more details. | ||
|
|
||
| ## Running the Conformance Tests |
There was a problem hiding this comment.
nit: s/Running the Conformance Tests/Running Conformance Tests/
| ## Running the Conformance Tests | ||
|
|
||
| 1. **Choose an Implementation**: | ||
| Install an [existing implementation](https://gateway-api-inference-extension.sigs.k8s.io/implementations/gateways/) or run tests against your implementation after completing the [implementer's guide](https://gateway-api-inference-extension.sigs.k8s.io/guides/implementers/#implementers-guide). |
There was a problem hiding this comment.
IMO this step should be in the Prerequisites section.
| ``` | ||
|
|
||
| 3. **Execute Tests**: | ||
| Run the following command to execute all available tests. Replace <your_gatewayclass_name> with the GatewayClass used by the implementation under test. |
There was a problem hiding this comment.
s/<your_gatewayclass_name>/<your_gatewayclass_name>/ (otherwise the text does not get rendered by mkdocs).
| @@ -0,0 +1,44 @@ | |||
|
|
|||
There was a problem hiding this comment.
mkdocs cannot find this doc without updating mkdocs.yml. Here's a docs structure to consider:
diff --git a/mkdocs.yml b/mkdocs.yml
index 1741fd1..675d837 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -65,7 +65,9 @@ nav:
- Adapter Rollout: guides/adapter-rollout.md
- InferencePool Rollout: guides/inferencepool-rollout.md
- Metrics: guides/metrics.md
- - Implementer's Guide: guides/implementers.md
+ - Implementer Guides:
+ - Getting started: guides/implementers.md
+ - Conformance Tests: guides/conformance-tests.md
- Performance:
- Benchmark: performance/benchmark/index.md
- Regression Testing: performance/regression-testing/index.md
This pr fixes a formatting issue in the report guide as well as adding instructions for test execution.