Skip to content

Commit

Permalink
Merge branch 'main' into dbeaver
Browse files Browse the repository at this point in the history
  • Loading branch information
@soyeric128
soyeric128 authored Jan 2, 2025
2 parents 086962d + e6af1f0 commit 5b63c7f
Show file tree
Hide file tree
Showing 54 changed files with 1,279 additions and 383 deletions.
82 changes: 40 additions & 42 deletions docs/cn/guides/10-deploy/01-deploy/01-non-production/01-deploying-databend.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import StepContent from '@site/src/components/Steps/step-content';
import Version from '@site/src/components/Version';
import LanguageDocs from '@site/src/components/LanguageDocs';

<FunctionDescription description="引入或更新: v1.2.168"/>
<FunctionDescription description="引入或更新于：v1.2.168"/>

import EEFeature from '@site/src/components/EEFeature';

Expand Down Expand Up @@ -53,7 +53,7 @@ import TabItem from '@theme/TabItem';
base64 -i <path-to-your-key-file> -o ~/Desktop/base64-encoded-key.txt
```

上述命令将生成一个名为 `base64-encoded-key.txt` 的文件，其中包含您随后将在 `databend-query.toml` 配置文件中用于配置连接的凭证。
上述命令将生成一个名为 `base64-encoded-key.txt` 的文件，其中包含您随后将在 `databend-query.toml` 配置文件中用于配置连接的凭据。

</TabItem>

Expand Down Expand Up @@ -172,7 +172,7 @@ base64 -i <path-to-your-key-file> -o ~/Desktop/base64-encoded-key.txt
### 下载 Databend

1. 在目录 `/usr/local` 中创建一个名为 `databend` 的文件夹。
2. 从 [GitHub Release](https://github.com/databendlabs/databend/releases) 下载并提取适用于您平台的最新 Databend 版本：
2. 从 [GitHub Release](https://github.com/databendlabs/databend/releases) 下载并解压适用于您平台的最新 Databend 版本：

<Tabs>
<TabItem value="linux-x86_64" label="Linux(x86)">
Expand Down Expand Up @@ -204,13 +204,13 @@ tar xzvf databend-[version]-aarch64-unknown-linux-musl.tar.gz
</TabItem>
</Tabs>

3. 将提取的文件夹 `bin`、`configs` 和 `scripts` 移动到文件夹 `/usr/local/databend`。
3. 将解压后的文件夹 `bin`、`configs` 和 `scripts` 移动到文件夹 `/usr/local/databend`。

</StepContent>

</StepsWrap>

### 步骤 1: 部署 Meta 节点
### 第一步：部署 Meta 节点

按照以下说明部署 Meta 节点：

Expand Down Expand Up @@ -240,7 +240,7 @@ curl -I http://127.0.0.1:28101/v1/health
</StepContent>
</StepsWrap>

### 步骤 2: 部署 Query 节点
### 第二步：部署 Query 节点

按照以下说明部署 Query 节点：

Expand All @@ -251,9 +251,9 @@ curl -I http://127.0.0.1:28101/v1/health
### 配置 Query 节点

1. 在文件夹 `/usr/local/databend/configs` 中找到文件 `databend-query.toml`。
2. 在文件 `databend-query.toml` 中，设置 [storage] 块中的参数 _type_，并配置连接到您的对象存储的访问凭证和端点 URL。
2. 在文件 `databend-query.toml` 中，设置 [storage] 块中的 *type* 参数，并配置连接到您的对象存储的访问凭据和端点 URL。

要配置您的存储设置，请通过在每行开头添加 `#` 来注释掉 [storage.fs] 部分。然后，通过删除 `#` 符号并填写您的值来取消注释适用于您的对象存储提供商的相关部分。
要配置您的存储设置，请在 [storage.fs] 部分前添加 `#` 注释掉每一行。然后，删除相关对象存储提供程序部分的 `#` 符号并填写您的值。

