This is an automated email from the ASF dual-hosted git repository.
wilfreds pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-yunikorn-site.git
The following commit(s) were added to refs/heads/master by this push:
new a93e22e [YUNIKORN-890] Update Yunikorn docs about e2e testing (#89)
a93e22e is described below
commit a93e22e5a0d332531cc6ec3ca3f1f4881f267b81
Author: pbacsko <[email protected]>
AuthorDate: Mon Nov 15 05:54:54 2021 +0100
[YUNIKORN-890] Update Yunikorn docs about e2e testing (#89)
Add explanation that REST interface tests are part of the e2e tests stored
in the k8shim.
---
docs/developer_guide/build.md | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/docs/developer_guide/build.md b/docs/developer_guide/build.md
index b93c02d..0db8de0 100644
--- a/docs/developer_guide/build.md
+++ b/docs/developer_guide/build.md
@@ -176,3 +176,9 @@ You can also use the same approach to run the scheduler
locally but connecting t
as long as the `$HOME/.kube/config` file is pointing to that remote cluster.
+## Verify external interface changes with e2e tests
+
+Yunikorn has an external REST interface which is validated by end-to-end
tests. However, the tests exist in the k8shim repository.
+Whenever a change is made to the external interface, make sure that it is
validated by running e2e tests or adjust the test cases accordingly.
+
+How to run the tests locally is described
[here](https://github.com/apache/incubator-yunikorn-k8shim/blob/master/test/e2e/README.md).
