From 09d00e7c9f933415278e325bd8825738de73427e Mon Sep 17 00:00:00 2001 From: li-jun056 <1255728208@qq.com> Date: Thu, 27 Aug 2020 19:33:18 +0800 Subject: [PATCH] modify broken links --- .../backup-and-restoration.md | 30 ++++---- .../Administratorguide/routine-maintenance.md | 48 ++++++------ .../Compilationguide/compiling-the-version.md | 44 +++++------ content/en/docs/Compilationguide/faqs.md | 9 --- .../en/docs/Description/enhanced-features.md | 46 +++++------ .../en/docs/Toolreference/pg_controldata.md | 3 +- .../creating-an-xml-configuration-file.md | 47 ++---------- ...itializing-the-installation-environment.md | 76 +++++++++---------- ...e-and-hardware-installation-environment.md | 44 +++++------ ...13\350\241\214\347\273\264\346\212\244.md" | 40 +++++----- ...75\344\270\216\346\201\242\345\244\215.md" | 32 ++++---- content/zh/docs/Compilationguide/FAQ.md | 16 +--- ...10\346\234\254\347\274\226\350\257\221.md" | 46 ++++++----- ...36\345\274\272\347\211\271\346\200\247.md" | 2 +- ...11\350\243\205\347\216\257\345\242\203.md" | 44 +++++------ ...15\347\275\256\346\226\207\344\273\266.md" | 24 +++--- ...11\350\243\205\347\216\257\345\242\203.md" | 76 +++++++++---------- 17 files changed, 284 insertions(+), 343 deletions(-) diff --git a/content/en/docs/Administratorguide/backup-and-restoration.md b/content/en/docs/Administratorguide/backup-and-restoration.md index e8104ae81..9e6c3a77d 100644 --- a/content/en/docs/Administratorguide/backup-and-restoration.md +++ b/content/en/docs/Administratorguide/backup-and-restoration.md @@ -2,18 +2,16 @@ -- [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](#overview) +- [Physical Backup and Restoration](#physical-backup-and-restoration) + - [gs\_basebackup](#gs\_basebackup) +- [Logical Backup and Restoration](#logical-backup-and-restoration) + - [gs\_dump](#gs\_dump) + - [gs\_dumpall](#gs\_dumpall) + - [gs\_restore](#gs\_restore) - - -## Overview +## Overview For database security purposes, openGauss provides two backup types, multiple backup and restoration solutions, and data reliability assurance mechanisms. @@ -116,10 +114,10 @@ Backup and restoration can be logically or physically performed. -## Physical Backup and Restoration +## Physical Backup and Restoration -### gs\_basebackup +### gs\_basebackup #### Background @@ -244,10 +242,10 @@ To restore the original database, perform the following steps: >- Incremental restoration from backup files is not supported. >- After the restoration, check that the link file in the database is linked to the correct file. -## Logical Backup and Restoration +## Logical Backup and Restoration -### gs\_dump +### gs\_dump #### Background @@ -809,7 +807,7 @@ Example 6: Use **gs\_dump** to export only the information about the views tha [gs\_dumpall](gs_dumpall.md#EN-US_TOPIC_0250273518) and [gs\_restore](gs_restore.md#EN-US_TOPIC_0250273519) -### gs\_dumpall +### gs\_dumpall #### Background @@ -1062,7 +1060,7 @@ gs_dumpall[port='37300'][2018-06-27 09:55:46]: total time: 56088 ms [gs\_dump](gs_dump.md#EN-US_TOPIC_0250273517), [gs\_restore](gs_restore.md#EN-US_TOPIC_0250273519) -### gs\_restore +### gs\_restore #### Background diff --git a/content/en/docs/Administratorguide/routine-maintenance.md b/content/en/docs/Administratorguide/routine-maintenance.md index f4a03dd9b..7de44a344 100644 --- a/content/en/docs/Administratorguide/routine-maintenance.md +++ b/content/en/docs/Administratorguide/routine-maintenance.md @@ -1,27 +1,23 @@ # Routine Maintenance + -- **[Routine Maintenance Check Items](routine-maintenance-check-items.md)** +- [Routine Maintenance Check Items](#routine-maintenance-check-items) +- [Checking OS Parameters](#checking-os-parameters) +- [Checking openGauss Health Status](#checking-opengauss-health-status) +- [Checking Database Performance](#checking-database-performance) +- [Checking and Deleting Logs](#checking-and-deleting-logs) +- [Checking Time Consistency](#checking-time-consistency) +- [Checking the Number of Application Connections](#checking-the-number-of-application-connections) +- [Routinely Maintaining Tables](#routinely-maintaining-tables) +- [Routinely Recreating an Index](#routinely-recreating-an-index) +- [Data Security Maintenance Suggestions](#data-security-maintenance-suggestions) -- **[Checking OS Parameters](checking-os-parameters.md)** + -- **[Checking openGauss Health Status](checking-opengauss-health-status.md)** -- **[Checking Database Performance](checking-database-performance.md)** - -- **[Checking and Deleting Logs](checking-and-deleting-logs.md)** - -- **[Checking Time Consistency](checking-time-consistency.md)** - -- **[Checking the Number of Application Connections](checking-the-number-of-application-connections.md)** - -- **[Routinely Maintaining Tables](routinely-maintaining-tables.md)** - -- **[Routinely Recreating an Index](routinely-recreating-an-index.md)** - -- **[Data Security Maintenance Suggestions](data-security-maintenance-suggestions.md)** To ensure data security in GaussDB Kernel and prevent accidents, such as data loss and illegal data access, read this section carefully. -## Routine Maintenance Check Items +## Routine Maintenance Check Items ### Checking openGauss Status @@ -191,7 +187,7 @@ Basic information includes versions, components, and patches. Periodic database ``` -## Checking OS Parameters +## Checking OS Parameters ### Check Method @@ -359,7 +355,7 @@ The **Abnormal** state cannot be ignored because the OS in this state affects ``` -## Checking openGauss Health Status +## Checking openGauss Health Status ### Check Method @@ -1082,7 +1078,7 @@ ClientAliveInterval=10800/ClientAliveInterval=0 -## Checking Database Performance +## Checking Database Performance ### Check Method @@ -1248,7 +1244,7 @@ After you use the **gs\_checkperf** tool to check the cluster performance, if -## Checking and Deleting Logs +## Checking and Deleting Logs You are advised to check OS logs and database run logs monthly for monitoring system status and troubleshooting, and to delete database run logs monthly for saving disk space. @@ -1402,7 +1398,7 @@ A large number of run logs will be generated during database running and occupy -## Checking Time Consistency +## Checking Time Consistency Database transaction consistency is guaranteed by a logical clock and is not affected by OS time. However, OS time inconsistency will lead to problems, such as abnormal backend O&M and monitoring functions. Therefore, you are advised to monthly check time consistency among nodes. @@ -1448,7 +1444,7 @@ Database transaction consistency is guaranteed by a logical clock and is not aff ``` -## Checking the Number of Application Connections +## Checking the Number of Application Connections If the number of connections between applications and the database exceeds the maximum value, new connections cannot be established. You are advised to daily check the number of connections, release idle connections in time, or increase the allowed maximum number of connections. @@ -1574,7 +1570,7 @@ If the number of connections in the command output is close to the value of **m ``` -## Routinely Maintaining Tables +## Routinely Maintaining Tables To ensure proper database running, after insert and delete operations, you need to routinely run **VACUUM FULL** and **ANALYZE** as appropriate for customer scenarios and update statistics to obtain better performance. @@ -1680,7 +1676,7 @@ You need to routinely run **VACUUM**, **VACUUM FULL**, and **ANALYZE** to ma - Routinely run **VACUUM FULL** on system catalogs, especially **PG\_ATTRIBUTE**. - Enable automatic vacuum processes \(**AUTOVACUUM**\) in the system. The processes automatically run the **VACUUM** and **ANALYZE** statements to reclaim the record space marked as the deleted state and update statistics in the table. -## Routinely Recreating an Index +## Routinely Recreating an Index ### Background @@ -1744,7 +1740,7 @@ Assume the ordinary index **areaS\_idx** exists in the **area\_id** column o >![](public_sys-resources/icon-note.gif) **NOTE:** >Before you recreate an index, you can increase the values of **maintenance\_work\_mem** and **psort\_work\_mem** to accelerate the index recreation. -## Data Security Maintenance Suggestions +## Data Security Maintenance Suggestions To ensure data security in GaussDB Kernel and prevent accidents, such as data loss and illegal data access, read this section carefully. diff --git a/content/en/docs/Compilationguide/compiling-the-version.md b/content/en/docs/Compilationguide/compiling-the-version.md index 4ccd90ce7..2b80dca67 100644 --- a/content/en/docs/Compilationguide/compiling-the-version.md +++ b/content/en/docs/Compilationguide/compiling-the-version.md @@ -3,17 +3,17 @@ A **build.sh** script is provided for compiling openGauss and generating the installation package. You can compile openGauss by using the script. You can also configure environment variables and run commands to compile openGauss. -- [Preparation Before Compiling](#preparation-before-compilinga-nameen-us_topic_0241496975a) - - [Downloading Code](#downloading-codea-namesection233903211619a) - - [Compiling Open-source Software](#compiling-open-source-softwarea-namesection38901725122017a) - - [Introduction to build.sh](#introduction-to-buildsha-namesection6993103732114a) -- [Software Compilation and Installation](#software-compilation-and-installationa-nameen-us_topic_0241496976a) - - [Prerequisites](#prerequisitesa-namesection383084619310a) - - [Compilation Using the One-click Script](#compilation-using-the-one-click-scripta-namesection1549373123218a) - - [Manual Compilation](#manual-compilationa-namesection1896812274122a) -- [Compiling the Installation Package](#compiling-the-installation-packagea-nameen-us_topic_0241496988a) - - [Prerequisites](#prerequisitesa-namesection383084619310a-1) - - [Procedure](#procedurea-namesection164893273386a) +- [Preparation Before Compiling](#preparation-before-compiling) + - [Downloading Code](#downloading-code) + - [Compiling Open-source Software](#compiling-open-source-software) + - [Introduction to build.sh](#introduction-to-buildsh) +- [Software Compilation and Installation](#software-compilation-and-installation) + - [Prerequisites](#prerequisites) + - [Compilation Using the One-click Script](#compilation-using-the-one-click-script) + - [Manual Compilation](#manual-compilation) +- [Compiling the Installation Package](#compiling-the-installation-package) + - [Prerequisites](#prerequisites-1) + - [Procedure](#procedure) @@ -22,9 +22,9 @@ This section describes the prerequisites and procedure for openGauss compilation ![](figures/绘图1.png) -## Preparation Before Compiling +## Preparation Before Compiling -### Downloading Code +### Downloading Code **Prerequisites** @@ -49,7 +49,7 @@ The git and git-lfs have been installed and configured on the local host. 2. When the progress of each download reaches 100%, the download is successful. -### Compiling Open-source Software +### Compiling Open-source Software **Compiling Open-source Software** @@ -133,7 +133,7 @@ In addition, you need to download the [gcc-8.2.0.zip](https://github.com/gcc-mi After the preceding script is executed, the final compilation and build result is stored in the **binarylibs** directory at the same level as **openGauss-third\_party**. These files will be used during the compilation of **openGauss-server**. -### Introduction to build.sh +### Introduction to build.sh **openGauss-server/build.sh** is an important script tool during compilation. It integrates software installation and compilation and product installation package compilation functions to quickly compile and package code. @@ -208,18 +208,18 @@ The following table describes the parameters. >2. **-3rd \[binarylibs path\]** is the path of **binarylibs**. By default, **binarylibs** exists in the current code folder. If **binarylibs** is moved to **openGauss-server** or a soft link to **binarylibs** is created in **openGauss-server**, you do not need to specify the parameter. However, if you do so, please note that the file is easy to be deleted by the **git clean** command. >3. Each option in this script has a default value. The number of options is small and the dependency is simple. Therefore, this script is easy to use. If the required value is different from the default value, set this parameter based on the actual requirements. -## Software Compilation and Installation +## Software Compilation and Installation Software compilation and installation are to compile code to generate software and install the software on a computer. The one-click compilation script **build.sh** is provided. You can also manually configure environment variables. The two methods are described below in this section. -### Prerequisites +### Prerequisites - The software and hardware have been prepared based on the requirements for setting up the compilation environment, and the code has been downloaded by referring to [Downloading Code](preparation-before-compiling.md#section233903211619). - The open-source software has been compiled and built. For details, see [Compiling Open-source Software](preparation-before-compiling.md#section38901725122017). - You are familiar with the parameter options and functions of the [build.sh](preparation-before-compiling.md#section6993103732114) script. - The code environment is clean, and no file is generated before the current compilation. For details, see [FAQ 4.1](how-do-i-delete-temporary-files-generated-during-compilation.md). -### Compilation Using the One-click Script +### Compilation Using the One-click Script 1. Run the following command to go to the directory where the software code compilation script is stored: @@ -251,7 +251,7 @@ Software compilation and installation are to compile code to generate software a - Compilation log: make\_compile.log -### Manual Compilation +### Manual Compilation 1. Run the following command to go to the software code directory: @@ -328,18 +328,18 @@ Software compilation and installation are to compile code to generate software a - The compiled binary files are stored in _$GAUSSHOME_**/bin**. -## Compiling the Installation Package +## Compiling the Installation Package To compile the installation package is to compile the code and generate the software installation package. The compilation and packaging process of the installation package is also integrated in **build.sh**. -### Prerequisites +### Prerequisites - The software and hardware have been prepared based on the requirements for setting up the compilation environment, and the code has been downloaded by referring to [Downloading Code](preparation-before-compiling.md#section233903211619). - The open-source software has been compiled and built. For details, see [Compiling Open-source Software](preparation-before-compiling.md#section38901725122017). - You are familiar with the parameter options and functions of the [build.sh](preparation-before-compiling.md#section6993103732114) script. - The code environment is clean, and no file is generated before the current compilation. For details, see [FAQ 4.1](how-do-i-delete-temporary-files-generated-during-compilation.md). -### Procedure +### Procedure 1. Run the following command to go to the code directory: diff --git a/content/en/docs/Compilationguide/faqs.md b/content/en/docs/Compilationguide/faqs.md index 5baacbc2d..6d0f729b4 100644 --- a/content/en/docs/Compilationguide/faqs.md +++ b/content/en/docs/Compilationguide/faqs.md @@ -1,14 +1,5 @@ # FAQs - - -- [How Do I Delete Temporary Files Generated During Compilation?](#how-do-i-delete-temporary-files-generated-during-compilationa-nameen-us_topic_0241496977a) -- [How Do I Resolve the "Configure error: C compiler cannot create executables" Error?](#how-do-i-resolve-the-configure-error-c-compiler-cannot-create-executables-errora-nameen-us_topic_0241496984a) -- [How Do I Handle the "g++: fatal error: Killed signal terminated program cclplus" Error?](#how-do-i-handle-the-g-fatal-error-killed-signal-terminated-program-cclplus-errora-nameen-us_topic_0250721950a) -- [How Do I Handle the "out of memory allocating xxx bytes after a total of xxx bytes" Error?](#how-do-i-handle-the-out-of-memory-allocating-xxx-bytes-after-a-total-of-xxx-bytes-errora-nameen-us_topic_0251012682a) - - - ## How Do I Delete Temporary Files Generated During Compilation? ### Question diff --git a/content/en/docs/Description/enhanced-features.md b/content/en/docs/Description/enhanced-features.md index cda9406d5..5a491270b 100644 --- a/content/en/docs/Description/enhanced-features.md +++ b/content/en/docs/Description/enhanced-features.md @@ -11,28 +11,28 @@ openGauss supports range partitioning. Records to be inserted into a table are d **Table 1** Partitioning benefits - - - - - - - - - - - - - - +

