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

47
bitnami/pinniped/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/pinniped
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/pinniped
```
> 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
Bitnami charts for Helm are carefully engineered, actively maintained and are the quickest and easiest way to deploy containers on a Kubernetes cluster that are ready to handle production workloads.
@@ -36,9 +38,11 @@ Looking to use Pinniped in production? Try [VMware Application Catalog](https://
To install the chart with the release name `my-release`:
```console
helm install my-release oci://registry-1.docker.io/bitnamicharts/pinniped
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/pinniped
```
> 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`.
The command deploys pinniped 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`
@@ -65,22 +69,22 @@ The command removes all the Kubernetes components associated with the chart and
### Common parameters
| Name | Description | Value |
| ------------------- | -------------------------------------------------------------------------------------------------------- | --------------------- |
| `kubeVersion` | Override Kubernetes version | `""` |
| `nameOverride` | String to partially override common.names.name | `""` |
| `fullnameOverride` | String to fully override common.names.fullname | `""` |
| `namespaceOverride` | String to fully override common.names.namespace | `""` |
| `commonLabels` | Labels to add to all deployed objects | `{}` |
| `commonAnnotations` | Annotations to add to all deployed objects | `{}` |
| `clusterDomain` | Kubernetes cluster domain name | `cluster.local` |
| `extraDeploy` | Array of extra objects to deploy with the release | `[]` |
| `image.registry` | Pinniped image registry | `docker.io` |
| `image.repository` | Pinniped image repository | `bitnami/pinniped` |
| `image.tag` | Pinniped image tag (immutable tags are recommended) | `0.27.0-debian-11-r0` |
| `image.digest` | Pinniped image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | `""` |
| `image.pullPolicy` | Pinniped image pull policy | `IfNotPresent` |
| `image.pullSecrets` | Pinniped image pull secrets | `[]` |
| Name | Description | Value |
| ------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------- |
| `kubeVersion` | Override Kubernetes version | `""` |
| `nameOverride` | String to partially override common.names.name | `""` |
| `fullnameOverride` | String to fully override common.names.fullname | `""` |
| `namespaceOverride` | String to fully override common.names.namespace | `""` |
| `commonLabels` | Labels to add to all deployed objects | `{}` |
| `commonAnnotations` | Annotations to add to all deployed objects | `{}` |
| `clusterDomain` | Kubernetes cluster domain name | `cluster.local` |
| `extraDeploy` | Array of extra objects to deploy with the release | `[]` |
| `image.registry` | Pinniped image registry | `REGISTRY_NAME` |
| `image.repository` | Pinniped image repository | `REPOSITORY_NAME/pinniped` |
| `image.tag` | Pinniped image tag (immutable tags are recommended) | `0.27.0-debian-11-r0` |
| `image.digest` | Pinniped image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | `""` |
| `image.pullPolicy` | Pinniped image pull policy | `IfNotPresent` |
| `image.pullSecrets` | Pinniped image pull secrets | `[]` |
### Concierge Parameters
@@ -318,17 +322,20 @@ Specify each parameter using the `--set key=value[,key=value]` argument to `helm
```console
helm install my-release \
--set supervisor.enabled=false \
oci://registry-1.docker.io/bitnamicharts/pinniped
oci://REGISTRY_NAME/REPOSITORY_NAME/pinniped
```
> 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`.
The above command sets disables the supervisor compoment deployment.
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,
```console
helm install my-release -f values.yaml oci://registry-1.docker.io/bitnamicharts/pinniped
helm install my-release -f values.yaml oci://REGISTRY_NAME/REPOSITORY_NAME/pinniped
```
> 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`.
> **Tip**: You can use the default [values.yaml](values.yaml)
## Configuration and installation details

4
bitnami/pinniped/values.yaml
View File

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