helm-values.adoc

Helm Reference Table

Global Settings

drbdRepoCred

Default

""

Valid values

secret name

Description

Names a secret containing registry credentials to pull LINSTOR container images.

global.imagePullPolicy

Default

IfNotPresent

Valid values

• ""

• Always

• IfNotPresent

• Never

Description

Global pull policy to apply to all images. Can be set to "" to use kubernetes default behaviour. See pull policy.

global.setSecurityContext

Default

True

Valid values

• True

• False

Description

If true, all non-privileged containers start with a fixed UID of 1000 and GID of 1000.

linstorHttpsClientSecret

Default

""

Valid values

secret name

Description

References the secret to use when configuring LINSTOR clients to use HTTPS. Check out the security guide

linstorHttpsControllerSecret

Default

""

Valid values

secret name

Description

References the secret to use when configuring LINSTOR contoller to use HTTPS. Check out the security guide

priorityClassName

Default

""

Valid values

priority class name

Description

Name of the priority class with which the LINSTOR components should be scheduled.

Operator

operator.image

Default

quay.io/piraeusdatastore/piraeus-operator:<tag>

Valid values

image ref

Description

Image to use for the operator deployment.

Note: prefer to use a pinned version (i.e. :v1.0.0) over a rolling tag (i.e. :latest). During development, the default value will be :latest, on release it will match the release tag.

operator.replicas

Default

1

Valid values

number

Description

Number of replicas of the operator.

operator.resources

Default

{}

Valid values

resource requests

Description

Resource requests and limits to apply to the operator containers.

Cluster Snapshot Controller

csi-snapshotter.enabled

Default

True

Valid values

• True

• False

Description

Enable deployment of the cluster-wide CSI snapshot controller. Your cluster may already provide this.

csi-snapshotter.image

Default

quay.io/k8scsi/snapshot-controller:v2.1.0

Valid values

image ref

Description

Image to use for the CSI snapshot controller. csi docs

csi-snapshotter.replicas

Default

1

Valid values

number

Description

Number of replicas of the CSI snapshot controller.

csi-snapshotter.resources

Default

{}

Valid values

resource requests

Description

Resource requests and limits to apply to the CSI snapshot controller containers.

CSI Driver

csi.controllerAffinity

Default

{}

Valid values

affinity

Description

Affinity settings for controller pods. Can be used to pin controller pods to specific nodes.

csi.controllerReplicas

Default

1

Valid values

number

Description

Number of replicas for the LINSTOR CSI controller.

csi.controllerTolerations

Default

[]

Valid values

tolerations

Description

Tolerations to pass to the LINSTOR CSI controller.

csi.csiAttacherImage

Default

quay.io/k8scsi/csi-attacher:v2.2.0

Valid values

image ref

Description

Image to use for LINSTOR CSI’s attacher container: csi docs

csi.csiNodeDriverRegistrarImage

Default

quay.io/k8scsi/csi-node-driver-registrar:v1.3.0

Valid values

image ref

Description

Image to use for LINSTOR CSI’s node registrar container: csi docs

csi.csiProvisionerImage

Default

quay.io/k8scsi/csi-provisioner:v1.6.0

Valid values

image ref

Description

Image to use for LINSTOR CSI’s provision container: csi docs

csi.csiResizerImage

Default

quay.io/k8scsi/csi-resizer:v0.5.0

Valid values

image ref

Description

Image to use for LINSTOR CSI’s resizer container: csi docs

csi.csiSnapshotterImage

Default

quay.io/k8scsi/csi-snapshotter:v2.1.0

Valid values

image ref

Description

Image to use for LINSTOR CSI’s snapshotter container: csi docs

csi.enabled

Default

True

Valid values

• True

• False

Description

Enable deployment of the LINSTOR CSI driver.

csi.enableTopology

Default

False

Value values

• True

• False

Description

Enable the CSI Topology feature. This feature ensures that pods are always assigned to nodes that can access persistent volumes. This is especially important for volumes without a networking layer (DRBD).

csi.nodeAffinity

Default

{}

Valid values

affinity

Description

Affinity settings for node pods. Can be used to restrict csi pods to specific nodes.

csi.nodeTolerations

Default

[]

Valid values

tolerations

Description

Tolerations to pass to the csi node pods.

csi.pluginImage

Default

quay.io/piraeusdatastore/piraeus-csi:v0.9.0

Valid values

image ref

Description

Image to use for LINSTOR CSI plugin containers (both node and controller). Project page

csi.resources

Default

{}

Valid values

resource requests

Description

Resource requests and limits to apply to the CSI driver pods.

Note: This will apply to every container individually, their resource usage is quite similar.

ETCD

etcd.image.repository

Default

gcr.io/etcd-development/etcd

Valid values

image name

Description

Image name for etcd. Will be joined with .tag.

etcd.image.tag

Default

v3.4.9

Valid values

image tag

Description

Image tag for etcd. Will be joined with .repository.

etcd.persistentVolume.enabled

Default

True

Valid values

• True

• False

Description

Use persistent volumes for etcd. Requires private volumes to be available outside of linstor.

etcd.persistentVolume.storage

Default

1Gi

Valid values

resource unit

Description

Size of the volume claim use to store etcd data.

etcd.replicas

Default

1

