Skip to main content

container

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

  Container commands

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

Commands:
  add     propose a new container in an existing cluster and give authority to
          deployer voter set to deploy bcs in it.
  info    Get information about a container
  limits  Propose new resource limits for given container There are three
          types of limits. Proposal can contain one, two, or all three types.
  list    List all existing containers
  remove  Propose removal of container. Command is irreversible

The container command (pmc container) consists of sub-commands to interact with containers. For example, list existing containers, create new containers, or remove containers.

add​

Usage: pmc container add [OPTIONS]

  propose a new container in an existing cluster and give authority to
  deployer voter set to deploy bcs in it.

Options:
  -cfg, --config VALUE      Configuration file for PMC (overrides system
                            configuration)
  -n, --name TEXT           Container name
  -a, --auto-generate-name  Set if container name should be autogenerated
                            (suppressed by -n)
  -c, --cluster TEXT        Name of cluster to put container in. Must exist in
                            database
  --consensus
  --voter-set VALUE         Name of voter set
  --pubkeys VALUE           Comma delimited list of public keys
  -h, --help                Show this message and exit

The add command (pmc container add) adds a container to an existing cluster. When creating a new container, a voter set is bound to the container, and members of the voter set get the authority to deploy blockchains. The voter set can either be an existing voter set or given by a comma-delimited list of public keys.

The consensus flag must be added if voting is applied to the container.

Example usage:

pmc container add --name <container-name> --cluster <cluster-name> --voter-set <name-of-voter-set>
pmc container add --auto-generated-name --cluster <cluster-name> --pubkeys <pubkey1>, <pubkey2>

limits​

Usage: pmc container limits [OPTIONS]

  Propose new resource limits for given container 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             Container name
  -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 container. The container has several limitations, such as the maximum number of blockchains, CPU limit, RAM limit, and storage limit.

Example usage:

pmc container limits --name <container-name> --max-blockchains 10 --cpu 50

list​

Usage: pmc container list [OPTIONS]

  List all existing containers

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

The list command (pmc container list) lists all the containers.

remove​

Usage: pmc container remove [OPTIONS]

  Propose removal of container. Command is irreversible

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

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