diff --git a/README.md b/README.md index 9b0f92630..de473f6ea 100644 --- a/README.md +++ b/README.md @@ -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]. @@ -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. diff --git a/docs/conformance-testing.md b/docs/conformance-testing.md index 09e35cc9c..5ac084281 100644 --- a/docs/conformance-testing.md +++ b/docs/conformance-testing.md @@ -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. @@ -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 @@ -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