bitnamicharts/common
Verified Publisher
Bitnami Helm chart for Common
Helm
Image
Artifact
Security
Integration & delivery
Monitoring & observability
0
10M+
bitnamicharts/common repository overview
Bitnami Common Library Chart
A Helm Library Chart for grouping common logic between Bitnami charts.
TL;DR
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/common
Note: You need to substitute the placeholders
REGISTRY_NAMEandREPOSITORY_NAMEwith a reference to your Helm chart registry and repository.
Introduction
This chart provides a common template helpers which can be used to develop new charts using Helm package manager.
Before you begin
- Kubernetes 1.23+
- Helm 3.8.0+
Parameters
The following subsections list global, common, and component-specific parameters.
Affinities
| Helper identifier | Description | Expected Input |
|---|---|---|
common.affinities.nodes.soft | Return a soft nodeAffinity definition | dict "key" "FOO" "values" (list "BAR" "BAZ") |
common.affinities.nodes.hard | Return a hard nodeAffinity definition | dict "key" "FOO" "values" (list "BAR" "BAZ") |
common.affinities.nodes | Return a nodeAffinity definition | dict "type" "soft" "key" "FOO" "values" (list "BAR" "BAZ") |
common.affinities.topologyKey | Return a topologyKey definition | dict "topologyKey" "FOO" |
common.affinities.pods.soft | Return a soft podAffinity/podAntiAffinity definition | dict "component" "FOO" "context" $ |
common.affinities.pods.hard | Return a hard podAffinity/podAntiAffinity definition | dict "component" "FOO" "context" $ |
common.affinities.pods | Return a podAffinity/podAntiAffinity definition | dict "type" "soft" "key" "FOO" "values" (list "BAR" "BAZ") |
Capabilities
| Helper identifier | Description | Expected Input |
|---|---|---|
common.capabilities.kubeVersion | Return the target Kubernetes version (using client default if .Values.kubeVersion is not set). | . Chart context |
common.capabilities.apiVersions.has | Return true if the apiVersion is supported | dict "version" "batch/v1" "context" $ |
common.capabilities.job.apiVersion | Return the appropriate apiVersion for job. | . Chart context |
common.capabilities.cronjob.apiVersion | Return the appropriate apiVersion for cronjob. | . Chart context |
common.capabilities.daemonset.apiVersion | Return the appropriate apiVersion for daemonset. | . Chart context |
common.capabilities.deployment.apiVersion | Return the appropriate apiVersion for deployment. | . Chart context |
common.capabilities.statefulset.apiVersion | Return the appropriate apiVersion for statefulset. | . Chart context |
common.capabilities.ingress.apiVersion | Return the appropriate apiVersion for ingress. | . Chart context |
common.capabilities.rbac.apiVersion | Return the appropriate apiVersion for RBAC resources. | . Chart context |
common.capabilities.crd.apiVersion | Return the appropriate apiVersion for CRDs. | . Chart context |
common.capabilities.policy.apiVersion | Return the appropriate apiVersion for podsecuritypolicy. | . Chart context |
common.capabilities.networkPolicy.apiVersion | Return the appropriate apiVersion for networkpolicy. | . Chart context |
common.capabilities.apiService.apiVersion | Return the appropriate apiVersion for APIService. | . Chart context |
common.capabilities.hpa.apiVersion | Return the appropriate apiVersion for Horizontal Pod Autoscaler | . Chart context |
common.capabilities.vpa.apiVersion | Return the appropriate apiVersion for Vertical Pod Autoscaler. | . Chart context |
common.capabilities.psp.supported | Returns true if PodSecurityPolicy is supported | . Chart context |
common.capabilities.supportsHelmVersion | Returns true if the used Helm version is 3.3+ | . Chart context |
common.capabilities.admissionConfiguration.supported | Returns true if AdmissionConfiguration is supported | . Chart context |
common.capabilities.admissionConfiguration.apiVersion | Return the appropriate apiVersion for AdmissionConfiguration. | . Chart context |
common.capabilities.podSecurityConfiguration.apiVersion | Return the appropriate apiVersion for PodSecurityConfiguration. | . Chart context |
Certificates
| Helper identifier | Description | Expected Input |
|---|---|---|
common.certs.sans | Returns a space-separated list of Subject Alternative Names (SANs) to create a TLS certificate | dict "namespace" "default" "clusterDomain" "cluster.local" "serviceName" "my-service" "headlessServiceName" "my-service-headless" |
Compatibility
| Helper identifier | Description | Expected Input |
|---|---|---|
common.compatibility.isOpenshift | Return true if the detected platform is Openshift | . Chart context |
common.compatibility.renderSecurityContext | Render a compatible securityContext depending on the platform. By default it is maintained as it is. In other platforms like Openshift we remove default user/group values that do not work out of the box with the restricted-v1 SCC | dict "secContext" .Values.containerSecurityContext "context" $ |
Errors
| Helper identifier | Description | Expected Input |
|---|---|---|
common.errors.upgrade.passwords.empty | It will ensure required passwords are given when we are upgrading a chart. If validationErrors is not empty it will throw an error and will stop the upgrade action. | dict "validationErrors" (list $validationError00 $validationError01) "context" $ |
common.errors.insecureImages | Throw error when original container images are replaced. The error can be bypassed by setting the global.security.allowInsecureImages to true. | dict "images" (list .Values.path.to.the.imageRoot) "context" $ |
Images
| Helper identifier | Description | Expected Input |
|---|---|---|
common.images.image | Return the proper and full image name | dict "imageRoot" .Values.path.to.the.image "global" $, see ImageRoot for the structure. |
common.images.pullSecrets | Return the proper Docker Image Registry Secret Names (deprecated: use common.images.renderPullSecrets instead) | dict "images" (list .Values.path.to.the.image1, .Values.path.to.the.image2) "global" .Values.global |
common.images.renderPullSecrets | Return the proper Docker Image Registry Secret Names (evaluates values as templates) | dict "images" (list .Values.path.to.the.image1, .Values.path.to.the.image2) "context" $ |
common.images.version | Return the proper image version | dict "imageRoot" .Values.path.to.the.image "chart" .Chart , see ImageRoot for the structure. |
Ingress
| Helper identifier | Description | Expected Input |
|---|---|---|
common.ingress.backend | Generate a proper Ingress backend entry depending on the API version | dict "serviceName" "foo" "servicePort" "bar", see the Ingress deprecation notice for the syntax differences |
common.ingress.certManagerRequest | Prints "true" if required cert-manager annotations for TLS signed certificates are set in the Ingress annotations | dict "annotations" .Values.path.to.the.ingress.annotations |
Labels
| Helper identifier | Description | Expected Input |
|---|---|---|
common.labels.standard | Return Kubernetes standard labels | . Chart context |
common.labels.matchLabels | Labels to use on deploy.spec.selector.matchLabels and svc.spec.selector | . Chart context |
Names
| Helper identifier | Description | Expected Input |
|---|---|---|
common.names.name | Expand the name of the chart or use .Values.nameOverride | . Chart context |
common.names.fullname | Create a default fully qualified app name. | . Chart context |
common.names.namespace | Allow the release namespace to be overridden | . Chart context |
common.names.fullname.namespace | Create a fully qualified app name adding the installation's namespace | . Chart context |
common.names.chart | Chart name plus version | . Chart context |
common.names.dependency.fullname | Create a default fully qualified dependency name. | dict "chartName" "dependency-chart-name" "chartValues" .Values.dependency-chart "context" $ |
Resources
| Helper identifier | Description | Expected Input |
|---|---|---|
common.resources.preset | Return a resource request/limit object based on a given preset. These presets are for basic testing and not meant to be used in production. | dict "type" "nano" |
Secrets
| Helper identifier | Description | Expected Input |
|---|---|---|
common.secrets.name | Generate the name of the secret. | dict "existingSecret" .Values.path.to.the.existingSecret "defaultNameSuffix" "mySuffix" "context" $ see ExistingSecret for the structure. |
common.secrets.key | Generate secret key. | dict "existingSecret" .Values.path.to.the.existingSecret "key" "keyName" see ExistingSecret for the structure. |
common.secrets.passwords.manage | Generate secret password or retrieve one if already created. | dict "secret" "secret-name" "key" "keyName" "providedValues" (list "path.to.password1" "path.to.password2") "length" 10 "strong" false "chartName" "chartName" "honorProvidedValues" false "context" $, length, strong, honorProvidedValues and chartName fields are optional. |
common.secrets.exists | Returns whether a previous generated secret already exists. | dict "secret" "secret-name" "context" $ |
common.secrets.lookup | Reuses the value from an existing secret, otherwise sets its value to a default value. | dict "secret" "secret-name" "key" "keyName" "defaultValue" .Values.myValue "context" $ |
Storage
| Helper identifier | Description | Expected Input |
|---|---|---|
common.storage.class | Return the proper Storage Class | dict "persistence" .Values.path.to.the.persistence "global" $, see Persistence for the structure. |
TplValues
| Helper identifier | Description | Expected Input |
|---|---|---|
common.tplvalues.render | Renders a value that contains template | dict "value" .Values.path.to.the.Value "context" $, value is the value should rendered as template, context frequently is the chart context $ or . |
common.tplvalues.merge | Merge a list of values that contains template after rendering them. | dict "values" (list .Values.path.to.the.Value1 .Values.path.to.the.Value2) "context" $ |
common.tplvalues.merge-overwrite | Merge a list of values that contains template after rendering them. | dict "values" (list .Values.path.to.the.Value1 .Values.path.to.the.Value2) "context" $ |
Utils
| Helper identifier | Description | Expected Input |
|---|---|---|
common.utils.fieldToEnvVar | Build environment variable name given a field. | dict "field" "my-password" |
common.utils.secret.getvalue | Print instructions to get a secret value. | dict "secret" "secret-name" "field" "secret-value-field" "context" $ |
common.utils.getValueFromKey | Gets a value from .Values object given its key path | dict "key" "path.to.key" "context" $ |
common.utils.getKeyFromList | Returns first .Values key with a defined value or first of the list if all non-defined | dict "keys" (list "path.to.key1" "path.to.key2") "context" $ |
common.utils.checksumTemplate | Checksum a template at "path" containing a single resource (ConfigMap,Secret) for use in pod annotations, excluding the metadata (see #18376) | dict "path" "/configmap.yaml" "context" $ |
Validations
| Helper identifier | Description | Expected Input |
|---|---|---|
common.validations.values.single.empty | Validate a value must not be empty. | dict "valueKey" "path.to.value" "secret" "secret.name" "field" "my-password" "subchart" "subchart" "context" $ secret, field and subchart are optional. In case they are given, the helper will generate a how to get instruction. See ValidateValue |
common.validations.values.multiple.empty | Validate a multiple values must not be empty. It returns a shared error for all the values. | dict "required" (list $validateValueConf00 $validateValueConf01) "context" $. See ValidateValue |
common.validations.values.mariadb.passwords | This helper will ensure required password for MariaDB are not empty. It returns a shared error for all the values. | dict "secret" "mariadb-secret" "subchart" "true" "context" $ subchart field is optional and could be true or false it depends on |
Note: the README for this chart is longer than the DockerHub length limit of 25000, so it has been trimmed. The full README can be found at https://techdocs.broadcom.com/us/en/vmware-tanzu/bitnami-secure-images/bitnami-secure-images/services/bsi-app-doc/apps-charts-common-index.html
Tag summary
Content type
Image
Digest
sha256:4a5f2b6ef…
Size
7.8 kB
Last updated
15 days ago
docker pull bitnamicharts/common:sha256-2d5e6b9301e29a87c51e5b7365d2d6c5a8a392f9a0b9f6e6ea43aec01b66f3d0This week's pulls
Pulls:
496,909
Jun 29 to Jul 5