Valid values

number

Description

number of replicas to use for ETCD. An odd number is preferred.

etcd.resources

Default

{}

Valid values

resource requests

Description

Resource requests and limits to apply to the etcd containers. See etcd docs

Piraeus Controller

operator.controller.affinity

Default

{}

Valid values

affinity

Description

Affinity settings for controller pods. Can be used to restrict the pods to specific nodes.

operator.controller.controllerImage

Default

quay.io/piraeusdatastore/piraeus-server:v1.9.0

Valid values

image ref

Description

Name of the image to use for the controller.

operator.controller.dbCertSecret

Default

""

Valid values

secret name

Description

Name of the secret that contains the necessary values for securely connecting to the database. Check the security guide.

operator.controller.dbUseClientCert

Default

False

Valid values

• True

• False

Description

Enable to use client certificates when authenticating on the database. Check the security guide.

operator.controller.luksSecret

Default

""

Valid values

secret name

Description

Name of the secret that contains the master passphrase to use for encrypted volumes. Check the security guide.

operator.controller.replicas

Default

1

Valid values

number

Description

Number of replicas to use for the Linstor controller.

operator.controller.resources

Default

{}

Valid values

resource requests

Description

Resource requests and limits to apply to the controller containers.

Note: at least 750MiB memory is recommended.

operator.controller.sslSecret

Default

""

Valid values

secret name

Description

Name of the secret to use for secure communication between controller and satellites. Check the security guide.

operator.controller.tolerations

Default

[]

Valid values

tolerations

Description

Tolerations to pass to the controller pods.

Piraeus Satellites

operator.satelliteSet.affinity

Default

{}

Valid values

affinity

Description

Affinity settings for satellite pods. Can be used to restrict the pods to specific nodes.

operator.satelliteSet.automaticStorageType

Default

None

Valid values

• None

• LVM

• LVMTHIN

• ZFS

Description

Automatically create storage pools of the specified type. Check the storage guide.

• None: no automatic set up (default)

• LVM: create a LVM (thick) storage pool

• LVMTHIN: create a LVM thin storage pool

• ZFS: create a ZFS based storage pool

operator.satelliteSet.kernelModuleInjectionImage

Default

quay.io/piraeusdatastore/drbd9-bionic:v9.0.25

Valid values

image ref

Description

Name of the image to use for loading kernel modules. This is specific to the nodes host system. Check the available drbd9 images

operator.satelliteSet.kernelModuleInjectionMode

Default

Compile

Valid values

• None

• Compile

• ShippedModules

• DepsOnly

Description

Determine how the required kernel modules are injected in the host kernel

• None: disable module injection (deprecated, use DepsOnly instead)

• Compile: will compile DRBD from source and load the other modules from the host

• ShippedModules: loads a pre-built DRBD from the container

• DepsOnly: will only load modules from the host without DRBD

operator.satelliteSet.kernelModuleInjectionResources

Default

{}

Valid values

resource requests

Description

Resource requests and limits to apply to the kernel module injection init containers.

Note: When using kernelModuleInjectionMode: Compile, at least 500MiB of memory is required.

operator.satelliteSet.resources

Default

{}

Valid values

resource requests

Description

Resource requests and limits to apply to the satellite containers.

Note: at least 750MiB memory is recommended.

operator.satelliteSet.satelliteImage

Default

quay.io/piraeusdatastore/piraeus-server:v1.9.0

Valid values

image ref

Description

Name of the image to use for the satellites.

operator.satelliteSet.sslSecret

Default

""

Valid values

secret name

Description

Name of the secret to use for secure communication between controller and satellites. Check the security guide.

operator.satelliteSet.storagePools

Default

None

Valid values

map

Description

See the guide on storage pool creation

operator.satelliteSet.tolerations

Default

[]

Valid values

tolerations

Description

Tolerations to pass to the satellite pods.

PSP

psp.privilegedRole

Default

""

Valid values

role name

Description

All service accounts of pods that need to run as privileged containers will be bound to this role.

Currently, two components require this:

• csi-nodes

• linstor-satellites

  They require:

• running as root (UID 0)

• running as privileged containers

• the SYS_ADMIN capability

psp.unprivilegedRole

Default

""

Valid values

role name

Description

All service accounts of pods that do not require special privileges will be bound to this role.

Stork Scheduler

stork.enabled

Default

True

Valid values

• True

• False

Description

Enable deployment of stork scheduler

stork.replicas

Default

1

Valid values

number

Description

Number of replicas for both stork plugin and kube-scheduler pods.

stork.schedulerResources

Default

{}

Valid values

resource requests

Description

Resource requests and limits to apply to the kube scheduler containers.

stork.schedulerImage

Default

gcr.io/google_containers/kube-scheduler-amd64

Valid values

image name

Description

(Base) name of the kube-scheduler image. Will be joined with schedulerTag

stork.schedulerTag

Default

""

Valid values

image tag

Description

Tag of the scheduler image to use. If left empty, will default to the tag matching the kubernetes version.

stork.storkImage

Default

docker.io/openstorage/stork:2.5.0

Valid values

image ref

Description

Name of the image to use for the stork plugin

stork.storkResources

Default

{}

Valid values

resource requests

Description

Resource requests and limits to apply to the stork containers.