Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions docs/cbdb-op-deploy-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,27 @@
title: Deploy Manually Using RPM Package
---

# Deploy Cloudberry Database Manually Using RPM Package
# Deploy Apache Cloudberry Manually Using RPM Package

This document introduces how to manually deploy Cloudberry Database on physical machines using RPM package. Before reading this document, it is recommended to first read the [Software and Hardware Configuration Requirements](/docs/cbdb-op-software-hardware.md) and [Prepare to Deploy Cloudberry Database on Physical Machine](/docs/cbdb-op-prepare-to-deploy.md).
This document introduces how to manually deploy Apache Cloudberry on physical/virtual machines using RPM package. Before reading this document, it is recommended to first read the [Software and Hardware Configuration Requirements](/docs/cbdb-op-software-hardware.md) and [Prepare to Deploy Apache Cloudberry](/docs/cbdb-op-prepare-to-deploy.md).

The deployment method in this document is for production environments.

The example in this document uses CentOS 7.6 and deploys Cloudberry Database v1.0.0. The main steps are as follows:
The example in this document uses CentOS 7.6 and deploys Apache Cloudberry v1.0.0. The main steps are as follows:

1. [Prepare node servers](#step-1-prepare-server-nodes).
2. [Install the RPM package](#step-2-install-the-rpm-package).
3. [Configure mutual trust between nodes](#step-3-configure-mutual-trust-between-nodes).
4. [Initialize the database](#step-4-initialize-cloudberry-database).
5. [Log into the database](#step-5-log-into-cloudberry-database).
4. [Initialize the database](#step-4-initialize-apache-cloudberry).
5. [Log into the database](#step-5-log-into-apache-cloudberry).

## Step 1: Prepare server nodes

Read the [Prepare to Deploy Cloudberry Database on Physical Machine](/docs/cbdb-op-prepare-to-deploy.md) document to prepare the server nodes.
Read the [Prepare to Deploy Apache Cloudberry](/docs/cbdb-op-prepare-to-deploy.md) document to prepare the server nodes.

## Step 2. Install the RPM package

After the preparation, it is time to install Cloudberry Database. You need to download the corresponding RPM package from [Cloudberry Database Releases](https://github.com/cloudberrydb/cloudberrydb/releases), and then install the database on each node using the installation package.
After the preparation, it is time to install Apache Cloudberry. You need to download the corresponding RPM package from [Apache Cloudberry Releases](https://github.com/apache/cloudberry/releases), and then install the database on each node using the installation package.

1. Download the RPM package to the home directory of `gpadmin`.

Expand Down Expand Up @@ -123,7 +123,7 @@ After the preparation, it is time to install Cloudberry Database. You need to do

If you fail to run `gpssh`, you can first run `source /usr/local/cloudberry-db/greenplum_path.sh` on the coordinator node.

## Step 4. Initialize Cloudberry Database
## Step 4. Initialize Apache Cloudberry

Before performing the following operations, run `su - gpadmin` to switch to the `gpadmin` user.

Expand Down Expand Up @@ -254,7 +254,7 @@ Before performing the following operations, run `su - gpadmin` to switch to the
DATABASE_NAME=warehouse
```

9. Use `gpinitsystem` to initialize Cloudberry Database. For example:
9. Use `gpinitsystem` to initialize Apache Cloudberry. For example:

```bash
gpinitsystem -c gpinitsystem_config -h /home/gpadmin/seg_hosts
Expand All @@ -268,22 +268,22 @@ Before performing the following operations, run `su - gpadmin` to switch to the
gpinitstandby -s cbdb-standbycoordinator
```

## Step 5. Log into Cloudberry Database
## Step 5. Log into Apache Cloudberry

Now you have successfully deployed Cloudberry Database. To log into the database, refer to the following command:
Now you have successfully deployed Apache Cloudberry. To log into the database, refer to the following command:

```bash
psql -h <hostname> -p <port> -U <username> -d <database>
```

In the command above:

- `<hostname>` is the IP address of the coordinator node of the Cloudberry Database server.
- `<port>` is the default port number of Cloudberry Database, which is `5432` by default.
- `<hostname>` is the IP address of the coordinator node of the Apache Cloudberry server.
- `<port>` is the default port number of Apache Cloudberry, which is `5432` by default.
- `<username>` is the user name of the database.
- `<database>` is the name of the database to connect.

After you run the `psql` command, the system will prompt you to enter the database password. After you enter the correct password, you will successfully log into the Cloudberry Database and can perform SQL queries and operations. Make sure that you have the correct permissions to access the target database.
After you run the `psql` command, the system will prompt you to enter the database password. After you enter the correct password, you will successfully log into Apache Cloudberry and can perform SQL queries and operations. Make sure that you have the correct permissions to access the target database.

```sql
[gpadmin@cddb-coordinator ~]$ psql warehouse
Expand Down
20 changes: 10 additions & 10 deletions docs/cbdb-op-prepare-to-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
title: Prepare to Deploy
---

# Prepare to Deploy on Physical Machine
# Prepare to Deploy on Physical or Virtual Machine

Before deploying Cloudberry Database on physical machines, you need to do some preparations. Read this document and [Software and Hardware Configuration Requirements](/docs/cbdb-op-software-hardware.md) before you start to deploy Cloudberry Database.
Before deploying Apache Cloudberry on physical or virtual machines, you need to do some preparations. Read this document and [Software and Hardware Configuration Requirements](/docs/cbdb-op-software-hardware.md) before you start to deploy Apache Cloudberry.

## Plan the deployment architecture

Plan your deployment architecture based on the [Cloudberry Database Architecture](/docs/cbdb-architecture.md) and [Software and Hardware Configuration Requirements](/docs/cbdb-op-software-hardware.md), and determine the number of servers needed. Ensure that all servers are within a single security group and have mutual trust configured.
Plan your deployment architecture based on the [Apache Cloudberry Architecture](/docs/cbdb-architecture.md) and [Software and Hardware Configuration Requirements](/docs/cbdb-op-software-hardware.md), and determine the number of servers needed. Ensure that all servers are within a single security group and have mutual trust configured.

The deployment plan for the example of this document includes 1 coordinator + 1 standby + 3 segments (primary + mirror), totaling 5 servers.

Expand Down Expand Up @@ -163,9 +163,9 @@ In the `/etc/sysctl.conf` configuration file,

#### Port

In the `/etc/sysctl.conf` configuration file, `net.ipv4.ip_local_port_range` is used to specify the port range. To avoid port conflicts between Cloudberry Database and other applications, you need to specify the port range via operating system parameters. When you later set Cloudberry Database initialization parameters, avoid setting Cloudberry Database related ports in this range.
In the `/etc/sysctl.conf` configuration file, `net.ipv4.ip_local_port_range` is used to specify the port range. To avoid port conflicts between Apache Cloudberry and other applications, you need to specify the port range via operating system parameters. When you later set Apache Cloudberry initialization parameters, avoid setting Apache Cloudberry related ports in this range.

For example, for `net.ipv4.ip_local_port_range = 10000 65535`, you need to avoid setting the Cloudberry Database related ports in the interval `[10000,65535]`. You can set them to `6000` and `7000`:
For example, for `net.ipv4.ip_local_port_range = 10000 65535`, you need to avoid setting the Apache Cloudberry related ports in the interval `[10000,65535]`. You can set them to `6000` and `7000`:

```
PORT_BASE = 6000
Expand All @@ -174,7 +174,7 @@ MIRROR_PORT_BASE = 7000

#### IP segmentation

When the Cloudberry Database uses the UDP protocol for internal connection, the network card controls the fragmentation and reassembly of IP packets. If the size of a UDP message is larger than the maximum size of network transmission unit (MTU), the IP layer fragments the message.
When the Apache Cloudberry uses the UDP protocol for internal connection, the network card controls the fragmentation and reassembly of IP packets. If the size of a UDP message is larger than the maximum size of network transmission unit (MTU), the IP layer fragments the message.

- `net.ipv4.ipfrag_high_thresh`: When the total size of IP fragments exceeds this threshold, the kernel will attempt to reorganize IP fragments. If the fragments exceed this threshold but all fragments have not arrived within the specified time, the kernel will not reorganize the fragments. This threshold is typically used to control whether larger shards are reorganized. The default value is `4194304` bytes (4 MB).
- `net.ipv4.ipfrag_low_thresh`: Indicates that when the total size of IP fragments is below this threshold, the kernel will wait as long as possible for more fragments to arrive, to allow for larger reorganizations. This threshold is used to minimize unfinished reorganization operations and improve system performance. The default value is `3145728` bytes (3 MB).
Expand Down Expand Up @@ -247,7 +247,7 @@ Edit the `/etc/security/limits.conf` file and add the following content, which l

#### Set mount options for the XFS file system

XFS is the file system for the data directory of Cloudberry Database. XFS has the following mount options:
XFS is the file system for the data directory of Apache Cloudberry. XFS has the following mount options:

```
rw,nodev,noatime,inode64
Expand Down Expand Up @@ -297,7 +297,7 @@ sudo /sbin/blockdev --setra 16384 /dev/vdc

#### I/O scheduling policy settings for disks

The disk type, operating system and scheduling policies of Cloudberry Database are as follows:
The disk type, operating system and scheduling policies of Apache Cloudberry are as follows:

<table>
<tr>
Expand Down Expand Up @@ -388,7 +388,7 @@ cat /sys/kernel/mm/*transparent_hugepage/enabled

#### Disable IPC object deletion

Disable IPC object deletion by setting the value of `RemoveIPC` to `no`. You can set this parameter in the `/etc/systemd/logind.conf` file of Cloudberry Database.
Disable IPC object deletion by setting the value of `RemoveIPC` to `no`. You can set this parameter in the `/etc/systemd/logind.conf` file of Apache Cloudberry.

```
RemoveIPC=no
Expand Down Expand Up @@ -422,7 +422,7 @@ service sshd restart

#### Clock synchronization

Cloudberry Database requires the clock synchronization to be configured for all hosts, and the clock synchronization service should be started when the host starts. You can choose one of the following synchronization methods:
Apache Cloudberry requires the clock synchronization to be configured for all hosts, and the clock synchronization service should be started when the host starts. You can choose one of the following synchronization methods:

- Use the coordinator node's time as the source, and other hosts synchronize the clock of the coordinator node host.
- Synchronize clocks using an external clock source.
Expand Down
10 changes: 6 additions & 4 deletions docs/cbdb-op-software-hardware.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ title: Software and Hardware Configuration

# Software and Hardware Configuration

This document introduces the software and hardware configuration required for Cloudberry Database.
This document introduces the software and hardware configuration required for Apache Cloudberry.

## Hardware requirements

### Physical machine
### Supported deployment environments

The following section describes the recommended physical machine configuration for Cloudberry Database in test and production environments.
Apache Cloudberry supports deployment on both physical machines and virtual machines. Below are the recommended configurations for the environments.

#### For development or test environments

Expand All @@ -30,6 +30,8 @@ The following section describes the recommended physical machine configuration f
| ETCD | 16+ cores | 64+ GB | SSD | 10 Gbps NIC (2 preferred) | 3+ |
| FTS | 4+ cores | 8+ GB | SSD | 10 Gbps NIC (2 preferred) | 3+ |

Apache Cloudberry can also be deployed on public cloud platforms such as AWS, Azure, and GCP. The hardware requirements for cloud-based deployments might vary based on the instance types selected on these platforms. Refer to the specific cloud provider’s documentation for instance configurations that meet or exceed the recommended hardware specifications.

### Storage

- To prevent a high data disk load from affecting the operating system's normal I/O response, mount the operating system and the data disk on separate disks.
Expand Down Expand Up @@ -96,7 +98,7 @@ mount /dev/data/data2 /data2/

### Supported OS

Cloudberry Database supports the following operating systems:
Apache Cloudberry supports the following operating systems:

- Kylin V10 SP1 or SP2
- NeoKylin V7update6
Expand Down
8 changes: 4 additions & 4 deletions i18n/zh/docusaurus-plugin-content-docs/current.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@
"message": "部署和构建",
"description": "The label for category deployment guides in sidebar docs"
},
"sidebar.docsbars.category.Deploy on Physical Machine": {
"message": "物理机部署",
"description": "The label for category physical machine deployment guides in sidebar docs"
"sidebar.docsbars.category.Deploy on Physical or Virtual Machine": {
"message": "物理机/虚拟机部署",
"description": "The label for category physical/virtual machine deployment guides in sidebar docs"
},
"sidebar.docsbars.category.Build from Source Code": {
"message": "从源码编译安装",
"description": "The label for category building CloudberryDB from source code in sidebar docs"
"description": "The label for category building Cloudberry from source code in sidebar docs"
},
"sidebar.docsbars.category.References": {
"message": "参考指南",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,29 @@
title: 通过 RPM 包手动部署
---

# 通过 RPM 包在物理机上手动部署 Cloudberry Database
# 通过 RPM 包手动部署 Apache Cloudberry

本文档介绍如何通过 RPM 包在物理机上安装与部署 Cloudberry Database。在阅读本文前,建议先阅读[软硬件配置需求](/i18n/zh/docusaurus-plugin-content-docs/current/cbdb-op-software-hardware.md)和[物理机部署前准备工作](/i18n/zh/docusaurus-plugin-content-docs/current/cbdb-op-prepare-to-deploy.md)。
本文档介绍如何通过 RPM 包在物理机/虚拟机上安装与部署 Apache Cloudberry。在阅读本文前,建议先阅读[软硬件配置需求](/i18n/zh/docusaurus-plugin-content-docs/current/cbdb-op-software-hardware.md)和[部署前准备工作](/i18n/zh/docusaurus-plugin-content-docs/current/cbdb-op-prepare-to-deploy.md)。

本文所介绍的部署方法可用于生产环境。

本文示例以 CentOS 7.6 为例,说明如何部署 Cloudberry Database v1.0.0。主要分为以下步骤:
本文示例以 CentOS 7.6 为例,说明如何部署 Apache Cloudberry v1.0.0。主要分为以下步骤:

1. [准备节点服务器](#第-1-步准备节点服务器)。
2. [安装 RPM 包](#第-2-步安装-rpm-包)。
3. [配置节点间互信](#第-3-步配置节点间互信)。
4. [初始化数据库](#第-4-步初始化-cloudberry-database)。
4. [初始化数据库](#第-4-步初始化-apache-cloudberry)。
5. [登录数据库](#第-5-步登录数据库)。

## 第 1 步:准备节点服务器

参照[物理机部署前准备工作](/i18n/zh/docusaurus-plugin-content-docs/current/cbdb-op-prepare-to-deploy.md)的内容,完成节点服务器的准备工作。
参照[部署前准备工作](/i18n/zh/docusaurus-plugin-content-docs/current/cbdb-op-prepare-to-deploy.md)的内容,完成节点服务器的准备工作。

## 第 2 步:安装 RPM 包

在完成准备工作后,就可以安装 Cloudberry Database 了。你需要从 [Cloudberry Database 发布页面](https://github.com/cloudberrydb/cloudberrydb/releases)下载对应的 RPM 安装包,然后在每个节点上通过安装包进行安装。
在完成准备工作后,就可以安装 Apache Cloudberry 了。你需要从 [Apache Cloudberry 发布页面](https://github.com/apache/cloudberry/releases)下载对应的 RPM 安装包,然后在每个节点上通过安装包进行安装。

1. 下载 Cloudberry Database 的 RPM 安装包至 `gpadmin` 主目录 `/home/gpadmin/`:
1. 下载 Apache Cloudberry 的 RPM 安装包至 `gpadmin` 主目录 `/home/gpadmin/`:

```bash
wget -P /home/gpadmin <下载地址>
Expand Down Expand Up @@ -128,7 +128,7 @@ title: 通过 RPM 包手动部署

若无法执行 `gpssh`,可在 Coordinator 节点先执行如下命令 `source /usr/local/cloudberry-db/greenplum_path.sh`。

## 第 4 步:初始化 Cloudberry Database
## 第 4 步:初始化 Apache Cloudberry

执行以下操作前,你需要先执行 `su - gpadmin` 切换到 `gpadmin` 用户。

Expand Down Expand Up @@ -259,7 +259,7 @@ title: 通过 RPM 包手动部署
DATABASE_NAME=warehouse
```

9. 初始化 Cloudberry Database。使用 `gpinitsystem` 命令进行初始化,命令示例如下:
9. 初始化 Apache Cloudberry。使用 `gpinitsystem` 命令进行初始化,命令示例如下:

```bash
gpinitsystem -c gpinitsystem_config -h /home/gpadmin/seg_hosts
Expand All @@ -275,20 +275,20 @@ title: 通过 RPM 包手动部署

## 第 5 步:登录数据库

至此,Cloudberry Database 已经成功部署,你可以参考以下命令来登录数据库:
至此,Apache Cloudberry 已经成功部署,你可以参考以下命令来登录数据库:

```bash
psql -h <hostname> -p <port> -U <username> -d <database>
```

以上命令中:

- `<hostname>` 是 Cloudberry Database 服务器的 Coordinator 节点 IP 地址。
- `<port>` 是 Cloudberry Database 的端口号,默认为 `5432`。
- `<hostname>` 是 Apache Cloudberry 服务器的 Coordinator 节点 IP 地址。
- `<port>` 是 Apache Cloudberry 的端口号,默认为 `5432`。
- `<username>` 是数据库的用户名。
- `<database>` 是要连接的数据库名称。

执行命令后,系统将提示你输入数据库密码。输入正确的密码后,你将成功登录到 Cloudberry Database,并可以执行相应的 SQL 查询和操作。请确保你有正确的权限来访问目标数据库。
执行命令后,系统将提示你输入数据库密码。输入正确的密码后,你将成功登录到 Apache Cloudberry,并可以执行相应的 SQL 查询和操作。请确保你有正确的权限来访问目标数据库。

```sql
[gpadmin@cddb-coordinator ~]$ psql warehouse
Expand Down
Loading