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

Clarifies some of the instructions #24

Merged
merged 1 commit into from
Oct 30, 2017
Merged

Conversation

timothysc
Copy link
Member

Updates the instructions to be more clear and to remove some of the ambiguity that folks have had.

Fixes #17
Fixes #6

/cc @mml @smarterclayton @aaronlevy @WilliamDenniss

issues.md Outdated

* https://github.com/kubernetes/kubernetes/issues/52822
* https://github.com/kubernetes/kubernetes/pull/52823
## At this time all known major issues have been fixed in the 1.8 e2e test suite.
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm glad that these are all fixed by I think it's worthwhile to keep a historical record, at least for a little while, to demonstrate that SIG-architecture has been working with program participants to deal with their issues.

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'll update to denote [FiV-1.8].

Copy link
Member Author

Choose a reason for hiding this comment

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

@dankohn In thinking about this it makes more sense to me to have a single tracking issue in this repo that other issues can reference. Otherwise this file will require constant maintenance.

Copy link
Member Author

Choose a reason for hiding this comment

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

e.g. - #27

Let me know what you think and I'll fix up this PR to point to that tracking issue.

Copy link
Contributor

Choose a reason for hiding this comment

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

+1

@dankohn
Copy link
Contributor

dankohn commented Oct 24, 2017

Good start, but could you please update https://github.com/cncf/k8s-conformance/blob/master/reviewing.md as well to clarify the version requirements. That's the outstanding issue on #11 (comment)

@timothysc
Copy link
Member Author

Good start, but could you please update https://github.com/cncf/k8s-conformance/blob/master/reviewing.md as well to clarify the version requirements. That's the outstanding issue on #11 (comment)

Yup, I'll update this PR soon-ish.

