Remove tox pip_version in tox.ini
[functest-kubernetes.git] / README.md
index 38272fe..71348da 100644 (file)
--- a/README.md
+++ b/README.md
@@ -15,14 +15,14 @@ and testing (vIMS, vRouter and vEPC) to ensure that the platforms meet Network
 Functions Virtualization requirements. Raspberry PI is also supported to verify
 datacenters as the lowest cost (50 euros hardware and software included).
 
-| Functest releases | Kubernetes releases       |
-|-------------------|---------------------------|
-| Hunter            | v1.13                     |
-| Iruya             | v1.15                     |
-| Jerma             | v1.17                     |
-| Kali              | v1.19                     |
-| Leguer            | v1.20                     |
-| Master            | v1.21.0-alpha.3 (rolling) |
+| Functest releases | Kubernetes releases           |
+|-------------------|-------------------------------|
+| v1.22             | v1.22                         |
+| v1.23             | v1.23                         |
+| v1.24             | v1.24                         |
+| v1.25             | v1.25                         |
+| v1.26             | v1.26                         |
+| **Master**        | **v1.27.0-alpha.0 (rolling)** |
 
 ## Prepare your environment
 
@@ -35,7 +35,7 @@ DEPLOY_SCENARIO=k8s-XXX
 
 ```bash
 sudo docker run --env-file env \
-    -v $(pwd)/config:/root/.kube/config \
+    -v $(pwd)/config:/home/xtesting/.kube/config \
     opnfv/functest-kubernetes-healthcheck
 ```
 
@@ -52,24 +52,37 @@ sudo docker run --env-file env \
 
 ```bash
 sudo docker run --env-file env \
-    -v $(pwd)/config:/root/.kube/config \
+    -v $(pwd)/config:/home/xtesting/.kube/config \
     opnfv/functest-kubernetes-smoke
 ```
 
 ```
-+---------------------------+------------------+---------------+------------------+----------------+
-|         TEST CASE         |     PROJECT      |      TIER     |     DURATION     |     RESULT     |
-+---------------------------+------------------+---------------+------------------+----------------+
-|      k8s_conformance      |     functest     |     smoke     |      94:26       |      PASS      |
-|     xrally_kubernetes     |     functest     |     smoke     |      13:05       |      PASS      |
-+---------------------------+------------------+---------------+------------------+----------------+
++----------------------------------+------------------+---------------+------------------+----------------+
+|            TEST CASE             |     PROJECT      |      TIER     |     DURATION     |     RESULT     |
++----------------------------------+------------------+---------------+------------------+----------------+
+|        xrally_kubernetes         |     functest     |     smoke     |      13:00       |      PASS      |
+|         k8s_conformance          |     functest     |     smoke     |      16:31       |      PASS      |
+|      k8s_conformance_serial      |     functest     |     smoke     |      15:34       |      PASS      |
+|        sig_api_machinery         |     functest     |     smoke     |      09:01       |      PASS      |
+|     sig_api_machinery_serial     |     functest     |     smoke     |      01:24       |      PASS      |
+|             sig_apps             |     functest     |     smoke     |      03:45       |      PASS      |
+|         sig_apps_serial          |     functest     |     smoke     |      00:31       |      PASS      |
+|             sig_auth             |     functest     |     smoke     |      09:04       |      PASS      |
+|      sig_cluster_lifecycle       |     functest     |     smoke     |      00:26       |      PASS      |
+|       sig_instrumentation        |     functest     |     smoke     |      00:03       |      PASS      |
+|           sig_network            |     functest     |     smoke     |      05:43       |      PASS      |
+|             sig_node             |     functest     |     smoke     |      28:03       |      PASS      |
+|      sig_scheduling_serial       |     functest     |     smoke     |      08:03       |      PASS      |
+|           sig_storage            |     functest     |     smoke     |      09:17       |      PASS      |
+|        sig_storage_serial        |     functest     |     smoke     |      02:40       |      PASS      |
++----------------------------------+------------------+---------------+------------------+----------------+
 ```
 
 ## Run security suite
 
 ```bash
 sudo docker run --env-file env \
-    -v $(pwd)/config:/root/.kube/config \
+    -v $(pwd)/config:/home/xtesting/.kube/config \
     opnfv/functest-kubernetes-security
 ```
 
@@ -87,7 +100,7 @@ sudo docker run --env-file env \
 
 ```bash
 sudo docker run --env-file env \
-    -v $(pwd)/config:/root/.kube/config \
+    -v $(pwd)/config:/home/xtesting/.kube/config \
     opnfv/functest-kubernetes-benchmarking
 ```
 
@@ -96,6 +109,7 @@ sudo docker run --env-file env \
 |           TEST CASE            |     PROJECT      |         TIER         |     DURATION     |     RESULT     |
 +--------------------------------+------------------+----------------------+------------------+----------------+
 |     xrally_kubernetes_full     |     functest     |     benchmarking     |      33:07       |      PASS      |
+|            netperf             |     functest     |     benchmarking     |      40:16       |      PASS      |
 +--------------------------------+------------------+----------------------+------------------+----------------+
 ```
 
@@ -103,16 +117,43 @@ sudo docker run --env-file env \
 
 ```bash
 sudo docker run --env-file env \
-    -v $(pwd)/config:/root/.kube/config \
+    -v $(pwd)/config:/home/xtesting/.kube/config \
     opnfv/functest-kubernetes-cnf
 ```
 
 ```
-+-------------------------+------------------+--------------+------------------+----------------+
-|        TEST CASE        |     PROJECT      |     TIER     |     DURATION     |     RESULT     |
-+-------------------------+------------------+--------------+------------------+----------------+
-|         k8s_vims        |     functest     |     cnf      |      09:06       |      PASS      |
-|        helm_vims        |     functest     |     cnf      |      08:54       |      PASS      |
-|     cnf_conformance     |     functest     |     cnf      |      02:00       |      PASS      |
-+-------------------------+------------------+--------------+------------------+----------------+
++-----------------------+------------------+--------------+------------------+----------------+
+|       TEST CASE       |     PROJECT      |     TIER     |     DURATION     |     RESULT     |
++-----------------------+------------------+--------------+------------------+----------------+
+|        k8s_vims       |     functest     |     cnf      |      09:06       |      PASS      |
+|       helm_vims       |     functest     |     cnf      |      08:54       |      PASS      |
+|     cnf_testsuite     |     functest     |     cnf      |      16:47       |      PASS      |
++-----------------------+------------------+--------------+------------------+----------------+
 ```
+
+
+## Use on air gap environments (no access to Internet)
+
+To test a Kubernetes without access to Internet, repository mirrors needs to be
+provided.
+
+Currently, all tests supports this feature except cnf conformance.
+
+There's two ways for providing the repository mirrors:
+
+- Give an environment variable (`MIRROR_REPO`) which gives a repository with
+  all needed images.
+- Gives an environment variable per needed repo:
+  - `DOCKERHUB_REPO` for DockerHub repository (`docker.io`)
+  - `GCR_REPO` for Google Cloud repository (`gcr.io`)
+  - `K8S_GCR_REPO` for Kubernetes repository (`k8s.gcr.io`)
+  - `QUAY_REPO` for Quay repository (`quay.io`)
+
+All needed images are given in
+[functest_kubernetes/ci/images.txt](functest_kubernetes/ci/images.txt)
+
+For e2e tests, `docker.io` is hardcoded. it does mean that you'll have to set up
+a mirror on docker. An example on how to set it up on docker daemon is provided
+here:
+[daemon-configuration-file](
+https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-configuration-file)