Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Filesystems Options

Options for: openebs, seaweedfs.

All options are under lab.clusters.<name>.components.

openebs.chart

Custom chart derivation. When null, uses nixhelm default.

Type: package

Default:

<derivation helm-chart-https-charts.containeroo.ch-local-path-provisioner-0.0.30>

Declared in: modules/lab/cluster/components/filesystems/openebs.nix


openebs.enable

Whether to enable OpenEBS storage operator.

Type: boolean

Default: false

Example: true

Declared in: modules/lab/cluster/components/filesystems/openebs.nix


openebs.engine

Storage engine:

  • hostpath: local path provisioner (dev/single-node)
  • lvm: LVM-based local storage
  • zfs: ZFS-based local storage
  • mayastor: replicated NVMe-oF storage (production HA)

Type: one of "hostpath", "lvm", "zfs", "mayastor"

Default: "hostpath"

Declared in: modules/lab/cluster/components/filesystems/openebs.nix


openebs.mayastor.cpuCount

CPU cores allocated to each Mayastor instance

Type: positive integer, meaning >0

Default: 2

Declared in: modules/lab/cluster/components/filesystems/openebs.nix


openebs.mayastor.replicas

Number of Mayastor IO engine replicas

Type: positive integer, meaning >0

Default: 3

Declared in: modules/lab/cluster/components/filesystems/openebs.nix


openebs.namespace

Namespace for OpenEBS

Type: string

Default: "openebs"

Declared in: modules/lab/cluster/components/filesystems/openebs.nix


openebs.phase

Deployment phase this component belongs to

Type: string

Default: "operators"

Declared in: modules/lab/cluster/components/filesystems/openebs.nix


openebs.ref

Computed references for OpenEBS

Type: attribute set

Default: { }

Declared in: modules/lab/cluster/components/filesystems/openebs.nix


openebs.storageClasses

StorageClass definitions to create

Type: attribute set of (submodule)

Default:

{
  openebs-default = {
    isDefault = true;
  };
}

Declared in: modules/lab/cluster/components/filesystems/openebs.nix


openebs.storageClasses.<name>.isDefault

Set as the cluster’s default StorageClass

Type: boolean

Default: false

Declared in: modules/lab/cluster/components/filesystems/openebs.nix


openebs.storageClasses.<name>.reclaimPolicy

PV reclaim policy

Type: one of "Delete", "Retain"

Default: "Delete"

Declared in: modules/lab/cluster/components/filesystems/openebs.nix


openebs.storageClasses.<name>.volumeBindingMode

Volume binding mode

Type: one of "WaitForFirstConsumer", "Immediate"

Default: "WaitForFirstConsumer"

Declared in: modules/lab/cluster/components/filesystems/openebs.nix


openebs.version

OpenEBS version

Type: string

Default: "4.1.1"

Declared in: modules/lab/cluster/components/filesystems/openebs.nix


seaweedfs.chart

Custom chart derivation. When null, uses nixhelm default.

Type: package

Default: <derivation helm-chart-https-seaweedfs.github.io-seaweedfs-helm-seaweedfs-4.0.0>

Declared in: modules/lab/cluster/components/filesystems/seaweedfs.nix


seaweedfs.enable

Whether to enable SeaweedFS distributed storage.

Type: boolean

Default: false

Example: true

Declared in: modules/lab/cluster/components/filesystems/seaweedfs.nix


seaweedfs.filer.replicas

Number of filer replicas (2+ for production)

Type: positive integer, meaning >0

Default: 1

Declared in: modules/lab/cluster/components/filesystems/seaweedfs.nix


seaweedfs.filer.s3.enable

Enable S3 API gateway on the filer

Type: boolean

Default: true

Declared in: modules/lab/cluster/components/filesystems/seaweedfs.nix


seaweedfs.filer.storage

Storage size for filer metadata

Type: string

Default: "10Gi"

Declared in: modules/lab/cluster/components/filesystems/seaweedfs.nix


seaweedfs.master.replicas

Number of master server replicas (3 for production)

Type: positive integer, meaning >0

Default: 1

Declared in: modules/lab/cluster/components/filesystems/seaweedfs.nix


seaweedfs.master.storage

Storage size for master metadata

Type: string

Default: "10Gi"

Declared in: modules/lab/cluster/components/filesystems/seaweedfs.nix


seaweedfs.namespace

Namespace for SeaweedFS

Type: string

Default: "seaweedfs"

Declared in: modules/lab/cluster/components/filesystems/seaweedfs.nix


seaweedfs.phase

Deployment phase this component belongs to

Type: string

Default: "infrastructure"

Declared in: modules/lab/cluster/components/filesystems/seaweedfs.nix


seaweedfs.ref

Computed references for SeaweedFS

Type: attribute set

Default: { }

Declared in: modules/lab/cluster/components/filesystems/seaweedfs.nix


seaweedfs.s3.enable

Enable S3 API

Type: boolean

Default: true

Declared in: modules/lab/cluster/components/filesystems/seaweedfs.nix


seaweedfs.s3.port

S3 API port

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 8333

Declared in: modules/lab/cluster/components/filesystems/seaweedfs.nix


seaweedfs.version

SeaweedFS version

Type: string

Default: "3.71"

Declared in: modules/lab/cluster/components/filesystems/seaweedfs.nix


seaweedfs.volume.replicas

Number of volume server replicas (3+ for production)

Type: positive integer, meaning >0

Default: 1

Declared in: modules/lab/cluster/components/filesystems/seaweedfs.nix


seaweedfs.volume.storage

Storage size per volume server

Type: string

Default: "50Gi"

Declared in: modules/lab/cluster/components/filesystems/seaweedfs.nix


seaweedfs.volume.storageClass

StorageClass for volume server PVCs (null = cluster default)

Type: null or string

Declared in: modules/lab/cluster/components/filesystems/seaweedfs.nix