1# Kubernetes Conformance Test Suite - {{.Version}}
2
3## **Summary**
4This document provides a summary of the tests included in the Kubernetes conformance test suite.
5Each test lists a set of formal requirements that a platform that meets conformance requirements must adhere to.
6
7The tests are a subset of the "e2e" tests that make up the Kubernetes testing infrastructure.
8Each test is identified by the presence of the `[Conformance]` keyword in the ginkgo descriptive function calls.
9The contents of this document are extracted from comments preceding those `[Conformance]` keywords
10and those comments are expected to include a descriptive overview of what the test is validating using
11RFC2119 keywords. This will provide a clear distinction between which bits of code in the tests are
12there for the purposes of validating the platform rather than simply infrastructure logic used to setup, or
13clean up the tests.
14
15Example:
16```
17/*
18 Release: v1.13
19 Testname: Kubelet, log output, default
20 Description: By default the stdout and stderr from the process being executed in a pod MUST be sent to the pod's logs.
21*/
22framework.ConformanceIt("should print the output to logs [NodeConformance]", func(ctx context.Context) {
23```
24
25would generate the following documentation for the test. Note that the "TestName" from the Documentation above will
26be used to document the test which make it more human readable. The "Description" field will be used as the
27documentation for that test.
28
29### **Output:**
30## [Kubelet, log output, default](https://github.com/kubernetes/kubernetes/tree/master/test/e2e/common/node/kubelet.go#L49)
31
32- Added to conformance in release v1.13
33- Defined in code as: [k8s.io] Kubelet when scheduling a busybox command in a pod should print the output to logs [NodeConformance] [Conformance]
34
35By default the stdout and stderr from the process being executed in a pod MUST be sent to the pod's logs.
36
37Notational Conventions when documenting the tests with the key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" are to be interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119).
38
39Note: Please see the Summary at the end of this document to find the number of tests documented for conformance.
40
41## **List of Tests**
View as plain text