common

Note

• Examples under each key are only to be used as a placement guide
• See the Full Examples section for complete examples.

Appears in

• .Values

Notes

This applies across all the documentation:

• Helm tpl:
  • ❌ means that the value is not templated
  • ✅ means that the value is templated, for example instead of a hardcoded value, you can set it to {{ .Values.some.value }}. and it will be replaced by the value contained in .Values.some.value at the installation/upgrade time.

---

global

Global values that apply to all charts

Note

See more info about global values here

Key	global
Type	map
Required	❌
Helm tpl	❌
Default	See here

Example

global: {}

---

fallbackDefaults

The fallback defaults are used when a value is not defined in the chart.

Note

• See more info about fallbackDefaults here

Key	fallbackDefaults
Type	map
Required	❌
Helm tpl	❌
Default	See here

---

extraTpl

Define kubernetes resources, 1 per list item, tpl will be resolved

Key	extraTpl
Type	list of string
Required	❌
Helm tpl	✅
Default	[]

Example

extraTpl:
  - |
    apiVersion: v1
    kind: Deployment
    ...

---

operator

Contains specific settings for helm charts containing or using system

Key	operator
Type	map
Required	❌
Helm tpl	❌

Default

operator:
  register: false
  verify:
    enabled: true
    additionalsystem: []

Example

operator:
  register: true
  verify:
    enabled: true
    additionalsystem:
      - operator1
      - operator2

---

operator.register

Adds a configmap in the operator’s namespace to register the chart as an operator

Key	operator.register
Type	bool
Required	❌
Helm tpl	❌
Default	false

Example

operator:
  register: true

---

operator.verify

Contains specific settings for verifying system

Key	operator.verify
Type	map
Required	❌
Helm tpl	❌

Default

operator:
  verify:
    enabled: true
    additionalsystem: []

Example

operator:
  verify:
    enabled: true
    additionalsystem:
      - operator1
      - operator2

---

operator.verify.enabled

Enables or disables the verification of system

Key	operator.verify.enabled
Type	bool
Required	❌
Helm tpl	❌
Default	true

Example

operator:
  verify:
    enabled: true

---

operator.verify.additionalsystem

Additional system to verify

Key	operator.verify.additionalsystem
Type	list of string
Required	❌
Helm tpl	❌
Default	[]

Example

operator:
  verify:
    additionalsystem:
      - operator1
      - operator2

---

podOptions

Options that apply to all pods, unless overridden at the pod level

Note

See more info about podOptions here

Key	podOptions
Type	map
Required	❌
Helm tpl	❌
Default	See here

Example

podOptions:
  enableServiceLinks: false
  hostNetwork: false
  hostPID: false
  hostUsers: false
  hostIPC: false
  shareProcessNamespace: false
  restartPolicy: Always
  dnsPolicy: ClusterFirst
  dnsConfig:
    options:
      - name: ndots
        value: "1"
  hostAliases: []
  tolerations: []
  runtimeClassName: ""
  automountServiceAccountToken: false
  terminationGracePeriodSeconds: 120

---

containerOptions

Options that apply to all containers, unless overridden at the container level

Note

See more info about containerOptions here

Key	containerOptions
Type	map
Required	❌
Helm tpl	❌
Default	See here

Example

containerOptions:
  NVIDIA_CAPS:
    - all

---

TZ

Timezone that is used everywhere applicable, unless overridden at the container level

Key	TZ
Type	map
Required	✅
Helm tpl	❌
Default	UTC

Example

TZ: UTC

---

namespace

Namespace to apply to all objects, unless overridden at the object level

Note

Does not apply to chart deps, use global.namespace for that

---

resources

Define resources for all containers, unless overridden at the container level

Note

Resources apply to EACH container, not to the pod as a whole.

Key	resources
Type	map
Required	✅
Helm tpl	❌
Default	See here

Example

resources:
  limits:
    cpu: 4000m
    memory: 8Gi
  requests:
    cpu: 10m
    memory: 50Mi

---

securityContext

Define security context for all containers and pods, unless overridden at the container/pod level

Note

See more info about securityContext here

Key	securityContext
Type	map
Required	✅
Helm tpl	❌
Default	See here

Example

