Skip to content

Commit b31ac96

Browse files
Merge pull request #3572 from replicatedhq/troubleshoot-brew-doc-update
Updated troubleshoot docs to add brew instructions
2 parents e4f28c9 + e239b2f commit b31ac96

File tree

3 files changed

+61
-36
lines changed

3 files changed

+61
-36
lines changed

docs/partials/support-bundles/_install-plugin.mdx

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,36 @@
11
The support-bundle plugin (a kubectl plugin) is required to generate support bundles from the command line.
22

3-
You can install the support-bundle plugin using krew or install it manually from the release archives.
4-
53
:::note
64
For Replicated Embedded Cluster and Replicated kURL installations, the support-bundle plugin is automatically installed on all of the control plane nodes. You can skip this prerequisite.
75
:::
86

9-
#### Install or Upgrade using krew
7+
#### Mac
8+
9+
For Mac users, Replicated recommends using Homebrew to install the support-bundle plugin:
10+
11+
```bash
12+
brew install support-bundle
13+
```
1014

11-
To install the support-bundle plugin using krew, do one of the following:
15+
#### Windows / Linux
16+
17+
For Windows and Linux users, use Krew to install the support-bundle plugin:
1218

1319
* If krew is _not_ installed already, run the following command to install krew and the support-bundle plugin at the same time:
14-
15-
```
20+
21+
```bash
1622
curl https://krew.sh/support-bundle | bash
1723
```
18-
19-
* If krew is installed already, run the following command to install the plug-in:
2024

21-
```
25+
* If krew is installed already, run the following command to install the plugin:
26+
27+
```bash
2228
kubectl krew install support-bundle
2329
```
2430

2531
* To upgrade your existing support-bundle plugin using krew:
2632

27-
```
33+
```bash
2834
kubectl krew upgrade support-bundle
2935
```
3036

docs/vendor/environment-setup.mdx

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -143,28 +143,34 @@ To install and run the latest Replicated CLI on Linux or Windows Subsystem for L
143143

144144
The preflight and support-bundle plugins available through the open source Troubleshoot project provide important troubleshooting tools for your customers, allowing them to run preflight checks and collect support bundles. For more information, see [About Preflight Checks and Support Bundles](/vendor/preflight-support-bundle-about).
145145

146-
These instructions show you how to install the Troubleshoot plugins using Krew. For more information about installing the preflight and support-bundle plugins, including other installation options, see [Getting Started](https://troubleshoot.sh/docs/) in the Troubleshoot documentation.
146+
For more information about installing the preflight and support-bundle plugins, including other installation options, see [Getting Started](https://troubleshoot.sh/docs/) in the Troubleshoot documentation.
147147

148-
To install the preflight and support-bundle plugins:
148+
#### Mac
149+
150+
For Mac users, Replicated recommends using Homebrew to install the preflight and support-bundle plugins:
151+
152+
```bash
153+
brew install preflight
154+
brew install support-bundle
155+
```
156+
157+
#### Windows / Linux
158+
159+
For Windows and Linux users, use Krew to install the preflight and support-bundle plugins:
149160

150161
1. Install Krew:
151162

152-
* Mac:
153-
```bash
154-
brew install krew
155-
```
156-
* Other operating systems:
157-
```bash
158-
(
159-
set -x; cd "$(mktemp -d)" &&
160-
OS="$(uname | tr '[:upper:]' '[:lower:]')" &&
161-
ARCH="$(uname -m | sed -e 's/x86_64/amd64/' -e 's/\(arm\)\(64\)\?.*/\1\2/' -e 's/aarch64$/arm64/')" &&
162-
KREW="krew-${OS}_${ARCH}" &&
163-
curl -fsSLO "https://github.com/kubernetes-sigs/krew/releases/latest/download/${KREW}.tar.gz" &&
164-
tar zxvf "${KREW}.tar.gz" &&
165-
./"${KREW}" install krew
166-
)
167-
```
163+
```bash
164+
(
165+
set -x; cd "$(mktemp -d)" &&
166+
OS="$(uname | tr '[:upper:]' '[:lower:]')" &&
167+
ARCH="$(uname -m | sed -e 's/x86_64/amd64/' -e 's/\(arm\)\(64\)\?.*/\1\2/' -e 's/aarch64$/arm64/')" &&
168+
KREW="krew-${OS}_${ARCH}" &&
169+
curl -fsSLO "https://github.com/kubernetes-sigs/krew/releases/latest/download/${KREW}.tar.gz" &&
170+
tar zxvf "${KREW}.tar.gz" &&
171+
./"${KREW}" install krew
172+
)
173+
```
168174

169175
1. After installing, add the krew binary directory to your PATH:
170176

docs/vendor/preflight-running.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,18 @@ To run preflight checks that are defined in your application Helm chart template
1414

1515
The preflight kubectl plugin is required to run preflight checks for Helm CLI installations. The preflight plugin is a client-side utility that adds a single binary to the path.
1616

17-
To install the preflight plugin, run the following command to install the preflight plug-in using krew:
17+
To install the preflight plugin:
18+
19+
* **Mac:** Replicated recommends using Homebrew:
20+
```bash
21+
brew install preflight
22+
```
23+
24+
* **Windows / Linux:** Use Krew:
25+
```bash
26+
curl https://krew.sh/preflight | bash
27+
```
1828

19-
```
20-
curl https://krew.sh/preflight | bash
21-
```
2229
For information about the preflight plugin, including additional installation options, see [Getting Started](https://troubleshoot.sh/docs/) in the open source Troubleshoot documentation.
2330

2431
## Command
@@ -76,11 +83,17 @@ To run preflights checks from a release before installation:
7683
helm registry login registry.replicated.com --username [email protected] password 1234abcd
7784
```
7885
79-
1. Run the second command to install the kubectl plugin with krew:
86+
1. Run the second command to install the kubectl plugin:
8087
81-
```
82-
curl https://krew.sh/preflight | bash
83-
```
88+
* **Mac:**
89+
```bash
90+
brew install preflight
91+
```
92+
93+
* **Windows / Linux:**
94+
```bash
95+
curl https://krew.sh/preflight | bash
96+
```
8497
8598
1. Run the third command to run preflight checks:
8699

0 commit comments

Comments
 (0)