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

[docs] Add supported version table #103

Merged
merged 1 commit into from
Oct 6, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,17 @@ Its selective data dumps of Kubernetes resource objects and cluster nodes allow
* Workload debugging
* Custom data collection via extensible plugins

## Supported Versions

*NOTE: The table below only applies to the e2e conformance tests.*

To ensure that your cluster is running the appropriate Kubernetes version for your Sonobuoy release, see the second column of the table below. Otherwise you may encounter the documented issues.

| Sonobuoy Version / Conformance Version | Required K8s Cluster Version | Known Issues |
|---|---|---|
| v0.9.0 / 1.8 | >= 1.7 | For earlier cluster versions (e.g. 1.6), the [*downward-api* tests](https://github.com/kubernetes/kubernetes/blob/master/test/e2e/common/downward_api.go) fail because they leverage some API fields that don't exist until 1.7. |
| v0.8.0 / 1.7 | N/A | N/A |

## Up and running

To easily get a Sonobuoy scan started on your cluster, use the browser-based [Sonobuoy Scanner tool][18]. Sonobuoy Scanner also provides a more user-friendly way of viewing your scan results.
Expand Down