Skip to content

data-mesher 🔹

Set up data-mesher

Will be deprecated

The data-mesher module might eventually be migrated to 'clanServices'*

See: clanServices

Categories

System

Usage via Inventory

Roles

This module can be used via predefined roles

  • peer
  • signer
  • admin

Every role has its own configuration options, which are each listed below.

For more information, see the inventory guide.

Example

For example the admin module adds the following options globally to all machines where it is used.

clan.admin.allowedkeys

This means there are two equivalent ways to set the allowedkeys option. Either via a nixos module or via the inventory interface. But it is recommended to keep together imports and config to preserve locality of the module configuration.

clan-core.lib.buildClan {
    inventory.services = {
        admin.me = {
            roles.default.machines = [ "jon" ];
            config.allowedkeys = [ "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQD..." ];
        };
    };
};

clan-core.lib.buildClan {
    machines = {
        jon = {
            clan.admin.allowedkeys = [ "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQD..." ];
            imports = [ clanModules.admin ];
        };
    };
};

Options of peer role

The following options are available when using the peer role.

bootstrapNodes

A list of bootstrap nodes that act as an initial gateway when joining the cluster.

Type: null or (list of string)

Default:

null
Example 
[
  "192.168.1.1:7946"
  "192.168.1.2:7946"
]

Declared in: clanModules/data-mesher/shared.nix

network.interface

The interface over which cluster communication should be performed. All the ip addresses associate with this interface will be part of our host claim, including both ipv4 and ipv6.

This should be set to an internal/VPN interface.

Type: string

Example 
"tailscale0"

Declared in: clanModules/data-mesher/shared.nix

network.port

Port to listen on for cluster communication.

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

Default:

7946

Declared in: clanModules/data-mesher/shared.nix

Options of signer role

The following options are available when using the signer role.

bootstrapNodes

A list of bootstrap nodes that act as an initial gateway when joining the cluster.

Type: null or (list of string)

Default:

null
Example 
[
  "192.168.1.1:7946"
  "192.168.1.2:7946"
]

Declared in: clanModules/data-mesher/shared.nix

network.interface

The interface over which cluster communication should be performed. All the ip addresses associate with this interface will be part of our host claim, including both ipv4 and ipv6.

This should be set to an internal/VPN interface.

Type: string

Example 
"tailscale0"

Declared in: clanModules/data-mesher/shared.nix

network.port

Port to listen on for cluster communication.

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

Default:

7946

Declared in: clanModules/data-mesher/shared.nix

Options of admin role

The following options are available when using the admin role.

bootstrapNodes

A list of bootstrap nodes that act as an initial gateway when joining the cluster.

Type: null or (list of string)

Default:

null
Example 
[
  "192.168.1.1:7946"
  "192.168.1.2:7946"
]

Declared in: clanModules/data-mesher/shared.nix

network.hostTTL

The TTL for hosts in the network, in the form of a Go time.Duration

Type: string

Default:

"672h"
Example 
"24h"

Declared in: clanModules/data-mesher/roles/admin.nix

network.interface

The interface over which cluster communication should be performed. All the ip addresses associate with this interface will be part of our host claim, including both ipv4 and ipv6.

This should be set to an internal/VPN interface.

Type: string

Example 
"tailscale0"

Declared in: clanModules/data-mesher/shared.nix

network.port

Port to listen on for cluster communication.

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

Default:

7946

Declared in: clanModules/data-mesher/shared.nix

network.tld

Top level domain to use for the network

Type: string

Default:

null

Declared in: clanModules/data-mesher/roles/admin.nix

Usage via Nix

This module cannot be imported directly in your nixos configuration.