Lollypops options

lollypops.deployment.config-dir

Path to place the configuration on the remote host

Type: string

Default: "/var/src/lollypops"

Declared by: - /nix/store/crccc2n6rxm3nb3qymbprzpjrqz69p9k-source/modules/nixos/deployment.nix

lollypops.deployment.deploy-method

Method for copying flake to the remote. Using the default (copy) will only deploy the flake itself, while archive deploys the flake and all it’s inputs to the remote machine. This is slower when deploying from a connection with slow upload speed, but allows using inputs which are not accessible from the remote.

When using copy all inputs of the flake will be substituted or pulled from configured caches.

Type: one of “copy”, “archive”

Default: "copy"

Declared by: - /nix/store/crccc2n6rxm3nb3qymbprzpjrqz69p9k-source/modules/nixos/deployment.nix

lollypops.deployment.group

Group name for the host, used to perform actions against a group of servers

Type: string

Default: "default"

Declared by: - /nix/store/crccc2n6rxm3nb3qymbprzpjrqz69p9k-source/modules/nixos/deployment.nix

lollypops.deployment.local-evaluation

Evaluate locally instead of on the remote when rebuilding

Type: boolean

Default: false

Declared by: - /nix/store/crccc2n6rxm3nb3qymbprzpjrqz69p9k-source/modules/nixos/deployment.nix

lollypops.deployment.ssh.command

Local SSH binary to use for remote connections.

The default value just uses the locally available ssh command.

Type: string

Default: "ssh"

Declared by: - /nix/store/crccc2n6rxm3nb3qymbprzpjrqz69p9k-source/modules/nixos/deployment.nix

lollypops.deployment.ssh.host

Host to deploy to

Type: string

Default: "nixos"

Declared by: - /nix/store/crccc2n6rxm3nb3qymbprzpjrqz69p9k-source/modules/nixos/deployment.nix

lollypops.deployment.ssh.login

SSH login command, combining the SSH binary, options and host.

This is used to run commands on the remote server. Also you can use it to connect to the remote server interactively, e.g.:

$ nix run --impure .#nixosConfigurations.<hostName>.config.lollypops.deployment.ssh.login -- hostname
<hostName>

Type: package (read only)

Default: <derivation lollypops-login>

Declared by: - /nix/store/crccc2n6rxm3nb3qymbprzpjrqz69p9k-source/modules/nixos/deployment.nix

lollypops.deployment.ssh.opts

Options to pass to the configured SSH command

Type: list of string

Default:

lib.optionals (cfg.ssh.user != null) ["-l" cfg.ssh.user]

Example:

[
  "-A"
]

Declared by: - /nix/store/crccc2n6rxm3nb3qymbprzpjrqz69p9k-source/modules/nixos/deployment.nix

lollypops.deployment.ssh.run

Command to run on the remote host, combining the SSH login command and optional sudo command.

This is used to run commands on the remote server. Also you can use it to run commands on the remote server, e.g.:

$ nix run --impure .#nixosConfigurations.<hostName>.config.lollypops.deployment.ssh.run -- whoami
root

Type: package

Default: <derivation lollypops-run>

Declared by: - /nix/store/crccc2n6rxm3nb3qymbprzpjrqz69p9k-source/modules/nixos/deployment.nix

lollypops.deployment.ssh.user

Remote user to deploy as.

Leave empty to try to login remotely with a user named like the current local user.

Type: null or string

Default: null

Declared by: - /nix/store/crccc2n6rxm3nb3qymbprzpjrqz69p9k-source/modules/nixos/deployment.nix

lollypops.deployment.sudo.enable

Enables the use of sudo for deployment on remote servers

Type: boolean

Default: false

Declared by: - /nix/store/crccc2n6rxm3nb3qymbprzpjrqz69p9k-source/modules/nixos/deployment.nix

lollypops.deployment.sudo.command

Command to run for permission elevation

Type: string

Default: "sudo"

Declared by: - /nix/store/crccc2n6rxm3nb3qymbprzpjrqz69p9k-source/modules/nixos/deployment.nix

lollypops.deployment.sudo.opts

Options to pass to the configured sudo command

Type: list of string

Default: [ ]

Example:

[
  "--user=user"
]

Declared by: - /nix/store/crccc2n6rxm3nb3qymbprzpjrqz69p9k-source/modules/nixos/deployment.nix

lollypops.extraTasks

