Chapter 9. The tpm Deployment Command

Table of Contents

9.1. Processing Installs and Upgrades
9.2. tpm INI File Configuration
9.2.1. Creating an INI file
9.2.2. Installation with INI File
9.2.3. Upgrades with an INI File
9.2.4. Configuration Changes with an INI file
9.3. Converting from Staging to INI
9.3.1. Using the translatetoini.pl Script
9.4. tpm Staging Configuration
9.4.1. Configuring default options for all services
9.4.2. Configuring a single service
9.4.3. Configuring a single host
9.4.4. Reviewing the current configuration
9.4.5. Installation
9.4.6. Upgrades from a Staging Directory
9.4.7. Configuration Changes from a Staging Directory
9.5. tpm Commands
9.5.1. tpm ask Command
9.5.2. tpm cert Command
9.5.3. tpm check Command
9.5.4. tpm configure Command
9.5.5. tpm delete-service Command
9.5.6. tpm diag Command
9.5.7. tpm fetch Command
9.5.8. tpm firewall Command
9.5.9. tpm find-seqno Command
9.5.10. tpm help Command
9.5.11. tpm install Command
9.5.12. tpm keep Command
9.5.13. tpm mysql Command
9.5.14. tpm ports Command
9.5.15. tpm post-process Command
9.5.16. tpm purge-thl Command
9.5.17. tpm query Command
9.5.18. tpm report Command
9.5.19. tpm reverse Command
9.5.20. tpm uninstall Command
9.5.21. tpm update Command
9.5.22. tpm validate Command
9.5.23. tpm validate-update Command
9.6. tpm Common Options
9.7. tpm Validation Checks
9.8. tpm Configuration Options
9.8.1. A tpm Options
9.8.2. B tpm Options
9.8.3. C tpm Options
9.8.4. D tpm Options
9.8.5. E tpm Options
9.8.6. F tpm Options
9.8.7. H tpm Options
9.8.8. I tpm Options
9.8.9. J tpm Options
9.8.10. L tpm Options
9.8.11. M tpm Options
9.8.12. N tpm Options
9.8.13. O tpm Options
9.8.14. P tpm Options
9.8.15. R tpm Options
9.8.16. S tpm Options
9.8.17. T tpm Options
9.8.18. U tpm Options
9.8.19. V tpm Options
9.8.20. W tpm Options

tpm, or the Tungsten Package Manager, is a complete configuration, installation and deployment tool for Tungsten Replicator. 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 Replicator. 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 9.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 Replicator 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.

  • 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 Tunsten.

  • The components of Tungsten Replicator 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 9.5, “tpm Commands”; and configuration options, which determine the parameters that configure individual services, which are detailed in Section 9.8, “tpm Configuration Options”.