Skip to content

Helm Configuration

Parameters

Below is an exhaustive list of helm parameters you can specify to modify the behavior of the LiteSpeed Kubernetes ADC Controller.

Specify each parameter using the --set key=value[,key=value] argument to helm install or helm upgrade. For example,

$ helm install ls-k8s-webadc --set image.pullPolicy=Always helm/ls-k8s-webadc
The above command sets the image.pullPolicy to Always.

Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,

$ helm install my-release -f values.yaml helm/ls-k8s-webadc

Tip

You can use the default values.yaml

Global parameters

Name Description Value
global.imageRegistry Global Docker image registry ""
global.imagePullSecrets Global Docker registry secret names as an array []

Common parameters

Name Description Value
nameOverride String to partially override common.names.fullname ""
fullnameOverride String to fully override common.names.fullname ""
commonLabels Add labels to all the deployed resources {}
commonAnnotations Add annotations to all the deployed resources {}
extraDeploy Array of extra objects to deploy with the release []

LiteSpeed WebADC Ingress Controller parameters

Name Description Value
image.registry LiteSpeed WebADC Ingress Controller image registry docker.io
image.repository LiteSpeed WebADC Ingress Controller image repository litespeedtech/ls-k8
image.tag LiteSpeed WebADC Ingress Controller image tag latest
image.pullPolicy LiteSpeed WebADC Ingress Controller image pull policy Always
image.pullSecrets Specify docker-registry secret names as an array []
defaultBackendService Default 404 backend service. ""
publishService.enabled Set the endpoint records on the Ingress objects to reflect those on the service false
publishService.pathOverride Allows overriding of the publish service to bind to ""
scope.enabled Limit the scope of the controller. Defaults to .Release.Namespace false
command Override default container command (useful when using custom images) []
args Override default container args (useful when using custom images) []
extraArgs Additional command line arguments to ls-k8s-webadc. Without leading dashes, comma separated, in quotes. See Arguments {}
extraEnvVars Extra environment variables to be set on LiteSpeed WebADC Ingress container []
extraEnvVarsSecret Name of a existing Secret containing extra environment variables ""

LiteSpeed WebADC Ingress deployment / daemonset parameters

Name Description Value
kind Install as Deployment or DaemonSet Deployment
daemonset.useHostPort If kind is DaemonSet, this will enable hostPort for TCP/80 and TCP/443 false
daemonset.hostPorts HTTP and HTTPS ports {}
nodeName Allows you to hardcode the node name if you wish. ""
replicaCount Desired number of Controller pods 1
updateStrategy Strategy to use to update Pods {}
revisionHistoryLimit The number of old history to retain to allow rollback 10
podSecurityContext.enabled Enable Controller pods' Security Context true
podSecurityContext.fsGroup Group ID for the container filesystem 1001
containerSecurityContext.enabled Enable Controller containers' Security Context true
containerSecurityContext.allowPrivilegeEscalation Switch to allow priviledge escalation on the Controller container true
containerSecurityContext.runAsUser User ID for the Controller container 1001
containerSecurityContext.capabilities.drop Linux Kernel capabilities that should be dropped []
containerSecurityContext.capabilities.add Linux Kernel capabilities that should be added []
minReadySeconds How many seconds a pod needs to be ready before killing the next, during update 0
resources.limits The resources limits for the Controller container {}
resources.requests The requested resources for the Controller container {}
livenessProbe.enabled Enable livenessProbe true
livenessProbe.httpGet.path Request path for livenessProbe /healthz
livenessProbe.httpGet.port Port for livenessProbe 11972
livenessProbe.httpGet.scheme Scheme for livenessProbe HTTP
livenessProbe.initialDelaySeconds Initial delay seconds for livenessProbe 10
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.httpGet.path Request path for readinessProbe /healthz
readinessProbe.httpGet.port Port for readinessProbe 11972
readinessProbe.httpGet.scheme Scheme for readinessProbe HTTP
readinessProbe.initialDelaySeconds Initial delay seconds for readinessProbe 10
readinessProbe.periodSeconds Period seconds for readinessProbe 10
readinessProbe.timeoutSeconds Timeout seconds for readinessProbe 1
readinessProbe.failureThreshold Failure threshold for readinessProbe 3
readinessProbe.successThreshold Success threshold for readinessProbe 1
customLivenessProbe Override default liveness probe {}
customReadinessProbe Override default readiness probe {}
lifecycle LifecycleHooks to set additional configuration at startup {}
podLabels Extra labels for Controller pods {}
podAnnotations Annotations for Controller pods {}
priorityClassName Controller priorityClassName ""
hostNetwork If the LiteSpeed WebADC deployment / daemonset should run on the host's network namespace false
dnsPolicy By default, while using host network, name resolution uses the host's DNS ClusterFirst
terminationGracePeriodSeconds How many seconds to wait before terminating a pod 60
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 pod assignment. Evaluated as a template. {}
nodeSelector Node labels for pod assignment. Evaluated as a template. {}
tolerations Tolerations for pod assignment. Evaluated as a template. []
extraVolumes Optionally specify extra list of additional volumes for Controller pods []
extraVolumeMounts Optionally specify extra list of additional volumeMounts for Controller container(s) []
initContainers Add init containers to the controller pods []
sidecars Add sidecars to the controller pods. []
customTemplate Override template {}
topologySpreadConstraints Topology spread constraints rely on node labels to identify the topology domain(s) that each Node is in []
podSecurityPolicy.enabled If true, create & use Pod Security Policy resources false