<Tabs groupId="operating-systems">

Expand All @@ -269,7 +269,7 @@ type = "s3"
bucket = "my_bucket"
endpoint_url = "https://s3.amazonaws.com"

# 如何获取 access_key_id 和 secret_access_key:
# How to get access_key_id and secret_access_key:
# https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html
// highlight-next-line
access_key_id = "<your-key-id>"
Expand All @@ -291,7 +291,7 @@ type = "gcs"
[storage.gcs]
bucket = "my_bucket"

# endpoint_url 默认为 "https://storage.googleapis.com"
# endpoint_url defaults to "https://storage.googleapis.com"

credential = "<your-credential>"
```
Expand All @@ -308,8 +308,6 @@ type = "azblob"
[storage.azblob]
endpoint_url = "https://<your-storage-account-name>.blob.core.windows.net"



# https://docs.microsoft.com/en-us/azure/storage/blobs/storage-quickstart-blobs-portal#create-a-container
container = "my_bucket"
account_name = "<your-storage-account-name>"
Expand All @@ -320,26 +318,26 @@ account_key = "<your-account-key>"

</TabItem>

<TabItem value="Tencent COS" label="Tencent COS">
<TabItem value="Tencent COS" label="腾讯云 COS">

在指定 `endpoint_url` 参数时，请确保从您的存储桶端点中排除 `<BucketName-APPID>` 部分。例如，如果您的存储桶端点是 `https://databend-xxxxxxxxxx.cos.ap-beijing.myqcloud.com`，请使用 `https://cos.ap-beijing.myqcloud.com`。有关腾讯云 COS 在不同区域的端点，请参考 https://www.tencentcloud.com/document/product/436/6224。
在指定 `endpoint_url` 参数时，请确保从您的存储桶端点中排除 `<BucketName-APPID>` 部分。例如，如果您的存储桶端点是 `https://databend-xxxxxxxxxx.cos.ap-beijing.myqcloud.com`，请使用 `https://cos.ap-beijing.myqcloud.com`。有关腾讯云 COS 各区域的端点，请参阅 https://www.tencentcloud.com/document/product/436/6224。

```toml title='databend-query.toml'
[storage]
# s3
type = "cos"

[storage.cos]
# 如何创建存储桶:
# 如何创建存储桶：
# https://cloud.tencent.com/document/product/436/13309
// highlight-next-line
bucket = "my_bucket"

# 以下是一个示例，区域为北京 (ap-beijing)。
# 以下示例区域为北京（ap-beijing）。
// highlight-next-line
endpoint_url = "https://cos.ap-beijing.myqcloud.com"

# 如何获取 secret_id 和 secret_key:
# 如何获取 secret_id 和 secret_key：
# https://cloud.tencent.com/document/product/436/68282
// highlight-next-line
secret_id = "<your-secret-id>"
Expand All @@ -349,7 +347,7 @@ secret_key = "<your-secret-key>"

</TabItem>

<TabItem value="Alibaba OSS" label="Alibaba Cloud OSS">
<TabItem value="Alibaba OSS" label="阿里云 OSS">

```toml title='databend-query.toml'
[storage]
Expand All @@ -365,30 +363,30 @@ bucket = "my_bucket"
// highlight-next-line
# https://<bucket-name>.<region-id>[-internal].aliyuncs.com
// highlight-next-line
# 此示例使用 OSS 区域 ID: oss-cn-beijing-internal。
# 本示例使用 OSS 区域 ID：oss-cn-beijing-internal。
endpoint_url = "https://oss-cn-beijing-internal.aliyuncs.com"
# enable_virtual_host_style = true

