Bitnami/charts
2
0
Fork 0
mirror of https://github.com/bitnami/charts.git synced 2026-03-16 06:47:30 +08:00
Code Issues Packages Projects Releases Wiki Activity

[bitnami/*] Standardize documentation (#19835)

Browse Source 
Signed-off-by: Jota Martos <jotamartos@vmware.com>
This commit is contained in:
Juan José Martos
2023-10-20 08:18:30 +02:00
committed by GitHub
parent 3e0672c0ad
commit af5f7530c1
216 changed files with 14699 additions and 13690 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
bitnami/flink/README.md
View File

@@ -11,9 +11,11 @@ Trademarks: This software listing is packaged by Bitnami. The respective tradema
## TL;DR
```console
helm install my-release oci://registry-1.docker.io/bitnamicharts/flink
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/flink
```
> Note: You need to substitute the placeholders `REGISTRY_NAME` and `REPOSITORY_NAME` with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use `REGISTRY_NAME=registry-1.docker.io` and `REPOSITORY_NAME=bitnamicharts`.
## Introduction
This chart bootstraps a [flink](https://github.com/bitnami/containers/tree/main/bitnami/flink) deployment on a [Kubernetes](https://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
@@ -34,9 +36,11 @@ Looking to use Apache Flink in production? Try [VMware Application Catalog](http
To install the chart with the release name `my-release`:
```console
helm install my-release oci://registry-1.docker.io/bitnamicharts/flink
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/flink
```
> Note: You need to substitute the placeholders `REGISTRY_NAME` and `REPOSITORY_NAME` with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use `REGISTRY_NAME=registry-1.docker.io` and `REPOSITORY_NAME=bitnamicharts`.
These commands deploy flink 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`
@@ -79,8 +83,8 @@ The command removes all the Kubernetes components associated with the chart and
| Name | Description | Value |
| ------------------- | ------------------------------------------------------------------------------------------------------------ | ----------------------- |
| `image.registry` | Apache Flink image registry | `docker.io` |
| `image.repository` | Apache Flink image repository | `bitnami/flink` |
| `image.registry` | Apache Flink image registry | `REGISTRY_NAME` |
| `image.repository` | Apache Flink image repository | `REPOSITORY_NAME/flink` |
| `image.tag` | Apache Flink image tag (immutable tags are recommended) | `1.17.1-debian-11-r120` |
| `image.digest` | Apache Flink image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | `""` |
| `image.pullPolicy` | image pull policy | `IfNotPresent` |

4
bitnami/flink/values.yaml
View File

@@ -61,8 +61,8 @@ diagnosticMode:
## Bitnami Apache Flink image
## ref: https://hub.docker.com/r/bitnami/flink/tags/
## @param image.registry Apache Flink image registry
## @param image.repository Apache Flink image repository
## @param image.registry [default: REGISTRY_NAME] Apache Flink image registry
## @param image.repository [default: REPOSITORY_NAME/flink] Apache Flink image repository
## @param image.tag Apache Flink image tag (immutable tags are recommended)
## @param image.digest Apache Flink image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag
## @param image.pullPolicy image pull policy