mirror of
https://github.com/helm/charts.git
synced 2026-08-23 22:37:45 +00:00
[stable/external-dns] Unify and refactor README.md (#18300)
Signed-off-by: Carlos Rodriguez Hernandez <crhernandez@bitnami.com>
This commit is contained in:
committed by
Kubernetes Prow Robot
parent
b9c6fd5ac8
commit
67e2f0cc4d
@@ -1,6 +1,6 @@
|
||||
apiVersion: v1
|
||||
name: external-dns
|
||||
version: 2.9.3
|
||||
version: 2.9.4
|
||||
appVersion: 0.5.17
|
||||
description: ExternalDNS is a Kubernetes addon that configures public DNS servers with information about exposed Kubernetes services to make them discoverable.
|
||||
keywords:
|
||||
|
||||
@@ -27,7 +27,7 @@ To install the chart with the release name `my-release`:
|
||||
$ helm install --name my-release stable/external-dns
|
||||
```
|
||||
|
||||
The command deploys ExternalDNS on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.
|
||||
The command deploys ExternalDNS on the Kubernetes cluster in the default configuration. The [Parameters](#parameters) section lists the parameters that can be configured during installation.
|
||||
|
||||
> **Tip**: List all releases using `helm list`
|
||||
|
||||
@@ -41,7 +41,7 @@ $ helm delete my-release
|
||||
|
||||
The command removes all the Kubernetes components associated with the chart and deletes the release.
|
||||
|
||||
## Configuration
|
||||
## Parameters
|
||||
|
||||
The following table lists the configurable parameters of the external-dns chart and their default values.
|
||||
|
||||
@@ -174,13 +174,17 @@ $ helm install --name my-release -f values.yaml stable/external-dns
|
||||
|
||||
> **Tip**: You can use the default [values.yaml](values.yaml)
|
||||
|
||||
## Configuration and installation details
|
||||
|
||||
### [Rolling VS Immutable tags](https://docs.bitnami.com/containers/how-to/understand-rolling-tags-containers/)
|
||||
|
||||
It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.
|
||||
|
||||
Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.
|
||||
|
||||
### Production configuration
|
||||
|
||||
This chart includes a `values-production.yaml` file where you can find some parameters oriented to production configuration in comparison to the regular `values.yaml`.
|
||||
|
||||
```console
|
||||
$ helm install --name my-release -f ./values-production.yaml stable/external-dns
|
||||
```
|
||||
This chart includes a `values-production.yaml` file where you can find some parameters oriented to production configuration in comparison to the regular `values.yaml`. You can use this file instead of the default one.
|
||||
|
||||
- Desired number of ExternalDNS replicas:
|
||||
```diff
|
||||
@@ -217,12 +221,6 @@ $ helm install --name my-release \
|
||||
stable/external-dns
|
||||
```
|
||||
|
||||
### [Rolling VS Immutable tags](https://docs.bitnami.com/containers/how-to/understand-rolling-tags-containers/)
|
||||
|
||||
It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.
|
||||
|
||||
Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.
|
||||
|
||||
## Upgrading
|
||||
|
||||
### To 2.0.0
|
||||
|
||||
Reference in New Issue
Block a user