Skip to content

Commit 5b86557

Browse files
authored
Merge pull request #4878 from heyste/update-e2e-testing
Remove/update legacy references in e2e testing guide
2 parents cd7f186 + eaa22ca commit 5b86557

File tree

1 file changed

+14
-18
lines changed

1 file changed

+14
-18
lines changed

contributors/devel/sig-testing/e2e-tests.md

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
- [Building Kubernetes and Running the Tests](#building-kubernetes-and-running-the-tests)
88
- [Cleaning up](#cleaning-up)
99
- [Advanced testing](#advanced-testing)
10-
- [Extracting a specific version of kubernetes](#extracting-a-specific-version-of-kubernetes)
10+
- [Extracting a specific version of Kubernetes](#extracting-a-specific-version-of-kubernetes)
1111
- [Bringing up a cluster for testing](#bringing-up-a-cluster-for-testing)
1212
- [Debugging clusters](#debugging-clusters)
1313
- [Local clusters](#local-clusters)
@@ -38,10 +38,10 @@ minor change may pass all unit and integration tests, but cause unforeseen
3838
changes at the system level.
3939

4040
The primary objectives of the e2e tests are to ensure a consistent and reliable
41-
behavior of the kubernetes code base, and to catch hard-to-test bugs before
41+
behavior of the Kubernetes code base, and to catch hard-to-test bugs before
4242
users do, when unit and integration tests are insufficient.
4343

44-
The e2e tests in kubernetes are built atop of
44+
The e2e tests in Kubernetes are built atop of
4545
[Ginkgo](http://onsi.github.io/ginkgo/) and
4646
[Gomega](http://onsi.github.io/gomega/). There are a host of features that this
4747
Behavior-Driven Development (BDD) testing framework provides, and it is
@@ -129,9 +129,9 @@ kubetest --down
129129

130130
## Advanced testing
131131

132-
### Extracting a specific version of kubernetes
132+
### Extracting a specific version of Kubernetes
133133

134-
The `kubetest` binary can download and extract a specific version of kubernetes,
134+
The `kubetest` binary can download and extract a specific version of Kubernetes,
135135
both the server, client and test binaries. The `--extract=E` flag enables this
136136
functionality.
137137

@@ -200,7 +200,7 @@ when a failure occurs
200200
--provider="": The name of the Kubernetes provider (gce, gke, local, vagrant,
201201
etc.)
202202
203-
--repo-root="../../": Root directory of kubernetes repository, for finding test
203+
--repo-root="../../": Root directory of Kubernetes repository, for finding test
204204
files.
205205
```
206206

@@ -401,10 +401,8 @@ where `->` means upgrading; container_vm (cvm) and gci are image names.
401401

402402
## Kinds of tests
403403

404-
We are working on implementing clearer partitioning of our e2e tests to make
405-
running a known set of tests easier (#10548). Tests can be labeled with any of
406-
the following labels, in order of increasing precedence (that is, each label
407-
listed below supersedes the previous ones):
404+
Tests can be labeled with any of the following labels, in order of increasing
405+
precedence (that is, each label listed below supersedes the previous ones):
408406

409407
- If a test has no labels, it is expected to run fast (under five minutes), be
410408
able to be run in parallel, and be consistent.
@@ -478,7 +476,7 @@ To use viper, rather than flags, to configure your tests:
478476

479477
Note that advanced testing parameters, and hierarchichally defined parameters, are only defined in viper, to see what they are, you can dive into [TestContextType](https://git.k8s.io/kubernetes/test/e2e/framework/test_context.go).
480478

481-
In time, it is our intent to add or autogenerate a sample viper configuration that includes all e2e parameters, to ship with kubernetes.
479+
In time, it is our intent to add or autogenerate a sample viper configuration that includes all e2e parameters, to ship with Kubernetes.
482480

483481
### Conformance tests
484482

@@ -548,9 +546,6 @@ the existing suite as a guide.
548546
**NOTE:** To build/run with tests in a new directory within ./test/e2e, add the
549547
directory to import list in ./test/e2e/e2e_test.go
550548

551-
TODO(#20357): Create a self-documented example which has been disabled, but can
552-
be copied to create new tests and outlines the capabilities and libraries used.
553-
554549
When writing a test, consult #kinds-of-tests above to determine how your test
555550
should be marked, (e.g. `[Slow]`, `[Serial]`; remember, by default we assume a
556551
test can run in parallel with other tests!).
@@ -604,7 +599,7 @@ Containers for all of these components can be found
604599
[here](https://hub.docker.com/u/prom/).
605600

606601
For more accurate measurements, you may wish to set up prometheus external to
607-
kubernetes in an environment where it can access the major system components
602+
Kubernetes in an environment where it can access the major system components
608603
(api-server, controller-manager, scheduler). This is especially useful when
609604
attempting to gather metrics in a load-balanced api-server environment, because
610605
all api-servers can be analyzed independently as well as collectively. On
@@ -627,9 +622,10 @@ job: {
627622
}
628623
```
629624

630-
Once prometheus is scraping the kubernetes endpoints, that data can then be
631-
plotted using promdash, and alerts can be created against the assortment of
632-
metrics that kubernetes provides.
625+
Once prometheus is scraping the Kubernetes endpoints, that data can then be
626+
plotted using [grafana](https://prometheus.io/docs/visualization/grafana/),
627+
and alerts can be created against the assortment of metrics that Kubernetes
628+
provides.
633629

634630
## One More Thing
635631

0 commit comments

Comments
 (0)