From be47be486d508f298c7720b06ecdb06024873fcb Mon Sep 17 00:00:00 2001 From: James Munnelly Date: Tue, 23 Oct 2018 12:28:57 +0100 Subject: [PATCH] Update running e2e tests docs Signed-off-by: James Munnelly --- docs/devel/end-to-end-tests.rst | 28 +++++++--------------------- 1 file changed, 7 insertions(+), 21 deletions(-) diff --git a/docs/devel/end-to-end-tests.rst b/docs/devel/end-to-end-tests.rst index c3bf226fc..a86448c45 100644 --- a/docs/devel/end-to-end-tests.rst +++ b/docs/devel/end-to-end-tests.rst @@ -15,34 +15,23 @@ Requirements Currently, a number of tools **must** be installed on your machine in order to run the tests: +* ``bazel`` - As with all other development, Bazel is required to actually + build the project as well as end-to-end test framework. Bazel will also + retrieve appropriate versions of any other dependencies depending on what + 'target' you choose to run. + * ``docker`` - We provision a whole Kubernetes cluster within Docker, and so an up to date version of Docker must be installed. The oldest Docker version we have tested is 17.09. -* kind_ - This - tool is responsible for actually building and starting the Kubernetes cluster - used during tests. - -* helm_ - A minimum version 2.10 is required. - * ``kubectl`` - If you are running the tests on Linux, this step is technically not required. For non-Linux hosts (i.e. OSX), you will need to ensure you have a relatively new version of kubectl available on your PATH. -* ``golang`` - We require golang to build cert-manager and various test - related components. You should use at least go version 1.9, although we - currently build with go 1.11 in our own CI. - * An internet connection - tests require access to DNS, and optionally Cloudflare APIs (if a Cloudflare API token is provided). -Docker, helm and kubectl should be installed through your preferred means. - -``kind`` can be installed like so: - -.. code-block:: shell - - go install github.com/kubernetes-sigs/kind +Bazel, Docker and Kubectl should be installed through your preferred means. Run end-to-end tests ==================== @@ -53,8 +42,5 @@ You can run the end-to-end tests by executing the following: ./hack/ci/run-e2e-kind.sh -The full suite may take up to 20 minutes to run. +The full suite may take up to 10 minutes to run. You can monitor output of this command to track progress. - -.. _kind: https://github.com/kubernetes/test-infra/tree/master/kind -.. _helm: https://github.com/helm/helm