Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add document for node conformance test. #1216

Merged
merged 1 commit into from
Sep 15, 2016
Merged

Add document for node conformance test. #1216

merged 1 commit into from
Sep 15, 2016

Conversation

Random-Liu
Copy link
Member

@Random-Liu Random-Liu commented Sep 13, 2016

This PR added a document for the node conformance test to Creating a Cluster/Running Kubernetes on Custom Solutions/Validate Node Setup

@dchen1107
/cc @kubernetes/sig-node


This change"s Reviewable

@davidopp
Copy link
Member

Does this mean the node e2e tests have to be 100% non-flaky? Or will node conformance test retry a few times on failure?

@Random-Liu
Copy link
Member Author

@davidopp By default, the node conformance test only runs the node e2e test with "[conformance]" label, which should be stable (or else we should fix it or remove the conformance tag)

However, add flake retry is a good idea for better user experience.

@devin-donnelly
Copy link
Contributor

Docs LGTM. Needs a Tech LGTM.

@Random-Liu
Copy link
Member Author

@dchen1107 PTAL.

@dchen1107
Copy link
Member

LGTM


*Node conformance test* is a 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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/test/tests

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK


### Run Node Conformance Test for Other Architectures

We also build node conformance test docker image for other architectures:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/image/images

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK.

test](https://github.com/kubernetes/kubernetes/blob/release-1.4/docs/devel/e2e-node-tests.md).
By default, it runs all conformance test.

Theoritically, you can run any node e2e test if you configure the container and
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/Theoritically/Theoretically

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK.

By default, it runs all conformance test.

Theoritically, you can run any node e2e test if you configure the container and
mount required volumes properly. But **it is strongly recommanded to only run conformance
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/recommanded/recommended

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK

test.
* The test will leave dead containers on the node, these containers are created
during the functionality test.
* Node conformance test validates kernel configuration. However, in some os
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be listed in the requirements?

## Prerequisite

Node conformance test is used to test whether a node is ready to join a
Kubernetes cluster, so the prerequisite is the same with a standard Kubernetes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are there any documentation on the "prerequisite" of a standard kubernetes npde?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I want to link somewhere, but I don't think we have it. :(

@Random-Liu
Copy link
Member Author

@pwittrock Docs and Tech Review both passed.

@devin-donnelly devin-donnelly merged commit e61d5ec into kubernetes:release-1.4 Sep 15, 2016
@Random-Liu Random-Liu deleted the add-node-conformance-test-doc branch September 15, 2016 20:36
mikutas pushed a commit to mikutas/k8s-website that referenced this pull request Sep 22, 2022
* wip
* fixups

Signed-off-by: William Morgan <william@buoyant.io>
Co-authored-by: Tarun Pothulapati <tarunpothulapati@outlook.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants