You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/partials/support-bundles/_install-plugin.mdx
+16-10Lines changed: 16 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,30 +1,36 @@
1
1
The support-bundle plugin (a kubectl plugin) is required to generate support bundles from the command line.
2
2
3
-
You can install the support-bundle plugin using krew or install it manually from the release archives.
4
-
5
3
:::note
6
4
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.
7
5
:::
8
6
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
+
```
10
14
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:
12
18
13
19
* 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
16
22
curl https://krew.sh/support-bundle | bash
17
23
```
18
-
19
-
* If krew is installed already, run the following command to install the plug-in:
20
24
21
-
```
25
+
* If krew is installed already, run the following command to install the plugin:
26
+
27
+
```bash
22
28
kubectl krew install support-bundle
23
29
```
24
30
25
31
* To upgrade your existing support-bundle plugin using krew:
Copy file name to clipboardExpand all lines: docs/vendor/environment-setup.mdx
+24-18Lines changed: 24 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -143,28 +143,34 @@ To install and run the latest Replicated CLI on Linux or Windows Subsystem for L
143
143
144
144
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).
145
145
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.
147
147
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:
149
160
150
161
1. Install Krew:
151
162
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/')"&&
Copy file name to clipboardExpand all lines: docs/vendor/preflight-running.md
+21-8Lines changed: 21 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,11 +14,18 @@ To run preflight checks that are defined in your application Helm chart template
14
14
15
15
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.
16
16
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
+
```
18
28
19
-
```
20
-
curl https://krew.sh/preflight | bash
21
-
```
22
29
For information about the preflight plugin, including additional installation options, see [Getting Started](https://troubleshoot.sh/docs/) in the open source Troubleshoot documentation.
23
30
24
31
## Command
@@ -76,11 +83,17 @@ To run preflights checks from a release before installation:
0 commit comments