ptk template

ptk template generates a configuration template.

Syntax

ptk template [flags]

Example

# Generate a local single instance configuration template.
ptk template -l > CONFIG.yaml

# Generate a configuration template for multi-instance clusters.
ptk template > CONFIG.yaml

# Customise the values of some of the configuration fields.
ptk template -n <CLUSTER_NAME> -u <OS_USER> -g <OS_USERGROUP> -d <BASE_DIR> -p <DB_PORT> > CONFIG.yaml

Option

-d, --base-dir string

• Description: specifies the root directory of the database to be installed.
• Data type: string
• Default value: /home/kylin/mogdb

-n, --cluster-name string

• Description: specifies the cluster name. It is generated randomly by default.
• Data type: string
• Default value: ""

-g, --group string

• Description: specifies the system user group.
• Data type: string
• Default value: kylin

-l, --local

• Description: generates the configuration file used for installing a database locally.
• Data type: boolean
• Default value: false

-p, --port int

• Description: specifies the database port.
• Data type: integer
• Default value: 26000

-u, --user string

• Description: specifies the system user name.
• Data type: string
• Default value: kylin

Option Inherited from the Parent Command

--disable-color

• Description: Disable color logs.
• Data type: bool
• Default value: false

--disable-debug-log

• Description: not generate debug log files.
• Data type: bool
• Default value: false

--disable-progressbar

• Description: No progress bar globally.
• Data type: bool
• Default value: false

-h, --help

• Description: outputs the help information for template.
• Data type: boolean
• Default value: false

--log-file string

• Description: specifies the file path to which the run log is stored.
• Data type: string
• Default value: ""

--log-format string

• Description: specifies the output format of a run log. The value can be text and json.
• Data type: string
• Default value: text

--log-level string

• Description: specifies the run log level. The value can be debug, info, warning, error, and panic.
• Data type: string
• Default value: info

--silence

• Description: Logs are not printed to standard output.
• Data type: bool
• Default value: false

--skip-fix-ssh

• Description: skips SSH connection fixing through interaction.

• Data type: boolean

• Default value: false

Added Version

v0.2

More Command

• ptk - A provisioning toolkit for MogDB.
• ptk template create - Creates a configuration file in an interactive way.
• ptk template mogha - Generates MogHA configuration.
• ptk template scale-out - Generates scale-out configuration.