securityContext:
  container:
    PUID: 568
    UMASK: "002"
    runAsNonRoot: true
    runAsUser: 568
    runAsGroup: 568
    readOnlyRootFilesystem: true
    allowPrivilegeEscalation: false
    privileged: false
    seccompProfile:
      type: RuntimeDefault
    capabilities:
      add: []
      drop:
        - ALL
  pod:
    fsGroup: 568
    fsGroupChangePolicy: OnRootMismatch
    supplementalGroups: []
    sysctls: []

---

Images

Tip

Use imageSelector to select the image to use for a container.

Images are defined in the following format:

image:
  repository: ""
  tag: ""
  pullPolicy: IfNotPresent

For additional images, you can define them in the following format:

nameImage:
  repository: ""
  tag: ""
  pullPolicy: IfNotPresent

Note

There isn’t anything special in the above format (nameImage), it’s just a convention. It’s also a format that some external tools can use for automatic image updates. For example, Renovate

---

image

Defines the image details

Key	image
Type	map
Required	✅
Helm tpl	❌

Default

image:
  repository: ""
  tag: ""
  pullPolicy: IfNotPresent

Example

image:
  repository: "my-repo"
  tag: "latest"
  pullPolicy: IfNotPresent

---

image.repository

Defines the image repository

Key	image.repository
Type	string
Required	✅
Helm tpl	❌
Default	""

Example

image:
  repository: "my-repo"

---

image.tag

Defines the image tag

Key	image.tag
Type	string
Required	✅
Helm tpl	❌
Default	""

Example

image:
  tag: "latest"

---

image.pullPolicy

Defines the image pull policy

Key	image.pullPolicy
Type	string
Required	✅
Helm tpl	❌
Default	IfNotPresent

Example

image:
  pullPolicy: IfNotPresent

---

Additional Documentation

• certificate
• configmap
• container
• containerOptions
• imagePullSecret
• ingress
• middlewares
• notes
• persistence
• podDisruptionBudget
• priorityClass
• rbac
• resources
• secret
• securityContext
• service
• serviceAccount
• storageClass
• volumeSnapshot
• volumeSnapshotClass
• webhook
• webhook
• workload

---

Full Examples

operator:
  register: false
  verify:
    enabled: true
    additionalsystem:
      - operator1
      - operator2
extraTpl:
  - |
    apiVersion: v1
    kind: Deployment
    ...

---

---

Function library for TrueCharts

Chart Sources

• https://ghcr.io/cloudnative-pg/postgis
• https://ghcr.io/cloudnative-pg/postgresql
• https://ghcr.io/tensorchord/cloudnative-pgvecto.rs
• https://ghcr.io/traefik/whoami
• https://github.com/truecharts/charts/tree/master/charts/library/common
• https://github.com/trueforge-org/truecharts/tree/master/charts/library/common
• https://hub.docker.com/_/
• https://hub.docker.com/r/mikefarah/yq

Available Documentation

• Addons
• Certificate
• Configmap
• Container Options
• credentials
• Fallback Defaults
• Global
• Image Pull Secret
• Notes
• Pod Disruption Budget
• Pod Options
• Priority Class
• RBAC
• Resources
• Secret
• Security Context
• Service Account
• Storage Class
• Volume Snapshot
• Volume Snapshot Class
• Webhook

---

Readme

General Info

For more information about this Chart, please check the docs on the TrueCharts website

This chart is not maintained by the upstream project and any issues with the chart should be raised here

Installation

Helm-Chart installation

To install TrueCharts Helm charts using Helm, you can use our OCI Repository.

helm install mychart oci://oci.trueforge.org/truecharts/common

For more information on how to install TrueCharts Helm charts, checkout the instructions on the website

Chart Specific Guides and information

All our charts have dedicated documentation pages. The documentation for this chart can be found here: https://trueforge.org/truecharts/library/common

Configuration Options

To view the chart specific options, please view Values.yaml included in the chart. The most recent version of which, is available here: https://github.com/trueforge-org/truecharts/blob/master/charts/library/common/values.yaml

All our Charts use a shared “common” library chart that contains most of the templating and options. For the complete overview of all available options, please checkout the documentation for them on the common docs on our website

For information about the common chart and all defaults included with it, please review its values.yaml file available here: https://github.com/trueforge-org/truecharts/blob/master/charts/library/common/values.yaml

Support

• See the Website
• Check our Discord
• Open a issue

---

Sponsor TrueCharts

TrueCharts can only exist due to the incredible effort of our staff. Please consider making a donation or contributing back to the project any way you can!

All Rights Reserved - The TrueCharts Project