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.│
│              This cluster will not be tracked by economy chain and nodes    │
│              running in it will not be rewarded. To create a cluster that is│
│              managed by economy chain please see command: 'pmc economy      │
│              add-cluster'                                                   │
│  request     Request system creating a new cluster (is not supported after  │
│              version 29)                                                    │
│  info        Get information about a cluster                                │
│  containers  List all existing cluster containers                           │
│  provider    Proposes an update of a cluster's providers                    │
│  limits      Propose new resource limits for given cluster                  │
│  remove      Propose removal of cluster. Command is irreversible            │
│  verify      Verify cluster status                                          │
│  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.

cluster list​

Usage: pmc cluster list [OPTIONS]

  List all existing clusters

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│  -cfg, --config=CONFIG    Alternate path for client configuration file      │
│  -s, --settings=SETTINGS  Alternate path for project settings file          │
│  --lookup-brid            Ignore any 'brid' property in configuration file, │
│                           always perform lookup                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│  -i, --interactive  Prompt for item to show details for                     │
│  -h, --help         Show this message and exit                              │
╰─────────────────────────────────────────────────────────────────────────────╯

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

cluster add​

Usage: pmc cluster add [OPTIONS]

  Create a new cluster that can hold containers with blockchains. This cluster
  will not be tracked by economy chain and nodes running in it will not be
  rewarded. To create a cluster that is managed by economy chain please see
  command: 'pmc economy add-cluster'

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│  -cfg, --config=CONFIG    Alternate path for client configuration file      │
│  -s, --settings=SETTINGS  Alternate path for project settings file          │
│  --lookup-brid            Ignore any 'brid' property in configuration file, │
│                           always perform lookup                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│  -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           │
│  -clu, --cluster-units=INT    Cluster Units (minimum 1) (default: 1)        │
│  -es, --extra-storage=INT     Extra Storage (MiB) (default: 0)              │
│  -clcl, --cluster-class=TEXT  Cluster Class tag (for API v29-32)            │
│* -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.

cluster request​

Usage: pmc cluster request [OPTIONS]

  Request system creating a new cluster (is not supported after version 29)

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│  -cfg, --config=CONFIG    Alternate path for client configuration file      │
│  -s, --settings=SETTINGS  Alternate path for project settings file          │
│  --lookup-brid            Ignore any 'brid' property in configuration file, │
│                           always perform lookup                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│  -n, --name=TEXT           Cluster name                                     │
│  -a, --auto-generate-name  Set if cluster name should be autogenerated      │
│                            (suppressed by -n)                               │
│* --size=INT                Size of cluster to be created                    │
│  --require-full / --do-not-require-full                                     │
│                            Fail if cluster is not full                      │
│  -h, --help                Show this message and exit                       │
╰─────────────────────────────────────────────────────────────────────────────╯

The request command (pmc cluster request) requests the system to create a new cluster. You can specify the cluster name (-n), whether the cluster name should be autogenerated (-a, --auto-generate-name), the size of the cluster to be created (--size), and whether the cluster should require full capacity (--require-full / --do-not-require-full).

cluster info​

Usage: pmc cluster info [OPTIONS]

  Get information about a cluster

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│  -cfg, --config=CONFIG    Alternate path for client configuration file      │
│  -s, --settings=SETTINGS  Alternate path for project settings file          │
│  --lookup-brid            Ignore any 'brid' property in configuration file, │
│                           always perform lookup                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -n, --name=TEXT  Cluster Name                                              │
│  -h, --help       Show this message and exit                                │
╰─────────────────────────────────────────────────────────────────────────────╯

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

cluster containers​

Usage: pmc cluster containers [OPTIONS]

  List all existing cluster containers

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│  -cfg, --config=CONFIG    Alternate path for client configuration file      │
│  -s, --settings=SETTINGS  Alternate path for project settings file          │
│  --lookup-brid            Ignore any 'brid' property in configuration file, │
│                           always perform lookup                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -n, --name=TEXT  Cluster name                                              │
│  -h, --help       Show this message and exit                                │
╰─────────────────────────────────────────────────────────────────────────────╯

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

cluster provider​

Usage: pmc cluster provider [OPTIONS]

  Proposes an update of a cluster's providers

  To remove provider from cluster set --add to false. Cluster governance voter
  set has authority to update a cluster's providers

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│  -cfg, --config=CONFIG    Alternate path for client configuration file      │
│  -s, --settings=SETTINGS  Alternate path for project settings file          │
│  --lookup-brid            Ignore any 'brid' property in configuration file, │
│                           always perform lookup                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -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>

cluster limits​

