Skip to content

Commit 91f1fae

Browse files
committed
Add Helm troubleshooting info
1 parent 099751c commit 91f1fae

File tree

3 files changed

+32
-4
lines changed

3 files changed

+32
-4
lines changed

docs/vendor/helm-install-airgap.mdx

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,15 +64,17 @@ To install with Helm in an air gap environment:
6464

6565
1. Run the command to install the `preflight` plugin. This allows you to run preflight checks before installing to ensure that the installation environment meets the requirements for the application.
6666

67-
1. For **Determine install method**, select one of the options depending on your ability to access the internet and the cluster from your workstation.
67+
1. For **Download a copy of the values.yaml file** and **Edit the values.yaml file**, run the `helm show values` command provided to download the values file for the Helm chart. Then, edit the values file as needed to customize the configuration of the given chart.
6868

69-
1. Run the `helm show values` command to download the default `values.yaml`. Then, edit the values as required.
69+
If you are installing a release that contains multiple Helm charts, repeat these steps to download and edit each values file.
7070

7171
:::note
72-
Replicated recommends that vendors provide detailed documentation that describes the values that customers need to configure.
72+
For installations with mutliple charts where two or more of the top-level charts in the release use the same name, ensure that each values file has a unique name to avoid installation error. For more information, see [Air Gap Installation Fails for Release With Multiple Helm Charts](helm-install-troubleshooting#air-gap-values-file-conflict) in _Troubleshooting Helm Installations_.
7373
:::
7474

75-
1. Use the commands provided and the edited `values.yaml` to run preflight checks and install the release with Helm.
75+
1. For **Determine install method**, select one of the options depending on your ability to access the internet and the cluster from your workstation.
76+
77+
1. Use the commands provided and the values file or files that you edited to run preflight checks and then install the release.
7678

7779
## Perform Updates
7880

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Troubleshooting Helm Installations with Replicated
2+
3+
This topic provides troubleshooting information for common issues related to performing installations and upgrades with the Helm CLI.
4+
5+
## Air Gap Installation Fails for Release With Multiple Helm Charts {#air-gap-values-file-conflict}
6+
7+
#### Symptom
8+
9+
When performing an air gap installation of a release with multiple Helm charts, the installation fails and you see the following error message:
10+
11+
```
12+
ERROR MESSAGE
13+
```
14+
15+
#### Cause
16+
17+
In the Download Portal, each chart's values file is named according to the chart's name. For example, the values file for the Helm chart Gitea would be named `gitea-values.yaml`.
18+
19+
If any top-level charts in the release use the same name, the associated values files will also be assigned the same name. This causes each new values file downloaded with the `helm show values` command to overwrite any previously-downloaded values file of the same name.
20+
21+
#### Solution
22+
23+
Replicated recommends that you use unique names for top-level Helm charts in the same release.
24+
25+
Alternatively, if a release contains charts that must use the same name, convert one or both of the charts into subcharts and use Helm conditions to differentiate them. See [Conditions and Tags](https://helm.sh/docs/chart_best_practices/dependencies/#conditions-and-tags) in the Helm documentation.

sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -508,6 +508,7 @@ const sidebars = {
508508
'vendor/install-with-helm',
509509
'vendor/helm-install-airgap',
510510
'vendor/using-third-party-registry-proxy',
511+
'vendor/helm-install-troubleshooting',
511512
],
512513
},
513514
{

0 commit comments

Comments
 (0)