You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: contributors/devel/sig-testing/e2e-tests.md
+14-18Lines changed: 14 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@
7
7
-[Building Kubernetes and Running the Tests](#building-kubernetes-and-running-the-tests)
8
8
-[Cleaning up](#cleaning-up)
9
9
-[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)
11
11
-[Bringing up a cluster for testing](#bringing-up-a-cluster-for-testing)
12
12
-[Debugging clusters](#debugging-clusters)
13
13
-[Local clusters](#local-clusters)
@@ -38,10 +38,10 @@ minor change may pass all unit and integration tests, but cause unforeseen
38
38
changes at the system level.
39
39
40
40
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
42
42
users do, when unit and integration tests are insufficient.
43
43
44
-
The e2e tests in kubernetes are built atop of
44
+
The e2e tests in Kubernetes are built atop of
45
45
[Ginkgo](http://onsi.github.io/ginkgo/) and
46
46
[Gomega](http://onsi.github.io/gomega/). There are a host of features that this
47
47
Behavior-Driven Development (BDD) testing framework provides, and it is
@@ -129,9 +129,9 @@ kubetest --down
129
129
130
130
## Advanced testing
131
131
132
-
### Extracting a specific version of kubernetes
132
+
### Extracting a specific version of Kubernetes
133
133
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,
135
135
both the server, client and test binaries. The `--extract=E` flag enables this
136
136
functionality.
137
137
@@ -200,7 +200,7 @@ when a failure occurs
200
200
--provider="": The name of the Kubernetes provider (gce, gke, local, vagrant,
201
201
etc.)
202
202
203
-
--repo-root="../../": Root directory of kubernetes repository, for finding test
203
+
--repo-root="../../": Root directory of Kubernetes repository, for finding test
204
204
files.
205
205
```
206
206
@@ -401,10 +401,8 @@ where `->` means upgrading; container_vm (cvm) and gci are image names.
401
401
402
402
## Kinds of tests
403
403
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):
408
406
409
407
- If a test has no labels, it is expected to run fast (under five minutes), be
410
408
able to be run in parallel, and be consistent.
@@ -478,7 +476,7 @@ To use viper, rather than flags, to configure your tests:
478
476
479
477
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).
480
478
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.
482
480
483
481
### Conformance tests
484
482
@@ -548,9 +546,6 @@ the existing suite as a guide.
548
546
**NOTE:** To build/run with tests in a new directory within ./test/e2e, add the
549
547
directory to import list in ./test/e2e/e2e_test.go
550
548
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
-
554
549
When writing a test, consult #kinds-of-tests above to determine how your test
555
550
should be marked, (e.g. `[Slow]`, `[Serial]`; remember, by default we assume a
556
551
test can run in parallel with other tests!).
@@ -604,7 +599,7 @@ Containers for all of these components can be found
604
599
[here](https://hub.docker.com/u/prom/).
605
600
606
601
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
608
603
(api-server, controller-manager, scheduler). This is especially useful when
609
604
attempting to gather metrics in a load-balanced api-server environment, because
610
605
all api-servers can be analyzed independently as well as collectively. On
@@ -627,9 +622,10 @@ job: {
627
622
}
628
623
```
629
624
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
0 commit comments