instructions.md Outdated
[sonobuoy](https://github.com/heptio/sonobuoy), and the standard way to run
these in your cluster is with `curl -L https://raw.githubusercontent.com/cncf/k8s-conformance/master/sonobuoy-conformance-1.7.yaml | kubectl apply -f -`.
[sonobuoy](https://github.com/heptio/sonobuoy/tree/latest), and the standard way to run
these in your cluster is with `curl -L https://raw.githubusercontent.com/heptio/sonobuoy/latest/examples/conformance.yaml | kubectl apply -f -`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Would prefer we kept this yaml file in this repo.

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'd prefer to point to the latest/example which will be kept up to date. The reason for the change was confusion that arose from #17 and #6 .

Copy link
Contributor

Choose a reason for hiding this comment

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

I don't understand why it's easier to keep the one in the sonobuoy repo up to date than this one. I agree that the config should be kept up to date, but I don't see why that means it can't be in this repo.

I think that our instructions should be under a cncf repo, and the sonobuoy config is part of those instructions. I would prefer that revisions to the YAML config undergo review here.

For example, the linked file includes a long list of resources and the systemd_logs plugin, which users don't need to run in order to generate conformance results.

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 don't understand why it's easier to keep the one in the sonobuoy repo up to date than this one.

b/c it's the canonical source and actively maintained and kept up to date, I'd also be happy to trim the conformance one and call it cncf-conformance. If we keep it here, that means someone should maintain it and actively update and verify it. The reason for this PR is because there were two issues filed against the version in the repo and no answers were given.

@timothysc
Copy link
Member Author

@dankohn minor update PTAL.

@dankohn
Copy link
Contributor

dankohn commented Oct 27, 2017

LGTM

@timothysc
Copy link
Member Author

@WilliamDenniss @mml PTAL - I've updated to address the comments.

@mml
Copy link
Contributor

mml commented Oct 27, 2017

@timothysc Thanks. Appreciate keeping this config in the CNCF repo.

My only request is that we leave behind the v1.7 YAML file with v1.7 in its name and add the new one with the name v1.8. People running conformance tests should be expected to know which version they are trying to certify, and I think just going to "latest" is not likely to yield expected (or reproducible, after a certain while) results.

If we really want a "latest" version, how about a symlink to the 1.8 one?

reviewing.md Outdated
@@ -1,5 +1,5 @@
# How to review conformance results

1. Make sure the list of files matches [the one specified here](https://github.com/cncf/k8s-conformance/blob/master/instructions.md#contents-of-the-pr)
2. Look at `version.txt`. Make sure the `client` and `server` versions match each other to the minor version level. Make sure this also matches the `vX.Y` subdirectory that the PR is in.
2. Look at `version.txt`. Make sure the `client` version is no more than one minor version greater than the `server` version
Copy link
Contributor

Choose a reason for hiding this comment

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

The guidance here is to make sure that "client" matches the directory they are putting their results into. So if they are certifying as being "kubernetes 1.7 conformant", they need to be running e2e tests built from 1.7.

Copy link
Member Author

Choose a reason for hiding this comment

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

Sorry I mis-read this now when I re-read it.. I'll swap back.. but the other comment below applies.

@timothysc
Copy link
Member Author

timothysc commented Oct 27, 2017

@mml There were issues found with the tests in 1.7 that have been fixed in 1.8 and validated that they work properly in 1.7. e.g. 1.8 tests are in some ways more complete and correct for validating a 1.7 cluster than the 1.7 tests. I don't think they need to match given how upstream patching process works, which is why the instructions have changed.

…t are tracking.

Signed-off-by: Timothy St. Clair <timothysc@gmail.com>
@mml
Copy link
Contributor

mml commented Oct 27, 2017

@timothysc see #6 (comment) In general, we are not maintaining k8s with the property that the conformance tests in N.{M+1} cover everything in N.M. On the contrary, I expect turned down APIs, sooner or later, to simply disappear from the e2e suite.

@mml
Copy link
Contributor

mml commented Oct 27, 2017

Also, regardless of the "one minor version" thing, the key check is in the match between the client version and the subdirectory. E.g., you can't submit results into the v1.8 directory using v1.6 client, even if your server is also v1.6.

@timothysc
Copy link
Member Author

The statement should read: v1.8 tests are ok on a v1.7 cluster to determine conformance b/c I've been actively making certain they do and ensuring that proper version gates are in place on any api additions or changes. If anything, new tests are added to gain wider coverage, and other tests have been fixed.

@mml
Copy link
Contributor

mml commented Oct 27, 2017

@timothysc I am happy to pursue the "N+1" argument separately. I think @bgrant0607 has some thoughts on skew testing and whether vM.{N+1} tests should be considered authoritative for vM.N.

So I am fine leaving in the N+1 guidance for now, but the reviewer needs to compare the client version (i.e. the test version) with the subdirectory (i.e. the version of kubernetes the PR author is claiming conformance with). The server version does not matter.

@timothysc
Copy link
Member Author

It's part of an ongoing effort of this body, along with sig-testing, to ensure the consistency and track the issues of the e2e "Conformance" tests. I have little doubt that there may be skew over time that may force us to maintain multiple submission files. However, in this particular case, there are number of known defects that exist in the 1.7 tests that have been fixed in 1.8 in an effort to get this process started.

#27 contains a sub-set of some of the issues, and not all have been cross-linked. Going forwards, we will likely have to revision our submission files, but I would prefer not to link the 1.7 tests b/c of the known problems that have been fixed.

Copy link

@mjura mjura left a comment

Choose a reason for hiding this comment

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

I've tested this change, works fine for me

@timothysc
Copy link
Member Author

@dankohn - PTAL. I think all immediate concerns have been addressed.

@dankohn
Copy link
Contributor

dankohn commented Oct 30, 2017

@timothysc What you have is good but I was hoping you would also update the reviewer instructions to address the question on #11

Or, does OpenShift need to re-run the conformance tests with the updated YAML?

cc @smarterclayton

@mml
Copy link
Contributor

mml commented Oct 30, 2017

LGTM

@WilliamDenniss WilliamDenniss merged commit dc1e1e9 into cncf:master Oct 30, 2017
BobyMCbobs pushed a commit that referenced this pull request Oct 23, 2023
Clarifies some of the instructions
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.

5 participants