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.

Sign up for GitHub

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

Jump to bottom

Fix old, and dead links #447

Merged
merged 1 commit into from
Jun 26, 2018
Merged

Fix old, and dead links #447

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 6 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,18 +30,17 @@ Sonobuoy supports Kubernetes versions 1.8 and later.

## More information

[The documentation][docs] provides detailed information about the conformance
tests, plugins, and snapshots.
[The documentation][docs] provides further information about the conformance
tests, plugins, etc.

[docs]: https://heptio.github.io/sonobuoy/
[docs]: https://github.com/heptio/sonobuoy/tree/master/docs

## Prerequisites

* Access to an up-and-running Kubernetes cluster. If you do not have a cluster,
follow the [AWS Quickstart Kubernetes Tutorial][quickstart] to set one up with
a single command.
we recommend following the [AWS Quickstart for Kubernetes][quickstart] instructions.

[quickstart]: http://docs.heptio.com/content/tutorials/aws-cloudformation-k8s.html
[quickstart]: https://aws.amazon.com/quickstart/architecture/heptio-kubernetes/

* `kubectl` installed. See [installing via Homebrew (MacOS)][brew] or [building
the binary (Linux)][linux].
Expand Down Expand Up @@ -70,13 +69,11 @@ Sonobuoy also provides a CLI that lets you run Sonobuoy on your cluster. The CLI
records the following results:

* Information about your cluster's hosts, Kubernetes resources, and versions.
* [`systemd`][systemd] logs from each host. Requires a plugin.
* systemd logs from each host. Requires a plugin.
* The results of a single e2e conformance test ("Pods should be submitted and
removed"). See the [conformance guide][conformance] for configuration details.
Requires a plugin.

[systemd]: https://github.com/systemd/systemd

### CLI Prerequisites

* Golang installed. We recommend [gimme][gimme], with golang version 1.9.4.
Expand Down
5 changes: 2 additions & 3 deletions docs/conformance-testing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ A conformance-passing cluster provides the following guarantees:

Individual Kubernetes distributions may offer additional features beyond conformance testing, but if you change distributions, these features can't be expected to be provided.

**NOTE:** Kubernetes documentation also describes the concept of [node conformance tests][3]. Although they are useful, these tests are more component-focused than system-wide. They validate only the behavior of a specific node, not cluster behavior as a whole.
**NOTE:** Kubernetes documentation also describes the concept of "node conformance tests". Although they are useful, these tests are more component-focused than system-wide. They validate only the behavior of a specific node, not cluster behavior as a whole.

See the [official documentation][4] for Kubernetes's existing conformance tests.

Expand All @@ -30,7 +30,7 @@ To customize the set of tests that are run as part of the report, the following
| `E2E_SKIP` | "Alpha|Disruptive|Feature|Flaky|Kubectl" | Which subset of tests to skip |
| `E2E_PROVIDER` | "local" | The platform that the cluster is running on |

*NOTE: The length of time it takes to run conformance can vary based on the size of your cluster---the timeout can be adjusted in the [Server.timeoutseconds][9] field of the Sonobuoy `config.json`.*
*NOTE: The length of time it takes to run conformance can vary based on the size of your cluster---the timeout can be adjusted in the Server.timeoutseconds field of the Sonobuoy `config.json`.*

[0]: #overview
[1]: #integration-with-sonobuoy
Expand All @@ -41,4 +41,3 @@ To customize the set of tests that are run as part of the report, the following
[6]: https://github.com/kubernetes/kubernetes/issues/49313
[7]: ../plugins.d/e2e.tmpl
[8]: ../examples/quickstart.yaml#L133
[9]: ../examples/quickstart.yaml#L102