Update node conformance test document. #1784
Conversation
k8s-ci-robot
added
the
cncf-cla: yes
Random-Liu
added
release-note
and removed
cncf-cla: yes
k8s-ci-robot
added
the
cncf-cla: yes
| minimum requirement of Kubernetes with a set of system verification and | ||
| functionality test. A node which passes the tests is qualified to join a | ||
| Kubernetes cluster. | ||
| *Node conformance test* is a containerized test framework validating whether a |
There was a problem hiding this comment.
"Node conformance test is a containerized test framework that provides a system verification and functionality test for a node. The test validates whether the node meets the minimum requirements for Kubernetes; a node that passes the test is qualified to join a Kubernetes cluster."
| *Node conformance test* is a containerized test framework validating whether a | ||
| node meets the minimum requirement of Kubernetes with a set of system | ||
| verification and functionality test. A node which passes the test is qualified | ||
| to join a Kubernetes cluster. | ||
|
|
||
| ## Limitations | ||
|
|
||
| There are following limitations in the current implementation of node |
There was a problem hiding this comment.
"Current" can be out of date. Reference a specific Kubernetes version.
"In Kuberentes version 1.5, node conformance test has the following limitations:"
There was a problem hiding this comment.
Good suggestion! Will do.
|
|
||
| * Node conformance test only supports Docker as the container runtime. | ||
| * Node conformance test doesn't validate network related system configurations | ||
| and functionalities. | ||
|
|
||
| ## Prerequisite |
There was a problem hiding this comment.
Change header to "## Node Prerequisites"
|
|
||
| * Node conformance test only supports Docker as the container runtime. | ||
| * Node conformance test doesn't validate network related system configurations | ||
| and functionalities. | ||
|
|
||
| ## Prerequisite | ||
|
|
||
| Node conformance test is used to test whether a node is ready to join a |
There was a problem hiding this comment.
"To run node conformance test, a node must satisfy the same prerequisites as a standard Kubernetes node. At a minimum, the node should have the following processes installed:"
| Node conformance test validates kernel configurations. If the kenrel module | ||
| `configs` is built as module in your environment, it must be loaded before the | ||
| test. (See [Caveats #3](#caveats) for more information) | ||
|
|
||
| ## Usage |
There was a problem hiding this comment.
Try not to nest headers underneath one another. That's usually indicative of structural problems in the document.
In this case, "## Usage" is unnecessary. Remove, and move all subsequent headers up one level.
| Node conformance test validates kernel configurations. If the kenrel module | ||
| `configs` is built as module in your environment, it must be loaded before the | ||
| test. (See [Caveats #3](#caveats) for more information) | ||
|
|
||
| ## Usage | ||
|
|
||
| ### Run Node Conformance Test | ||
|
|
There was a problem hiding this comment.
Add an introductory sentence:
"To run a node conformance test, perform the following steps:"
| Node conformance test validates kernel configurations. If the kenrel module | ||
| `configs` is built as module in your environment, it must be loaded before the | ||
| test. (See [Caveats #3](#caveats) for more information) | ||
|
|
||
| ## Usage | ||
|
|
||
| ### Run Node Conformance Test | ||
|
|
||
| * **Step 1:** Point your Kubelet to localhost `--api-servers="http://localhost:8080"`, |
There was a problem hiding this comment.
You can remove "Step 1:" and the bullet list, and use a markdown list instead. You can still nest bullets inside of it for the Kubelet flags.
- Point your Kubelet to localhost, etc.
--pod-cidr: If you are usingkubenet...
- Run the node conformance test with the following command:
| Node conformance test validates kernel configurations. If the kenrel module | ||
| `configs` is built as module in your environment, it must be loaded before the | ||
| test. (See [Caveats #3](#caveats) for more information) | ||
|
|
||
| ## Usage | ||
|
|
||
| ### Run Node Conformance Test |
| ``` | ||
|
|
||
| ### Run Node Conformance Test for Other Architectures | ||
|
|
||
| We also build node conformance test docker images for other architectures: | ||
| Find node conformance test docker images for other architectures: |
There was a problem hiding this comment.
"Kubernetes also provides node conformance test docker images for other architectures:"
| test. | ||
| * The test will leave dead containers on the node, these containers are created | ||
| * The test leaves dead containers on the node, these containers are created |
There was a problem hiding this comment.
Replace comma with period. Split this into two sentences.
|
@devin-donnelly Addressed comments. Thanks a lot for your carefully review. |
|
Awesome, thanks. Who's a good tech reviewer for this pull request? |
|
LGTM |
Update node conformance test document.
@dchen1107
/cc @kubernetes/sig-node
This change is