- Overview
- Quick Start
- Install PTK
- Usage
- Configuration
- Config Samples
- Commands
- ptk
- ptk completion
- ptk register
- ptk init-cluster
- ptk collect
- ptk rec-guc
- ptk cache
- ptk gen-ptkc
- ptk manage
- ptk demo
- ptk meta
- ptk version
- ptk self
- ptk gen-om-xml
- ptk env
- ptk gen-static-config
- ptk cluster
- ptk cluster rename
- ptk cluster throwout
- ptk cluster takeover
- ptk cluster uninstall-cm
- ptk cluster install-cm
- ptk cluster gen-cert-files
- ptk cluster load-cm-vip
- ptk cluster del-kerberos-auth
- ptk cluster add-kerberos-auth
- ptk cluster uninstall-kerberos-server
- ptk cluster install-kerberos-server
- ptk cluster is-in-upgrade
- ptk cluster upgrade-rollback
- ptk cluster upgrade-commit
- ptk cluster upgrade
- ptk cluster demote
- ptk cluster promote
- ptk cluster refresh
- ptk cluster shell
- ptk cluster modify-comment
- ptk cluster show-config
- ptk cluster set-guc
- ptk cluster show-guc
- ptk cluster set-hba
- ptk cluster show-hba
- ptk cluster scale-out
- ptk cluster scale-in
- ptk cluster uninstall-mogha
- ptk cluster install-mogha
- ptk cluster list-plugins
- ptk cluster install-plugin
- ptk cluster inspect
- ptk cluster failover
- ptk cluster switchover
- ptk cluster build
- ptk cluster status
- ptk cluster restart
- ptk cluster stop
- ptk cluster start
- ptk uninstall
- ptk ls
- ptk install
- ptk exec
- ptk template
- ptk encrypt
- ptk checkos
- ptk download
- ptk candidate
- Troubleshooting
- FAQ
- Release Note
- GPTK - Graphical Deployment Tool
- Community
- Appendix: YAML Syntax
Installation
PTK is a provisioning toolkit. It does not need to be installed on the same server together with a database instance.
It is recommended that a management server is used to install PTK and deploy database instances on other servers. In this way, you can avoid PTK unavailability due to the failure of the database instance machine.
Online Installation
Note: Command line installation does not support PTK installed on Windows.
You can run the following command to install PTK on macOS or Linux operating systems.
curl --proto '=https' --tlsv1.2 -sSf https://cdn-mogdb.enmotech.com/ptk/install.sh | sh
After running the command, PTK is automatically installed in the $HOME/.ptk
directory where cache files, data files, cluster configuration files, and backup files are stored. Additionally, the $HOME/.ptk/bin
directory will be automatically updated to the environment variable of the corresponding Shell profile file. After login, you can run the ptk-related commands.
Offline Installation
If the server where PTK is to be installed cannot be connected to the external network or you need to install PTK on Windows, you can manually install PTK.
Perform the following operations to install PTK manually:
Step 1: Download the installation package corresponding to your server on your PC from the following link page.
🔗 https://www.mogdb.io/downloads/ptk/all
Step 2: Send the installation package to the target server on the intranet.
Step 3: Decompress the package to obtain a binary file named ptk
(executable file of PTK) and move the file to a directory ($HOME/.ptk/bin/
is recommended and it needs to be manually created) as you need. Update the directory to the PTK PATH environment variable.
mkdir -p $HOME/.ptk/bin/
tar -xvf <PTK.tar.gz> -c $HOME/.ptk/bin/
echo 'export PATH=$HOME/.ptk/bin:$PATH' >> ~/.bashrc
source ~/.bashrc
PTK Upgrade
For offline installation, download the latest installation package to cover the binary file on the server to upgrade PTK.
For online installation, run the following command to upgrade PTK.
ptk self upgrade