Usage: pmc cluster limits [OPTIONS]

  Propose new resource limits for given cluster

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│  -cfg, --config=CONFIG    Alternate path for client configuration file      │
│  -s, --settings=SETTINGS  Alternate path for project settings file          │
│  --lookup-brid            Ignore any 'brid' property in configuration file, │
│                           always perform lookup                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -n, --name=TEXT             Cluster name                                   │
│  -clu, --cluster-units=INT   Cluster Units (minimum 1)                      │
│  -es, --extra-storage=INT    Extra Storage (MiB)                            │
│  --description=TEXT          Proposal description                           │
│  -mc, --max-containers=INT   Max containers per cluster (deprecated)        │
│  -mb, --max-blockchains=INT  Max number of blockchains per container        │
│                              (deprecated)                                   │
│  -c, --cpu=INT               CPU limit (percent of cpus, 10 == 0.1 cpu(s),  │
│                              150 == 1.5 cpu(s)) (deprecated)                │
│  -r, --ram=INT               RAM limit (MiB) (deprecated)                   │
│  -st, --storage=INT          Storage limit (MiB) (deprecated)               │
│  -ir, --io-read=INT          Disk I/O read limit (MiB/s) (deprecated)       │
│  -iw, --io-write=INT         Disk I/O write limit (MiB/s) (deprecated)      │
│  -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.

cluster remove​

Usage: pmc cluster remove [OPTIONS]

  Propose removal of cluster. Command is irreversible

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│  -cfg, --config=CONFIG    Alternate path for client configuration file      │
│  -s, --settings=SETTINGS  Alternate path for project settings file          │
│  --lookup-brid            Ignore any 'brid' property in configuration file, │
│                           always perform lookup                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -n, --name=TEXT     Cluster name to remove                                 │
│  --description=TEXT  Proposal description                                   │
│  -h, --help          Show this message and exit                             │
╰─────────────────────────────────────────────────────────────────────────────╯

The remove command (pmc cluster remove) proposes the removal of a cluster. It's important to note that this action is irreversible.

cluster verify​

Usage: pmc cluster verify [OPTIONS]

  Verify cluster status

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│  -cfg, --config=CONFIG    Alternate path for client configuration file      │
│  -s, --settings=SETTINGS  Alternate path for project settings file          │
│  --lookup-brid            Ignore any 'brid' property in configuration file, │
│                           always perform lookup                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -n, --name=TEXT  name of cluster                                           │
│  -h, --help       Show this message and exit                                │
╰─────────────────────────────────────────────────────────────────────────────╯

The verify command (pmc cluster verify) verifies the status of a specific cluster identified by its name (-n).

cluster replica​

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

  Cluster replica commands

╭─ Options ───────────────────────────────────────────────────────────────────╮
│  -h, --help  Show this message and exit                                     │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────╮
│  add     add replica of a cluster                                           │
│  remove  Remove replica of a cluster                                        │
╰─────────────────────────────────────────────────────────────────────────────╯

The replica command (pmc cluster replica) manages cluster replicas. It includes sub-commands for adding and removing replicas of a cluster.

cluster replica add​

Usage: pmc cluster replica add [OPTIONS]

  add replica of a cluster

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│  -cfg, --config=CONFIG    Alternate path for client configuration file      │
│  -s, --settings=SETTINGS  Alternate path for project settings file          │
│  --lookup-brid            Ignore any 'brid' property in configuration file, │
│                           always perform lookup                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -n, --name=TEXT      Cluster Name                                          │
│* -pk, --pubkey=VALUE  Public key                                            │
│  -h, --help           Show this message and exit                            │
╰─────────────────────────────────────────────────────────────────────────────╯

The replica add command (pmc cluster replica add) adds a replica of a cluster. You need to specify the cluster name (-n) and the public key of the replica (-pk, --pubkey).

cluster replica remove​

Usage: pmc cluster replica remove [OPTIONS]

  Remove replica of a cluster

╭─ Configuration Properties ──────────────────────────────────────────────────╮
│  -cfg, --config=CONFIG    Alternate path for client configuration file      │
│  -s, --settings=SETTINGS  Alternate path for project settings file          │
│  --lookup-brid            Ignore any 'brid' property in configuration file, │
│                           always perform lookup                             │
│  --network=TEXT           Target network to make requests to (if chromia.yml│
│                           is configured)                                    │
╰─────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────╮
│* -n, --name=TEXT      Cluster Name                                          │
│* -pk, --pubkey=VALUE  Public key                                            │
│  -h, --help           Show this message and exit                            │
╰─────────────────────────────────────────────────────────────────────────────╯

The replica remove command (pmc cluster replica remove) removes a replica of a cluster. You need to specify the cluster name (-n) and the public key of the replica (-pk, --pubkey).