Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
26 changes: 16 additions & 10 deletions docs/partials/support-bundles/_install-plugin.mdx
Original file line number Diff line number Diff line change
@@ -1,30 +1,36 @@
The support-bundle plugin (a kubectl plugin) is required to generate support bundles from the command line.

You can install the support-bundle plugin using krew or install it manually from the release archives.

:::note
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.
:::

#### Install or Upgrade using krew
#### Mac

For Mac users, Replicated recommends using Homebrew to install the support-bundle plugin:

```bash
brew install support-bundle
```

To install the support-bundle plugin using krew, do one of the following:
#### Windows / Linux

For Windows and Linux users, use Krew to install the support-bundle plugin:

* If krew is _not_ installed already, run the following command to install krew and the support-bundle plugin at the same time:
```

```bash
curl https://krew.sh/support-bundle | bash
```

* If krew is installed already, run the following command to install the plug-in:

```
* If krew is installed already, run the following command to install the plugin:

```bash
kubectl krew install support-bundle
```

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

```
```bash
kubectl krew upgrade support-bundle
```

Expand Down
42 changes: 24 additions & 18 deletions docs/vendor/environment-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -143,28 +143,34 @@ To install and run the latest Replicated CLI on Linux or Windows Subsystem for L

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).

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.
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.

To install the preflight and support-bundle plugins:
#### Mac

For Mac users, Replicated recommends using Homebrew to install the preflight and support-bundle plugins:

```bash
brew install preflight
brew install support-bundle
```

#### Windows / Linux

For Windows and Linux users, use Krew to install the preflight and support-bundle plugins:

1. Install Krew:

* Mac:
```bash
brew install krew
```
* Other operating systems:
```bash
(
set -x; cd "$(mktemp -d)" &&
OS="$(uname | tr '[:upper:]' '[:lower:]')" &&
ARCH="$(uname -m | sed -e 's/x86_64/amd64/' -e 's/\(arm\)\(64\)\?.*/\1\2/' -e 's/aarch64$/arm64/')" &&
KREW="krew-${OS}_${ARCH}" &&
curl -fsSLO "https://github.com/kubernetes-sigs/krew/releases/latest/download/${KREW}.tar.gz" &&
tar zxvf "${KREW}.tar.gz" &&
./"${KREW}" install krew
)
```
```bash
(
set -x; cd "$(mktemp -d)" &&
OS="$(uname | tr '[:upper:]' '[:lower:]')" &&
ARCH="$(uname -m | sed -e 's/x86_64/amd64/' -e 's/\(arm\)\(64\)\?.*/\1\2/' -e 's/aarch64$/arm64/')" &&
KREW="krew-${OS}_${ARCH}" &&
curl -fsSLO "https://github.com/kubernetes-sigs/krew/releases/latest/download/${KREW}.tar.gz" &&
tar zxvf "${KREW}.tar.gz" &&
./"${KREW}" install krew
)
```

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

Expand Down
29 changes: 21 additions & 8 deletions docs/vendor/preflight-running.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,18 @@ To run preflight checks that are defined in your application Helm chart template

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.

To install the preflight plugin, run the following command to install the preflight plug-in using krew:
To install the preflight plugin:

* **Mac:** Replicated recommends using Homebrew:
```bash
brew install preflight
```

* **Windows / Linux:** Use Krew:
```bash
curl https://krew.sh/preflight | bash
```

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

## Command
Expand Down Expand Up @@ -76,11 +83,17 @@ To run preflights checks from a release before installation:
helm registry login registry.replicated.com --username [email protected] password 1234abcd
```

1. Run the second command to install the kubectl plugin with krew:
1. Run the second command to install the kubectl plugin:

```
curl https://krew.sh/preflight | bash
```
* **Mac:**
```bash
brew install preflight
```

* **Windows / Linux:**
```bash
curl https://krew.sh/preflight | bash
```

1. Run the third command to run preflight checks:

Expand Down