README.md

Parameters

Global parameters

Name	Description	Value
global.imageRegistry	Global Docker image registry	nil
global.imagePullSecrets	Global Docker registry secret names as an array	[]
global.storageClass	Global StorageClass for Persistent Volume(s)	nil

Ndustrial metadata fields (Optional)

Name	Description	Value
ndustrial		{}
ndustrial.project	Unique project id that this repository belongs too (Required) aka. Project slug	""
ndustrial.name	The name of the application/service. (Required)	""
ndustrial.type	The service type of this deployment (api, database, backend, frontend, etl, etc...) (Required)	""
ndustrial.organization	The slug of the Organization that owns the application (Required)	""
ndustrial.owner	The person/team that owns this service. (Required)	""
ndustrial.managed_by	The service which manages the kubernetes object Should most likely be one of: helm, contxt, fleet. (Required)	""
ndustrial.env	The environment being deployed into Should most likely be one of: dev, staging, prod, or qa. (Required)	""
ndustrial.version	The app version being deployed (Required)	""
ndustrial.repo	The github repository where the code exists (populated by CI/CD)	""
ndustrial.depends	List of projects/services this serivce depends on	[]
ndustrial.depends.0.project	The name of the project that this service depends on	""
ndustrial.depends.0.name	The name of the project service	""
contxt		{}
contxt.projectId	The ID of the Contxt Stack that this object belongs to (if applicable)	""
contxt.serviceId	The ID of the Contxt Service that this object belongs to (if applicable)	""
contxt.serviceType	The type of the Contxt Service that this object belongs to (if applicable)	""

Common parameters

Name	Description	Value
nameOverride	String to partially override common.names.fullname	nil
fullnameOverride	String to fully override common.names.fullname	nil
labels	Labels to add to all deployed objects	{}
annotations	Annotations to add to all deployed objects	{}

StatefulSet parameters

Name	Description	Value
replicaCount	Number of Controller replicas	1
startupProbe.enabled	Enable startupProbe	false
startupProbe.path	Path for startupProbe	/
startupProbe.initialDelaySeconds	Initial delay seconds for startupProbe	60
startupProbe.periodSeconds	Period seconds for startupProbe	10
startupProbe.timeoutSeconds	Timeout seconds for startupProbe	1
startupProbe.failureThreshold	Failure threshold for startupProbe	3
startupProbe.successThreshold	Success threshold for startupProbe	1
livenessProbe.enabled	Enable livenessProbe	true
livenessProbe.path	Path for livenessProbe	/
livenessProbe.initialDelaySeconds	Initial delay seconds for livenessProbe	60
livenessProbe.periodSeconds	Period seconds for livenessProbe	10
livenessProbe.timeoutSeconds	Timeout seconds for livenessProbe	1
livenessProbe.failureThreshold	Failure threshold for livenessProbe	3
livenessProbe.successThreshold	Success threshold for livenessProbe	1
readinessProbe.enabled	Enable readinessProbe	true
readinessProbe.path	Path for readinessProbe	/
readinessProbe.initialDelaySeconds	Initial delay seconds for readinessProbe	5
readinessProbe.periodSeconds	Period seconds for readinessProbe	5
readinessProbe.timeoutSeconds	Timeout seconds for readinessProbe	1
readinessProbe.failureThreshold	Failure threshold for readinessProbe	3
readinessProbe.successThreshold	Success threshold for readinessProbe	1
updateStrategy.type	StatefulSet deployment update strategy	RollingUpdate
updateStrategy.rollingUpdate	StatefulSet deployment rolling update configuration parameters	{}

persistentVolume parameters

Name	Description	Value
persistentVolume.enabled	Enable persistentVolume	true
persistentVolume.accessModes	Storage size of the persistentVolume	["ReadWriteOnce"]
persistentVolume.storageClass	StorageClass of the persistentVolume	""
persistentVolume.size	Storage size of the persistentVolume	400M
persistentVolume.mountPath	Mount path of the persistentVolume	/tmp/volume

Service parameters

