mirror of
https://github.com/bitnami/charts.git
synced 2026-03-27 15:27:10 +08:00
[bitnami/*] Unify READMEs (#14472)
* [bitnami/*] Unify READMEs Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com> * Fix typo Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com> Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com>
This commit is contained in:
committed by
GitHub
parent
2ed7bf9767
commit
2064fb8dcc
@@ -7,12 +7,12 @@ Kong is an open source Microservice API gateway and platform designed for managi
|
||||
[Overview of Kong](https://konghq.com/kong-community-edition/)
|
||||
|
||||
Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.
|
||||
|
||||
|
||||
## TL;DR
|
||||
|
||||
```console
|
||||
helm repo add my-repo https://charts.bitnami.com/bitnami
|
||||
helm install my-release my-repo/kong
|
||||
$ helm repo add my-repo https://charts.bitnami.com/bitnami
|
||||
$ helm install my-release my-repo/kong
|
||||
```
|
||||
|
||||
## Introduction
|
||||
@@ -34,8 +34,8 @@ Bitnami charts can be used with [Kubeapps](https://kubeapps.dev/) for deployment
|
||||
To install the chart with the release name `my-release`:
|
||||
|
||||
```console
|
||||
helm repo add my-repo https://charts.bitnami.com/bitnami
|
||||
helm install my-release my-repo/kong
|
||||
$ helm repo add my-repo https://charts.bitnami.com/bitnami
|
||||
$ helm install my-release my-repo/kong
|
||||
```
|
||||
|
||||
These commands deploy kong on the Kubernetes cluster in the default configuration. The [Parameters](#parameters) section lists the parameters that can be configured during installation.
|
||||
@@ -47,7 +47,7 @@ These commands deploy kong on the Kubernetes cluster in the default configuratio
|
||||
To uninstall/delete the `my-release` deployment:
|
||||
|
||||
```console
|
||||
helm delete my-release
|
||||
$ helm delete my-release
|
||||
```
|
||||
|
||||
## Parameters
|
||||
@@ -352,7 +352,7 @@ To uninstall/delete the `my-release` deployment:
|
||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
|
||||
|
||||
```console
|
||||
helm install my-release \
|
||||
$ helm install my-release \
|
||||
--set service.exposeAdmin=true my-repo/kong
|
||||
```
|
||||
|
||||
@@ -361,7 +361,7 @@ The above command exposes the Kong admin ports inside the Kong service.
|
||||
Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,
|
||||
|
||||
```console
|
||||
helm install my-release -f values.yaml my-repo/kong
|
||||
$ helm install my-release -f values.yaml my-repo/kong
|
||||
```
|
||||
|
||||
> **Tip**: You can use the default [values.yaml](values.yaml)
|
||||
@@ -381,13 +381,13 @@ The Bitnami Kong chart allows setting two database backends: PostgreSQL or Cassa
|
||||
- Deploy the PostgreSQL sub-chart (default)
|
||||
|
||||
```console
|
||||
helm install my-release my-repo/kong
|
||||
$ helm install my-release my-repo/kong
|
||||
```
|
||||
|
||||
- Use an external PostgreSQL database
|
||||
|
||||
```console
|
||||
helm install my-release my-repo/kong \
|
||||
$ helm install my-release my-repo/kong \
|
||||
--set postgresql.enabled=false \
|
||||
--set postgresql.external.host=_HOST_OF_YOUR_POSTGRESQL_INSTALLATION_ \
|
||||
--set postgresql.external.password=_PASSWORD_OF_YOUR_POSTGRESQL_INSTALLATION_ \
|
||||
@@ -397,7 +397,7 @@ The Bitnami Kong chart allows setting two database backends: PostgreSQL or Cassa
|
||||
- Deploy the Cassandra sub-chart
|
||||
|
||||
```console
|
||||
helm install my-release my-repo/kong \
|
||||
$ helm install my-release my-repo/kong \
|
||||
--set database=cassandra \
|
||||
--set postgresql.enabled=false \
|
||||
--set cassandra.enabled=true
|
||||
@@ -406,7 +406,7 @@ The Bitnami Kong chart allows setting two database backends: PostgreSQL or Cassa
|
||||
- Use an existing Cassandra installation
|
||||
|
||||
```console
|
||||
helm install my-release my-repo/kong \
|
||||
$ helm install my-release my-repo/kong \
|
||||
--set database=cassandra \
|
||||
--set postgresql.enabled=false \
|
||||
--set cassandra.enabled=false \
|
||||
@@ -518,7 +518,7 @@ Find more information about how to deal with common errors related to Bitnami's
|
||||
|
||||
It's necessary to specify the existing passwords while performing a upgrade to ensure the secrets are not updated with invalid randomly generated passwords. Remember to specify the existing values of the `postgresql.postgresqlPassword` or `cassandra.password` parameters when upgrading the chart:
|
||||
|
||||
```bash
|
||||
```console
|
||||
$ helm upgrade my-release my-repo/kong \
|
||||
--set database=postgresql
|
||||
--set postgresql.enabled=true
|
||||
@@ -643,4 +643,4 @@ Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
limitations under the License.
|
||||
|
||||
Reference in New Issue
Block a user