Skip to main content

cluster

Usage: pmc cluster [OPTIONS] COMMAND [ARGS]...

  Interacting with clusters

Options:
  -h, --help  Show this message and exit

Commands:
  list        List all existing clusters
  add         Create a new cluster that can hold containers with blockchains.
  request     Request system creating a new cluster
  info        Get information about a cluster
  containers  List all existing cluster containers
  provider    proposes an update of a cluster's providers. add = false =>
              remove provider from cluster. Cluster governance voter set has
              authority to update a cluster's providers
  limits      Propose new resource limits for given cluster. There are three
              types of limits. Proposal can contain one, two, or all three
              types.
  remove      Propose removal of cluster. Command is irreversible
  replica     Cluster replica commands

The cluster command (pmc cluster) consists of sub-commands to interact with clusters. For example, list existing clusters, create new clusters, and remove clusters.

list​

Usage: pmc cluster list [OPTIONS]

  List all existing clusters

Options:
  -cfg, --config VALUE  Configuration file for PMC (overrides system
                        configuration)
  -h, --help            Show this message and exit

The list command (pmc cluster list) lists all the clusters.

add​

Usage: pmc cluster add [OPTIONS]

  Create a new cluster that can hold containers with blockchains.

Options:
  -cfg, --config VALUE      Configuration file for PMC (overrides system
                            configuration)
  -n, --name TEXT           Cluster name
  -a, --auto-generate-name  Set if cluster name should be autogenerated
                            (suppressed by -n)
  --voter-set VALUE         Name of voter set
  --pubkeys VALUE           Comma delimited list of public keys
  -g, --governor TEXT       Name of another voter set which can update this
                            cluster.
  -h, --help                Show this message and exit

The add command (pmc cluster add) creates a new cluster that can hold nodes with containers holding blockchains.

To add a cluster, you must provide:

  • The name of the cluster.
  • The name of the voter set.
  • The pubkeys of the providers will be included in the cluster.
  • The name of the governor.

info​

Usage: pmc cluster info [OPTIONS]

  Get information about a cluster

Options:
  -cfg, --config VALUE  Configuration file for PMC (overrides system
                        configuration)
  -n, --name TEXT       Cluster Name
  -h, --help            Show this message and exit

The info command (pmc provider info) shows the information about a cluster.

containers​

Usage: pmc cluster containers [OPTIONS]

  List all existing cluster containers

Options:
  -cfg, --config VALUE  Configuration file for PMC (overrides system
                        configuration)
  -n, --name TEXT       Cluster name
  -h, --help            Show this message and exit

The containers command (pmc cluster containers) lists all cluster containers.

provider​

Usage: pmc cluster provider [OPTIONS]

  proposes an update of a cluster's providers. add = false => remove provider
  from cluster. Cluster governance voter set has authority to update a
  cluster's providers

Options:
  -cfg, --config VALUE      Configuration file for PMC (overrides system
                            configuration)
  -pk, --pubkey VALUE       Public key
  -c, --cluster TEXT        Name of existing cluster to update
  -a, --add / -r, --remove  Add or remove provider pubkey from cluster
  --description TEXT        Proposal description
  -h, --help                Show this message and exit

The provider command (pmc cluster provider) proposes an update to a cluster's providers.

Example usage:

pmc cluster provider --add --pubkey <pubkey> --cluster <cluster-name>

limits​

Usage: pmc cluster limits [OPTIONS]

  Propose new resource limits for given cluster. There are three types of
  limits. Proposal can contain one, two, or all three types.

Options:
  -cfg, --config VALUE        Configuration file for PMC (overrides system
                              configuration)
  -n, --name TEXT             Cluster name
  -mc, --max-containers INT   Max containers per cluster
  -mb, --max-blockchains INT  Max number of blockchains per container
  -c, --cpu INT               CPU limit (percent of cpus, 10 == 0.1 cpu(s),
                              150 == 1.5 cpu(s))
  -r, --ram INT               RAM limit (MiB)
  -s, --storage INT           Storage limit (MiB)
  -ir, --io-read INT          Disk I/O read limit (MiB/s)
  -iw, --io-write INT         Disk I/O write limit (MiB/s)
  --description TEXT          Proposal description
  -h, --help                  Show this message and exit

The limits command (pmc cluster limits) proposes a set of new resource limits for a cluster. There are several types of limitations; the maximum number of containers in the cluster, the maximum number of blockchains in the container, CPU limits, RAM limit, and storage limit.

remove​

Usage: pmc cluster remove [OPTIONS]

  Propose removal of cluster. Command is irreversible

Options:
  -cfg, --config VALUE  Configuration file for PMC (overrides system
                        configuration)
  -n, --name TEXT       Cluster name to remove
  --description TEXT    Proposal description
  -h, --help            Show this message and exit

The remove command (pmc node remove) proposes the removal of a cluster.