Extra tasks to run for the host. If any are defined with the same name as the default tasks (<literal>deploy-secrets</literal>, <literal>rebuild</literal>, <literal>deploy-flake</literal>) the original tasks will be overriden.

Type: attribute set of (submodule)

Default: { }

Declared by: - /nix/store/crccc2n6rxm3nb3qymbprzpjrqz69p9k-source/modules/nixos/tasks.nix

lollypops.extraTasks.<name>.cmds

Commands for the task.

Type: list of string

Declared by: - /nix/store/crccc2n6rxm3nb3qymbprzpjrqz69p9k-source/modules/nixos/tasks.nix

lollypops.extraTasks.<name>.deps

Dependencies for the task.

Type: list of string

Default: [ ]

Declared by: - /nix/store/crccc2n6rxm3nb3qymbprzpjrqz69p9k-source/modules/nixos/tasks.nix

lollypops.extraTasks.<name>.desc

Description for the task.

Type: string

Declared by: - /nix/store/crccc2n6rxm3nb3qymbprzpjrqz69p9k-source/modules/nixos/tasks.nix

lollypops.extraTasks.<name>.dir

Directory in which the task should run.

Type: absolute path or string

Default: "."

Declared by: - /nix/store/crccc2n6rxm3nb3qymbprzpjrqz69p9k-source/modules/nixos/tasks.nix

lollypops.secrets.cmd-name-prefix

Prefix to prepend to all name when passing to the cmd

Type: string

Default: ""

Declared by: - /nix/store/crccc2n6rxm3nb3qymbprzpjrqz69p9k-source/modules/common/secrets.nix

lollypops.secrets.default-cmd

Default command to retrieve passwords. Will be passed the name as parameter

Type: string

Default: "\${pkgs.pass}/bin/pass"

Declared by: - /nix/store/crccc2n6rxm3nb3qymbprzpjrqz69p9k-source/modules/common/secrets.nix

lollypops.secrets.default-dir

Path to place the secrets on the remote host if no alternative is specified

Type: string

Default: "/var/src/lollypops-secrets"

Declared by: - /nix/store/crccc2n6rxm3nb3qymbprzpjrqz69p9k-source/modules/common/secrets.nix

lollypops.secrets.files

Attribute set specifying secrets to be deployed

Type: attribute set of (submodule)

Default: { }

Declared by: - /nix/store/crccc2n6rxm3nb3qymbprzpjrqz69p9k-source/modules/common/secrets.nix

lollypops.secrets.files.<name>.cmd

Command to print the secret. E.g. cat mysecretfile

Type: string

Default: "<default-cmd> <vault-name>"

Declared by: - /nix/store/crccc2n6rxm3nb3qymbprzpjrqz69p9k-source/modules/common/secrets.nix

lollypops.secrets.files.<name>.group-name

Group of the secret file

Type: string

Default: "users"

Declared by: - /nix/store/crccc2n6rxm3nb3qymbprzpjrqz69p9k-source/modules/common/secrets.nix

lollypops.secrets.files.<name>.mode

Unix permission

Type: string

Default: "0400"

Declared by: - /nix/store/crccc2n6rxm3nb3qymbprzpjrqz69p9k-source/modules/common/secrets.nix

lollypops.secrets.files.<name>.name

Name of the secret

Type: string

Default: "<name>"

Declared by: - /nix/store/crccc2n6rxm3nb3qymbprzpjrqz69p9k-source/modules/common/secrets.nix

lollypops.secrets.files.<name>.owner

Owner of the secret file

Type: string

Default: "root"

Declared by: - /nix/store/crccc2n6rxm3nb3qymbprzpjrqz69p9k-source/modules/common/secrets.nix

lollypops.secrets.files.<name>.path

Path to place the secret file

Type: string

Default: "<default-dir>/<name>"

Declared by: - /nix/store/crccc2n6rxm3nb3qymbprzpjrqz69p9k-source/modules/common/secrets.nix

lollypops.secrets.files.<name>.vault-name

Name of the secret in the vault

Type: string

Default: "<cmd-name-prefix><name>"

Declared by: - /nix/store/crccc2n6rxm3nb3qymbprzpjrqz69p9k-source/modules/common/secrets.nix

lollypops.tasks

The list of tasks to run for each host.

Type: list of string

Default:

[
  "deploy-flake"
  "deploy-secrets"
  "rebuild"
]

Declared by: - /nix/store/crccc2n6rxm3nb3qymbprzpjrqz69p9k-source/modules/nixos/tasks.nix