Name	Description	Value
service.enabled	StatefulSet service	true
service.type	StatefulSet service type	ClusterIP
service.port	StatefulSet service HTTP port	80
service.httpsPort	StatefulSet service HTTPS port	nil
service.nodePorts.http	Node port for HTTP	nil
service.nodePorts.https	Node port for HTTPS	nil
service.clusterIP	StatefulSet service Cluster IP	nil
service.loadBalancerIP	StatefulSet service Load Balancer IP	nil
service.loadBalancerSourceRanges	StatefulSet service Load Balancer sources	[]
service.externalTrafficPolicy	StatefulSet service external traffic policy	Cluster
service.annotations	Additional custom annotations for StatefulSet service	{}
service.ports	Additional port definitions for the service	[]

Ingress parameters

Name	Description	Value
ingress.enabled	Enable ingress record generation for StatefulSet	false
ingress.pathType	Ingress path type	ImplementationSpecific
ingress.apiVersion	Force Ingress API version (automatically detected if not set)	nil
ingress.hostname	Default host for the ingress record	chart-example.local
ingress.path	Default path for the ingress record	/
ingress.annotations	Additional custom annotations for the ingress record	{}
ingress.tls	Enable TLS configuration for the host defined at ingress.hostname parameter	false
ingress.certManager	Add the corresponding annotations for cert-manager integration	false
ingress.selfSigned	Create a TLS secret for this ingress record using self-signed certificates generated by Helm	false
ingress.extraHosts	An array with additional hostname(s) to be covered with the ingress record	[]
ingress.extraPaths	An array with additional arbitrary paths that may need to be added to the ingress under the main host	[]
ingress.extraTls	TLS configuration for additional hostname(s) to be covered with this ingress record	[]
ingress.secrets	Custom TLS certificates as secrets	[]

Pod Image parameters

Name	Description	Value
image.registry	Deployment image registry	docker.io
image.repository	Deployment image repository	busybox
image.tag	Deployment image tag (immutabe tags are recommended)	latest
image.pullPolicy	Deployment image pull policy	IfNotPresent
image.pullSecrets	Deployment image pull secrets	[]

Pod parameters

Name	Description	Value
ports[0].containerPort	Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.	80
ports[0].name	If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.	http
ports[0].hostIp	What host IP to bind the external port to.	nil
ports[0].hostPort	Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.	nil
ports[0].protocol	Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".	TCP
command	Override StatefulSet default command	[]
args	Override StatefulSet default args	[]
priorityClassName	StatefulSet pod priority class name	nil
hostAliases	Custom host aliases for StatefulSet pods	[]
tolerations	Tolerations for pod assignment	[]
podLabels	Extra labels for StatefulSet pods	{}
podAnnotations	Annotations for StatefulSet pods	{}
lifecycleHooks	Add lifecycle hooks to the StatefulSet deployment	{}
shareProcessNamespace	Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.	false
extraEnvVars	Add extra environment variables to the StatefulSet container	[]
extraEnvVarsMap	Add extra environment variables to the Deployment container	{}
extraEnvVarsCM	Name of existing ConfigMap containing extra env vars	nil
extraEnvVarsCMs	Optionally specify extra list of additional existing ConfigMaps containing extra env vars	[]
extraEnvVarsSecret	Name of existing Secret containing extra env vars	nil
extraEnvVarsSecrets	Optionally specify extra list of additional existing Secrets containing extra env vars	[]
extraVolumes	Optionally specify extra list of additional volumes for StatefulSet pods	[]
extraVolumeMounts	Optionally specify extra list of additional volumeMounts for StatefulSet container(s)	[]
initContainers	Add additional init containers to the StatefulSet pods	{}
sidecars	Add additional sidecar containers to the StatefulSet pod	{}
serviceAccount.create	Specifies whether a ServiceAccount should be created	true
serviceAccount.name	The name of the ServiceAccount to use.	""
serviceAccount.annotations	Additional custom annotations for the ServiceAccount	{}
resources.limits	The resources limits for the StatefulSet container	{}
resources.requests	The requested resources for the StatefulSet container	{}
podSecurityContext.enabled	Enabled StatefulSet pods' Security Context	false
podSecurityContext.fsGroup	Set StatefulSet pod's Security Context fsGroup	1000
containerSecurityContext.enabled	Enabled StatefulSet containers' Security Context	false
containerSecurityContext.runAsUser	Set StatefulSet container's Security Context runAsUser	1001
containerSecurityContext.runAsNonRoot	Set StatefulSet container's Security Context runAsNonRoot	true

