All calls to tpm will follow a similar structure, made up of the command, which defines the type of operation, and one or more options.
shell> tpm command [sub command] [tpm options] [command options]
The command options will vary for each command. The core tpm options are:
Table 10.1. tpm Core Options
Option | Description |
---|---|
--force , -f | Do not display confirmation prompts or stop the configure process for errors |
--help , -h | Displays help message |
--info , -i | Display info, notice, warning and error messages |
--notice , -n | Display notice, warning and error messages |
--preview , -p | Displays the help message and preview the effect of the command line options |
--profile | Sets name of config file |
--quiet , -q | Only display warning and error messages |
--verbose , -v | Display debug, info, notice, warning and error messages |
− --force
Forces the deployment process to complete even if there are warning or error messages that would normally cause the process to fail. Forcing the installation also ignores all confirmation prompts during installation and always attempts to complete the process.
− --help
Displays the help message for tpm showing the current options, commands and version information.
− --info
Changes the reporting level to include information, notice,
warning and error messages. Information level messages include
annotations of the current process and stage in the deployment,
such as configuration or generating files and configurations.
This shows slightly more information than the default, but less
than the full debug level offered by
--verbose
.
− --notice
Sets the output level to include notice, warning, and error messages. Notice level messages include information about further steps or actions that should be taken, or things that should be noted without indicating a failure or error with the configuration options select.
Displays the help message and preview the effect of the command line options.
Specify the name of the configuration file to be used, e.g.
tpm profile /tmp/config.sh
.
This can be useful if you are performing multiple configurations or
deployments from the same staging directory. The entire
configuration and deployment information is stored in the file
before installation is started. By specifying a different file
you can have multiple deployments and configurations without
requiring separate staging directories.
− --quiet
Changes the error reporting level so that only warning and error messages are displayed. This mode can be useful in automated deployments as it provides output only when a warning or error exists. All other messages, including informational ones, are suppressed.
Displays a much more detailed output of the status and progress of the deployment. In verbose mode, tpm annotates the entire process describing both what it is doing and all debug, warning and other messages in the output.
The tpm utility handles all operations from installation to updates and upgrades, and also provides a number of useful post-installation commands that can be used to simplify common administration operations.
The installation process starts in a staging directory. This is different
from the installation directory where Tungsten Cluster will ultimately be
placed but may be a sub-directory. In most cases we will install to
/opt/continuent
but use
/opt/continuent/software
as a
staging directory. The release package should be unpacked in the staging
directory before proceeding. See the Section B.2, “Staging Host Configuration”
for instructions on selecting a staging directory.
Table 10.2. tpm Commands
Option | Description |
---|---|
ask | Ask tpm to provide values from the common configuration |
configure | Configure a data service within the global configuration |
connector | Open a connection to the configured connector using mysql |
copy | Automates the act of copying the shared SSL keys generated during installation to other cluster nodes as part of the post-installation workflow. |
delete-service | Delete a replication service or a composite datasource |
diag | Obtain diagnostic information |
fetch | Fetch configuration information from a running service |
find-seqno | Assists with locating event information in the THL and producing a dsctl set command as output. |
firewall | Display firewall information for the configured services |
generate-haproxy-for-api | Generates a correctly formatted haproxy configuration block for use with Tungsten Dashboard v1 |
help | Show command help information |
install | Install a data service based on the existing and runtime parameters |
mysql | Open a connection to the configured MySQL server |
policy | Display and optionally set the cluster policy. |
post-process | Reset the THL for a host |
promote-connector | Restart the connectors in the active configuration |
purge-thl | Reset the THL for a host |
query | Query the active configuration for information |
report | Generate a security report for all available communication channels on a per-node basis |
reverse | Show you the commands required to rebuild the configuration for the current directory. |
uninstall | Uninstall software from host(s) |
update | Update an existing configuration or software version |
validate | Validate the current configuration |
validate-update | Validate the current configuration and update |