Skip to content

Commit eae5026

Browse files
jimmidysonjimmidyson
committed
docs: Add details on how to run e2e tests
1 parent 92bc593 commit eae5026

File tree

11 files changed

+65
-0
lines changed

11 files changed

+65
-0
lines changed

‎docs/content/addons/_index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
+++
22
title = "Addons"
3+
weight = 2
4+
icon = "fa-solid fa-cubes"
35
+++

‎docs/content/addons/calico-cni.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
+++
22
title = "Calico CNI"
3+
icon = "fa-solid fa-network-wired"
34
+++
45

56
When deploying a cluster with CAPI, deployment and configuration of CNI is up to the user. By leveraging CAPI cluster

‎docs/content/addons/nfd.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
+++
22
title = "Node Feature Discovery"
3+
icon = "fa-solid fa-eye"
34
+++
45

56
By leveraging CAPI cluster lifecycle hooks, this handler deploys [Node Feature

‎docs/content/contributing/_index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
+++
2+
title = "Contributing"
3+
weight = 99
4+
icon = "fa-solid fa-gift"
5+
+++

‎docs/content/contributing/e2e_tests.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
+++
2+
title = "End-to-end tests"
3+
+++
4+
5+
This project uses [Ginkgo] to run end-to-end tests. Tests are labelled to make running targeted or specific tests
6+
easier.
7+
8+
To determine what labels are available, run:
9+
10+
```shell
11+
ginkgo --dry-run -v -tags e2e ./test/e2e
12+
```
13+
14+
Tests are currently labelled via infrastructure provider, CNI provider, and addon strategy. Here are some examples to
15+
specify what tests to run.
16+
17+
Run all AWS tests:
18+
19+
```shell
20+
make e2e-test E2E_LABEL='provider:AWS'
21+
```
22+
23+
Run all Cilium tests:
24+
25+
```shell
26+
make e2e-test E2E_LABEL='cni:Cilium'
27+
```
28+
29+
Labels can also be combined.
30+
31+
Run Cilium tests on AWS:
32+
33+
```shell
34+
make e2e-test E2E_LABEL='provider:AWS && cni:Cilium'
35+
```
36+
37+
To make debugging easier, you can retain the e2e test environment, which by default is cleaned up after tests run:
38+
39+
```shell
40+
make e2e-test E2E_LABEL='provider:AWS && cni:Cilium' E2E_SKIP_CLEANUP=true
41+
```
42+
43+
To speed up the development process, if you have only change e2e tests then you can skip rebuilding the whole project:
44+
45+
```shell
46+
make e2e-test E2E_LABEL='provider:AWS && cni:Cilium' SKIP_BUILD=true
47+
```
48+
49+
[Ginkgo]: https://onsi.github.io/ginkgo/

‎docs/content/customization/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
+++
22
title = "Cluster customizations"
33
weight = 1
4+
icon = "fa-solid fa-screwdriver-wrench"
45
+++
56

67
The cluster configuration handlers wrap all the other mutation handlers in a convenient single patch for inclusion in

‎docs/content/customization/aws/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
+++
22
title = "AWS"
3+
icon = "fa-brands fa-aws"
34
+++
45

56
The customizations in this section are applicable only to AWS clusters. They will only be applied to clusters that

‎docs/content/customization/docker/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
+++
22
title = "Docker"
3+
icon = "fa-brands fa-docker"
34
+++
45

56
The customizations in this section are applicable only to AWS clusters. They will only be applied to clusters that

‎docs/content/customization/generic/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
+++
22
title = "Generic"
33
weight = 1
4+
icon = "fa-solid fa-circle-nodes"
45
+++
56

67
The customizations in this section are applicable to all providers.

‎docs/content/lifecycle/_index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
+++
22
title = "Lifecycle handlers"
3+
weight = 3
4+
icon = "fa-solid fa-seedling"
35
+++

‎docs/content/lifecycle/service-loadbalancer-gc.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
+++
22
title = "LoadBalancer Services Garbage Collection"
3+
icon = "fa-solid fa-recycle"
34
+++
45

56
When using Kubernetes `LoadBalancer` services, the relevant cloud provider interface creates and configures external

0 commit comments

Comments
 (0)