Pod Affinity parameters

Name	Description	Value
podAffinityPreset	Pod affinity preset. Ignored if affinity is set. Allowed values: soft or hard	""
podAntiAffinityPreset	Pod anti-affinity preset. Ignored if affinity is set. Allowed values: soft or hard	soft
nodeAffinityPreset.type	Node affinity preset type. Ignored if affinity is set. Allowed values: soft or hard	""
nodeAffinityPreset.key	Node label key to match. Ignored if affinity is set	""
nodeAffinityPreset.values	Node label values to match. Ignored if affinity is set	[]
affinity	Affinity for Cert Manager StatefulSet	{}
nodeSelector	Node labels for pod assignment	{}

Metrics paramaters

Name	Description	Value
metrics.enabled	Start a sidecar prometheus exporter to expose StatefulSet metrics	false
metrics.serviceMonitor.enabled	Create ServiceMonitor resource(s) for scraping metrics using PrometheusOperator	false
metrics.serviceMonitor.namespace	The namespace in which the ServiceMonitor will be created	nil
metrics.serviceMonitor.interval	The interval at which metrics should be scraped	30s
metrics.serviceMonitor.scrapeTimeout	The timeout after which the scrape is ended	nil
metrics.serviceMonitor.relabellings	Metrics relabellings to add to the scrape endpoint	[]
metrics.serviceMonitor.honorLabels	Specify honorLabels parameter to add the scrape endpoint	false
metrics.serviceMonitor.additionalLabels	Additional labels that can be used so ServiceMonitor resource(s) can be discovered by Prometheus	{}

Datadog integration parameters

Name	Description	Value
datadog.apm.enabled	Enable Datadog APM	false
datadog.apm.agent_host	The Datadog Agent hostname for sending traces -- has the same functionality as the below trace_agent_host but is used by different language's implementations of the Datadog trace library (Default: status.hostIP)	""
datadog.apm.env	Set an application’s environment e.g. prod, pre-prod, staging.	""
datadog.apm.version	Set an application’s version in traces and logs e.g. 1.2.3, 6c44da20, 2020.02.13. Generally set along with DD_SERVICE.	""
datadog.apm.profiling_enabled	Enable Datadog profiling when using ddtrace-run. (Default: false)	false
datadog.apm.logs_injection	Enables Logs Injection https://ddtrace.readthedocs.io/en/stable/advanced_usage.html#logs-injection (Default: true)	true
datadog.apm.trace_sample_rate	A float, f, 0.0 <= f <= 1.0. f*100% of traces will be sampled. (Default: 1.0)	1
datadog.apm.trace_agent_host	The Datadog Agent hostname for sending traces -- has the same functionality as the above agent_host but is used by different language's implementations of the Datadog trace library (Default: status.hostIP)	""
datadog.openmetrics.enabled	Enable OpenMetrics scraping	false
datadog.openmetrics.schema	The schema to use for OpenMetrics. (Default: http)	http
datadog.openmetrics.host	The hostname or ip to scape metrics from. (Default: Pod ip)	%%host%%
datadog.openmetrics.port	The port to scrap metrics from (Default: 8080)	8080
datadog.openmetrics.endpoint	The endpoint to scrape metrics from	/metrics
datadog.openmetrics.metrics	List of metrics to collect	[]
datadog.openmetrics.type_overrides	Override the collected metrics types	{}

External secrets

Name	Description	Value
externalSecrets	Secrets resolved from an external source	[]
externalSecrets.0.path	Path of the external secret	""
externalSecrets.0.secret	Optionally specify the name of the generated secret. Default value derived from path	""
externalSecrets.0.provider	Optionally specify the name of the secret store provider. Defaults to "vault-backend"	""
externalSecrets.0.storeKind	Optionally specify the kind of secret store. Defaults to "ClusterSecretStore"	""