Default backend parameters

Name Description Value
defaultBackend.enabled Enable a default backend based on LiteSpeed WebADC false
defaultBackend.hostAliases Add deployment host aliases []
defaultBackend.image.registry Default backend image registry docker.io
defaultBackend.image.repository Default backend image repository litespeedtech/ols-backend
defaultBackend.image.tag Default backend image tag (immutable tags are recommended) latest
defaultBackend.image.pullPolicy Image pull policy Always
defaultBackend.image.pullSecrets Specify docker-registry secret names as an array []
defaultBackend.extraArgs Additional command line arguments to pass to LiteSpeed WebADC container {}
defaultBackend.containerPort HTTP container port number 80
defaultBackend.serverBlockConfig LiteSpeed WebADC backend default server block configuration ""
defaultBackend.replicaCount Desired number of default backend pods 1
defaultBackend.podSecurityContext.enabled Enable Default backend pods' Security Context false
defaultBackend.podSecurityContext.fsGroup Group ID for the container filesystem 1001
defaultBackend.containerSecurityContext.enabled Enable Default backend containers' Security Context false
defaultBackend.containerSecurityContext.runAsUser User ID for the Default backend container 1001
defaultBackend.resources.limits The resources limits for the Default backend container {}
defaultBackend.resources.requests The requested resources for the Default backend container {}
defaultBackend.livenessProbe.enabled Enable livenessProbe true
defaultBackend.livenessProbe.httpGet.path Request path for livenessProbe /healthz
defaultBackend.livenessProbe.httpGet.port Port for livenessProbe http
defaultBackend.livenessProbe.httpGet.scheme Scheme for livenessProbe HTTP
defaultBackend.livenessProbe.initialDelaySeconds Initial delay seconds for livenessProbe 30
defaultBackend.livenessProbe.periodSeconds Period seconds for livenessProbe 10
defaultBackend.livenessProbe.timeoutSeconds Timeout seconds for livenessProbe 5
defaultBackend.livenessProbe.failureThreshold Failure threshold for livenessProbe 3
defaultBackend.livenessProbe.successThreshold Success threshold for livenessProbe 1
defaultBackend.readinessProbe.enabled Enable readinessProbe true
defaultBackend.readinessProbe.httpGet.path Request path for readinessProbe /healthz
defaultBackend.readinessProbe.httpGet.port Port for readinessProbe http
defaultBackend.readinessProbe.httpGet.scheme Scheme for readinessProbe HTTP
defaultBackend.readinessProbe.initialDelaySeconds Initial delay seconds for readinessProbe 0
defaultBackend.readinessProbe.periodSeconds Period seconds for readinessProbe 5
defaultBackend.readinessProbe.timeoutSeconds Timeout seconds for readinessProbe 5
defaultBackend.readinessProbe.failureThreshold Failure threshold for readinessProbe 6
defaultBackend.readinessProbe.successThreshold Success threshold for readinessProbe 1
defaultBackend.podLabels Extra labels for Controller pods {}
defaultBackend.podAnnotations Annotations for Controller pods {}
defaultBackend.priorityClassName priorityClassName ""
defaultBackend.podAffinityPreset Pod affinity preset. Ignored if affinity is set. Allowed values: soft or hard ""
defaultBackend.podAntiAffinityPreset Pod anti-affinity preset. Ignored if affinity is set. Allowed values: soft or hard soft
defaultBackend.nodeAffinityPreset.type Node affinity preset type. Ignored if affinity is set. Allowed values: soft or hard ""
defaultBackend.nodeAffinityPreset.key Node label key to match. Ignored if affinity is set. ""
defaultBackend.nodeAffinityPreset.values Node label values to match. Ignored if affinity is set. []
defaultBackend.affinity Affinity for pod assignment {}
defaultBackend.nodeSelector Node labels for pod assignment {}
defaultBackend.tolerations Tolerations for pod assignment []
defaultBackend.service.type Kubernetes Service type for default backend ClusterIP
defaultBackend.service.port Default backend service port 80
defaultBackend.pdb.create Enable/disable a Pod Disruption Budget creation for Default backend false
defaultBackend.pdb.minAvailable Minimum number/percentage of Default backend pods that should remain scheduled 1
defaultBackend.pdb.maxUnavailable Maximum number/percentage of Default backend pods that may be made unavailable ""

