Skip to content

Commit 0472434

Browse files
committed
Document how to run e2e tests locally
1 parent 934a600 commit 0472434

File tree

2 files changed

+34
-0
lines changed

2 files changed

+34
-0
lines changed

vertical-pod-autoscaler/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
- [Getting started](#getting-started)
88
- [Components and Architecture](#components-and-architecture)
99
- [Features and Known limitations](#features-and-known-limitations)
10+
- [Development and testing](#development-and-testing)
1011
- [Related links](#related-links)
1112

1213
## Intro
@@ -51,6 +52,10 @@ You can also read about the [features](./docs/features.md) and [known limitation
5152
> * When the admission-controller tries to set a container-level limit higher than the pod-level limit, the operation is prohibited, and the pod will not be created.
5253
> * When the admission-controller tries to set the newly recommended container-level requests, their total value cannot exceed the pod-level request or limit. For example, if the pod-level memory request is 100Mi, but the newly recommended total of container-level requests is 250Mi, the pod will fail to be created.
5354
55+
## Development and testing
56+
57+
Have a look at the [Development and testing](./docs/development-and-testing.md) page for more information about developing on the VPA.
58+
5459
## Related links
5560

5661
- [Design proposal](https://github.com/kubernetes/design-proposals-archive/blob/main/autoscaling/vertical-pod-autoscaler.md)
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Development and testing
2+
3+
## Contents
4+
5+
- [Development and testing](#development-and-testing)
6+
- [Introduction](#introduction)
7+
- [Running e2e tests](#running-e2e-tests)
8+
- [Feature gates](#feature-gates)
9+
- [Parallelism](#parallelism)
10+
11+
## Introduction
12+
13+
This project contains various scripts and tools to aid in the development of the three VPA components.
14+
15+
## Running e2e tests
16+
17+
The VPA contains some e2e tests that test how each component interacts with Pods and VPA resources inside a real Kubernetes cluster.
18+
19+
They can be run using the `./hack/run-e2e-locally.sh` helper script. Please note that this script will delete any existing [kind](https://kind.sigs.k8s.io) cluster running on the local machine before creating a fresh cluster for executing the tests.
20+
21+
### Feature gates
22+
23+
By default, the e2e test suite only runs feature-gated tests for features that are enabled by default (typically beta and GA). Alpha features, which are disabled by default, are not tested.
24+
25+
Setting the environment variable `ENABLE_ALL_FEATURE_GATES=true` will enable all feature gates and run all feature-gated tests.
26+
27+
### Parallelism
28+
29+
By default, the e2e tests create 4 worker processes, each one running its own test. This can be changed by setting the `NUMPROC=<workers>` variable.

0 commit comments

Comments
 (0)