doveadm-cluster-backend

NAME

doveadm-cluster-backend - Utility actions for Palomar backend

SYNOPSIS

doveadm [GLOBAL OPTIONS] cluster backend add [ --id id ] [ --site host ] --self | name

doveadm [GLOBAL OPTIONS] cluster backend remove --self | host

doveadm [GLOBAL OPTIONS] cluster backend update [ --status online|offline|standby ] [ --load-factor <0..100> ] --self | host

doveadm [GLOBAL OPTIONS] cluster backend evacuate --self | host

doveadm [GLOBAL OPTIONS] cluster backend status --self | host

doveadm [GLOBAL OPTIONS] cluster backend list

DESCRIPTION

doveadm cluster backend can be used to run actions that interact with and modify Palomar backends.

Command specific options

--self

Target the same host where the command is ran from. Uses cluster_backend_name setting as the host name.

COMMANDS

cluster backend add

doveadm [GLOBAL OPTIONS] cluster backend add [ --id id ] [ --site host ] --self | name

Adds a new backend to cluster. New backends are added in standby state. UUID should not be used unless you are re-adding the same backend.

name

Must be a resolvable DNS name. Unresolvable DNS names and IPv4/v6 literal addresses will be rejected.

cluster backend remove

doveadm [GLOBAL OPTIONS] cluster backend remove --self | host

Remove a backend from cluster.

cluster backend update

doveadm [GLOBAL OPTIONS] cluster backend update [ --status online|offline|standby ] [ --load-factor <0..100> ] --self | host

Updates a backend's information.

--status

See BACKEND STATUS

--load-factor

Load factor is the approximate amount of site load in percentage that this backend gets allocated. This value is not exact, and requires Palomar Cluster Controller to work correctly.

Recommended values are 100, 75, 50, 25 and 0. Setting it to 0 will indicate that backend should be drained in Cluster Controller.

cluster backend evacuate

doveadm [GLOBAL OPTIONS] cluster backend evacuate --self | host

Start moving all user groups to other backends. Will not wait for the moves to finish. Also sets the backend to standby and load factor to 0.

cluster backend status

doveadm [GLOBAL OPTIONS] cluster backend status --self | host

Shows the current status of the backend.

cluster backend list

doveadm [GLOBAL OPTIONS] cluster backend list [ --site host ]

Lists all backends in this cluster, including other sites. You can use optional --site parameter to specify site to list.

BACKEND STATUS

online

The backend is reachable and accepts connections.

offline

The backend is unreachable.

standby

The backend is reachable, but does not accept connections.

SEE ALSO

doveadm-cluster(1)