correcting capitalization: helm > Helm (#1018)

2026-09-25 04:28:15 +00:00 · 2023-12-06 16:17:31 -05:00
parent 3b8defdbb1
commit 437ab199da
75 changed files with 111 additions and 114 deletions
@@ -65,7 +65,7 @@ You'll use the backup as a restoration point if something goes wrong during upgr

 ## 2. Update the Helm chart repository

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

    ```
    helm repo update
@@ -12,7 +12,7 @@ Now that you have a running RKE cluster, you can install Rancher in it. For secu

 ### Install cert-manager

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

 ```
 helm repo add jetstack https://charts.jetstack.io
@@ -49,7 +49,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
@@ -33,7 +33,7 @@ helm install rancher-backup-crd rancher-charts/rancher-backup-crd -n cattle-reso
 helm install rancher-backup rancher-charts/rancher-backup -n cattle-resources-system --version $CHART_VERSION
 ```
 <br/>
-For an **air-gapped environment**, use the option below to pull the `backup-restore-operator` image from your private registry when installing the rancher-backup-crd helm chart.
+For an **air-gapped environment**, use the option below to pull the `backup-restore-operator` image from your private registry when installing the rancher-backup-crd Helm chart.
 ```
 --set image.repository $REGISTRY/rancher/backup-restore-operator
 ```
@@ -56,7 +56,7 @@ For details on using Fleet behind a proxy, see [this page.](../../../explanation

 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
 ---
@@ -61,7 +61,7 @@ For details on using Fleet behind a proxy, see [this page](../explanations/integ

 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

@@ -14,7 +14,7 @@ In Rancher v2.5, the Apps and Marketplace feature replaced the catalog system.

 In the cluster manager, Rancher uses a catalog system to import bundles of charts and then uses those charts to either deploy custom helm applications or Rancher's tools such as Monitoring or Istio. The catalog system is still available in the cluster manager in Rancher v2.5, but it is deprecated.

-Now in the Cluster Explorer, Rancher uses a similar but simplified version of the same system. Repositories can be added in the same way that catalogs were, but are specific to the current cluster. Rancher tools come as pre-loaded repositories which deploy as standalone helm charts.
+Now in the Cluster Explorer, Rancher uses a similar but simplified version of the same system. Repositories can be added in the same way that catalogs were, but are specific to the current cluster. Rancher tools come as pre-loaded repositories which deploy as standalone Helm charts.

 ### Charts

@@ -34,7 +34,7 @@ All three types are deployed and managed in the same way.

 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:

@@ -67,7 +67,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

@@ -75,7 +75,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

@@ -123,7 +123,7 @@ Example on setting a static proxy header with `ingress.configurationSnippet`. Th

 ### HTTP Proxy

-Rancher requires internet access for some functionality (helm charts). Use `proxy` to set your proxy server.
+Rancher requires internet access for some functionality, such as reaching remote Helm charts. Use `proxy` to set your proxy server.

 Add your IP exceptions to the `noProxy` list. Make sure you add the Pod cluster IP range (default: `10.42.0.0/16`), Service cluster IP range (default: `10.43.0.0/16`), the internal cluster domains (default: `.svc,.cluster.local`) and any worker cluster `controlplane` nodes. Rancher supports CIDR notation ranges in this list.

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