Scenario

-

Benefits

-

Frequently accessed rows in a table are located in one or a few partitions.

-

Improves access performance by significantly reduces search space.

-

Most partition records need to be queried or updated.

-

Improves performance because only one partition rather than the whole table needs to be scanned.

-

Records that need to be loaded or deleted in batches are located in one or a few partitions.

-

Improves processing performance because related partitions can be directly read or deleted. Reduces de-fragmentation workloads because records can be deleted in batches.

-
+ + + + + + + + + + + + +

Scenario

+

Benefits

+

Frequently accessed rows in a table are located in one or a few partitions.

+

Improves access performance by significantly reduces search space.

+

Most partition records need to be queried or updated.

+

Improves performance because only one partition rather than the whole table needs to be scanned.

+

Records that need to be loaded or deleted in batches are located in one or a few partitions.

+

Improves processing performance because related partitions can be directly read or deleted. Reduces de-fragmentation workloads because records can be deleted in batches.

+
Data partitioning provides the following benefits: @@ -74,7 +74,7 @@ In a wide table containing a huge amount of data, a query usually only involves **Figure 2** Hybrid row-column storage engine - ![](figures/20200804-145516(espace).png) + The restrictions of the column storage engine are as follows: diff --git a/content/en/docs/Toolreference/pg_controldata.md b/content/en/docs/Toolreference/pg_controldata.md index 586886b0c..b2b49c797 100644 --- a/content/en/docs/Toolreference/pg_controldata.md +++ b/content/en/docs/Toolreference/pg_controldata.md @@ -25,8 +25,7 @@ Ensure that the data directory is correct and the **pg\_control** file exists - Display help information. ``` - pg_controldata - -? | --help + pg_controldata -? | --help ``` diff --git a/content/en/docs/installation/creating-an-xml-configuration-file.md b/content/en/docs/installation/creating-an-xml-configuration-file.md index 102d6f7e4..cf3589fec 100644 --- a/content/en/docs/installation/creating-an-xml-configuration-file.md +++ b/content/en/docs/installation/creating-an-xml-configuration-file.md @@ -6,14 +6,14 @@ The following describes how to create an XML configuration file based on the dep -- [Configuring the Database Name and Directories](#configuring-the-database-name-and-directoriesa-nameen-us_topic_0249784584a) -- [Configuring the Basic Host Information](#configuring-the-basic-host-informationa-nameen-us_topic_0249784567a) -- [Configuring Primary Database Node Information](#configuring-primary-database-node-informationa-nameen-us_topic_0249784583a) +- [Configuring the Database Name and Directories](#configuring-the-database-name-and-directories) +- [Configuring the Basic Host Information](#configuring-the-basic-host-information) +- [Configuring Primary Database Node Information](#configuring-primary-database-node-information) -## Configuring the Database Name and Directories +## Configuring the Database Name and Directories The information in bold is only an example. You can replace it as required. Each line of information is commented out. @@ -119,7 +119,7 @@ The information in bold is only an example. You can replace it as required. Each -## Configuring the Basic Host Information +## Configuring the Basic Host Information >![](public_sys-resources/icon-note.gif) **NOTE:** >Each server must contain the following information. The following uses **node1** as an example. @@ -191,7 +191,7 @@ The information in bold is only an example. You can replace it as required. Each > >``` -## Configuring Primary Database Node Information +## Configuring Primary Database Node Information The information in bold is only an example. You can replace it as required. Each line of information is commented out. @@ -231,18 +231,6 @@ The information in bold is only an example. You can replace it as required. Each

Basic port number of the database node. The default value is 40000.

-

dataListenIp1

- -

IP address being listened on. This address is used to receive requests for connections from other database nodes. If this parameter is not set, the value is determined based on backIp1 of the corresponding host.

-

If a virtual IP address is configured, this parameter can be set to a virtual IP address.

- - -

dataHaIp1

- -

IP address used for communication between the primary and standby database nodes. If this parameter is not set, the value is determined based on backIp of the corresponding host.

-

This parameter can be set to the IP addresses of the hosts where the primary and standby database nodes reside.

- -

dataNode1

Directory for storing data of the database nodes on the current host. It is a data storage directory, and should be on a data disk.

@@ -256,28 +244,7 @@ The information in bold is only an example. You can replace it as required. Each -**Table 2** Database instance data directories - - - - - - - - - - - - -

Instance

-

Data Directory

-

Primary database node

-

/opt/huawei/install/data/xxx

-

xxx indicates the name of the current primary database node.

-

Standby database node

-

/opt/huawei/install/data/slaveX

-

xxx indicates the name of the current standby database node.

-
+  \ No newline at end of file diff --git a/content/en/docs/installation/initializing-the-installation-environment.md b/content/en/docs/installation/initializing-the-installation-environment.md index 45fe88613..2a065fd9a 100644 --- a/content/en/docs/installation/initializing-the-installation-environment.md +++ b/content/en/docs/installation/initializing-the-installation-environment.md @@ -4,29 +4,29 @@ To ensure the correct installation of the openGauss, you need to configure the h -- [Creating the Required User Account and Configuring the Installation Environment](#creating-the-required-user-account-and-configuring-the-installation-environmenta-nameen-us_topic_0249784578a) - - [Prerequisites](#prerequisitesa-nameen-us_topic_0241805803_en-us_topic_0085434653_en-us_topic_0059781995_s3773af79eeb74c4bae1bd46533cc0cd8a) - - [Precautions](#precautionsa-nameen-us_topic_0241805803_en-us_topic_0085434653_en-us_topic_0059781995_section20734484163420a) - - [Procedure](#procedurea-nameen-us_topic_0241805803_en-us_topic_0085434653_en-us_topic_0059781995_s407f29ab5691456590018c719cf81e9da) - - [Examples](#examplesa-nameen-us_topic_0241805803_en-us_topic_0085434653_en-us_topic_0059781995_section412490911620a) - - [Troubleshooting](#troubleshootinga-nameen-us_topic_0241805803_en-us_topic_0085434653_en-us_topic_0059781995_s51853c2b09e54b12a90e4f8c512a61e4a) -- [Establishing Mutual Trust Manually](#establishing-mutual-trust-manuallya-nameen-us_topic_0249784564a) - - [Prerequisites](#prerequisitesa-nameen-us_topic_0241805804_en-us_topic_0085434625_en-us_topic_0059782039_s88bba380d9334b129eab3023c5399d45a) - - [Establishing Mutual Trust Using a Script](#establishing-mutual-trust-using-a-scripta-nameen-us_topic_0241805804_en-us_topic_0085434625_en-us_topic_0059782039_s8028dd8189914444b059c07d8c8c82dea) - - [Establishing Mutual Trust Manually](#establishing-mutual-trust-manuallya-nameen-us_topic_0241805804_en-us_topic_0085434625_en-us_topic_0059782039_section63620881152125a) - - [Deleting Mutual Trust Between Users **root** ](#deleting-mutual-trust-between-users--root-a-namesection149417461942a) - - [Examples](#examplesa-nameen-us_topic_0241805804_en-us_topic_0085434625_en-us_topic_0059782039_s9928a16b5b7347edbdb587133575483ea) -- [Configuring OS Parameters](#configuring-os-parametersa-nameen-us_topic_0249784554a) - - [OS Parameters](#os-parametersa-nameen-us_topic_0241805805_en-us_topic_0085434661_en-us_topic_0059782062_section3705271819540a) - - [File System Parameters](#file-system-parametersa-nameen-us_topic_0241805805_en-us_topic_0085434661_en-us_topic_0059782062_section4118580316369a) - - [Setting the transparent\_hugepage Service](#setting-the-transparent\_hugepage-servicea-nameen-us_topic_0241805805_en-us_topic_0085434661_en-us_topic_0059782062_section38366550113020a) - - [Setting File Handles](#setting-file-handlesa-nameen-us_topic_0241805805_en-us_topic_0085434661_en-us_topic_0059782062_section49556455195442a) - - [Setting the Maximum Number of Allowed Processes](#setting-the-maximum-number-of-allowed-processesa-nameen-us_topic_0241805805_en-us_topic_0085434661_en-us_topic_0059782062_section65253147151525a) - - [Setting NIC Parameters](#setting-nic-parametersa-nameen-us_topic_0241805805_en-us_topic_0085434661_en-us_topic_0059782062_section6007556195457a) +- [Creating the Required User Account and Configuring the Installation Environment](#creating-the-required-user-account-and-configuring-the-installation-environment) + - [Prerequisites](#prerequisites) + - [Precautions](#precautions) + - [Procedure](#procedure) + - [Examples](#examples) + - [Troubleshooting](#troubleshooting) +- [Establishing Mutual Trust Manually](#establishing-mutual-trust-manually) + - [Prerequisites](#prerequisites-1) + - [Establishing Mutual Trust Using a Script](#establishing-mutual-trust-using-a-script) + - [Establishing Mutual Trust Manually](#establishing-mutual-trust-manually-1) + - [Deleting Mutual Trust Between Users **root**](#deleting-mutual-trust-between-users--root) + - [Examples](#examples-1) +- [Configuring OS Parameters](#configuring-os-parameters) + - [OS Parameters](#os-parameters) + - [File System Parameters](#file-system-parameters) + - [Setting the transparent\_hugepage Service](#setting-the-transparent\_hugepage-service) + - [Setting File Handles](#setting-file-handles) + - [Setting the Maximum Number of Allowed Processes](#setting-the-maximum-number-of-allowed-processes) + - [Setting NIC Parameters](#setting-nic-parameters) -## Creating the Required User Account and Configuring the Installation Environment +## Creating the Required User Account and Configuring the Installation Environment After the clusteropenGauss configuration file is created, you need to run the **gs\_preinstall** script to prepare the account and environment so that you can perform clusteropenGauss installation and management operations with the minimum permission, ensuring system security. @@ -37,17 +37,17 @@ Executing the **gs\_preinstall** script enables the system to automatically co - If the installation user and user group of the clusteropenGauss do not exist, the system automatically creates them. - Reads the directory information in the clusteropenGauss configuration file, creates the directory, and grants the directory permission to the installation user. -### Prerequisites +### Prerequisites - You have completed all the tasks described in [Preparing for Installation](preparing-for-installation.md). -### Precautions +### Precautions - You must check the upper-layer directory permissions to ensure that the user has the read, write, and execution permissions on the installation package and configuration file directory. - The mapping between each host name and IP address in the XML configuration file must be correct. - Only user **root** is authorized to run the **gs\_preinstall** command. -### Procedure +### Procedure 1. Log in to any host where the clusteropenGauss is to be installed as user **root** and create a directory for storing the installation package as planned. @@ -191,7 +191,7 @@ Executing the **gs\_preinstall** script enables the system to automatically co -### Examples +### Examples Execute the **gs\_preinstall** script. @@ -380,21 +380,21 @@ Successfully set finish flag. Preinstallation succeeded. ``` -### Troubleshooting +### Troubleshooting If configuring the installation environment fails, obtain the **gs\_preinstall-YYYY-MM-DD\_HHMMSS.log** and **gs\_local-YYYY-MM-DD\_HHMMSS.log** files from the **$GAUSSLOG/om** directory for storing clusteropenGauss logs. Then, locate the problem based on the log information. For example, if the path specified by the **gaussdbLogPath** parameter in the configuration file is **/var/log/gaussdb**, the **$GAUSSLOG/om** path is **/var/log/gaussdb/omm/om**, and the **omm** user is the user running clusteropenGauss. >![](public_sys-resources/icon-notice.gif) **NOTICE:** >While the installation user and environment is prepared, user **root** is used to add scheduled tasks for routine inspection and reporting. -## Establishing Mutual Trust Manually +## Establishing Mutual Trust Manually During the openGauss installation, you need to perform operations such as running commands and transferring files between hosts in openGauss. Establish mutual trust among the hosts before installing the cluster as a common user. During the execution of the pre-installation script, establish mutual trust between users **root**, then create a common user account, and finally establish mutual trust between common users. >![](public_sys-resources/icon-notice.gif) **NOTICE:** >The mutual trust between users **root** may incur security risks. You are advised to delete the mutual trust between users **root** after the installation is complete. -### Prerequisites +### Prerequisites - The SSH service has been enabled. - You have verified that SSH ports will not be disabled by firewalls. @@ -426,7 +426,7 @@ During the openGauss installation, you need to perform operations such as runnin ``` -### Establishing Mutual Trust Using a Script +### Establishing Mutual Trust Using a Script 1. Create the file for executing the mutual trust script, and add the IP addresses of all the hosts in the openGauss to the file. @@ -447,7 +447,7 @@ During the openGauss installation, you need to perform operations such as runnin The **/opt/software/hostfile** file contains a list of the hosts. The list provides the IP addresses of all the hosts among which mutual trust needs to be established. -### Establishing Mutual Trust Manually +### Establishing Mutual Trust Manually If the passwords of user **root** on the hosts in the openGauss are different, the **gs\_preinstall** script cannot be used to establish mutual trust. In this case, manually establish mutual trust. @@ -598,7 +598,7 @@ The procedure of manually establishing mutual trust is as follows \(**plat1**, >If there are more than three hosts, the procedure of manually establishing mutual trust between the hosts is similar to the one in this section. Assume that the host names are **plat1**, **plat2**, **plat3**, ... Firstly, generate a licensed file for user **root** on host **plat1** \(referred to as the local host\). Secondly, obtain the public keys of all the hosts \(**plat1**, **plat2**, **plat3**, ...\) between which mutual trust needs to be established, and write the public keys to the **known\_hosts** file on the local host. Thirdly, send the file from the local host to all the other hosts \(**plat2**, **plat3**, ...\). Finally, verify that mutual trust has been successfully established. -### Deleting Mutual Trust Between Users **root** +### Deleting Mutual Trust Between Users **root** The mutual trust established between users **root** may incur security risks. You are advised to delete the mutual trust between users **root** immediately after the installation is complete. @@ -619,7 +619,7 @@ The mutual trust established between users **root** may incur security risks. Are you sure you want to continue connecting \(yes/no\)? -### Examples +### Examples The following is an example describing how to establish mutual trust between users **root**: @@ -697,7 +697,7 @@ Successfully verified SSH trust on all hosts. Successfully created SSH trust. ``` -## Configuring OS Parameters +## Configuring OS Parameters openGauss requires that the OS parameters on every host be set to specified values to ensure system running performance. @@ -715,7 +715,7 @@ Some of these parameters are set during the openGauss installation environment p ``` -### OS Parameters +### OS Parameters **Table 1** OS parameters @@ -1043,7 +1043,7 @@ Some of these parameters are set during the openGauss installation environment p -### File System Parameters +### File System Parameters - soft nofile @@ -1064,11 +1064,11 @@ Some of these parameters are set during the openGauss installation environment p Recommended value: **3072** -### Setting the transparent\_hugepage Service +### Setting the transparent\_hugepage Service By default, openGauss disables the transparent\_hugepage service and this setting is written into the OS startup file. -### Setting File Handles +### Setting File Handles To manually set the number of file handles, run the following commands to modify the involved parameters as user **root**: @@ -1113,7 +1113,7 @@ After the modification is complete, restart the OS to make the setting take effe -### Setting the Maximum Number of Allowed Processes +### Setting the Maximum Number of Allowed Processes To manually set the maximum number of allowed processes, run the following command to open the configuration file: @@ -1150,7 +1150,7 @@ After the modification is complete, restart the OS to make the setting take effe -### Setting NIC Parameters +### Setting NIC Parameters **Table 4** Setting NIC parameters diff --git a/content/en/docs/installation/preparing-the-software-and-hardware-installation-environment.md b/content/en/docs/installation/preparing-the-software-and-hardware-installation-environment.md index 5698e9f0d..edcb66c2c 100644 --- a/content/en/docs/installation/preparing-the-software-and-hardware-installation-environment.md +++ b/content/en/docs/installation/preparing-the-software-and-hardware-installation-environment.md @@ -4,25 +4,25 @@ This chapter describes the preparations for the installation. -- [Software and Hardware Requirements](#software-and-hardware-requirementsa-nameen-us_topic_0249784577a) - - [Hardware Requirements](#hardware-requirementsa-nameen-us_topic_0241802565_en-us_topic_0085434629_en-us_topic_0059782022_sdd36768784254b8ba03c77c86b831caea) - - [Software Requirements](#software-requirementsa-nameen-us_topic_0241802565_en-us_topic_0085434629_en-us_topic_0059782022_s3124e90db74142ddaf11e2e8fd69cadba) - - [Software Dependency Requirements](#software-dependency-requirementsa-namesection5459315183816a) -- [Modifying OS Configuration](#modifying-os-configurationa-nameen-us_topic_0249784574a) - - [Disabling the OS Firewall](#disabling-the-os-firewalla-namesection392211235453a) - - [Setting Character Set Parameters](#setting-character-set-parametersa-namesection13321183394714a) - - [Setting the Time Zone and Time](#setting-the-time-zone-and-timea-namesection399102113483a) - - [Disabling the Swap Memory](#disabling-the-swap-memorya-namesection108571059134820a) - - [Setting the NIC MTU](#setting-the-nic-mtua-namesection111222032174911a) -- [Setting Remote Login of User root](#setting-remote-login-of-user-roota-nameen-us_topic_0249784566a) +- [Software and Hardware Requirements](#software-and-hardware-requirements) + - [Hardware Requirements](#hardware-requirements) + - [Software Requirements](#software-requirements) + - [Software Dependency Requirements](#software-dependency-requirements) +- [Modifying OS Configuration](#modifying-os-configuration) + - [Disabling the OS Firewall](#disabling-the-os-firewall) + - [Setting Character Set Parameters](#setting-character-set-parameters) + - [Setting the Time Zone and Time](#setting-the-time-zone-and-time) + - [Disabling the Swap Memory](#disabling-the-swap-memory) + - [Setting the NIC MTU](#setting-the-nic-mtu) +- [Setting Remote Login of User root](#setting-remote-login-of-user-root) -## Software and Hardware Requirements +## Software and Hardware Requirements This section describes hardware and software requirements of openGauss. It is recommended that servers to be deployed on openGauss have the same software and hardware configurations. -### Hardware Requirements +### Hardware Requirements [Table 1](#en-us_topic_0241802565_en-us_topic_0085434629_en-us_topic_0059782022_t62cd0eed17004265b1b8ad98f302a4bc) describes the minimum hardware requirements of openGauss. When planning the hardware configuration of a product, consider the data scale and expected database response speed. Plan hardware as required. @@ -67,7 +67,7 @@ This section describes hardware and software requirements of openGauss. It is re -### Software Requirements +### Software Requirements **Table 2** Software requirements @@ -101,15 +101,15 @@ This section describes hardware and software requirements of openGauss. It is re -### Software Dependency Requirements +### Software Dependency Requirements [\#EN-US\_TOPIC\_0249784577/table11459151513383](#table11459151513383) lists the software dependency requirements for the openGauss. You are advised to use the default installation packages of the following dependent software in the listed OS installation CD-ROMs or sources. If the following software does not exist, refer to the recommended versions of the software. -## Modifying OS Configuration +## Modifying OS Configuration -### Disabling the OS Firewall +### Disabling the OS Firewall To ensure that the openGauss can work properly when the firewall is enabled, related services, protocols, IP addresses, and ports need to be added to the firewall whitelist of each host in the openGauss. @@ -206,7 +206,7 @@ Currently, EulerOS can be installed only when the firewall is disabled. 5. Repeat steps 1 to 3 on other hosts. -### Setting Character Set Parameters +### Setting Character Set Parameters Set the same character set for all database nodes. You can add **export LANG=**_Unicode_ in the **/etc/profile** file. @@ -214,7 +214,7 @@ Set the same character set for all database nodes. You can add **export LANG=** vim /etc/profile ``` -### Setting the Time Zone and Time +### Setting the Time Zone and Time Set the same time zone for all database nodes by copying the **/etc/localtime** time zone file to the **/usr/share/zoneinfo/** directory. @@ -234,7 +234,7 @@ date -s Mon May 11 16:42:11 CST 2020 >![](public_sys-resources/icon-note.gif) **NOTE:** >You can run the **date** command to query the time zone of the host. -### Disabling the Swap Memory +### Disabling the Swap Memory Run the **swapoff -a** command on each database node to disable the swap memory. @@ -242,7 +242,7 @@ Run the **swapoff -a** command on each database node to disable the swap memor swapoff -a ``` -### Setting the NIC MTU +### Setting the NIC MTU Set the NIC MTU value on each database node to the same value. For X86, the recommended MTU value is 1500. For ARM, the recommended MTU value is 8192. @@ -250,7 +250,7 @@ Set the NIC MTU value on each database node to the same value. For X86, the reco ifconfig NIC ID mtu Value ``` -## Setting Remote Login of User root +## Setting Remote Login of User root During the openGauss installation, the user **root** is required for remote login. This section describes how to set the user **root** for remote login. diff --git "a/content/zh/docs/Administratorguide/\344\276\213\350\241\214\347\273\264\346\212\244.md" "b/content/zh/docs/Administratorguide/\344\276\213\350\241\214\347\273\264\346\212\244.md" index c019aa627..a4ca48447 100644 --- "a/content/zh/docs/Administratorguide/\344\276\213\350\241\214\347\273\264\346\212\244.md" +++ "b/content/zh/docs/Administratorguide/\344\276\213\350\241\214\347\273\264\346\212\244.md" @@ -2,22 +2,22 @@ -- [日维护检查项](#日维护检查项a-namezh-cn_topic_0242215053a) -- [检查操作系统参数](#检查操作系统参数a-namezh-cn_topic_0242215054a) -- [检查openGauss健康状态](#检查opengauss健康状态a-namezh-cn_topic_0242215057a) -- [检查数据库性能](#检查数据库性能a-namezh-cn_topic_0242215060a) -- [检查和清理日志](#检查和清理日志a-namezh-cn_topic_0242215063a) -- [检查时间一致性](#检查时间一致性a-namezh-cn_topic_0242215067a) -- [检查应用连接数](#检查应用连接数a-namezh-cn_topic_0242215068a) -- [例行维护表](#例行维护表a-namezh-cn_topic_0242215069a) -- [例行重建索引](#例行重建索引a-namezh-cn_topic_0242215070a) -- [数据安全维护建议](#数据安全维护建议a-namezh-cn_topic_0242215071a) +- [日维护检查项](#日维护检查项) +- [检查操作系统参数](#检查操作系统参数) +- [检查openGauss健康状态](#检查opengauss健康状态) +- [检查数据库性能](#检查数据库性能) +- [检查和清理日志](#检查和清理日志) +- [检查时间一致性](#检查时间一致性) +- [检查应用连接数](#检查应用连接数) +- [例行维护表](#例行维护表) +- [例行重建索引](#例行重建索引) +- [数据安全维护建议](#数据安全维护建议) 为保证openGauss数据库中的数据安全，避免丢失数据，非法访问数据等事故发生，请仔细阅读以下内容。 -## 日维护检查项 +## 日维护检查项 ### 检查openGauss状态 @@ -187,7 +187,7 @@ SQL语句长时间运行会占用大量系统资源，用户可以通过查看 ``` -## 检查操作系统参数 +## 检查操作系统参数 ### 检查办法 @@ -356,7 +356,7 @@ gs_checkos -i A --detail ``` -## 检查openGauss健康状态 +## 检查openGauss健康状态 ### 检查办法 @@ -1068,7 +1068,7 @@ For more information please refer to /usr1/gaussdb/tool/script/gspylib/inspectio -## 检查数据库性能 +## 检查数据库性能 ### 检查办法 @@ -1234,7 +1234,7 @@ Cluster statistics information: -## 检查和清理日志 +## 检查和清理日志 日志是检查系统运行及故障定位的关键手段。建议按月度例行查看操作系统日志及数据库的运行日志。同时，随着时间的推移，日志的增加会占用较多的磁盘空间。建议按月度清理数据库的运行日志。 @@ -1386,7 +1386,7 @@ vim /var/log/messages -## 检查时间一致性 +## 检查时间一致性 数据库事务一致性通过逻辑时钟保证，与操作系统时间无关，但是系统时间不一致会导致诸多潜在问题，主要是后台运维和监控功能异常，因此在月度检查时建议检查各个节点的时间一致性。 @@ -1432,7 +1432,7 @@ vim /var/log/messages ``` -## 检查应用连接数 +## 检查应用连接数 如果应用程序与数据库的连接数超过最大值，则新的连接无法建立。建议每天检查连接数，及时释放空闲的连接或者增加最大连接数。 @@ -1558,7 +1558,7 @@ vim /var/log/messages ``` -## 例行维护表 +## 例行维护表 为了保证数据库的有效运行，数据库必须在插入/删除操作后，基于客户场景，定期做VACUUM FULL和ANALYZE，更新统计信息，以便获得更优的性能。 @@ -1664,7 +1664,7 @@ vim /var/log/messages - 定期对系统表做VACUUM FULL，主要是PG\_ATTRIBUTE。 - 启用系统自动清理进程（AUTOVACUUM）自动执行VACUUM和ANALYZE，回收被标识为删除状态的记录空间，并更新表的统计数据。 -## 例行重建索引 +## 例行重建索引 ### 背景信息 @@ -1728,7 +1728,7 @@ vim /var/log/messages >![](public_sys-resources/icon-note.gif) **说明：** >在重建索引前，用户可以通过临时增大maintenance\_work\_mem和psort\_work\_mem的取值来加快索引的重建。 -## 数据安全维护建议 +## 数据安全维护建议 为保证openGauss数据库中的数据安全，避免丢失数据，非法访问数据等事故发生，请仔细阅读以下内容。 diff --git "a/content/zh/docs/Administratorguide/\345\244\207\344\273\275\344\270\216\346\201\242\345\244\215.md" "b/content/zh/docs/Administratorguide/\345\244\207\344\273\275\344\270\216\346\201\242\345\244\215.md" index be1135af3..e598d41b2 100644 --- "a/content/zh/docs/Administratorguide/\345\244\207\344\273\275\344\270\216\346\201\242\345\244\215.md" +++ "b/content/zh/docs/Administratorguide/\345\244\207\344\273\275\344\270\216\346\201\242\345\244\215.md" @@ -2,17 +2,17 @@ -- [概述](#概述a-namezh-cn_topic_0242215084a) -- [物理备份恢复](#物理备份恢复a-namezh-cn_topic_0242218789a) - - [gs\_basebackup](#gs\_basebackupa-namezh-cn_topic_0256377135a) -- [逻辑备份恢复](#逻辑备份恢复a-namezh-cn_topic_0242218810a) - - [gs\_dump](#gs\_dumpa-namezh-cn_topic_0256377136a) - - [gs\_dumpall](#gs\_dumpalla-namezh-cn_topic_0256377137a) - - [gs\_restore](#gs\_restorea-namezh-cn_topic_0256377138a) - - [gs\_backup](#gs\_backupa-namezh-cn_topic_0256377139a) +- [概述](#概述) +- [物理备份恢复](#物理备份恢复) + - [gs\_basebackup](#gs\_basebackup) +- [逻辑备份恢复](#逻辑备份恢复) + - [gs\_dump](#gs\_dump) + - [gs\_dumpall](#gs\_dumpall) + - [gs\_restore](#gs\_restore) + - [gs\_backup](#gs\_backup) -## 概述 +## 概述 数据备份是保护数据安全的重要手段之一，为了更好的保护数据安全，openGauss数据库支持两种备份恢复类型、多种备份恢复方案，备份和恢复过程中提供数据的可靠性保障机制。 @@ -115,10 +115,10 @@ -## 物理备份恢复 +## 物理备份恢复 -### gs\_basebackup +### gs\_basebackup #### 背景信息 @@ -243,10 +243,10 @@ INFO: The starting position of the xlog copy of the full build is: 0/1B800000. >- 暂不支持备份文件增量恢复 >- 恢复后需要检查数据库中的链接文件是否链接到正确的文件 -## 逻辑备份恢复 +## 逻辑备份恢复 -### gs\_dump +### gs\_dump #### 背景信息 @@ -807,7 +807,7 @@ gs_dump[port='37300'][postgres][2018-06-27 10:37:22]: total time: 37017 ms [gs\_dumpall](gs_dumpall.md)，[gs\_restore](gs_restore.md) -### gs\_dumpall +### gs\_dumpall #### 背景信息 @@ -1060,7 +1060,7 @@ gs_dumpall[port='37300'][2018-06-27 09:55:46]: total time: 56088 ms [gs\_dump](zh-cn_topic_0249632271.md)，[gs\_restore](gs_restore.md) -### gs\_restore +### gs\_restore #### 背景信息 @@ -1447,7 +1447,7 @@ gs_restore[2017-07-21 19:16:26]: total time: 20203 ms [gs\_dump](zh-cn_topic_0249632271.md)，[gs\_dumpall](zh-cn_topic_0249632251.md) -### gs\_backup +### gs\_backup #### 背景信息 diff --git a/content/zh/docs/Compilationguide/FAQ.md b/content/zh/docs/Compilationguide/FAQ.md index df3574611..f5b719b50 100644 --- a/content/zh/docs/Compilationguide/FAQ.md +++ b/content/zh/docs/Compilationguide/FAQ.md @@ -1,14 +1,6 @@ # FAQ - - -- [如何清除编译过程中生成的临时文件](#如何清除编译过程中生成的临时文件a-namezh-cn_topic_0241496977a) -- [如何解决“Configure error: C compiler cannot create executables”报错](#如何解决configure-error-c-compiler-cannot-create-executables报错a-namezh-cn_topic_0241496984a) -- [如何解决 "g++: fatal error: Killed signal terminated program cclplus" 报错](#如何解决-g-fatal-error--killed-signal-terminated-program-cclplus-报错a-namezh-cn_topic_0250721950a) -- [如何解决"out of memory allocating xxx bytes after a total of xxx bytes"报错](#如何解决out-of-memory-allocating-xxx-bytes-after-a-total-of-xxx-bytes报错a-namezh-cn_topic_0251012682a) - - -## 如何清除编译过程中生成的临时文件 +## 如何清除编译过程中生成的临时文件 ### 问题 @@ -30,7 +22,7 @@ make clean -sj ``` -## 如何解决“Configure error: C compiler cannot create executables”报错 +## 如何解决“Configure error: C compiler cannot create executables”报错 ### 问题 @@ -42,7 +34,7 @@ 解决办法：若binarylibs是通过开源软件构建而来，请重新构建开源第三方软件；若binarylibs是代码下载而来，请重新下载。最后重新执行当前脚本或命令。 -## 如何解决 "g++: fatal error: Killed signal terminated program cclplus" 报错 +## 如何解决 "g++: fatal error: Killed signal terminated program cclplus" 报错 ### 问题 @@ -54,7 +46,7 @@ 解决办法：编译过程中降低make 并发数，或者直接使用make命令。使用一键式脚本的话需要修改脚本。 -## 如何解决"out of memory allocating xxx bytes after a total of xxx bytes"报错 +## 如何解决"out of memory allocating xxx bytes after a total of xxx bytes"报错 ### 问题 diff --git "a/content/zh/docs/Compilationguide/\347\211\210\346\234\254\347\274\226\350\257\221.md" "b/content/zh/docs/Compilationguide/\347\211\210\346\234\254\347\274\226\350\257\221.md" index 6ca26f42b..6f941ae80 100644 --- "a/content/zh/docs/Compilationguide/\347\211\210\346\234\254\347\274\226\350\257\221.md" +++ "b/content/zh/docs/Compilationguide/\347\211\210\346\234\254\347\274\226\350\257\221.md" @@ -4,17 +4,17 @@ openGauss的编译过程和生成安装包的过程已经写成了一个一键 -- [编译前准备](#编译前准备a-namezh-cn_topic_0241496975a) - - [代码下载](#代码下载a-namesection188203481850a) - - [开源软件编译构建](#开源软件编译构建a-namesection13890105116714a) - - [build.sn介绍](#buildsn介绍a-namesection926810175121a) -- [软件安装编译](#软件安装编译a-namezh-cn_topic_0241496976a) - - [前提条件](#前提条件a-namesection383084619310a) - - [一键式脚本编译](#一键式脚本编译a-namesection1549373123218a) - - [手动编译](#手动编译a-namesection1896812274122a) -- [产品安装包编译](#产品安装包编译a-namezh-cn_topic_0241496988a) - - [前提条件](#前提条件a-namesection383084619310a-1) - - [操作步骤](#操作步骤a-namesection164893273386a) +- [编译前准备](#编译前准备) + - [代码下载](#代码下载) + - [开源软件编译构建](#开源软件编译构建) + - [build.sn介绍](#buildsn介绍) +- [软件安装编译](#软件安装编译) + - [前提条件](#前提条件) + - [一键式脚本编译](#一键式脚本编译) + - [手动编译](#手动编译) +- [产品安装包编译](#产品安装包编译) + - [前提条件](#前提条件-1) + - [操作步骤](#操作步骤) @@ -25,9 +25,9 @@ openGauss的编译过程和生成安装包的过程已经写成了一个一键 -## 编译前准备 +## 编译前准备 -### 代码下载 +### 代码下载 **前提条件** @@ -52,7 +52,7 @@ openGauss的编译过程和生成安装包的过程已经写成了一个一键 2. 下载项进度均显示为100%时表示下载成功。 -### 开源软件编译构建 +### 开源软件编译构建 **开源软件编译构建** @@ -136,8 +136,7 @@ openGauss的编译，需要提前把所依赖的开源第三方软件进行编 执行上述脚本，最终编译构建出的结果会存放在openGauss-third\_party同级的binarylibs目录。这些文件会在后面编译openGauss-server时使用到。 -### build.sn介绍 - +### build.sn介绍 openGauss-server/build.sh是编译过程中的重要脚本工具。其集成了软件安装编译、产品安装包编译两种功能，可快速进行代码编译和打包。 详细参数选项如下表所示： @@ -211,18 +210,17 @@ openGauss-server/build.sh是编译过程中的重要脚本工具。其集成了 >2. -3rd \[binarylibs path\] 为binarylibs的路径。缺省情况下，会认为当前代码文件夹下存在binarylibs。因此如果将binarylibs移动到openGauss-server下，或在openGauss-server下创建了指向binarylibs的软链接，可不指定此选项。但需要注意其容易被git clean等操作删除。 >3. 此脚本每个参数选项都设置了缺省值，且数量并不多，依赖关系简单，因此使用时非常方便。如果用户需求值与缺省值不同，请根据实际情况进行设置。 -## 软件安装编译 - +## 软件安装编译 软件安装编译即将代码编译生成软件，并将软件安装到机器上。提供一键式编译脚本build.sh进行操作，也可以自己配置环境变量手动操作。两种方式将在本章节的一键式脚本操作步骤、手动编译操作步骤中进行讲解 -### 前提条件 +### 前提条件 - 已按照[搭建编译环境](搭建编译环境.md)的要求准备好相关软硬件，并且已参考[代码下载](编译前准备.md#section188203481850)下载了代码。 - 已完成开源软件编译构建，具体请参见[开源软件编译构建](编译前准备.md#section13890105116714)。 - 了解 [build.sn](编译前准备.md#section926810175121)脚本的参数选项和功能。 - 代码环境干净，没有以前编译生成的文件。具体请参见[FAQ 4.1](如何清除编译过程中生成的临时文件.md)。 -### 一键式脚本编译 +### 一键式脚本编译 1. 执行如下命令进入到软件代码编译脚本目录。 @@ -254,7 +252,7 @@ openGauss-server/build.sh是编译过程中的重要脚本工具。其集成了 - 编译日志为：make\_compile.log -### 手动编译 +### 手动编译 1. 执行如下命令进入到软件代码目录。 @@ -331,18 +329,18 @@ openGauss-server/build.sh是编译过程中的重要脚本工具。其集成了 - 编译后的二进制放置路径为：$GAUSSHOME/bin -## 产品安装包编译 +## 产品安装包编译 安装包编译即将代码编译生成软件安装包，安装包的编译打包过程也集成在build.sh之中。 -### 前提条件 +### 前提条件 - 已按照[搭建编译环境](搭建编译环境.md)的要求准备好相关软硬件，并且已参考[代码下载](编译前准备.md#section188203481850)下载了代码。 - 已完成开源软件编译构建，具体请参见[开源软件编译构建](编译前准备.md#section13890105116714)。 - 了解 [build.sn](编译前准备.md#section926810175121)脚本的参数选项和功能。 - 代码环境干净，没有以前编译生成的文件。具体请参见[FAQ 4.1](如何清除编译过程中生成的临时文件.md)。 -### 操作步骤 +### 操作步骤 1. 执行如下命令进入到代码目录。 diff --git "a/content/zh/docs/Description/\344\274\201\344\270\232\347\272\247\345\242\236\345\274\272\347\211\271\346\200\247.md" "b/content/zh/docs/Description/\344\274\201\344\270\232\347\272\247\345\242\236\345\274\272\347\211\271\346\200\247.md" index a8f743201..87775c4dc 100644 --- "a/content/zh/docs/Description/\344\274\201\344\270\232\347\272\247\345\242\236\345\274\272\347\211\271\346\200\247.md" +++ "b/content/zh/docs/Description/\344\274\201\344\270\232\347\272\247\345\242\236\345\274\272\347\211\271\346\200\247.md" @@ -74,7 +74,7 @@ openGauss支持范围分区（Range Partitioning）功能，即根据表的一 **图 2** 行列混存引擎 - ![](figures/openGauss行列混存引擎.png) + 当前列存储引擎有以下约束： diff --git "a/content/zh/docs/installation/\345\207\206\345\244\207\350\275\257\347\241\254\344\273\266\345\256\211\350\243\205\347\216\257\345\242\203.md" "b/content/zh/docs/installation/\345\207\206\345\244\207\350\275\257\347\241\254\344\273\266\345\256\211\350\243\205\347\216\257\345\242\203.md" index e41511c4e..6b0b45204 100644 --- "a/content/zh/docs/installation/\345\207\206\345\244\207\350\275\257\347\241\254\344\273\266\345\256\211\350\243\205\347\216\257\345\242\203.md" +++ "b/content/zh/docs/installation/\345\207\206\345\244\207\350\275\257\347\241\254\344\273\266\345\256\211\350\243\205\347\216\257\345\242\203.md" @@ -4,25 +4,25 @@ -- [软硬件环境要求](#软硬件环境要求a-namezh-cn_topic_0249784577a) - - [硬件环境要求](#硬件环境要求a-namezh-cn_topic_0241802565_zh-cn_topic_0085434629_zh-cn_topic_0059782022_sdd36768784254b8ba03c77c86b831caea) - - [软件环境要求](#软件环境要求a-namezh-cn_topic_0241802565_zh-cn_topic_0085434629_zh-cn_topic_0059782022_s3124e90db74142ddaf11e2e8fd69cadba) - - [软件依赖要求](#软件依赖要求a-namesection5459315183816a) -- [修改操作系统配置](#修改操作系统配置a-namezh-cn_topic_0249784574a) - - [关闭操作系统防火墙](#关闭操作系统防火墙a-namesection178235734314a) - - [设置字符集参数](#设置字符集参数a-namesection17609182719467a) - - [设置时区和时间](#设置时区和时间a-namesection2058219344711a) - - [关闭swap交换内存](#关闭swap交换内存a-namesection1868124934810a) - - [设置网卡MTU值](#设置网卡mtu值a-namesection23866245014a) -- [设置root用户远程登录](#设置root用户远程登录a-namezh-cn_topic_0249784566a) +- [软硬件环境要求](#软硬件环境要求) + - [硬件环境要求](#硬件环境要求) + - [软件环境要求](#软件环境要求) + - [软件依赖要求](#软件依赖要求) +- [修改操作系统配置](#修改操作系统配置) + - [关闭操作系统防火墙](#关闭操作系统防火墙) + - [设置字符集参数](#设置字符集参数) + - [设置时区和时间](#设置时区和时间) + - [关闭swap交换内存](#关闭swap交换内存) + - [设置网卡MTU值](#设置网卡mtu值) +- [设置root用户远程登录](#设置root用户远程登录) -## 软硬件环境要求 +## 软硬件环境要求 介绍openGauss的软硬件环境要求。建议部署openGauss的各服务器具有等价的软硬件配置。 -### 硬件环境要求 +### 硬件环境要求 [表1](#zh-cn_topic_0241802565_zh-cn_topic_0085434629_zh-cn_topic_0059782022_t62cd0eed17004265b1b8ad98f302a4bc)列出了openGauss服务器应具备的最低硬件要求。在实际产品中，硬件配置的规划需考虑数据规模及所期望的数据库响应速度。请根据实际情况进行规划。 @@ -67,7 +67,7 @@ -### 软件环境要求 +### 软件环境要求 **表 2** 软件环境要求 @@ -101,7 +101,7 @@ -### 软件依赖要求 +### 软件依赖要求 openGauss的软件依赖要求如[表 软件依赖要求](#table1212531681911)所示。 @@ -154,9 +154,9 @@ openGauss的软件依赖要求如[表 软件依赖要求](#table1212531681911) -## 修改操作系统配置 +## 修改操作系统配置 -### 关闭操作系统防火墙 +### 关闭操作系统防火墙 为了在防火墙开启的状态下，确保openGauss的正常使用。用户需要将同openGauss相关的服务、协议、IP以及端口添加到openGauss各主机的防火墙白名单中。 @@ -253,7 +253,7 @@ openGauss的软件依赖要求如[表 软件依赖要求](#table1212531681911) 5. 在其他主机上重复步骤1到步骤4。 -### 设置字符集参数 +### 设置字符集参数 将各数据库节点的字符集设置为相同的字符集，可以在/etc/profile文件中添加"export LANG=XXX"（XXX为Unicode编码）。 @@ -261,7 +261,7 @@ openGauss的软件依赖要求如[表 软件依赖要求](#table1212531681911) vim /etc/profile ``` -### 设置时区和时间 +### 设置时区和时间 将各数据库节点的时区设置为相同时区，可以将/usr/share/zoneinfo/目录下的时区文件拷贝为/etc/localtime文件。 @@ -281,7 +281,7 @@ date -s Mon May 11 16:42:11 CST 2020 >![](public_sys-resources/icon-note.gif) **说明：** >可以通过date命令查询主机时区。 -### 关闭swap交换内存 +### 关闭swap交换内存 在各数据库节点上，使用swapoff -a命令将交换内存关闭。 @@ -289,7 +289,7 @@ date -s Mon May 11 16:42:11 CST 2020 swapoff -a ``` -### 设置网卡MTU值 +### 设置网卡MTU值 将各数据库节点的网卡MTU值设置为相同大小。对于X86，MTU值推荐1500；对于ARM，MTU值推荐8192。 @@ -297,7 +297,7 @@ swapoff -a ifconfig 网卡编号 mtu 值 ``` -## 设置root用户远程登录 +## 设置root用户远程登录 在openGauss安装时需要root帐户远程登录访问权限，本章介绍如何设置使用root用户远程登录。 diff --git "a/content/zh/docs/installation/\345\210\233\345\273\272XML\351\205\215\347\275\256\346\226\207\344\273\266.md" "b/content/zh/docs/installation/\345\210\233\345\273\272XML\351\205\215\347\275\256\346\226\207\344\273\266.md" index 8b72e7345..eba766f74 100644 --- "a/content/zh/docs/installation/\345\210\233\345\273\272XML\351\205\215\347\275\256\346\226\207\344\273\266.md" +++ "b/content/zh/docs/installation/\345\210\233\345\273\272XML\351\205\215\347\275\256\346\226\207\344\273\266.md" @@ -6,17 +6,17 @@ -- [配置数据库名称及各项目录](#配置数据库名称及各项目录a-namezh-cn_topic_0249784584a) -- [配置Host基本信息](#配置host基本信息a-namezh-cn_topic_0249784567a) -- [配置数据库主节点信息](#配置数据库主节点信息a-namezh-cn_topic_0249784583a) -- [示例](#示例a-namezh-cn_topic_0249784528a) - - [单节点配置文件](#单节点配置文件a-namesection1698454873416a) - - [一主一备配置文件](#一主一备配置文件a-namesection946242113712a) +- [配置数据库名称及各项目录](#配置数据库名称及各项目录) +- [配置Host基本信息](#配置host基本信息) +- [配置数据库主节点信息](#配置数据库主节点信息) +- [示例](#示例) + - [单节点配置文件](#单节点配置文件) + - [一主一备配置文件](#一主一备配置文件) -## 配置数据库名称及各项目录 +## 配置数据库名称及各项目录 在script/gspylib/etc/conf/cluster\_config\_template.xml获取XML文件模板。加粗字体内容为示例，可自行替换。每行信息均有注释进行说明。 @@ -115,7 +115,7 @@ -## 配置Host基本信息 +## 配置Host基本信息 >![](public_sys-resources/icon-note.gif) **说明：** >每台Host服务器都必须有如下信息，如下示例以node1为例。 @@ -187,7 +187,7 @@ > >``` -## 配置数据库主节点信息 +## 配置数据库主节点信息 加粗字体内容为示例，可自行替换。每行信息均有注释进行说明。 @@ -240,9 +240,9 @@ -## 示例 +## 示例 -### 单节点配置文件 +### 单节点配置文件 ``` @@ -281,7 +281,7 @@ ``` -### 一主一备配置文件 +### 一主一备配置文件 ``` diff --git "a/content/zh/docs/installation/\345\210\235\345\247\213\345\214\226\345\256\211\350\243\205\347\216\257\345\242\203.md" "b/content/zh/docs/installation/\345\210\235\345\247\213\345\214\226\345\256\211\350\243\205\347\216\257\345\242\203.md" index 6d49cb962..cc4d07409 100644 --- "a/content/zh/docs/installation/\345\210\235\345\247\213\345\214\226\345\256\211\350\243\205\347\216\257\345\242\203.md" +++ "b/content/zh/docs/installation/\345\210\235\345\247\213\345\214\226\345\256\211\350\243\205\347\216\257\345\242\203.md" @@ -4,28 +4,28 @@ -- [准备安装用户及环境](#准备安装用户及环境a-namezh-cn_topic_0249784578a) - - [前提条件](#前提条件a-namezh-cn_topic_0241805803_zh-cn_topic_0085434653_zh-cn_topic_0059781995_s3773af79eeb74c4bae1bd46533cc0cd8a) - - [注意事项](#注意事项a-namezh-cn_topic_0241805803_zh-cn_topic_0085434653_zh-cn_topic_0059781995_section20734484163420a) - - [操作步骤](#操作步骤a-namezh-cn_topic_0241805803_zh-cn_topic_0085434653_zh-cn_topic_0059781995_s407f29ab5691456590018c719cf81e9da) - - [示例](#示例a-namezh-cn_topic_0241805803_zh-cn_topic_0085434653_zh-cn_topic_0059781995_section412490911620a) - - [错误排查](#错误排查a-namezh-cn_topic_0241805803_zh-cn_topic_0085434653_zh-cn_topic_0059781995_s51853c2b09e54b12a90e4f8c512a61e4a) -- [手工建立互信](#手工建立互信a-namezh-cn_topic_0249784564a) - - [前提条件](#前提条件a-namezh-cn_topic_0241805804_zh-cn_topic_0085434625_zh-cn_topic_0059782039_s88bba380d9334b129eab3023c5399d45a) - - [使用脚本建立互信](#使用脚本建立互信a-namezh-cn_topic_0241805804_zh-cn_topic_0085434625_zh-cn_topic_0059782039_s8028dd8189914444b059c07d8c8c82dea) - - [手工建立互信](#手工建立互信a-namezh-cn_topic_0241805804_zh-cn_topic_0085434625_zh-cn_topic_0059782039_section63620881152125a) - - [删除root用户互信](#删除root用户互信a-namesection149417461942a) - - [示例](#示例a-namezh-cn_topic_0241805804_zh-cn_topic_0085434625_zh-cn_topic_0059782039_s9928a16b5b7347edbdb587133575483ea) -- [配置操作系统参数](#配置操作系统参数a-namezh-cn_topic_0249784554a) - - [操作系统参数](#操作系统参数a-namezh-cn_topic_0241805805_zh-cn_topic_0085434661_zh-cn_topic_0059782062_section3705271819540a) - - [文件系统参数](#文件系统参数a-namezh-cn_topic_0241805805_zh-cn_topic_0085434661_zh-cn_topic_0059782062_section4118580316369a) - - [transparent\_hugepage设置](#transparent\_hugepage设置a-namezh-cn_topic_0241805805_zh-cn_topic_0085434661_zh-cn_topic_0059782062_section38366550113020a) - - [文件句柄设置](#文件句柄设置a-namezh-cn_topic_0241805805_zh-cn_topic_0085434661_zh-cn_topic_0059782062_section49556455195442a) - - [系统支持的最大进程数设置](#系统支持的最大进程数设置a-namezh-cn_topic_0241805805_zh-cn_topic_0085434661_zh-cn_topic_0059782062_section65253147151525a) - - [网卡参数配置](#网卡参数配置a-namezh-cn_topic_0241805805_zh-cn_topic_0085434661_zh-cn_topic_0059782062_section6007556195457a) +- [准备安装用户及环境](#准备安装用户及环境) + - [前提条件](#前提条件) + - [注意事项](#注意事项) + - [操作步骤](#操作步骤) + - [示例](#示例) + - [错误排查](#错误排查) +- [手工建立互信](#手工建立互信) + - [前提条件](#前提条件-1) + - [使用脚本建立互信](#使用脚本建立互信) + - [手工建立互信](#手工建立互信-1) + - [删除root用户互信](#删除root用户互信) + - [示例](#示例-1) +- [配置操作系统参数](#配置操作系统参数) + - [操作系统参数](#操作系统参数) + - [文件系统参数](#文件系统参数) + - [transparent\_hugepage设置](#transparent\_hugepage设置) + - [文件句柄设置](#文件句柄设置) + - [系统支持的最大进程数设置](#系统支持的最大进程数设置) + - [网卡参数配置](#网卡参数配置) -## 准备安装用户及环境 +## 准备安装用户及环境 创建完openGauss配置文件后，在执行安装前，为了后续能以最小权限进行安装及openGauss管理操作，保证系统安全性，需要运行安装前置脚本gs\_preinstall准备好安装用户及环境。 @@ -36,17 +36,17 @@ - openGauss安装用户、用户组不存在时，自动创建安装用户以及用户组。 - 读取openGauss配置文件中的目录信息并创建，将目录权限授予安装用户。 -### 前提条件 +### 前提条件 - 已完成[安装准备](安装准备.md)的所有任务。 -### 注意事项 +### 注意事项 - 用户需要检查上层目录权限，保证安装用户对安装包和配置文件目录读写执行的权限。 - xml文件中各主机的名称与IP映射配置正确。 - 只能使用root用户执行gs\_preinstall命令。 -### 操作步骤 +### 操作步骤 1. 以root用户登录待安装openGauss的任意主机，并按规划创建存放安装包的目录。 @@ -128,7 +128,7 @@ -### 示例 +### 示例 执行前置脚本： @@ -316,21 +316,21 @@ Successfully set finish flag. Preinstallation succeeded. ``` -### 错误排查 +### 错误排查 如果准备安装环境失败请根据openGauss日志目录“$GAUSSLOG/om”下的“gs\_preinstall-YYYY-MM-DD\_HHMMSS.log”和“gs\_local-YYYY-MM-DD\_HHMMSS.log”中的日志信息排查错误。例如配置文件中“gaussdbLogPath”参数指定的路径为“/var/log/gaussdb”，则“$GAUSSLOG/om”路径为“/var/log/gaussdb/omm/om”，omm用户为运行openGauss的用户。 >![](public_sys-resources/icon-notice.gif) **须知：** >准备安装用户及环境的过程中会使用root添加定时任务用于定时巡检和上报。 -## 手工建立互信 +## 手工建立互信 openGauss在安装过程中，需要在openGauss中的主机间执行命令，传送文件等操作。因此，在普通用户安装前需要确保互信是连通的。前置脚本中会先建立root用户间的互信，然后创建普通用户，并建立普通用户间的互信。 >![](public_sys-resources/icon-notice.gif) **须知：** >root用户互信可能会存在安全隐患，因此建议用户在使用完成后，立即删除各主机上root用户的互信。 -### 前提条件 +### 前提条件 - 确保ssh服务打开。 - 确保ssh端口不会被防火墙关闭。 @@ -362,7 +362,7 @@ openGauss在安装过程中，需要在openGauss中的主机间执行命令， ``` -### 使用脚本建立互信 +### 使用脚本建立互信 1. 创建一个执行互信脚本所需要的输入文本，并在此文件中添加openGauss中所有主机IP。 @@ -383,7 +383,7 @@ openGauss在安装过程中，需要在openGauss中的主机间执行命令， /opt/software/hostfile为主机列表，列出所有需要建立互信机器的主机IP。 -### 手工建立互信 +### 手工建立互信 如果openGauss各主机的root密码不一致，gs\_preinstall脚本无法建立互信，可以手工建立互信。 @@ -534,7 +534,7 @@ openGauss在安装过程中，需要在openGauss中的主机间执行命令， >如果三个以上节点，和上述过程类似。假设节点名为plat1、plat2、plat3、......。第一步，需要在plat1上生成root用户的本机授权文件；第二步，需要收集所有待建互信主机\(plat1、plat2、plat3、......\)的公钥并写入到本机known\_hosts文件中；第三步，需要将互信文件分发到除本机外的所有其它主机\(plat2、plat3、......\)上；第四步，检查互信是否建立成功。 -### 删除root用户互信 +### 删除root用户互信 为了避免Root用户互信可能存在的安全隐患，因此建议用户在使用完成后，立即删除各主机上root用户的互信。 @@ -555,7 +555,7 @@ openGauss在安装过程中，需要在openGauss中的主机间执行命令， Are you sure you want to continue connecting \(yes/no\)? -### 示例 +### 示例 root用户建立互信示例： @@ -633,7 +633,7 @@ Successfully verified SSH trust on all hosts. Successfully created SSH trust. ``` -## 配置操作系统参数 +## 配置操作系统参数 openGauss要求各主机上的操作系统参数设置成一定的值，以满足系统运行的性能要求等。 @@ -651,7 +651,7 @@ openGauss要求各主机上的操作系统参数设置成一定的值，以满 ``` -### 操作系统参数 +### 操作系统参数 **表 1** 操作系统参数 @@ -1067,7 +1067,7 @@ openGauss要求各主机上的操作系统参数设置成一定的值，以满 -### 文件系统参数 +### 文件系统参数 - soft nofile @@ -1088,11 +1088,11 @@ openGauss要求各主机上的操作系统参数设置成一定的值，以满 推荐值：3072 -### transparent\_hugepage设置 +### transparent\_hugepage设置 openGauss默认关闭使用transparent\_hugepage服务，并将关闭命令写入操作系统启动文件。 -### 文件句柄设置 +### 文件句柄设置 需要对文件句柄数进行手动设置时，使用root用户执行如下命令进行参数修改： @@ -1137,7 +1137,7 @@ echo "* hard nofile 1000000" >>/etc/security/limits.conf -### 系统支持的最大进程数设置 +### 系统支持的最大进程数设置 需要对系统支持的最大进程数进行手动设置时，执行如下命令打开conf文件。 @@ -1174,7 +1174,7 @@ vim /etc/security/limits.d/90-nproc.conf -### 网卡参数配置 +### 网卡参数配置 **表 4** 网卡参数配置 -- Gitee