diff --git a/product/en/docs-ptk/v2.0/commands/ptk-cluster-createdb.md b/product/en/docs-ptk/v2.0/commands/ptk-cluster-createdb.md new file mode 100644 index 0000000000000000000000000000000000000000..1c29dc68f410d2c7fe53cb3b1f1f36767f187830 --- /dev/null +++ b/product/en/docs-ptk/v2.0/commands/ptk-cluster-createdb.md @@ -0,0 +1,146 @@ +--- +title: dist/docs/commands/ptk-cluster-createdb.md +summary: dist/docs/commands/ptk-cluster-createdb.md +author: ptk +date: 2024-08-29T18:48:05+08:00 +--- + +# ptk cluster createdb + +Create Database + +## Syntax + +```bash +ptk cluster createdb [flags] +``` + +## Example + +```bash +# Create Database +ptk cluster -n createdb --dbname +[--owner ] [--encoding ] [--lc-collate ] +[--lc-type ] [--compatibility ] +[--tablespace ] [--connlimit ] +``` + +## Option + +### --compatibility string + +* Description: Database compatibility +* Data type: string +* Default value: "A" + +### --connlimit int + +* Description: CONNECTION LIMIT of database +* Data type: int +* Default value: 0 + +### --dbname string + +* Description: Database name +* Data type: string +* Default value: "" + +### --encoding string + +* Description: ENCODING of database +* Data type: string +* Default value: "" + +### --lc-collate string + +* Description: LC_COLLATE of database +* Data type: string +* Default value: "" + +### --lc-type string + +* Description: LC_TYPE of database +* Data type: string +* Default value: "" + +### --owner string + +* Description: OWNER of database +* Data type: string +* Default value: "" + +### --tablespace string + +* Description: TABLESPACE of database +* Data type: string +* Default value: "" + +## Option Inherited from the Parent Command + +### --disable-color + +* Description: Disable color logging +* Data type: bool +* Default value: false + +### --disable-debug-log + +* Description: Do not generate debug log files +* Data type: bool +* Default value: false + +### --disable-progressbar + +* Description: Progress bar not shown globally +* Data type: bool +* Default value: false + +### -h, --help + +* Description: Print help information +* Data type: bool +* Default value: false + +### --log-file string + +* Description: Specify the path to the runlog file +* Data type: string +* Default value: "" + +### --log-format string + +* Description: Specify the output format of the runlog, options: [text, json]. +* Data type: string +* Default value: "text" + +### --log-level string + +* Description: Specify the runtime log level, options: [debug, info, warning, error, panic]. +* Data type: string +* Default value: "info" + +### -n, --name string + +* Description: Cluster name +* Data type: string +* Default value: "" + +### --silence + +* Description: Does not print logs to standard output +* Data type: bool +* Default value: false + +### --skip-fix-ssh + +* Description: No need to repair ssh connections interactively +* Data type: bool +* Default value: false + +## Added Version + +v1.7 + +## More Command + +* [ptk cluster](./ptk-cluster.md) - Manage cluster diff --git a/product/en/docs-ptk/v2.0/commands/ptk-cluster-install-compat-tools.md b/product/en/docs-ptk/v2.0/commands/ptk-cluster-install-compat-tools.md new file mode 100644 index 0000000000000000000000000000000000000000..8fce6f2aa7e2df25faadfdef8030ec2d1eb4cc18 --- /dev/null +++ b/product/en/docs-ptk/v2.0/commands/ptk-cluster-install-compat-tools.md @@ -0,0 +1,106 @@ +--- +title: dist/docs/commands/ptk-cluster-install-compat-tools.md +summary: dist/docs/commands/ptk-cluster-install-compat-tools.md +author: ptk +date: 2024-08-29T18:48:05+08:00 +--- + +# ptk cluster install-compat-tools + +Install compat-tools + +## Syntax + +```bash +ptk cluster install-compat-tools [flags] +``` + +## Example + +```bash +ptk cluster -n install-compat-tools -d --dir +``` + +## Option + +### -d, --dbname string + +* Description: Specify the database to install compat-tools on +* Data type: string +* Default value: "" + +### --dir string + +* Description: Specify the local directory for compat-tools +* Data type: string +* Default value: "" + +## Option Inherited from the Parent Command + +### --disable-color + +* Description: Disable color logging +* Data type: bool +* Default value: false + +### --disable-debug-log + +* Description: Do not generate debug log files +* Data type: bool +* Default value: false + +### --disable-progressbar + +* Description: Progress bar not shown globally +* Data type: bool +* Default value: false + +### -h, --help + +* Description: Print help information +* Data type: bool +* Default value: false + +### --log-file string + +* Description: Specify the path to the runlog file +* Data type: string +* Default value: "" + +### --log-format string + +* Description: Specify the output format of the runlog, options: [text, json]. +* Data type: string +* Default value: "text" + +### --log-level string + +* Description: Specify the runtime log level, options: [debug, info, warning, error, panic]. +* Data type: string +* Default value: "info" + +### -n, --name string + +* Description: Cluster name +* Data type: string +* Default value: "" + +### --silence + +* Description: Does not print logs to standard output +* Data type: bool +* Default value: false + +### --skip-fix-ssh + +* Description: No need to repair ssh connections interactively +* Data type: bool +* Default value: false + +## Added Version + +v1.7 + +## More Command + +* [ptk cluster](./ptk-cluster.md) - Manage cluster diff --git a/product/en/docs-ptk/v2.0/commands/ptk-cluster-install-mogha.md b/product/en/docs-ptk/v2.0/commands/ptk-cluster-install-mogha.md index 76a979e39c99dc796f6fd0e2e8626a5c1906aef3..f79894ba86ad4ea5a73b005212884525b6827ea8 100644 --- a/product/en/docs-ptk/v2.0/commands/ptk-cluster-install-mogha.md +++ b/product/en/docs-ptk/v2.0/commands/ptk-cluster-install-mogha.md @@ -45,7 +45,7 @@ ptk cluster -n install-mogha -c node.conf [-y] [-p install-mogila -d --dir +``` + +## Option + +### --db-user string + +* Description: Create a database user for mogila +* Data type: string +* Default value: "" + +### -d, --dbname string + +* Description: Specify the database where you want to install mogila +* Data type: string +* Default value: "" + +### --dir string + +* Description: Specify the local directory for mogila +* Data type: string +* Default value: "" + +## Option Inherited from the Parent Command + +### --disable-color + +* Description: Disable color logging +* Data type: bool +* Default value: false + +### --disable-debug-log + +* Description: Do not generate debug log files +* Data type: bool +* Default value: false + +### --disable-progressbar + +* Description: Progress bar not shown globally +* Data type: bool +* Default value: false + +### -h, --help + +* Description: Print help information +* Data type: bool +* Default value: false + +### --log-file string + +* Description: Specify the path to the runlog file +* Data type: string +* Default value: "" + +### --log-format string + +* Description: Specify the output format of the runlog, options: [text, json]. +* Data type: string +* Default value: "text" + +### --log-level string + +* Description: Specify the runtime log level, options: [debug, info, warning, error, panic]. +* Data type: string +* Default value: "info" + +### -n, --name string + +* Description: Cluster name +* Data type: string +* Default value: "" + +### --silence + +* Description: Does not print logs to standard output +* Data type: bool +* Default value: false + +### --skip-fix-ssh + +* Description: No need to repair ssh connections interactively +* Data type: bool +* Default value: false + +## Added Version + +v1.7 + +## More Command + +* [ptk cluster](./ptk-cluster.md) - Manage cluster diff --git a/product/en/docs-ptk/v2.0/commands/ptk-cluster-scale-out.md b/product/en/docs-ptk/v2.0/commands/ptk-cluster-scale-out.md index 7e9c5557e17d87ed503721b346c097d4a8ae6793..b79a6b1d395283570c8be7a97acd2be056310567 100644 --- a/product/en/docs-ptk/v2.0/commands/ptk-cluster-scale-out.md +++ b/product/en/docs-ptk/v2.0/commands/ptk-cluster-scale-out.md @@ -68,6 +68,12 @@ ptk cluster -n scale-out -c scale-out.yaml --build-from - Data type: boolean - Default value: **false** +### --skip-check-hostname + +- Description: skips hostname check. +- Data type: bool +- Default value: **false** + ### --skip-check-os - Description: skips system check. diff --git a/product/en/docs-ptk/v2.0/commands/ptk-cluster-takeover.md b/product/en/docs-ptk/v2.0/commands/ptk-cluster-takeover.md index 928053040b9f2933ee9e091175870af3264b8215..2e95406fbcc898d1b152e5f6d22ac474129f1cce 100644 --- a/product/en/docs-ptk/v2.0/commands/ptk-cluster-takeover.md +++ b/product/en/docs-ptk/v2.0/commands/ptk-cluster-takeover.md @@ -18,11 +18,11 @@ ptk cluster takeover [flags] ## Example ```bash -ptk cluster -n takeover [-H|--host ][-U|--user ] +ptk cluster -n takeover [-H|--host ][--db-user ][--ssh-user ] [-i|--identity ] [--appdir ] [--datadir ] [--logdir ] [--tmpdir ] [--tooldir ] # For example: -ptk cluster -n takeover -H -U +ptk cluster -n takeover -H --db-user ``` ## Option @@ -51,6 +51,12 @@ ptk cluster -n takeover -H -U * Data type: int * Default value: 0 +### --db-user string + +* Description: Operating system user running the database +* Data type: string +* Default value: "" + ### -H, --host string * Description: Specify the host of the takeover node @@ -69,21 +75,21 @@ ptk cluster -n takeover -H -U * Data type: string * Default value: "" -### --tmpdir string +### --ssh-user string -* Description: Tmp dir of db server +* Description: SSH login user * Data type: string * Default value: "" -### --tooldir string +### --tmpdir string -* Description: Tool dir of db server +* Description: Tmp dir of db server * Data type: string * Default value: "" -### -U, --username string +### --tooldir string -* Description: Specify the user to takeover the node +* Description: Tool dir of db server * Data type: string * Default value: "" diff --git a/product/en/docs-ptk/v2.0/commands/ptk-cluster-uninstall-compat-tools.md b/product/en/docs-ptk/v2.0/commands/ptk-cluster-uninstall-compat-tools.md new file mode 100644 index 0000000000000000000000000000000000000000..8da7b24bc5c787cf27a557b407ef7e44f1d75aa1 --- /dev/null +++ b/product/en/docs-ptk/v2.0/commands/ptk-cluster-uninstall-compat-tools.md @@ -0,0 +1,106 @@ +--- +title: dist/docs/commands/ptk-cluster-uninstall-compat-tools.md +summary: dist/docs/commands/ptk-cluster-uninstall-compat-tools.md +author: ptk +date: 2024-08-29T18:48:05+08:00 +--- + +# ptk cluster uninstall-compat-tools + +Uninstall compat-tools + +## Syntax + +```bash +ptk cluster uninstall-compat-tools [flags] +``` + +## Example + +```bash +ptk cluster -n uninstall-compat-tools -d --dir +``` + +## Option + +### -d, --dbname string + +* Description: Specify the database to uninstall compat-tools from +* Data type: string +* Default value: "" + +### --dir string + +* Description: Specify the local directory for compat-tools +* Data type: string +* Default value: "" + +## Option Inherited from the Parent Command + +### --disable-color + +* Description: Disable color logging +* Data type: bool +* Default value: false + +### --disable-debug-log + +* Description: Do not generate debug log files +* Data type: bool +* Default value: false + +### --disable-progressbar + +* Description: Progress bar not shown globally +* Data type: bool +* Default value: false + +### -h, --help + +* Description: Print help information +* Data type: bool +* Default value: false + +### --log-file string + +* Description: Specify the path to the runlog file +* Data type: string +* Default value: "" + +### --log-format string + +* Description: Specify the output format of the runlog, options: [text, json]. +* Data type: string +* Default value: "text" + +### --log-level string + +* Description: Specify the runtime log level, options: [debug, info, warning, error, panic]. +* Data type: string +* Default value: "info" + +### -n, --name string + +* Description: Cluster name +* Data type: string +* Default value: "" + +### --silence + +* Description: Does not print logs to standard output +* Data type: bool +* Default value: false + +### --skip-fix-ssh + +* Description: No need to repair ssh connections interactively +* Data type: bool +* Default value: false + +## Added Version + +v1.7 + +## More Command + +* [ptk cluster](./ptk-cluster.md) - Manage cluster diff --git a/product/en/docs-ptk/v2.0/commands/ptk-cluster.md b/product/en/docs-ptk/v2.0/commands/ptk-cluster.md index 5b19df8cadd92d89d314a8a8c508696f05707e21..a5d1b01d0696dbf6862625d9f2abb1bcf6e15c22 100644 --- a/product/en/docs-ptk/v2.0/commands/ptk-cluster.md +++ b/product/en/docs-ptk/v2.0/commands/ptk-cluster.md @@ -89,14 +89,17 @@ v0.1 * [ptk](./ptk.md) - A provisioning toolkit for MogDB. * [ptk cluster add-kerberos-auth](./ptk-cluster-add-kerberos-auth.md) - Adds kerberos authentication. * [ptk cluster build](./ptk-cluster-build.md) - Rebuilds data from database instance. +* [ptk cluster createdb](./ptk-cluster-createdb.md) - Ctrate database. * [ptk cluster del-kerberos-auth](./ptk-cluster-del-kerberos-auth.md) - Deletes kerberos authentication. * [ptk cluster demote](./ptk-cluster-demote.md) - Demotes a database role from primary to standby, or from standby to cascade standby. * [ptk cluster failover](./ptk-cluster-failover.md) - Makes a standby database become a primary database. * [ptk cluster gen-cert-files](./ptk-cluster-gen-cert-files.md) - Generates SSL certificate file. * [ptk cluster inspect](./ptk-cluster-inspect.md) - Returns cluster information. * [ptk cluster install-cm](./ptk-cluster-install-cm.md) - Installs CM. +* [ptk cluster install-compat-tools](./ptk-cluster-install-compat-tools.md) - Install compat-tools. * [ptk cluster install-kerberos-server](./ptk-cluster-install-kerberos-server.md) - Installs a kerberos server. * [ptk cluster install-mogha](./ptk-cluster-install-mogha.md) - Installs MogHA for MogDB. +* [ptk cluster install-mogila](./ptk-cluster-install-mogila.md) - Installs mogila sample data. * [ptk cluster install-plugin](./ptk-cluster-install-plugin.md) - Installs MogDB plugins. * [ptk cluster is-in-upgrade](./ptk-cluster-is-in-upgrade.md) - Checks whether a cluster is in upgrade. * [ptk cluster list-plugins](./ptk-cluster-list-plugins.md) - Lists the plugins in the cluster. @@ -121,6 +124,7 @@ v0.1 * [ptk cluster takeover](./ptk-cluster-takeover.md) - Takeover a new server to PTK metadata. * [ptk cluster throwout](./ptk-cluster-throwout.md) - Remove a server from PTK metadata. * [ptk cluster uninstall-cm](./ptk-cluster-uninstall-cm.md) - Uninstall CM. +* [ptk cluster uninstall-compat-tools](./ptk-cluster-uninstall-compat-tools.md) - Uninstall compat-tools. * [ptk cluster uninstall-kerberos-server](./ptk-cluster-uninstall-kerberos-server.md) - Uninstalls a kerberos server. * [ptk cluster uninstall-mogha](./ptk-cluster-uninstall-mogha.md) - Uninstalls MogHA. * [ptk cluster upgrade](./ptk-cluster-upgrade.md) - Upgrades the database version of a cluster. diff --git a/product/en/docs-ptk/v2.0/commands/ptk-demo.md b/product/en/docs-ptk/v2.0/commands/ptk-demo.md index 6b535d7c200ae584b3f65cb55ba3490a8f39e155..16cf2d9e5ebfa5209cac33b0077e4a189618dabc 100644 --- a/product/en/docs-ptk/v2.0/commands/ptk-demo.md +++ b/product/en/docs-ptk/v2.0/commands/ptk-demo.md @@ -19,11 +19,17 @@ ptk demo [flags] ```bash ptk demo -ptk demo -p +ptk demo -p --base-dir ``` ## Option +### --base-dir string + +* Description: Specify the directory where the database will be installed. +* Data type: string +* Default value: "" + ### --compat-tools-dir string * Description: specifies the directory of compat-tools. diff --git a/product/en/docs-ptk/v2.0/commands/ptk-download.md b/product/en/docs-ptk/v2.0/commands/ptk-download.md index 69981add5c1ee54f7c12a9b98989b7f1b5b13139..23b955931ccece5693ae5b41849aa2e0b15370d4 100644 --- a/product/en/docs-ptk/v2.0/commands/ptk-download.md +++ b/product/en/docs-ptk/v2.0/commands/ptk-download.md @@ -40,7 +40,7 @@ ptk download --db-version 5.0.5 This flag only support MogDB. - Data type: string -- Default value: **5.0.7** +- Default value: **5.0.8** ### --dest-dir string diff --git a/product/en/docs-ptk/v2.0/commands/ptk-gen-static-config.md b/product/en/docs-ptk/v2.0/commands/ptk-gen-static-config.md index 06d2176ab38e18ebb0204fd9ed1c9b1ab12d9027..a7108b92ad0ddbf6abf867a0b816ace01fe6a61f 100644 --- a/product/en/docs-ptk/v2.0/commands/ptk-gen-static-config.md +++ b/product/en/docs-ptk/v2.0/commands/ptk-gen-static-config.md @@ -7,7 +7,7 @@ date: 2024-06-04T17:04:56+08:00 # ptk gen-static-config -`ptk gen-static-config` generates a new cluster static file using the specified YAML configuration file and distribute it to the data nodes. +`ptk gen-static-config` specify the cluster to create the static file and distribute it to the instance nodes. ## Syntax @@ -18,15 +18,14 @@ ptk gen-static-config [flags] ## Example ```bash -ptk gen-static-config -f -ptk distribute -f +ptk gen-static-config -n ``` ## Option -### -f, --file string +### -n, --clustername string -* Description: specifies the cluster configuration file. +* Description: specifies the cluster name. * Data type: string * Default value: "" diff --git a/product/en/docs-ptk/v2.0/commands/ptk-install.md b/product/en/docs-ptk/v2.0/commands/ptk-install.md index 28b9c3dd45cf0b4535afd52976148e02855b9dfe..1da416064cab4e2154eb557628747ac4a4be9bf5 100644 --- a/product/en/docs-ptk/v2.0/commands/ptk-install.md +++ b/product/en/docs-ptk/v2.0/commands/ptk-install.md @@ -63,6 +63,12 @@ ptk install -f -p -y --skip-check-os --comment - Data type: string - Default value: "" +### --db-conf-file string + +* Description: Specify a custom database parameter configuration file in the same format as postgresql.conf +* Data type: string +* Default value: "" + ### --db-version string - Description: Specify the database package version if use online package @@ -71,7 +77,7 @@ ptk install -f -p -y --skip-check-os --comment This flag only support MogDB - Data type: string -- Default value: **5.0.7** +- Default value: **5.0.8** ### --default-guc @@ -141,7 +147,13 @@ ptk install -f -p -y --skip-check-os --comment ### --skip-check-distro -- Description: skips the system distro check. +- Description: skips checking system distributions. +- Data type: boolean +- Default value: **false** + +### --skip-check-hostname + +- Description: skips checking hostname. - Data type: boolean - Default value: **false** diff --git a/product/en/docs-ptk/v2.0/commands/ptk-manage.md b/product/en/docs-ptk/v2.0/commands/ptk-manage.md index 4fe10f85a9a23988e059104c9e7cc543f360c90a..e8cd463a695064e5a4d0d61c9e8765bbe0f62ba4 100644 --- a/product/en/docs-ptk/v2.0/commands/ptk-manage.md +++ b/product/en/docs-ptk/v2.0/commands/ptk-manage.md @@ -35,6 +35,12 @@ ptk manage --clustername -H -U * Data type: string * Default value: "" +### --ssh-port int + +* Description: specifies the SSH port. +* Data type: int +* Default value: 22 + ### -U, --username string * Description: specifies the operating system user running the database. diff --git a/product/en/docs-ptk/v2.0/commands/ptk-template-create.md b/product/en/docs-ptk/v2.0/commands/ptk-template-create.md index ee03e9fb2e3db6128104ae48447677cfd6fbe884..629c4d448deb01f60256917cebb6b2065d07cdce 100644 --- a/product/en/docs-ptk/v2.0/commands/ptk-template-create.md +++ b/product/en/docs-ptk/v2.0/commands/ptk-template-create.md @@ -18,7 +18,7 @@ ptk template create [flags] ## Example ```bash -ptk template create [-o CONFIG.yaml] +ptk template create [-o CONFIG.yaml] [--tui] ``` ## Option @@ -33,7 +33,7 @@ ptk template create [-o CONFIG.yaml] - Description: specifies the name of the output file. - Data type: string -- Default value: "config.2024-06-04T17_04_56.yaml" +- Default value: "config..yaml" ## Option Inherited from the Parent Command diff --git a/product/en/docs-ptk/v2.0/commands/ptk-register.md b/product/en/docs-ptk/v2.0/commands/ptk-view-static-config.md similarity index 32% rename from product/en/docs-ptk/v2.0/commands/ptk-register.md rename to product/en/docs-ptk/v2.0/commands/ptk-view-static-config.md index a1c2b325c85864214fa45462740396aa144ca8fd..dfd8952298d2403a3ff71ab59cd8b13f6a7ac39a 100644 --- a/product/en/docs-ptk/v2.0/commands/ptk-register.md +++ b/product/en/docs-ptk/v2.0/commands/ptk-view-static-config.md @@ -1,83 +1,100 @@ --- -title: ptk register -summary: ptk register +title: dist/docs/commands/ptk-view-static-config.md +summary: dist/docs/commands/ptk-view-static-config.md author: ptk -date: 2023-01-12T15:49:05+08:00 +date: 2024-08-29T18:48:05+08:00 --- -# ptk register +# ptk view-static-config -> ! This command is deprecated and will be removed in future release. - -`ptk register` registers internal PTK types to meet special requirements. +Show parsed static file content. ## Syntax ```bash -ptk register [flags] +ptk view-static-config [flags] +``` + +## Example + +```bash +ptk view-static-config -f [--raw] ``` +## Option + +### --file string + +* Description: Specify local static file +* Data type: string +* Default value: "" + +### --raw + +* Description: Show the original content of the static file +* Data type: bool +* Default value: false + ## Option Inherited from the Parent Command ### --disable-color -* Description: Disable color logs. +* Description: Disable color logging * Data type: bool * Default value: false ### --disable-debug-log -* Description: not generate debug log files. +* Description: Do not generate debug log files * Data type: bool * Default value: false ### --disable-progressbar -* Description: No progress bar globally. +* Description: Progress bar not shown globally * Data type: bool * Default value: false ### -h, --help -* Description: outputs the help information for metadata. -* Data type: boolean -* Default value: **false** +* Description: Print help information +* Data type: bool +* Default value: false ### --log-file string -* Description: specifies the file path to which the run log is stored. +* Description: Specify the path to the runlog file * Data type: string * Default value: "" ### --log-format string -* Description: specifies the output format of a run log. The value can be **text** and **json**. +* Description: Specify the output format of the runlog, options: [text, json]. * Data type: string -* Default value: **text** +* Default value: "text" ### --log-level string -* Description: specifies the run log level. The value can be **debug**, **info**, **warning**, **error**, and **panic**. +* Description: Specify the runtime log level, options: [debug, info, warning, error, panic]. * Data type: string -* Default value: **info** +* Default value: "info" ### --silence -* Description: Logs are not printed to standard output. +* Description: Does not print logs 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** +* Description: No need to repair ssh connections interactively +* Data type: bool +* Default value: false ## Added Version -v0.4 +v1.7 ## More Command -* [ptk](./ptk.md) - A provisioning toolkit for MogDB. +* [ptk](./ptk.md) - Provisioning Toolkit for MogDB diff --git a/product/en/docs-ptk/v2.0/commands/ptk.md b/product/en/docs-ptk/v2.0/commands/ptk.md index 0c346515c4b7fe6c2df347990d7b67ae7f2f2bec..5d06419ea4b98c7b2b2c0a2ef43ccbc34317c2b7 100644 --- a/product/en/docs-ptk/v2.0/commands/ptk.md +++ b/product/en/docs-ptk/v2.0/commands/ptk.md @@ -97,15 +97,15 @@ ptk [flags] [args...] * [ptk exec](./ptk-exec.md) - Executes a shell command or script. * [ptk gen-om-xml](./ptk-gen-om-xml.md) - Generates a XML configuration file of gs_om. * [ptk gen-ptkc](./ptk-gen-ptkc.md) - Generates a ptkc binary file. -* [ptk gen-static-config](./ptk-gen-static-config.md) - Generates a new cluster static file with the specified YAML configuration file and distribute it to the data nodes. +* [ptk gen-static-config](./ptk-gen-static-config.md) - Specify the cluster to create the static file and distribute it to the instance nodes. * [ptk init-cluster](./ptk-init-cluster.md) - Generates a new empty cluster. * [ptk install](./ptk-install.md) - Installs a MogDB or Uqbar database cluster. * [ptk ls](./ptk-ls.md) - Lists all MogDB database clusters. * [ptk manage](./ptk-manage.md) - Manages the existing cluster. * [ptk meta](./ptk-meta.md) - Manages PTK metadata. * [ptk rec-guc](./ptk-rec-guc.md) - Shows the list of optimisation parameters. -* [ptk register](./ptk-register.md) - Registers internal PTK types to meet special requirements. * [ptk self](./ptk-self.md) - Specifies PTK itself operation. * [ptk template](./ptk-template.md) - Generates a configuration template. * [ptk uninstall](./ptk-uninstall.md) - Uninstalls a database cluster. * [ptk version](./ptk-version.md) - Prints the PTK version. +* [ptk view-static-config](./ptk-view-static-config.md) - Show parsed static file content. diff --git a/product/en/docs-ptk/v2.0/guide/guide-install-cluster.md b/product/en/docs-ptk/v2.0/guide/guide-install-cluster.md index 4995855cd233689dfacdf0e15c58bdc9a26ddb16..ad32288233e31fd6f4a9f4a03aeb5eec83fd6807 100644 --- a/product/en/docs-ptk/v2.0/guide/guide-install-cluster.md +++ b/product/en/docs-ptk/v2.0/guide/guide-install-cluster.md @@ -39,7 +39,13 @@ Of course, if you are under the mandatory requirements of enterprise security, y omm hard stack unlimited ``` -3. Fill in the `ssh_option` section of the configuration file with the login information for the user you created +3. Change the SSH login user to `omm` in the `ssh_option` section of the configuration file. + + ``` + ssh_option: + user: omm + ... + ``` > Note: If you use a non-superuser for cluster management, some commands that rely on superprivileges will not be available later, such as `install-mogha`. diff --git a/product/en/docs-ptk/v2.0/guide/manage-cluster/manage-cluster-install-plugin.md b/product/en/docs-ptk/v2.0/guide/manage-cluster/manage-cluster-install-plugin.md index 03d6d20b2b3ce6f54599c5c5d9ae18f154189cbd..fd5c5e0b90120db74067384bbf41129c33ebfd42 100644 --- a/product/en/docs-ptk/v2.0/guide/manage-cluster/manage-cluster-install-plugin.md +++ b/product/en/docs-ptk/v2.0/guide/manage-cluster/manage-cluster-install-plugin.md @@ -80,7 +80,7 @@ CREATE Extension **When to use**: -1. Wish to use a different version of plugin with the current version of the database. +1. Need to test installing plugins that do not match the current database version. 2. If there is no corresponding plugin package released for a particular MogDB version, you can use this option to skip the validation and install another version of the plugin. ### Can I uninstall a plugin that is already installed? diff --git a/product/en/docs-ptk/v2.0/guide/manage-cluster/manage-cluster-scale-in.md b/product/en/docs-ptk/v2.0/guide/manage-cluster/manage-cluster-scale-in.md index 0651334cb43a4de9d9f14b5db81ce3c141c495a9..ca3e6f79f8ca082ecdc7f3d2e525bcc8c8189b02 100644 --- a/product/en/docs-ptk/v2.0/guide/manage-cluster/manage-cluster-scale-in.md +++ b/product/en/docs-ptk/v2.0/guide/manage-cluster/manage-cluster-scale-in.md @@ -20,7 +20,7 @@ ptk cluster -n scale-in [-H|--host HOST] [-i|--id ID] [--skip-cle ## Sample Topology Before And After Scale-in -- One primary N standby and M cascade +### One primary N standby and M cascade The original cluster topology is as follows: @@ -46,7 +46,7 @@ At this point, `standby2` is not in the cluster, and the upstream of the downstr PTK implementation: If the target node role is `standby`, if the node has downstream nodes and there are other `standby` nodes, then all the downstream nodes of the node to be scaled-in will point to the rest of the `standby` nodes in the upstream. -- One primary one standby and one cascade +### One primary one standby and one cascade The original cluster topology is as follows: @@ -72,7 +72,7 @@ Yes. Please refer to [Cluster Scale-out](./manage-cluster-scale-out.md). No, you cannot. After a scale-out, the cluster will have at least one available data node. -To get an empty cluster, see [Create Empty Cluster](./manage-cluster-init-empty-clsuter.md), or refer to [Throwout Node](./manage-cluster-throwout.md). +To get an empty cluster, see [Create Empty Cluster](./manage-cluster-init-empty-cluster.md), or refer to [Throwout Node](./manage-cluster-throwout.md). ### Can I directly scale-in the primary node? diff --git a/product/en/docs-ptk/v2.0/reference/ref-config.md b/product/en/docs-ptk/v2.0/reference/ref-config.md index 193ca20b5352cc05ebb2db03303f16730bb43939..8abde53296a8fec301a22744ba5f1bfd354e577c 100644 --- a/product/en/docs-ptk/v2.0/reference/ref-config.md +++ b/product/en/docs-ptk/v2.0/reference/ref-config.md @@ -7,19 +7,19 @@ date: 2024-04-09T09:59:28+08:00 # Configuration -The PTK topology configuration file is in the [YAML format](../appendix/yaml-grammar.md). +The PTK configuration file is in the [YAML format](../appendix/yaml-grammar.md). This file describes all the parameters of the topology configuration file. When installing a database cluster, a user-supplied configuration file describing the cluster topology is required to tell PTK what structure the cluster should follow. -PTK provides the ability to create profiles interactively, and the interactive process can be accessed by running the following command: +PTK provides the ability to create configuration files graphically in the terminal, and the interactive process can be accessed by running the following command: ```shell ptk template create --tui ``` -You just need to follow the steps prompted by the terminal step by step to complete the configuration, and the config.yaml file will eventually be generated in the current folder. +You just need to follow the steps prompted by the terminal step by step to complete the configuration, and the config.xx.yaml file will eventually be generated in the current folder. Alternatively, if you want to generate a file with the default configuration without using interactive creation, you can run the following command: @@ -32,7 +32,8 @@ After running this command, the system will generate a config.yaml file, and you For non-interactive modification, sensitive fields such as user_password, db_password, ssh_option.password or ssh_option.passphrase must be encrypted using the encryption command provided by PTK. ```shell -ptk encrypt PASSWORD +// It is recommended to wrap the string to be encrypted in single quotes to avoid escaping it. +ptk encrypt '' ``` --- @@ -54,8 +55,6 @@ global: db_servers: - host: # IP address of the database instance server (only supporting IPv4) - host: # IP address of the database instance server (only supporting IPv4) -# CM server list in a cluster -cm_servers: [] ``` - Complex configuration @@ -79,7 +78,6 @@ global: cm_option: dir: /opt/mogdb/cm # CM installation directory cm_server_port: 15300 # Listening port of the CM server - db_service_vip: "" # Virtual IP address for the database to provide service. # Configuration information of database instance servers in a cluster db_servers: - host: # IP address of the database instance server (only supporting IPv4) @@ -116,10 +114,8 @@ db_servers: cm_servers: - host: # IP address of the CM server (only IPv4 is supported.) port: 15300 # Listening port of the CM server - role: "" - host: # IP address of the CM server (only IPv4 is supported.) port: 15300 # Listening port of the CM server - role: "" ``` ### global @@ -521,22 +517,6 @@ Appears in: **Added in**: v1.1.0 -### cm_voting_vg_path - -**Data type**: string - -**Description**: CM voting volume path. - -**Added in**: v1.1.0 - -### cm_share_vg_path - -**Data type**: string - -**Description**: CM shared volume path. - -**Added in**: v1.1.0 - ### inst_vg_map **Data type**: map[string]string @@ -569,27 +549,89 @@ inst_vg_map: **Added in**: v1.1.0 -### inter_connect_type +### interconnect_type **Data type**: string -**Description**: Internal MES communication protocol type +**Description**: DSS inter-process communication method. **Default Value**: TCP **Range**: TCP/RDMA -**Added in**: v1.1.0 +**Added in**: v1.7.2 -### ss_guc_config +### interconnect_channel_num -**Data type**: map[string]string +**Data type**: int -**Description**: Resource pooling GUC parameter configuration. +**Description**: DSS Number of inter-process communication channels. -**Range**: See [openGauss docs](https://docs.opengauss.org/zh/docs/5.0.0/docs/DatabaseReference/%E8%B5%84%E6%BA%90%E6%B1%A0%E5%8C%96%E5%8F%82%E6%95%B0.html) +**Default Value**: 2 -**Added in**: v1.1.0 +**Range**: [1, 32] + +**Added in**: v1.7.2 + +### work_thread_count + +**Data type**: int + +**Description**: Number of threads processing communication messages. + +**Default Value**: 2 + +**Range**: [2, 64] + +**Added in**: v1.7.2 + +### io_threads + +**Data type**: int + +**Description**: Number of working thread pools in the DSS process. + +**Default Value**: 2 + +**Range**: [1, 8] + +**Added in**: v1.7.2 + +### work_threads + +**Data type**: int + +**Description**: Number of threads in each thread pool in the DSS process. + +**Default Value**: 16 + +**Range**: [16, 128] + +**Added in**: v1.7.2 + +### storage_mode + +**Data type**: string + +**Description**: Storage type. + +**Default Value**: CLUSTER_RAID + +**Range**: CLUSTER_RAID、RAID、DISK、DISK_LOCK + +**Added in**: v1.7.2 + +### max_session_nums + +**Data type**: int + +**Description**: Maximum number of session connections supported by the DSS process. + +**Default Value**: 8192 + +**Range**: [16, 166320] + +**Added in**: v1.7.2 --- @@ -661,6 +703,22 @@ cm_agent_conf: **Added in**: v0.4 +### cm_voting_vg_path + +**Data type**: string + +**Description**: CM voting volume path (used in resource pooling scenarios). + +**Added in**: v1.7.2 + +### cm_share_vg_path + +**Data type**: string + +**Description**: CM shared volume path (used in resource pooling scenarios). + +**Added in**: v1.7.2 + --- ## CMServer diff --git a/product/en/docs-ptk/v2.0/release-notes/release-16x.md b/product/en/docs-ptk/v2.0/release-notes/release-16x.md index 4fcb70d864de4423c7f19c23bf66f3843f66a07a..21903a7f994d7c99351c62227d36d3ad86c35669 100644 --- a/product/en/docs-ptk/v2.0/release-notes/release-16x.md +++ b/product/en/docs-ptk/v2.0/release-notes/release-16x.md @@ -7,6 +7,12 @@ date: 2024-07-16 # 1.6 Release Note +## 1.6.3 (2024-08-12) + +**Bug Fixes** + +- **checkos:** Fix the misrecognition of package management commands in system repair commands for some operating systems. + ## 1.6.2 (2024-07-31) **Features** diff --git a/product/en/docs-ptk/v2.0/release-notes/release-17x.md b/product/en/docs-ptk/v2.0/release-notes/release-17x.md new file mode 100644 index 0000000000000000000000000000000000000000..29953400c5e48f2558644a1f3a6bf4af38e91875 --- /dev/null +++ b/product/en/docs-ptk/v2.0/release-notes/release-17x.md @@ -0,0 +1,64 @@ +--- +title: v1.7 Release Note +summary: v1.7 Release Note +author: Yao Qian +date: 2024-08-30 +--- + +# 1.7 Release Note + +## 1.7.4 (2024-10-31) + +**Features** + +- Added MogDB 5.0.9 download configuration. + +## 1.7.3 (2024-10-15) + +**Features** + +- **checkos**: Adjust the python3 checksum level from warning to normal. + +**Bug Fixes** + +- **upgrade**: Fixes an issue where upgrading to version 5.0.7 fails after rolling back the upgrade. +- **exec**: Remove role checking for exec commands so that they can be used to execute scripts or commands with scale-out configurations. +- **template**: Fix the problem that some buttons in the English version of the GUI are not fully displayed. + +## 1.7.2 (2024-09-24) + +**Features** + +- **template**: add `--tui` parameter to create sub-command, support terminal graphical creation of configuration files +- **install**: add ifconfig permission checking and auto-completion when deploying CM cluster. +- **internal**: Support sudo command by password for SSH server with password login. + +## 1.7.1 (2024-09-04) + +**Bug Fixes** + +- **install**: Fix md5 check error in installer, add confirmation interaction. +- **install**: Fix the error of LD_LIBRARY_PATH setting introduced in 1.7.0. + +## 1.7.0 (2024-08-30) + +**Features** + +- **cluster**: Added `install-mogila` command to support installation of [mogila sample data](https://gitee.com/enmotech/mogila) +- **cluster**: Added `install-compat-tools` command to support installation of [compat-tools](https://gitee.com/enmotech/compat-tools) +- **cluster**: Added `createdb` command to support database creation via PTK. +- Added `view-static-config` command to view static file contents. +- **install**: New `--db-conf-file` parameter in install command, support user to pass customized database parameters through file. +- **upgrade**: Add CPU architecture consistency check between current cluster and target package before upgrade. +- **checkos**: add `en_US.UTF-8` character set necessity check for unicode check items. +- **takeover**: Deprecates `--user` parameter and adds `--db-user` and `-ssh-user` parameters. +- **manage**: Add `--ssh-port` parameter. +- **scaleout**: Scale-out new nodes to modify only the necessary server-related parameters, and inherit the existing configuration of other nodes as much as possible. +- **gen-static-config**: deprecates `-f` parameter, adds `-n` parameter, allows operation of PTK-managed clusters only +- Optimize the PATH variable in the .ptk_mogdb_env file to explicitly fill in the system default directory to ensure that system tools can be retrieved. + +**Bug Fixes** + +- **upgrade**: Fixes an issue where SQL execution reports read-only errors when upgrading a patched database. +- **upgrade**: Fix an issue where upgrade fails due to old PTK metadata before upgrade. +- **scaleout**: Fix an occasional problem that occurs during scale-out when the standby node is built and reports that the hba information does not exist. diff --git a/product/en/docs-ptk/v2.0/samples/samples-double-ip.md b/product/en/docs-ptk/v2.0/samples/samples-double-ip.md index 118b905f4fc1d96ebb9dc8b2f5b3c1befdee9015..c2831479c85a0687e5ba1a57ba1b4c4ee9754274 100644 --- a/product/en/docs-ptk/v2.0/samples/samples-double-ip.md +++ b/product/en/docs-ptk/v2.0/samples/samples-double-ip.md @@ -6,7 +6,9 @@ date: 2024-06-14 # Dual Network Segment -## One Primary and One Standby +Dual-segment control is supported in the `ha_ips` field of each server in `db_servers`, which currently only supports up to one redundant IP, which must be on the same server as the `host` field. + +> ! Note: If dual segment is configured, it must be configured on all servers, not some machines. ```yaml global: @@ -22,13 +24,6 @@ global: db_port: 26000 # Database installation base directory base_dir: /data/mogdb - # SSH connection configuration - ssh_option: - port: 22 - user: root - password: "" # ptk encrypt password - key_file: "" - passphrase: "" db_servers: - host: