Ceph

`services.ceph.client.enable`

Whether to enable Ceph client configuration. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.client.extraConfig`

Extra configuration to add to the client section. Configuration for rados gateways would be added here, with their own sections, see example.

Type: attribute set of attribute set of string

Default

{ }

Example

{# This would create a section for a radosgw daemon named node0 and related# configuration for it"client.radosgw.node0" = { "some config option" = "true"; };};

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.enable`

Whether to enable Ceph global configuration. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.extraConfig`

Extra configuration to add to the global section. Use for setting values that are common for all daemons in the cluster.

Type: attribute set of string

Default

{ }

Example

{"ms bind ipv6" = "true";}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.global.authClientRequired`

Enables requiring the cluster to authenticate itself to the client.

Type: one of "cephx", "none"

Default

"cephx"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.global.authClusterRequired`

Enables requiring daemons to authenticate with eachother in the cluster.

Type: one of "cephx", "none"

Default

"cephx"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.global.authServiceRequired`

Enables requiring clients to authenticate with the cluster to access services in the cluster (e.g. radosgw, mds or osd).

Type: one of "cephx", "none"

Default

"cephx"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.global.clusterName`

Name of cluster

Type: string

Default

"ceph"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.global.clusterNetwork`

A comma-separated list of subnets that will be used as cluster networks in the cluster.

Type: null or strings concatenated with ","

Default

null

Example

'' 10.10.0.0/24, 192.168.0.0/24''

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.global.fsid`

Filesystem ID, a generated uuid, its must be generated and set before attempting to start a cluster

Type: string

Example

'' 433a2193-4f8a-47a0-95d2-209d7ca2cca5''

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.global.maxOpenFiles`

Max open files for each OSD daemon.

Type: signed integer

Default

131072

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.global.mgrModulePath`

Path at which to find ceph-mgr modules.

Type: path

Default

"${pkgs.ceph.lib}/lib/ceph/mgr"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.global.monHost`

List of hostname shortnames/IP addresses of the initial monitors.

Type: null or strings concatenated with ","

Default

null

Example

'' 10.10.0.1, 10.10.0.2, 10.10.0.3''

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.global.monInitialMembers`

List of hosts that will be used as monitors at startup.

Type: null or strings concatenated with ","

Default

null

Example

'' node0, node1, node2''

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.global.publicNetwork`

A comma-separated list of subnets that will be used as public networks in the cluster.

Type: null or strings concatenated with ","

Default

null

Example

'' 10.20.0.0/24, 192.168.1.0/24''

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.global.rgwMimeTypesFile`

Path to mime types used by radosgw.

Type: null or path

Default

"${pkgs.mailcap}/etc/mime.types"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.mds.daemons`

A list of metadata service daemons that should have a service created. The names correspond to the id part in ceph i.e. [ "name1" ] would result in mds.name1

Type: list of string

Default

[ ]

Example

["name1""name2"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.mds.enable`

Whether to enable Ceph MDS daemon. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.mds.extraConfig`

Extra configuration to add to the MDS section.

Type: attribute set of string

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.mds.package`

The ceph package to use. Type: package

Default

pkgs.ceph

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.mgr.daemons`

A list of names for manager daemons that should have a service created. The names correspond to the id part in ceph i.e. [ "name1" ] would result in mgr.name1

Type: list of string

Default

[ ]

Example

["name1""name2"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.mgr.enable`

Whether to enable Ceph MGR daemon. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.mgr.extraConfig`

Extra configuration to add to the global section for manager daemons.

Type: attribute set of string

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.mgr.package`

The ceph package to use. Type: package

Default

pkgs.ceph

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.mon.daemons`

A list of monitor daemons that should have a service created. The names correspond to the id part in ceph i.e. [ "name1" ] would result in mon.name1

Type: list of string

Default

[ ]

Example

["name1""name2"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.mon.enable`

Whether to enable Ceph MON daemon. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.mon.extraConfig`

Extra configuration to add to the monitor section.

Type: attribute set of string

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.mon.package`

The ceph package to use. Type: package

Default

pkgs.ceph

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.osd.daemons`

A list of OSD daemons that should have a service created. The names correspond to the id part in ceph i.e. [ "name1" ] would result in osd.name1

Type: list of string

Default

[ ]

Example

["name1""name2"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.osd.enable`

Whether to enable Ceph OSD daemon. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.osd.extraConfig`

Extra configuration to add to the OSD section.

Type: attribute set of string

Default

{"osd crush chooseleaf type" = "1";"osd journal size" = "10000";"osd pool default min size" = "2";"osd pool default pg num" = "200";"osd pool default pgp num" = "200";"osd pool default size" = "3";}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.osd.package`

The ceph package to use. Type: package

Default

pkgs.ceph

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.rgw.daemons`

A list of rados gateway daemons that should have a service created. The names correspond to the id part in ceph i.e. [ "name1" ] would result in client.name1, radosgw daemons aren't daemons to cluster in the sense that OSD, MGR or MON daemons are. They are simply daemons, from ceph, that uses the cluster as a backend.

Type: list of string

Default

[ ]

Example

["name1""name2"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.rgw.enable`

Whether to enable Ceph RadosGW daemon. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix

`services.ceph.rgw.package`

The ceph package to use. Type: package

Default

pkgs.ceph

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/ceph.nix