Chapter 10. The tpm Deployment Command

Table of Contents

10.1. Processing Installs and Upgrades
10.2. tpm INI File Configuration
10.2.1. Creating an INI file
10.2.2. Installation with INI File
10.2.3. Upgrades with an INI File
10.2.4. Configuration Changes with an INI file
10.3. Converting from Staging to INI
10.3.1. Using the translatetoini.pl Script
10.4. tpm Staging Configuration
10.4.1. Configuring default options for all services
10.4.2. Configuring a single service
10.4.3. Configuring a single host
10.4.4. Reviewing the current configuration
10.4.5. Installation
10.4.6. Upgrades from a Staging Directory
10.4.7. Configuration Changes from a Staging Directory
10.5. tpm Commands
10.5.1. tpm ask Command
10.5.2. tpm check Command
10.5.3. tpm configure Command
10.5.4. tpm connector Command
10.5.5. tpm copy Command
10.5.6. tpm delete-service Command
10.5.7. tpm diag Command
10.5.8. tpm fetch Command
10.5.9. tpm firewall Command
10.5.10. tpm find-seqno Command
10.5.11. tpm generate-haproxy-for-api Command
10.5.12. tpm help Command
10.5.13. tpm install Command
10.5.14. tpm mysql Command
10.5.15. tpm policy Command
10.5.16. tpm post-process Command
10.5.17. tpm promote-connector Command
10.5.18. tpm purge-thl Command
10.5.19. tpm query Command
10.5.20. tpm report Command
10.5.21. tpm reverse Command
10.5.22. tpm uninstall Command
10.5.23. tpm update Command
10.5.24. tpm validate Command
10.5.25. tpm validate-update Command
10.6. tpm Common Options
10.7. tpm Validation Checks
10.8. tpm Configuration Options
10.8.1. A tpm Options
10.8.2. B tpm Options
10.8.3. C tpm Options
10.8.4. D tpm Options
10.8.5. E tpm Options
10.8.6. F tpm Options
10.8.7. H tpm Options
10.8.8. I tpm Options
10.8.9. J tpm Options
10.8.10. L tpm Options
10.8.11. M tpm Options
10.8.12. N tpm Options
10.8.13. O tpm Options
10.8.14. P tpm Options
10.8.15. R tpm Options
10.8.16. S tpm Options
10.8.17. T tpm Options
10.8.18. U tpm Options
10.8.19. W tpm Options

tpm, or the Tungsten Package Manager, is a complete configuration, installation and deployment tool for Tungsten Clustering. It includes some utility commands to simplify those and other processes. In order to provide a stable system, all configuration changes must be completed using tpm. tpm makes use of ssh enabled communication and the sudo support as required by the Appendix B, Prerequisites.

For deployments, tpm operates by use of an INI file, typically /etc/tungsten/tungsten.ini.

tpm uses the INI file to configure the service on the local host. The INI file must be created on each host that will run Tungsten Clustering. tpm only manages the services on the local host; in a multi-host deployment, upgrades, updates, and configuration must be handled separately on each host.

Important

In older releases, a Staging deployment method was available.

For backwards compatability, this is still supported however it will be deprecated in a future release and therefore it is not recommended for new deployments. Existing deployments should be converted when possible. See Section 10.3, “Converting from Staging to INI” for details on converting.

Within a staging configuration a tpm configuration is created by defining the command-line arguments that define the deployment type, structure and any additional parameters. tpm then installs all the software on all the required hosts by using ssh to distribute Tungsten Clustering and the configuration, and optionally automatically starts the services on each host. tpm manages the entire deployment, configuration and upgrade procedure.

During installation and updates, the tpm tool works as follows:

  • tpm reads the local configuration file that contains the basic configuration information required by tpm. This configuration declares the basic parameters, such as the list of hosts, topology requirements, username and password information. These parameters describe top-level information, which tpm translates into more detailed configuration according to the topology and other settings.

  • Each host is accessed if possible (using ssh), and various checks are performed, for example, checking database configuration, whether certain system parameters match required limits, and that the environment is suitable for running Tungsten Clustering.

  • During an installation or upgrade, tpm copies the software to the releases direcotry within the location defined by install-directory.

  • During a new installation, a number of other directories are created, and the release is symlinked to the core running directory tungsten

  • The core configuration file is then used to translate a number of template files within the configuration of each component of the system into the configuration properties files used by Tungsten.

  • The components of Tungsten Clustering are then started (installation) or restarted according to the configuration options.

This method of operation ensures:

  • Active configurations and properties are not updated until validation is completed. This prevents a running installation from being affected by an incompatible or potentially dangerous change to the configuration.

  • Services are not stopped/restarted unnecessarily.

  • During an upgrade or update, the time required to reconfigure and restart is kept to a minimum.

Because of this safe approach to performing configuration, downtime is minimized, and the configuration is always based on files that are separate from, and independent of, the live configuration.

Important

tpm always creates the active configuration from the combination of the template files and parameters given to tpm. This means that changes to the underlying property files within the configuration are overwritten by tpm when the service is configured or updated.

In addition to the commands that tpm supports for the installation and configuration, the command also supports a number of other utility and information modes, for example, the tpm reverse and tpm query commands return information about an active configuration.

Using tpm is divided up between the commands that define the operation the command will perform, which are covered in Section 10.5, “tpm Commands”; and configuration options, which determine the parameters that configure individual services, which are detailed in Section 10.8, “tpm Configuration Options”.