# 如何获取 access_key_id 和 secret_access_key:
# 如何获取 access_key_id 和 secret_access_key：
# https://help.aliyun.com/document_detail/53045.htm
// highlight-next-line
access_key_id = "<your-key-id>"
// highlight-next-line
secret_access_key = "<your-access-key>"
access_key_secret = "<your-access-key>"
```

Databend 企业版支持 OSS 中的服务器端加密。此功能使您能够通过激活 OSS 中存储数据的服务器端加密来增强数据安全性和隐私。您可以选择最适合您需求的加密方法。请注意，您必须拥有有效的 Databend 企业版许可证才能使用此功能。要获取许可证，请参阅 [Licensing Databend](../../../00-overview/00-editions/01-dee/20-license.md)。
Databend 企业版支持 OSS 中的服务器端加密。此功能使您能够通过激活 OSS 中存储数据的服务器端加密来增强数据安全性和隐私性。您可以选择最适合您需求的加密方法。请注意，您必须拥有有效的 Databend 企业版许可证才能使用此功能。要获取许可证，请参阅 [Databend 企业版许可证](../../../00-overview/00-editions/01-dee/20-license.md)。

要在 Databend 中启用服务器端加密，请将以下参数添加到 [storage.oss] 部分：
要在 Databend 中启用服务器端加密，请在 [storage.oss] 部分添加以下参数：

| 参数 | 描述 | 可用值 |
| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
| server_side_encryption | 指定 OSS 数据的服务器端加密方法。"AES256" 使用 OSS 管理的 AES256 密钥进行加密，而 "KMS" 使用 server_side_encryption_key_id 中定义的密钥。 | "AES256" 或 "KMS" |
| server_side_encryption_key_id | 当 server_side_encryption 设置为 "KMS" 时，此参数用于指定 OSS 的服务器端加密密钥 ID。它仅在使用 KMS 加密模式时适用。 | 字符串，KMS 加密密钥的唯一标识符。 |
| 参数 | 描述 | 可用值 |
| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- |
| server_side_encryption | 指定 OSS 数据的服务器端加密方法。"AES256" 使用 OSS 管理的 AES256 密钥进行加密，而 "KMS" 使用 server_side_encryption_key_id 中定义的密钥。 | "AES256" 或 "KMS" |
| server_side_encryption_key_id | 当 server_side_encryption 设置为 "KMS" 时，此参数用于指定 OSS 的服务器端加密密钥 ID。仅在 KMS 加密模式下适用。 | 字符串，KMS 加密密钥的唯一标识符。 |

</TabItem>

<TabItem value="QingCloud QingStor" label="QingCloud QingStor">
<TabItem value="QingCloud QingStor" label="青云 QingStor">

```toml title='databend-query.toml'
[storage]
Expand All @@ -401,11 +399,11 @@ bucket = "my_bucket"

# 您可以从存储桶详情页面获取 URL。
# https://docsv3.qingcloud.com/storage/object-storage/intro/object-storage/#zone
# 使用与 AWS S3 兼容的 API。您需要在域名中添加一个 s3 子域，例如 https://s3.<zone-id>.qingstor.com
# 使用与 AWS S3 兼容的 API。您需要在域名前添加 s3 子域名，如 https://s3.<zone-id>.qingstor.com
// highlight-next-line
endpoint_url = "https://s3.pek3b.qingstor.com"

# 如何获取 access_key_id 和 secret_access_key:
# 如何获取 access_key_id 和 secret_access_key：
# https://docsv3.qingcloud.com/development_docs/api/overview/
// highlight-next-line
access_key_id = "<your-key-id>"
Expand All @@ -416,7 +414,7 @@ secret_access_key = "<your-access-key>"
</TabItem>

<!-- #ifcndef -->
<TabItem value="Huawei OBS" label="Huawei OBS">
<TabItem value="Huawei OBS" label="华为云 OBS">

