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
4 changes: 4 additions & 0 deletions docs/vendor/helm-image-registry.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ To configure your application to use the proxy registry with Helm CLI installati

1. <RewriteHelmValues/>

:::note
Bitnami charts may display the error "Original containers have been substituted for unrecognized ones" when images are pulled from the Replicated proxy registry instead of the default Bitnami registry. To resolve this, set `global.security.allowInsecureImages=true` in your Helm values. Despite the name, this flag permits images from non-Bitnami registries. Your images are still pulled over HTTPS with authentication.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Bitnami'?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('been substituted').

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('are pulled').

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Bitnami'?

:::

1. <Helper/>

1. <UseHelper/>
Expand Down
18 changes: 18 additions & 0 deletions docs/vendor/support-bundle-customizing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,24 @@ To add the default support bundle spec to a release for your application:

1. Add the chart archive to a new release. Promote the release to an internal development channel, and install the release in a development environment to test your changes.

## RBAC requirements for exec collectors {#exec-rbac}

The Replicated SDK includes a built-in support bundle spec that uses `exec` collectors to call internal SDK API endpoints (such as `/api/v1/app/info` and `/api/v1/license/info`). These collectors retrieve application and license information that appears as `app-info.json` and `license.yaml` in the generated bundle.

For these `exec` collectors to work, the service account running the support bundle must have `pods/exec` with the `create` verb in its RBAC Role or ClusterRole. For example:

```yaml
- apiGroups: [""]
resources: ["pods/exec"]
verbs: ["create"]
```

Without this permission, the `exec` collectors fail silently. The support bundle is still generated and can be uploaded to the Vendor Portal, but `app-info.json` and `license.yaml` will be missing. The Vendor Portal displays warnings such as "No app-info file found" and "No license file found" when these files are absent.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('be uploaded').


:::note
KOTS installations include `pods/exec` permissions in the default kotsadm Role. For Helm CLI installations, you must ensure the service account used to run `kubectl support-bundle` has this permission.
:::

## (Recommended) Customize the default support bundle spec {#customize-the-spec}

You can customize the support bundle spec by:
Expand Down
26 changes: 25 additions & 1 deletion docs/vendor/support-bundle-generating.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,28 @@ Run the following command:

```bash
kubectl support-bundle https://raw.githubusercontent.com/replicatedhq/troubleshoot-specs/main/in-cluster/default.yaml
```
```

## Troubleshoot

### Support bundle is missing app-info or license data

#### Symptom

After uploading a support bundle to the Vendor Portal, you see warnings: "No app-info file found" or "No license file found."

#### Cause

The Replicated SDK's built-in support bundle spec uses `exec` collectors to retrieve application and license information from the SDK pod. If the service account running the support bundle does not have `pods/exec` permissions with the `create` verb, these collectors fail silently and the data is not included in the bundle.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.


#### Solution

Add `pods/exec` permissions to the RBAC Role or ClusterRole for the service account running the support bundle:

```yaml
- apiGroups: [""]
resources: ["pods/exec"]
verbs: ["create"]
```

For more information, see [RBAC requirements for exec collectors](/vendor/support-bundle-customizing#exec-rbac).
Loading