correcting capitalization: helm > Helm (#1018)

2026-04-30 02:03:20 +00:00 · 2023-12-06 16:17:31 -05:00
parent 3b8defdbb1
commit 437ab199da
75 changed files with 111 additions and 114 deletions
@@ -55,7 +55,7 @@ You'll use the backup as a restore point if something goes wrong during upgrade.

 ### 2. Update the Helm chart repository

-1. Update your local helm repo cache.
+1. Update your local Helm repo cache:

    ```
    helm repo update
@@ -20,7 +20,7 @@ sudo ./get_helm.sh

 ### Install cert-manager

-Add the cert-manager helm repository:
+Add the cert-manager Helm repository:

 ```
 helm repo add jetstack https://charts.jetstack.io
@@ -63,7 +63,7 @@ kubectl rollout status deployment -n cert-manager cert-manager-webhook

 ### Install Rancher

-Next you can install Rancher itself. First add the helm repository:
+Next you can install Rancher itself. First, add the Helm repository:

 ```
 helm repo add rancher-latest https://releases.rancher.com/server-charts/latest
@@ -32,7 +32,7 @@ Since Rancher can be installed on any Kubernetes cluster, you can use this backu
 ### 1. Install the rancher-backup Helm chart
 Install the [rancher-backup chart](https://github.com/rancher/backup-restore-operator/tags), using a version in the 2.x.x major version range:

-  1. Add the helm repository:
+  1. Add the Helm repository:

     ```bash
     helm repo add rancher-charts https://charts.rancher.io
@@ -54,7 +54,7 @@ For details on using Fleet behind a proxy, see [this page.](../../../integration

 In order for Helm charts with dependencies to deploy successfully, you must run a manual command (as listed below), as it is up to the user to fulfill the dependency list. If you do not do this and proceed to clone your repository and run `helm install`, your installation will fail because the dependencies will be missing.

-The Helm chart in the git repository must include its dependencies in the charts subdirectory. You must either manually run `helm dependencies update $chart` OR run `helm dependencies build $chart` locally, then commit the complete charts directory to your git repository. Note that you will update your commands with the applicable parameters.
+The Helm chart in the git repository must include its dependencies in the charts subdirectory. You must either manually run `helm dependencies update $chart` or run `helm dependencies build $chart` locally, then commit the complete charts directory to your git repository. Note that you will update your commands with the applicable parameters.

 ## Troubleshooting

@@ -22,7 +22,7 @@ Native Helm charts include an application along with other software required to

 ### Rancher Charts

-Rancher charts are native helm charts with two files that enhance user experience: `app-readme.md` and `questions.yaml`. Read more about them in [Additional Files for Rancher Charts.](#additional-files-for-rancher-charts)
+Rancher charts are native Helm charts with two files that enhance user experience: `app-readme.md` and `questions.yaml`. Read more about them in [Additional Files for Rancher Charts.](#additional-files-for-rancher-charts)

 Rancher charts add simplified chart descriptions and configuration forms to make the application deployment easy. Rancher users do not need to read through the entire list of Helm variables to understand how to launch an application.

@@ -51,7 +51,7 @@ For details on using Fleet behind a proxy, see the [Using Fleet Behind a Proxy](

 In order for Helm charts with dependencies to deploy successfully, you must run a manual command (as listed below), as it is up to the user to fulfill the dependency list. If you do not do this and proceed to clone your repository and run `helm install`, your installation will fail because the dependencies will be missing.

-The Helm chart in the git repository must include its dependencies in the charts subdirectory. You must either manually run `helm dependencies update $chart` OR run `helm dependencies build $chart` locally, then commit the complete charts directory to your git repository. Note that you will update your commands with the applicable parameters
+The Helm chart in the git repository must include its dependencies in the charts subdirectory. You must either manually run `helm dependencies update $chart` or run `helm dependencies build $chart` locally, then commit the complete charts directory to your git repository. Note that you will update your commands with the applicable parameters

 ## Troubleshooting

@@ -74,7 +74,7 @@ Apps managed by the Cluster Manager (the global view in the legacy Rancher UI) s

 From the left sidebar select _"Repositories"_.

-These items represent helm repositories, and can be either traditional helm endpoints which have an index.yaml, or git repositories which will be cloned and can point to a specific branch. In order to use custom charts, simply add your repository here and they will become available in the Charts tab under the name of the repository.
+These items represent Helm repositories, and can be either traditional Helm endpoints which have an index.yaml, or git repositories which will be cloned and can point to a specific branch. In order to use custom charts, simply add your repository here and they will become available in the Charts tab under the name of the repository.

 To add a private CA for Helm Chart repositories:

@@ -66,7 +66,7 @@ In general, you want to scrape data from all the workloads running in your clust

 ### About Prometheus Exporters

-A lot of 3rd party workloads like databases, queues or web-servers either already support exposing metrics in a Prometheus format, or there are so called exporters available that translate between the tool's metrics and the format that Prometheus understands. Usually you can add these exporters as additional sidecar containers to the workload's Pods. A lot of helm charts already include options to deploy the correct exporter. Additionally you can find a curated list of exports by SysDig on [promcat.io](https://promcat.io/) and on [ExporterHub](https://exporterhub.io/).
+Many 3rd party workloads, such as databases, queues, and web-servers, already support exposing metrics in a Prometheus format, or offer exporters that translate between the tool's metrics and a format that Prometheus understands. You can usually add these exporters as additional sidecar containers to the workload's Pods. Many Helm charts already include options to deploy the correct exporter. You can find a curated list of exports by SysDig on [promcat.io](https://promcat.io/) and on [ExporterHub](https://exporterhub.io/).

 ### Prometheus support in Programming Languages and Frameworks

@@ -74,7 +74,7 @@ To get your own custom application metrics into Prometheus, you have to collect

 ### ServiceMonitors and PodMonitors

-Once all your workloads expose metrics in a Prometheus format, you have to configure Prometheus to scrape it. Under the hood Rancher is using the [prometheus-operator](https://github.com/prometheus-operator/prometheus-operator). This makes it easy to add additional scraping targets with ServiceMonitors and PodMonitors. A lot of helm charts already include an option to create these monitors directly. You can also find more information in the Rancher documentation.
+Once all your workloads expose metrics in a Prometheus format, you have to configure Prometheus to scrape it. Under the hood Rancher is using the [prometheus-operator](https://github.com/prometheus-operator/prometheus-operator). This makes it easy to add additional scraping targets with ServiceMonitors and PodMonitors. Many Helm charts let you create these monitors directly. You can also find more information in the Rancher documentation.

 ### Prometheus Push Gateway

@@ -49,13 +49,11 @@ An example of where this might be used is with Istio. For more information, see

 ## Configuring Applications Packaged within Monitoring v2

-We deploy kube-state-metrics and node-exporter with monitoring v2. Node exporter are deployed as DaemonSets. In the monitoring v2 helm chart, in the values.yaml, each of the things are deployed as sub charts.
+We deploy kube-state-metrics and node-exporter with monitoring v2. The node exporters are deployed as DaemonSets. Each of these entities are deployed as sub-charts through the monitoring v2 Helm chart, values.yaml.

-We also deploy grafana which is not managed by prometheus.
+We also deploy Grafana, which is not managed by Prometheus.

-If you look at what the helm chart is doing like in kube-state-metrics, there are plenty more values that you can set that aren’t exposed in the top level chart.
-
-But in the top level chart you can add values that override values that exist in the sub chart.
+Many values aren’t exposed in the top level chart. However, you can add values to the top level chart to override values that exist in the sub-charts.

 ### Increase the Replicas of Alertmanager

@@ -60,7 +60,7 @@ helm upgrade --reuse-values rancher-webhook rancher-charts/rancher-webhook  -n c
 ```
 **Note:** This temporary workaround may violate an environment's security policy. This workaround also requires that port 9443 is unused on the host network.

-**Note:** Helm uses secrets by default. This is a datatype that some webhook versions validate to store information. In these cases, directly update the deployment with the hostNetwork=true value using kubectl, then run the helm commands listed above to avoid drift between the helm configuration and the actual state in the cluster.
+**Note:** Helm uses secrets by default. This is a datatype that some webhook versions validate to store information. In these cases, directly update the deployment with the hostNetwork=true value using kubectl, then run the Helm commands listed above to prevent drift between the Helm configuration and the actual state of the cluster.

 ### Private GKE Cluster