From 69f7154ca55aad3400974adb2956129f8ec589f7 Mon Sep 17 00:00:00 2001 From: Jon Ji Date: Wed, 4 Jan 2023 23:09:40 +0800 Subject: [PATCH] Add brew installation to README, fix broken plugin link Signed-off-by: Jon Ji --- README.md | 12 ++++++++++++ site/content/docs/main/_index.md | 12 ++++++++++++ site/content/plugins/list/02-end-to-end-testing.md | 2 +- 3 files changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bc1943058..00c802153 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,10 @@ more about the new release cycles in [our blog][decoupling-sonobuoy-k8s]. ## Installation +The following methods exist for installing Sonobuoy: + +### Install binary + 1. Download the [latest release][releases] for your client platform. 2. Extract the tarball: @@ -46,6 +50,14 @@ more about the new release cycles in [our blog][decoupling-sonobuoy-k8s]. Move the extracted `sonobuoy` executable to somewhere on your `PATH`. +### Install with Hombrew (MacOS) + +1. Run the command: + + ``` + brew install sonobuoy + ``` + ## Getting Started To launch conformance tests (ensuring [CNCF][cncf] conformance) and wait until they are finished run: diff --git a/site/content/docs/main/_index.md b/site/content/docs/main/_index.md index 04fb71547..bdff82a6b 100644 --- a/site/content/docs/main/_index.md +++ b/site/content/docs/main/_index.md @@ -43,6 +43,10 @@ more about the new release cycles in [our blog][decoupling-sonobuoy-k8s]. ## Installation +The following methods exist for installing Sonobuoy: + +### Install binary + 1. Download the [latest release][releases] for your client platform. 2. Extract the tarball: @@ -52,6 +56,14 @@ more about the new release cycles in [our blog][decoupling-sonobuoy-k8s]. Move the extracted `sonobuoy` executable to somewhere on your `PATH`. +### Install with Hombrew (MacOS) + +1. Run the command: + + ``` + brew install sonobuoy + ``` + ## Getting Started To launch conformance tests (ensuring [CNCF][cncf] conformance) and wait until they are finished run: diff --git a/site/content/plugins/list/02-end-to-end-testing.md b/site/content/plugins/list/02-end-to-end-testing.md index 97091ec20..9f67b6bb3 100644 --- a/site/content/plugins/list/02-end-to-end-testing.md +++ b/site/content/plugins/list/02-end-to-end-testing.md @@ -5,4 +5,4 @@ link: https://sonobuoy.io/docs/main/e2eplugin/ The Kubernetes end-to-end testing plugin (the e2e plugin) is used to run tests which are maintained by the upstream Kubernetes community in the [kubernetes/kubernetes][1] repo. -[1]: https://github.com/kubernetes/kubernetes/tree/main/cluster/images/conformance \ No newline at end of file +[1]: https://github.com/kubernetes/kubernetes/tree/master/test/conformance/image \ No newline at end of file