```toml title='databend-query.toml'
[storage]
Expand Down Expand Up @@ -450,12 +448,12 @@ type = "s3"
// highlight-next-line
bucket = "my_bucket"

# 您可以从以下链接获取 URL:
# 您可以从以下链接获取 URL：
# https://wasabi-support.zendesk.com/hc/en-us/articles/360015106031-What-are-the-service-URLs-for-Wasabi-s-different-regions-
// highlight-next-line
endpoint_url = "https://s3.us-east-2.wasabisys.com"

# 如何获取 access_key_id 和 secret_access_key:
# 如何获取 access_key_id 和 secret_access_key：
// highlight-next-line
access_key_id = "<your-key-id>"
// highlight-next-line
Expand Down Expand Up @@ -501,7 +499,7 @@ secret_access_key = "<your-access-key>"
3. 使用 [query.users] 部分配置管理员用户。有关更多信息，请参阅 [配置管理员用户](../../04-references/01-admin-users.md)。要继续使用默认的 root 用户和 "no_password" 认证类型，请确保在文件 `databend-query.toml` 中删除以下行前的 '#' 字符：

:::caution
在本教程中使用 "no_password" 认证的 root 用户只是一个示例，不建议在生产环境中使用，因为可能存在安全风险。
在本教程中使用 "no_password" 认证的 root 用户仅作为示例，由于潜在的安全风险，不推荐在生产环境中使用。
:::

```toml title='databend-query.toml'
Expand All @@ -516,10 +514,10 @@ auth_type = "no_password"

<StepContent number="2">

### 启动查询节点
### 启动 Query 节点

1. 打开终端窗口并导航到文件夹 `/usr/local/databend/bin`。
2. 运行以下命令以启动查询节点：
2. 运行以下命令以启动 Query 节点：

```shell
./databend-query -c ../configs/databend-query.toml > query.log 2>&1 &
Expand All @@ -529,9 +527,9 @@ auth_type = "no_password"

<StepContent number="3">

### 检查查询节点
### 检查 Query 节点

运行以下命令以检查查询节点是否成功启动：
运行以下命令以检查 Query 节点是否成功启动：

```shell
curl -I http://127.0.0.1:8080/v1/health
Expand All @@ -543,7 +541,7 @@ curl -I http://127.0.0.1:8080/v1/health

### 步骤 3：验证部署

在此步骤中，您将使用 [BendSQL](https://github.com/databendlabs/BendSQL) 对 Databend 运行一个简单的查询，以验证部署。
在此步骤中，您将使用 [BendSQL](https://github.com/databendlabs/BendSQL) 对 Databend 运行一个简单查询以验证部署。

<StepsWrap>

Expand All @@ -566,7 +564,7 @@ curl -I http://127.0.0.1:8080/v1/health

### 启动 / 停止 Databend

每次启动或停止 Databend 时，无需单独管理 Meta 和 Query 节点。执行 `/usr/local/databend/scripts` 目录中的脚本，以一次性处理两个节点：
每次启动或停止 Databend 时，无需单独管理 Meta 和 Query 节点。执行 `/usr/local/databend/scripts` 目录中的脚本即可一次性处理两个节点：

```shell
# 启动 Databend
Expand All @@ -591,7 +589,7 @@ curl -I http://127.0.0.1:8080/v1/health
Databend Query start failure, cause: Code: 1104, Text = failed to create appender: Os { code: 13, kind: PermissionDenied, message: "Permission denied" }.
```
请运行以下命令，然后再次尝试启动 Databend：
运行以下命令并再次尝试启动 Databend：
```shell
sudo mkdir /var/log/databend
Expand All @@ -609,4 +607,4 @@ sudo chown -R $USER /var/lib/databend
部署 Databend 后，您可能需要了解以下主题：
- [加载 & 卸载数据](/guides/load-data)：管理 Databend 中的数据导入/导出。
- [可视化](/guides/visualize)：将 Databend 与可视化工具集成以获取洞察。
- [可视化](/guides/visualize)：将 Databend 与可视化工具集成以获得洞察。
Loading

0 comments on commit 5b63c7f

Please sign in to comment.