From a7d8ce6ee67599bc2f6e564edc988d6cad676fe7 Mon Sep 17 00:00:00 2001 From: li-jun056 <1255728208@qq.com> Date: Fri, 21 Aug 2020 14:25:42 +0800 Subject: [PATCH] update documents --- .../en/docs/Administratorguide/audit-logs.md | 6 - .../backup-and-restoration.md | 1461 +++++++++++++- .../docs/Administratorguide/check-method-0.md | 350 ---- .../docs/Administratorguide/check-method-2.md | 40 - .../docs/Administratorguide/check-method.md | 60 - .../checking-and-deleting-logs.md | 11 - .../checking-database-performance.md | 7 - .../checking-opengauss-health-status.md | 7 - .../checking-opengauss-run-logs.md | 111 - .../Administratorguide/checking-os-logs.md | 14 - .../checking-os-parameters.md | 7 - ...g-the-number-of-application-connections.md | 126 -- .../checking-time-consistency.md | 46 - .../Administratorguide/cleaning-run-logs.md | 25 - .../data-security-maintenance-suggestions.md | 23 - .../exception-handling-1.md | 370 ---- .../exception-handling-3.md | 124 -- .../Administratorguide/exception-handling.md | 106 - .../generating-configuration-files.md | 122 +- .../docs/Administratorguide/gs_basebackup.md | 125 -- content/en/docs/Administratorguide/gs_dump.md | 561 ------ .../en/docs/Administratorguide/gs_dumpall.md | 253 --- .../en/docs/Administratorguide/gs_restore.md | 387 ---- .../docs/Administratorguide/log-overview.md | 55 - .../docs/Administratorguide/log-reference.md | 183 +- .../logical-backup-and-restoration.md | 9 - .../docs/Administratorguide/operation-logs.md | 30 - .../en/docs/Administratorguide/overview.md | 103 - .../Administratorguide/performance-logs.md | 22 - .../physical-backup-and-restoration.md | 5 - .../Administratorguide/querying-status.md | 124 +- .../Administratorguide/risky-operations.md | 36 +- .../routine-maintenance-check-items.md | 170 -- .../Administratorguide/routine-maintenance.md | 1793 ++++++++++++++++- .../routinely-maintaining-tables.md | 106 - .../routinely-recreating-an-index.md | 64 - .../starting-and-stopping-opengauss.md | 124 +- .../en/docs/Administratorguide/system-logs.md | 25 - content/en/docs/Administratorguide/wals.md | 29 - ...)-setting-the-standby-node-to-readable.md} | 6 +- .../Quickstart/configuring-os-parameters.md | 493 ----- .../creating-an-xml-configuration-file.md | 164 +- ...onfiguring-the-installation-environment.md | 361 ---- .../establishing-mutual-trust-manually.md | 310 --- .../docs/Quickstart/executing-installation.md | 112 +- ...itializing-the-installation-environment.md | 1190 ++++++++++- .../docs/Quickstart/installation-process.md | 46 +- .../installation-user-and-user-group.md | 32 +- .../Quickstart/installing-the-opengauss.md | 4 +- ...g-and-verifying-an-installation-package.md | 6 +- .../Quickstart/preparing-for-installation.md | 2 +- ...e-and-hardware-installation-environment.md | 239 ++- .../Quickstart/verifying-the-installation.md | 8 +- ...l)-setting-the-standby-node-to-readable.md | 20 +- .../checking-the-health-status.md | 61 - .../completing-the-installation.md | 1 - ...n-file-for-primary-secondary-deployment.md | 47 - ...ion-file-for-single-instance-deployment.md | 37 - .../configurations-during-installation.md | 1 - .../installation/configuring-os-parameters.md | 503 ----- ...uring-primary-database-node-information.md | 90 - .../configuring-the-basic-host-information.md | 72 - ...onfiguring-the-locale-and-character-set.md | 119 -- .../creating-a-configuration-file.md | 15 - ... => creating-an-xml-configuration-file.md} | 389 +++- ...onfiguring-the-installation-environment.md | 361 ---- .../deleting-cluster-configurations.md | 92 - .../installation/disabling-the-os-firewall.md | 97 - .../installation/disabling-the-swap-memory.md | 8 - .../establishing-mutual-trust-manually.md | 310 --- content/en/docs/installation/examples.md | 7 - .../installation/executing-installation.md | 214 +- .../installation/executing-uninstallation.md | 54 - .../installation/initial-configuration.md | 7 - .../initializing-the-database.md | 2 +- ...itializing-the-installation-environment.md | 1204 ++++++++++- .../installation/installation-overview.md | 18 +- .../docs/installation/installation-process.md | 30 +- .../installation-user-and-user-group.md | 18 +- .../installation/installing-the-opengauss.md | 24 +- .../modifying-os-configuration.md | 13 - ...g-and-verifying-an-installation-package.md | 110 +- .../preparing-for-installation.md | 26 +- ...e-and-hardware-installation-environment.md | 324 ++- .../setting-character-set-parameters.md | 8 - .../setting-remote-login-of-user-root.md | 60 - .../docs/installation/setting-the-nic-mtu.md | 8 - .../setting-the-time-zone-and-time.md | 20 - .../software-and-hardware-requirements.md | 136 -- .../installation/starting-installation.md | 1 - .../uninstalling-the-opengauss.md | 159 +- .../verifying-the-installation.md | 66 +- content/en/menu/index.md | 79 +- 93 files changed, 7407 insertions(+), 7597 deletions(-) delete mode 100644 content/en/docs/Administratorguide/audit-logs.md delete mode 100644 content/en/docs/Administratorguide/check-method-0.md delete mode 100644 content/en/docs/Administratorguide/check-method-2.md delete mode 100644 content/en/docs/Administratorguide/check-method.md delete mode 100644 content/en/docs/Administratorguide/checking-and-deleting-logs.md delete mode 100644 content/en/docs/Administratorguide/checking-database-performance.md delete mode 100644 content/en/docs/Administratorguide/checking-opengauss-health-status.md delete mode 100644 content/en/docs/Administratorguide/checking-opengauss-run-logs.md delete mode 100644 content/en/docs/Administratorguide/checking-os-logs.md delete mode 100644 content/en/docs/Administratorguide/checking-os-parameters.md delete mode 100644 content/en/docs/Administratorguide/checking-the-number-of-application-connections.md delete mode 100644 content/en/docs/Administratorguide/checking-time-consistency.md delete mode 100644 content/en/docs/Administratorguide/cleaning-run-logs.md delete mode 100644 content/en/docs/Administratorguide/data-security-maintenance-suggestions.md delete mode 100644 content/en/docs/Administratorguide/exception-handling-1.md delete mode 100644 content/en/docs/Administratorguide/exception-handling-3.md delete mode 100644 content/en/docs/Administratorguide/exception-handling.md delete mode 100644 content/en/docs/Administratorguide/gs_basebackup.md delete mode 100644 content/en/docs/Administratorguide/gs_dump.md delete mode 100644 content/en/docs/Administratorguide/gs_dumpall.md delete mode 100644 content/en/docs/Administratorguide/gs_restore.md delete mode 100644 content/en/docs/Administratorguide/log-overview.md delete mode 100644 content/en/docs/Administratorguide/logical-backup-and-restoration.md delete mode 100644 content/en/docs/Administratorguide/operation-logs.md delete mode 100644 content/en/docs/Administratorguide/overview.md delete mode 100644 content/en/docs/Administratorguide/performance-logs.md delete mode 100644 content/en/docs/Administratorguide/physical-backup-and-restoration.md delete mode 100644 content/en/docs/Administratorguide/routine-maintenance-check-items.md delete mode 100644 content/en/docs/Administratorguide/routinely-maintaining-tables.md delete mode 100644 content/en/docs/Administratorguide/routinely-recreating-an-index.md delete mode 100644 content/en/docs/Administratorguide/system-logs.md delete mode 100644 content/en/docs/Administratorguide/wals.md rename content/en/docs/Quickstart/{optional-setting-the-standby-node-to-readable.md => (optional)-setting-the-standby-node-to-readable.md} (69%) delete mode 100644 content/en/docs/Quickstart/configuring-os-parameters.md delete mode 100644 content/en/docs/Quickstart/creating-the-required-user-account-and-configuring-the-installation-environment.md delete mode 100644 content/en/docs/Quickstart/establishing-mutual-trust-manually.md delete mode 100644 content/en/docs/installation/checking-the-health-status.md delete mode 100644 content/en/docs/installation/completing-the-installation.md delete mode 100644 content/en/docs/installation/configuration-file-for-primary-secondary-deployment.md delete mode 100644 content/en/docs/installation/configuration-file-for-single-instance-deployment.md delete mode 100644 content/en/docs/installation/configurations-during-installation.md delete mode 100644 content/en/docs/installation/configuring-os-parameters.md delete mode 100644 content/en/docs/installation/configuring-primary-database-node-information.md delete mode 100644 content/en/docs/installation/configuring-the-basic-host-information.md delete mode 100644 content/en/docs/installation/configuring-the-locale-and-character-set.md delete mode 100644 content/en/docs/installation/creating-a-configuration-file.md rename content/en/docs/installation/{configuring-the-database-name-and-directories.md => creating-an-xml-configuration-file.md} (40%) delete mode 100644 content/en/docs/installation/creating-the-required-user-account-and-configuring-the-installation-environment.md delete mode 100644 content/en/docs/installation/deleting-cluster-configurations.md delete mode 100644 content/en/docs/installation/disabling-the-os-firewall.md delete mode 100644 content/en/docs/installation/disabling-the-swap-memory.md delete mode 100644 content/en/docs/installation/establishing-mutual-trust-manually.md delete mode 100644 content/en/docs/installation/examples.md delete mode 100644 content/en/docs/installation/executing-uninstallation.md delete mode 100644 content/en/docs/installation/initial-configuration.md rename content/en/docs/{Quickstart => installation}/initializing-the-database.md (78%) delete mode 100644 content/en/docs/installation/modifying-os-configuration.md delete mode 100644 content/en/docs/installation/setting-character-set-parameters.md delete mode 100644 content/en/docs/installation/setting-remote-login-of-user-root.md delete mode 100644 content/en/docs/installation/setting-the-nic-mtu.md delete mode 100644 content/en/docs/installation/setting-the-time-zone-and-time.md delete mode 100644 content/en/docs/installation/software-and-hardware-requirements.md delete mode 100644 content/en/docs/installation/starting-installation.md diff --git a/content/en/docs/Administratorguide/audit-logs.md b/content/en/docs/Administratorguide/audit-logs.md deleted file mode 100644 index 2631d1712..000000000 --- a/content/en/docs/Administratorguide/audit-logs.md +++ /dev/null @@ -1,6 +0,0 @@ -# Audit Logs - -After the audit function is enabled, a large number of audit logs will be generated, which occupy large storage space. You can customize an audit log maintenance policy based on the size of available storage space. - -For details, see "Database Security Management \> Configuring Database Audit \> Maintaining Audit Logs" in the _Developer Guide_. - diff --git a/content/en/docs/Administratorguide/backup-and-restoration.md b/content/en/docs/Administratorguide/backup-and-restoration.md index be708caf9..e8104ae81 100644 --- a/content/en/docs/Administratorguide/backup-and-restoration.md +++ b/content/en/docs/Administratorguide/backup-and-restoration.md @@ -1,9 +1,1452 @@ -# Backup and Restoration - -- **[Overview](overview.md)** - -- **[Physical Backup and Restoration](physical-backup-and-restoration.md)** - -- **[Logical Backup and Restoration](logical-backup-and-restoration.md)** - - +# Backup and Restoration + + + +- [Overview](#overviewa-nameen-us_topic_0242215084a) +- [Physical Backup and Restoration](#physical-backup-and-restorationa-nameen-us_topic_0242218789a) + - [gs\_basebackup](#gs\_basebackupa-nameen-us_topic_0250273516a) +- [Logical Backup and Restoration](#logical-backup-and-restorationa-nameen-us_topic_0242218810a) + - [gs\_dump](#gs\_dumpa-nameen-us_topic_0250273517a) + - [gs\_dumpall](#gs\_dumpalla-nameen-us_topic_0250273518a) + - [gs\_restore](#gs\_restorea-nameen-us_topic_0250273519a) + + + + +## Overview + +For database security purposes, openGauss provides two backup types, multiple backup and restoration solutions, and data reliability assurance mechanisms. + +Backup and restoration can be logically or physically performed. + +- Logical backup and restoration: backs up data by logically exporting data. This method can dump data that is backed up at a certain time point, and restore data only to this backup point. A logical backup does not back up data processed between failure occurrence and the last backup. It applies to scenarios where data rarely changes. Such data damaged due to misoperation can be quickly restored using a logical backup. To restore all the data in a database through logical backup, rebuild a database and import the backup data. Logical backup is not recommended for databases requiring high data availability because it takes a long time for data restoration. Logical backup is a major approach to migrate and transfer data because it can be performed on any platform. +- Physical backup and restoration: copies physical files in the unit of disk blocks from the primary node to the standby node to back up a database. A database can be restored using backup files, such as data files and archive log files. Physical backup is usually used for full backup, quickly backing up and restoring data with low costs if properly planned. + + The two data backup and restoration solutions supported by openGauss are as follows. Methods for restoring data in case of an exception differ for different backup and restoration solutions. + + **Table 1** Comparison between logical and physical backup and restoration + + +
+ | ++ | ++ | ++ | ++ | +
---|---|---|---|---|
+ | ++ | +A plain-text script file containing SQL statements and commands. The commands can be executed on gsql, a command line terminal, to recreate database objects and load table data. + |
+You are advised to use plain-text exported files for small databases. + |
+Before using gsql to restore database objects, you can use a text editor to edit the plain-text export file as required. + |
+
+ | ++ | +A binary file that allows the restoration of all or selected database objects from an exported file. + |
+You are advised to use custom-format archive files for medium or large database. + |
+You can use gs_restore to import database objects from a custom-format archive. + |
+
+ | ++ | +A directory containing directory files and the data files of tables and BLOB objects. + |
++ | +|
+ | ++ | +A tar-format archive that allows the restoration of all or selected database objects from an exported file. It cannot be further compressed and has an 8-GB limitation on the size of a single table. + |
++ | +
- | -- | -
---|---|
- | -Run the following command to check whether SSD is faulty. If yes, analyze the specific cause. -gs_checkperf -i SSD -U omm- |
-
- | -- | -- | -- | -- | -
---|---|---|---|---|
- | -- | -A plain-text script file containing SQL statements and commands. The commands can be executed on gsql, a command line terminal, to recreate database objects and load table data. - |
-You are advised to use plain-text exported files for small databases. - |
-Before using gsql to restore database objects, you can use a text editor to edit the plain-text export file as required. - |
-
- | -- | -A binary file that allows the restoration of all or selected database objects from an exported file. - |
-You are advised to use custom-format archive files for medium or large database. - |
-You can use gs_restore to import database objects from a custom-format archive. - |
-
- | -- | -A directory containing directory files and the data files of tables and BLOB objects. - |
-- | -|
- | -- | -A tar-format archive that allows the restoration of all or selected database objects from an exported file. It cannot be further compressed and has an 8-GB limitation on the size of a single table. - |
-- | -
@@ -83,24 +83,24 @@ openGauss has been started. |
---|
@@ -24,13 +24,13 @@ Perform operations strictly following instructions provided in the guide. Do not |
---|
@@ -94,5 +94,5 @@ Perform operations strictly following instructions provided in the guide. Do not |
---|
+ | ++ | +
---|---|
+ | +Run the following command to check whether SSD is faulty. If yes, analyze the specific cause. +gs_checkperf -i SSD -U omm+ |
+
- | -- | -- | -- | -
---|---|---|---|
- | -- | -- | -- | -
- | -- | -- | -- | -
---|---|---|---|
- | -- | -- | -- | -
- | -- | -- | -- | -
+
+
+## Configuring the Basic Host Information
> **NOTE:**
>Each server must contain the following information. The following uses **node1** as an example.
@@ -145,40 +143,40 @@ The information in bold is only an example. You can replace it as required. Each
**Table 1** Parameter description
-
-
|
---|