Traffic exposure parameters

Name Description Value
service.type Kubernetes Service type for Controller LoadBalancer
service.ports.http Service HTTP port 80
service.ports.https Service HTTPS port 443
service.nodePorts.http Specify the nodePort value(s) for the LoadBalancer and NodePort service types for http. ""
service.nodePorts.https Specify the nodePort value(s) for the LoadBalancer and NodePort service types for https. ""
service.nodePorts.tcp Specify the nodePort value(s) for the LoadBalancer and NodePort service types for tcp. {}
service.nodePorts.udp Specify the nodePort value(s) for the LoadBalancer and NodePort service types for udp. {}
service.annotations Annotations for controller service {}
service.labels Labels for controller service {}
service.clusterIP Controller Internal Cluster Service IP (optional) ""
service.externalIPs Controller Service external IP addresses []
service.loadBalancerIP Kubernetes LoadBalancerIP to request for Controller (optional, cloud specific) ""
service.loadBalancerSourceRanges List of IP CIDRs allowed access to load balancer (if supported) []
service.externalTrafficPolicy Set external traffic policy to: "Local" to preserve source IP on providers supporting it ""
service.healthCheckNodePort Set this to the managed health-check port the kube-proxy will expose. If blank, a random port in the NodePort range will be assigned 0

RBAC parameters

Role-Based Access Control parameters include:

Name Description Value
serviceAccount.create Enable the creation of a ServiceAccount for Controller pods true
serviceAccount.name Name of the created ServiceAccount ""
serviceAccount.annotations Annotations for service account. {}
rbac.create Specifies whether RBAC rules should be created true

Other parameters

Name Description Value
pdb.create Enable/disable a Pod Disruption Budget creation for Controller false
pdb.minAvailable Minimum number/percentage of Controller pods that should remain scheduled 1
pdb.maxUnavailable Maximum number/percentage of Controller pods that may be made unavailable ""
autoscaling.enabled Enable autoscaling for Controller false
autoscaling.minReplicas Minimum number of Controller replicas 1
autoscaling.maxReplicas Maximum number of Controller replicas 11
autoscaling.targetCPU Target CPU utilization percentage ""
autoscaling.targetMemory Target Memory utilization percentage ""

Metrics parameters

Name Description Value
metrics.enabled Enable exposing Controller statistics false
metrics.service.type Type of Prometheus metrics service to create ClusterIP
metrics.service.port Service HTTP management port 9913
metrics.service.annotations Annotations for the Prometheus exporter service {}
metrics.serviceMonitor.enabled Create ServiceMonitor resource for scraping metrics using PrometheusOperator false
metrics.serviceMonitor.namespace Namespace in which Prometheus is running ""
metrics.serviceMonitor.interval Interval at which metrics should be scraped 30s
metrics.serviceMonitor.scrapeTimeout Specify the timeout after which the scrape is ended ""
metrics.serviceMonitor.selector ServiceMonitor selector labels {}
metrics.prometheusRule.enabled Create PrometheusRules resource for scraping metrics using PrometheusOperator false
metrics.prometheusRule.additionalLabels Used to pass Labels that are required by the Installed Prometheus Operator {}
metrics.prometheusRule.namespace Namespace which Prometheus is running in ""
metrics.prometheusRule.rules Rules to be prometheus in YAML format, check values for an example []

Configuration and installation details

Rolling VS Immutable tags

It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.

Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.

Sidecars and Init Containers

If you have a need for additional containers to run within the same pod as the LiteSpeed WebADC Ingress Controller (e.g. an additional metrics or logging exporter), you can do so via the sidecars config parameter. Simply define your container according to the Kubernetes container spec.

sidecars:
  - name: your-image-name
    image: your-image
    imagePullPolicy: Always
    ports:
      - name: portname
       containerPort: 1234

Similarly, you can add extra init containers using the initContainers parameter.

initContainers:
  - name: your-image-name
    image: your-image
    imagePullPolicy: Always
    ports:
      - name: portname
        containerPort: 1234

Deploying extra resources

There are cases where you may want to deploy extra objects, such a ConfigMap containing your app's configuration or some extra deployment with a micro service used by your app. For covering this case, the chart allows adding the full specification of other objects using the extraDeploy parameter.

Setting Pod's affinity

This chart allows you to set your custom affinity using the affinity parameter. Find more information about Pod's affinity in the kubernetes documentation.

As an alternative, you can use of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common chart. To do so, set the podAffinityPreset, podAntiAffinityPreset, or nodeAffinityPreset parameters.

And if necessary you can hard code the node the Deployment schedules a pod to with nodeName.


Last update: November 5, 2021