replictl is a command line tool to interact with Replicante
and the clusters it manages.
Compatibility between different
replictland Replicante versions is not guaranteed.
In general the same version should be used for both the cluster and
replictl --help to explore available commands and sub-commands.
Authentication and authorization support are not currently implemented.
They are on the roadmap (because of course they are) and will be implemented as soon as possible.
Because of that, some concepts such as Single-Sign On have been introduced even if they are not complete.
To know which Replicante Core instance to connect to and how to interact with it,
replictl uses contexts.
This allows users to create a context for each instance they manage and switch among them when needed.
Context are created, changed, selected and removed with the commands in
One of the foundational ideas is that generic tasks not tailored to a specific cluster
(such as performing some
should be transferable from one scope (namespace, cluster, node) to another.
To make this easier
replictl supports scope attributes:
clustercan set or override set cluster to operate on.
namespacecan set or override the namespace to operate on.
nodecan set or override the node to operate on.
Contexts can store a default value for scope attributtes so they don’t need to be repeated
replictl context change).
replictl scope attributes can be set or overridden with the command line:
--clusterfor the cluster.
--namespacefor the namespace.
--nodefor the node.
On top of the command line arguments above scope attributes can be set using environment variables:
RCTL_CLUSTERto set or override the
RCTL_NAMESPACEto set or override the
RCTL_NODEto set or override the
The command line tool also supports and additional
RCTL_CONTEXT environment variable to
specify an available context to use.