add_subcluster

Adds a new subcluster to an Eon Mode database.

Adds a new subcluster to an Eon Mode database. For details, see Creating subclusters.

Syntax

vcluster add_subcluster options

Required options

--catalog-path string
The absolute path to the catalog directory.
{ -c | --config } string
The path to the config file. If a configuration file is present in the default location (automatically generated by create_db), you do not need to specify this option.

Default: /opt/vertica/config/vertica_cluster.yaml

--subcluster string
The name of the new subcluster. This string must conform to the format used for database names.

Options

--cert-file string
The absolute path to the certificate file. If you specify this option, you must also specify --key-file. You should only use --cert-file and --key-file if you have configured the Node Management Agent (NMA) to use custom certificates.
--control-set-size int
The number of control nodes in the subcluster.

Default: -1 (All nodes in the subcluster are control nodes)

--data-path string
The absolute path to the data directory. This should be the same for all nodes in the database.
--depot-path string
[Eon only] The absolute path to depot directory.
--depot-size string
[Eon only] Size of depot in one of the following formats:
  • integer{K|M|G|T}, where K is kilobytes, M is megabytes, G is gigabytes, and T is terabytes.
  • integer%, which expresses the depot size as a percentage of the total disk size.
--force-removal
Whether to delete any existing database directories in the new hosts before attempting to add them.
{ -h | --help }
Prints help text.
--ipv6
Whether the hosts use IPv6 addresses. Hostnames resolve to IPv4 by default.
--is-primary
Whether the new subcluster should be a primary subcluster. If this option is omitted, new subclusters are secondary.
--key-file string
Path to the key file. If you specify this option, you must also specify --cert-file. You should only use --cert-file and --key-file if you have configured the Node Management Agent (NMA) to use custom certificates.
{ -l | --log-path } string
The absolute path for debug logs.

Default: /opt/vertica/log/vcluster.log

--new-hosts string[,...]
A comma-separated list of hosts or IP addresses to add to the subcluster.
{ -p | --password } string
The database password.
--password-file string
The absolute path to a file containing the database password.

If you pass a dash(-) (that is, `--password-file -`), the password is read from STDIN.

--read-password-from-prompt
Prompts the user to enter the password.
--skip-rebalance-shards
[Eon only] Whether to skip shard rebalancing.
--verbose
Shows the details of VCluster run in the console.

Examples

To add a primary subcluster with one control node:

$ vcluster add_subcluster --subcluster sc1 \
  --config /opt/vertica/config/vertica_cluster.yaml \
  --is-primary --control-set-size 1

To add a secondary subcluster with one control node containing the new node 192.0.2.4:

$ vcluster add_subcluster --subcluster sc1 \
  --control-set-size 1 --new-hosts 192.0.2.4