You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shenyu.apache.org by xi...@apache.org on 2022/06/06 01:26:18 UTC
[incubator-shenyu-website] branch main updated: [DOC #587] Add the user initializing database guide. (#588)
This is an automated email from the ASF dual-hosted git repository.
xiaoyu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-shenyu-website.git
The following commit(s) were added to refs/heads/main by this push:
new 73dfd7c30c [DOC #587] Add the user initializing database guide. (#588)
73dfd7c30c is described below
commit 73dfd7c30ce304a663250b7067b45e34b3e2cd0e
Author: Shawn Jim <32...@users.noreply.github.com>
AuthorDate: Mon Jun 6 09:26:13 2022 +0800
[DOC #587] Add the user initializing database guide. (#588)
* [DOC #587] Add the user initializing database guide.
* [DOC #587] pass markdownlint.
* [DOC #587] pass markdownlint.
---
docs/deployment/deployment-before.md | 25 ++++++++++++++++++++++
docs/deployment/deployment-cluster.md | 2 ++
docs/deployment/deployment-custom.md | 1 +
docs/deployment/deployment-docker-compose.md | 2 ++
docs/deployment/deployment-docker.md | 2 ++
docs/deployment/deployment-helm.md | 2 ++
docs/deployment/deployment-k8s.md | 3 ++-
docs/deployment/deployment-local.md | 2 ++
docs/deployment/deployment-package.md | 1 +
docs/deployment/deployment-quick.md | 2 ++
.../current/deployment/deployment-before.md | 24 +++++++++++++++++++++
.../current/deployment/deployment-cluster.md | 4 +++-
.../current/deployment/deployment-custom.md | 1 +
.../deployment/deployment-docker-compose.md | 2 ++
.../current/deployment/deployment-docker.md | 2 ++
.../current/deployment/deployment-helm.md | 2 ++
.../current/deployment/deployment-k8s.md | 3 ++-
.../current/deployment/deployment-local.md | 2 ++
.../current/deployment/deployment-package.md | 2 ++
.../current/deployment/deployment-quick.md | 2 ++
.../version-2.4.3/deployment/deployment-before.md | 24 +++++++++++++++++++++
.../version-2.4.3/deployment/deployment-cluster.md | 6 ++++--
.../version-2.4.3/deployment/deployment-custom.md | 1 +
.../deployment/deployment-docker-compose.md | 2 ++
.../version-2.4.3/deployment/deployment-docker.md | 2 ++
.../version-2.4.3/deployment/deployment-helm.md | 2 ++
.../version-2.4.3/deployment/deployment-k8s.md | 3 ++-
.../version-2.4.3/deployment/deployment-local.md | 2 ++
.../version-2.4.3/deployment/deployment-package.md | 1 +
.../version-2.4.3/deployment/deployment-quick.md | 2 ++
.../version-2.4.3/deployment/deployment-before.md | 25 ++++++++++++++++++++++
.../version-2.4.3/deployment/deployment-cluster.md | 2 ++
.../version-2.4.3/deployment/deployment-custom.md | 1 +
.../deployment/deployment-docker-compose.md | 2 ++
.../version-2.4.3/deployment/deployment-docker.md | 2 ++
.../version-2.4.3/deployment/deployment-helm.md | 2 ++
.../version-2.4.3/deployment/deployment-k8s.md | 3 ++-
.../version-2.4.3/deployment/deployment-local.md | 2 ++
.../version-2.4.3/deployment/deployment-package.md | 1 +
.../version-2.4.3/deployment/deployment-quick.md | 2 ++
40 files changed, 166 insertions(+), 7 deletions(-)
diff --git a/docs/deployment/deployment-before.md b/docs/deployment/deployment-before.md
new file mode 100644
index 0000000000..15cacfa16f
--- /dev/null
+++ b/docs/deployment/deployment-before.md
@@ -0,0 +1,25 @@
+---
+sidebar_position: 0
+title: Deployment Prerequisites
+keywords: ["Deployment Prerequisites"]
+description: Deployment Prerequisites
+---
+
+This article describes some of the prerequisites you need to prepare before deploying the Apache ShenYu gateway.
+
+## Database Initialize
+
+Before deploying the `Shenyu-admin` project, initialize the database it uses (databases currently support: Mysql, PostgreSql, Oracle), which used the script files are stored in db directory [project root directory](https://github.com/apache/incubator-shenyu/tree/master/db), The following describes the initial steps for each database.
+
+### Mysql
+
+In [the mysql initialization scripts directory](https://github.com/apache/incubator-shenyu/tree/master/db/init/mysql) found in the initialization script `schema.sql`, Use the client connection tool to connect to your Mysql service and execute, so you get a database named `shenyu`, which can later be used as the database for the `Shenyu-admin` project.
+
+### PostgreSql
+
+In [the pg initialization scripts directory](https://github.com/apache/incubator-shenyu/tree/master/db/init/pg) found in the initialization script `create-database.sql`、 `create-table.sql`, and use the client connection tool to connect to your PostgreSql service. so you get a database named `shenyu`, which can later be used as a database for the `Shenyu-admin` project.
+
+### Oracle
+
+In [the oracle initialization scripts directory](https://github.com/apache/incubator-shenyu/blob/master/db/init/oracle) found in the initialization script `schema.sql`, Use the client connection tool to connect to your Oracle service to create a database, execute the `schema.sql` script on this database, and initialize the `Shenyu-admin` database. After can be [project configuration file](https://github.com/apache/incubator-shenyu/blob/master/shenyu-admin/src/main/resources/application-o [...]
+
diff --git a/docs/deployment/deployment-cluster.md b/docs/deployment/deployment-cluster.md
index 0e2b85d384..e1c3242856 100644
--- a/docs/deployment/deployment-cluster.md
+++ b/docs/deployment/deployment-cluster.md
@@ -5,6 +5,8 @@ keywords: ["Gateway Cluster Enviroment", "Cluster Enviroment"]
description: Cluster Delopyment
---
+> Before you read this document, you need to complete some preparations before deploying Shenyu according to the [Deployment Prerequisites document](./deployment-before.md).
+
This aritcle introduces how to delopy the `Shenyu` gateway in cluster enviroment.
> In this part, you can see [ShenYu Binary Packages Deployment](./deployment-package.md) before deploying.
diff --git a/docs/deployment/deployment-custom.md b/docs/deployment/deployment-custom.md
index 2d869fcfc7..2c948e754f 100644
--- a/docs/deployment/deployment-custom.md
+++ b/docs/deployment/deployment-custom.md
@@ -7,6 +7,7 @@ description: Custom Deployment
This article describes how to build your own gateway based on `Apache ShenYu`.
+> Before you read this document, you need to complete some preparations before deploying Shenyu according to the [Deployment Prerequisites document](./deployment-before.md).
### Start Apache ShenYu Admin
diff --git a/docs/deployment/deployment-docker-compose.md b/docs/deployment/deployment-docker-compose.md
index 89c740486e..bb5e708c89 100644
--- a/docs/deployment/deployment-docker-compose.md
+++ b/docs/deployment/deployment-docker-compose.md
@@ -7,6 +7,8 @@ description: Docker-compose Deployment
This article introduces the use of `docker-compose` to deploy the `Apache ShenYu` gateway.
+> Before you read this document, you need to complete some preparations before deploying Shenyu according to the [Deployment Prerequisites document](./deployment-before.md).
+
### Download shell script
```shell
diff --git a/docs/deployment/deployment-docker.md b/docs/deployment/deployment-docker.md
index 94282f723c..791f4ee1a7 100644
--- a/docs/deployment/deployment-docker.md
+++ b/docs/deployment/deployment-docker.md
@@ -7,6 +7,8 @@ description: Docker Deployment
This article introduces the use of `docker` to deploy the `Apache ShenYu` gateway.
+> Before you read this document, you need to complete some preparations before deploying Shenyu according to the [Deployment Prerequisites document](./deployment-before.md).
+
### Start Apache ShenYu Admin
```
diff --git a/docs/deployment/deployment-helm.md b/docs/deployment/deployment-helm.md
index b4e0d410e7..38c7126d0b 100644
--- a/docs/deployment/deployment-helm.md
+++ b/docs/deployment/deployment-helm.md
@@ -6,3 +6,5 @@ description: Helm Deployment
---
This article introduces the use of `helm` to deploy the `Apache ShenYu` gateway.
+
+> Before you read this document, you need to complete some preparations before deploying Shenyu according to the [Deployment Prerequisites document](./deployment-before.md).
diff --git a/docs/deployment/deployment-k8s.md b/docs/deployment/deployment-k8s.md
index 50d4b5b024..ed2f8a4cd3 100644
--- a/docs/deployment/deployment-k8s.md
+++ b/docs/deployment/deployment-k8s.md
@@ -5,8 +5,9 @@ keywords: ["k8s"]
description: k8s Deployment
---
-This article introduces the use of `k8s` to deploy the `Apache ShenYu` gateway.
+> Before you read this document, you need to complete some preparations before deploying Shenyu according to the [Deployment Prerequisites document](./deployment-before.md).
+This article introduces the use of `k8s` to deploy the `Apache ShenYu` gateway.
> Catalog
>
diff --git a/docs/deployment/deployment-local.md b/docs/deployment/deployment-local.md
index c68cd83b4f..01dce11874 100644
--- a/docs/deployment/deployment-local.md
+++ b/docs/deployment/deployment-local.md
@@ -7,6 +7,8 @@ description: Local Deployment
This article introduces how to start the `Apache ShenYu` gateway in the local environment.
+> Before you read this document, you need to complete some preparations before deploying Shenyu according to the [Deployment Prerequisites document](./deployment-before.md).
+
### Environmental preparation
* Install JDK1.8+ locally
diff --git a/docs/deployment/deployment-package.md b/docs/deployment/deployment-package.md
index a2cf411ed9..8a6d2613e2 100644
--- a/docs/deployment/deployment-package.md
+++ b/docs/deployment/deployment-package.md
@@ -7,6 +7,7 @@ description: Binary Packages Deployment
This article introduces the deployment of the `Apache ShenYu` gateway using the binary packages.
+> Before you read this document, you need to complete some preparations before deploying Shenyu according to the [Deployment Prerequisites document](./deployment-before.md).
### Start Apache ShenYu Admin
diff --git a/docs/deployment/deployment-quick.md b/docs/deployment/deployment-quick.md
index 304e8fd319..8aa9e2a4e0 100644
--- a/docs/deployment/deployment-quick.md
+++ b/docs/deployment/deployment-quick.md
@@ -7,6 +7,8 @@ description: Local Quick Deployment
This article introduces how to quick start the `Apache ShenYu` gateway in the standalone environment.
+> Before you read this document, you need to complete some preparations before deploying Shenyu according to the [Deployment Prerequisites document](./deployment-before.md).
+
### Environmental preparation
* Install JDK1.8+ locally
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-before.md b/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-before.md
new file mode 100644
index 0000000000..f8c47d3b88
--- /dev/null
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-before.md
@@ -0,0 +1,24 @@
+---
+sidebar_position: 0
+title: 部署先决条件
+keywords: ["Prerequisites"]
+description: 部署先决条件
+---
+
+本文介绍在部署 `Apache ShenYu` 网关前, 所需要准备的一些先决条件。
+
+## 数据库环境准备
+
+在部署`shenyu-admin`项目前, 需初始化其所使用的数据库（数据库目前支持: Mysql、PostgreSql、Oracle）, 其中所用到的脚本文件都存放在 [项目根目录下的db目录](https://github.com/apache/incubator-shenyu/tree/master/db) 中, 以下介绍了各数据库的初始步骤.
+
+### Mysql
+
+在[项目mysql初始化脚本目录](https://github.com/apache/incubator-shenyu/tree/master/db/init/mysql) 中找到初始化脚本`schema.sql`, 使用客户端连接工具连接您的Mysql服务并执行, 由此您会得到一个名为`shenyu`的数据库, 它之后可作为`shenyu-admin`项目的数据库使用.
+
+### PostgreSql
+
+在[项目pg初始化脚本目录](https://github.com/apache/incubator-shenyu/tree/master/db/init/pg) 中找到初始化脚本`create-database.sql`、`create-table.sql`, 并使用客户端连接工具连接您的PostgreSql服务依次执行，由此您会得到一个名为shenyu的数据库, 它之后可作为`shenyu-admin`项目的数据库使用.
+
+### Oracle
+
+在[项目oracle初始化脚本目录](https://github.com/apache/incubator-shenyu/blob/master/db/init/oracle) 中找到初始化脚本`schema.sql`, 使用客户端连接工具连接您的Oracle服务创建一个数据库, 在此数据库上执行`schema.sql`脚本, 由此您便初始化了`shenyu-admin`的数据库, 之后可在[项目配置文件](https://github.com/apache/incubator-shenyu/blob/master/shenyu-admin/src/main/resources/application-oracle.yml) 中调整您的oracle环境配置.
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-cluster.md b/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-cluster.md
index a20174188c..6a9337ebea 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-cluster.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-cluster.md
@@ -5,7 +5,9 @@ keywords: ["网关集群", "集群部署"]
description: 集群部署
---
-文本是介绍在集群环境中快速部署`ShenYu`网关。
+> 在阅读本文档前，你需要先阅读[部署先决条件](./deployment-before.md)文档来完成部署`shenyu`前的环境准备工作.
+
+本文是介绍在集群环境中快速部署`ShenYu`网关。
> 在阅读本文档时，你可以先阅读[二进制包部署](./deployment-package.md)。
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-custom.md b/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-custom.md
index 279f4fa110..ed08347932 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-custom.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-custom.md
@@ -6,6 +6,7 @@ description: 自定义部署
本文介绍如何基于 `Apache ShenYu` 搭建属于你自己的网关。
+> 在阅读本文档前，你需要先阅读[部署先决条件](./deployment-before.md)文档来完成部署`shenyu`前的环境准备工作.
### 启动Apache ShenYu Admin
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-docker-compose.md b/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-docker-compose.md
index 14ef693e9f..08cba0e0bb 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-docker-compose.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-docker-compose.md
@@ -7,6 +7,8 @@ description: Docker-compose Deployment
本文介绍使用 `docker-compose` 来部署 `Apache ShenYu` 网关。
+> 在阅读本文档前，你需要先阅读[部署先决条件](./deployment-before.md)文档来完成部署`shenyu`前的环境准备工作.
+
### 下载 shell 脚本
```shell
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-docker.md b/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-docker.md
index 721cf05018..79885dc681 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-docker.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-docker.md
@@ -7,6 +7,8 @@ description: docker部署
本文介绍使用 `docker` 来部署 `Apache ShenYu` 网关。
+> 在阅读本文档前，你需要先阅读[部署先决条件](./deployment-before.md)文档来完成部署`shenyu`前的环境准备工作.
+
### 启动Apache ShenYu Admin
```
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-helm.md b/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-helm.md
index cbcdb497da..53418a9ab9 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-helm.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-helm.md
@@ -6,3 +6,5 @@ description: Helm部署
---
本文介绍使用 `helm` 来部署 `Apache ShenYu` 网关。
+
+> 在阅读本文档前，你需要先阅读[部署先决条件](./deployment-before.md)文档来完成部署`shenyu`前的环境准备工作.
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-k8s.md b/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-k8s.md
index 6b9c01abb3..93d6fddfca 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-k8s.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-k8s.md
@@ -5,8 +5,9 @@ keywords: ["k8s"]
description: k8s部署
---
-本文介绍使用 `k8s` 来部署 `Apache ShenYu` 网关。
+> 在阅读本文档前，你需要先阅读[部署先决条件](./deployment-before.md)文档来完成部署`shenyu`前的环境准备工作.
+本文介绍使用 `k8s` 来部署 `Apache ShenYu` 网关。
> 目录
>
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-local.md b/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-local.md
index ab77e8958d..b06bb1996d 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-local.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-local.md
@@ -7,6 +7,8 @@ description: 本地部署
本文介绍本地环境启动 `Apache ShenYu` 网关。
+> 在阅读本文档前，你需要先阅读[部署先决条件](./deployment-before.md)文档来完成部署`shenyu`前的环境准备工作.
+
### 环境准备
* 本地正确安装JDK1.8+
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-package.md b/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-package.md
index 7b3a45b080..60f0ddc8c5 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-package.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-package.md
@@ -7,6 +7,8 @@ description: 二进制包部署
本文介绍使用二进制包部署 `Apache ShenYu` 网关。
+> 在阅读本文档前，你需要先阅读[部署先决条件](./deployment-before.md)文档来完成部署`shenyu`前的环境准备工作.
+
### 启动 Apache ShenYu Admin
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-quick.md b/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-quick.md
index b189dd4963..d6e011ead6 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-quick.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/deployment/deployment-quick.md
@@ -7,6 +7,8 @@ description: 单机快速部署
本文介绍单机环境快速启动 `Apache ShenYu` 网关。
+> 在阅读本文档前，你需要先阅读[部署先决条件](./deployment-before.md)文档来完成部署`shenyu`前的环境准备工作.
+
### 环境准备
* 本地正确安装JDK1.8+
diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-before.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-before.md
new file mode 100644
index 0000000000..f8c47d3b88
--- /dev/null
+++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-before.md
@@ -0,0 +1,24 @@
+---
+sidebar_position: 0
+title: 部署先决条件
+keywords: ["Prerequisites"]
+description: 部署先决条件
+---
+
+本文介绍在部署 `Apache ShenYu` 网关前, 所需要准备的一些先决条件。
+
+## 数据库环境准备
+
+在部署`shenyu-admin`项目前, 需初始化其所使用的数据库（数据库目前支持: Mysql、PostgreSql、Oracle）, 其中所用到的脚本文件都存放在 [项目根目录下的db目录](https://github.com/apache/incubator-shenyu/tree/master/db) 中, 以下介绍了各数据库的初始步骤.
+
+### Mysql
+
+在[项目mysql初始化脚本目录](https://github.com/apache/incubator-shenyu/tree/master/db/init/mysql) 中找到初始化脚本`schema.sql`, 使用客户端连接工具连接您的Mysql服务并执行, 由此您会得到一个名为`shenyu`的数据库, 它之后可作为`shenyu-admin`项目的数据库使用.
+
+### PostgreSql
+
+在[项目pg初始化脚本目录](https://github.com/apache/incubator-shenyu/tree/master/db/init/pg) 中找到初始化脚本`create-database.sql`、`create-table.sql`, 并使用客户端连接工具连接您的PostgreSql服务依次执行，由此您会得到一个名为shenyu的数据库, 它之后可作为`shenyu-admin`项目的数据库使用.
+
+### Oracle
+
+在[项目oracle初始化脚本目录](https://github.com/apache/incubator-shenyu/blob/master/db/init/oracle) 中找到初始化脚本`schema.sql`, 使用客户端连接工具连接您的Oracle服务创建一个数据库, 在此数据库上执行`schema.sql`脚本, 由此您便初始化了`shenyu-admin`的数据库, 之后可在[项目配置文件](https://github.com/apache/incubator-shenyu/blob/master/shenyu-admin/src/main/resources/application-oracle.yml) 中调整您的oracle环境配置.
diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-cluster.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-cluster.md
index 75871af2f6..f4f69dfcd7 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-cluster.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-cluster.md
@@ -5,9 +5,11 @@ keywords: ["网关集群", "集群部署"]
description: 集群部署
---
-文本是介绍在集群环境中快速部署`ShenYu`网关。
+> 在阅读本文档前，你需要先阅读[部署先决条件](./deployment-before.md)文档来完成部署`shenyu`前的环境准备工作.
-> 在阅读本文档时，你可以先阅读[二进制包部署](./deployment-package.md)。
+本文是介绍在集群环境中快速部署`ShenYu`网关。
+
+> 同时，在阅读本文档前，你可以先阅读[二进制包部署](./deployment-package.md)。
### 环境准备
diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-custom.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-custom.md
index 279f4fa110..ed08347932 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-custom.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-custom.md
@@ -6,6 +6,7 @@ description: 自定义部署
本文介绍如何基于 `Apache ShenYu` 搭建属于你自己的网关。
+> 在阅读本文档前，你需要先阅读[部署先决条件](./deployment-before.md)文档来完成部署`shenyu`前的环境准备工作.
### 启动Apache ShenYu Admin
diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-docker-compose.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-docker-compose.md
index 14ef693e9f..08cba0e0bb 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-docker-compose.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-docker-compose.md
@@ -7,6 +7,8 @@ description: Docker-compose Deployment
本文介绍使用 `docker-compose` 来部署 `Apache ShenYu` 网关。
+> 在阅读本文档前，你需要先阅读[部署先决条件](./deployment-before.md)文档来完成部署`shenyu`前的环境准备工作.
+
### 下载 shell 脚本
```shell
diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-docker.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-docker.md
index 721cf05018..79885dc681 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-docker.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-docker.md
@@ -7,6 +7,8 @@ description: docker部署
本文介绍使用 `docker` 来部署 `Apache ShenYu` 网关。
+> 在阅读本文档前，你需要先阅读[部署先决条件](./deployment-before.md)文档来完成部署`shenyu`前的环境准备工作.
+
### 启动Apache ShenYu Admin
```
diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-helm.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-helm.md
index cbcdb497da..53418a9ab9 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-helm.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-helm.md
@@ -6,3 +6,5 @@ description: Helm部署
---
本文介绍使用 `helm` 来部署 `Apache ShenYu` 网关。
+
+> 在阅读本文档前，你需要先阅读[部署先决条件](./deployment-before.md)文档来完成部署`shenyu`前的环境准备工作.
diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-k8s.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-k8s.md
index 6b9c01abb3..93d6fddfca 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-k8s.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-k8s.md
@@ -5,8 +5,9 @@ keywords: ["k8s"]
description: k8s部署
---
-本文介绍使用 `k8s` 来部署 `Apache ShenYu` 网关。
+> 在阅读本文档前，你需要先阅读[部署先决条件](./deployment-before.md)文档来完成部署`shenyu`前的环境准备工作.
+本文介绍使用 `k8s` 来部署 `Apache ShenYu` 网关。
> 目录
>
diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-local.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-local.md
index ab77e8958d..180cf97754 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-local.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-local.md
@@ -7,6 +7,8 @@ description: 本地部署
本文介绍本地环境启动 `Apache ShenYu` 网关。
+> 在阅读本文档前，你需要先阅读[部署先决条件](./deployment-before.md)文档来完成部署`shenyu`前的环境准备工作.
+
### 环境准备
* 本地正确安装JDK1.8+
diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-package.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-package.md
index 9d4c716ed1..56ac2f2bb2 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-package.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-package.md
@@ -7,6 +7,7 @@ description: 二进制包部署
本文介绍使用二进制包部署 `Apache ShenYu` 网关。
+> 在阅读本文档前，你需要先阅读[部署先决条件](./deployment-before.md)文档来完成部署`shenyu`前的环境准备工作.
### 启动 Apache ShenYu Admin
diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-quick.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-quick.md
index b189dd4963..d6e011ead6 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-quick.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/deployment/deployment-quick.md
@@ -7,6 +7,8 @@ description: 单机快速部署
本文介绍单机环境快速启动 `Apache ShenYu` 网关。
+> 在阅读本文档前，你需要先阅读[部署先决条件](./deployment-before.md)文档来完成部署`shenyu`前的环境准备工作.
+
### 环境准备
* 本地正确安装JDK1.8+
diff --git a/versioned_docs/version-2.4.3/deployment/deployment-before.md b/versioned_docs/version-2.4.3/deployment/deployment-before.md
new file mode 100644
index 0000000000..15cacfa16f
--- /dev/null
+++ b/versioned_docs/version-2.4.3/deployment/deployment-before.md
@@ -0,0 +1,25 @@
+---
+sidebar_position: 0
+title: Deployment Prerequisites
+keywords: ["Deployment Prerequisites"]
+description: Deployment Prerequisites
+---
+
+This article describes some of the prerequisites you need to prepare before deploying the Apache ShenYu gateway.
+
+## Database Initialize
+
+Before deploying the `Shenyu-admin` project, initialize the database it uses (databases currently support: Mysql, PostgreSql, Oracle), which used the script files are stored in db directory [project root directory](https://github.com/apache/incubator-shenyu/tree/master/db), The following describes the initial steps for each database.
+
+### Mysql
+
+In [the mysql initialization scripts directory](https://github.com/apache/incubator-shenyu/tree/master/db/init/mysql) found in the initialization script `schema.sql`, Use the client connection tool to connect to your Mysql service and execute, so you get a database named `shenyu`, which can later be used as the database for the `Shenyu-admin` project.
+
+### PostgreSql
+
+In [the pg initialization scripts directory](https://github.com/apache/incubator-shenyu/tree/master/db/init/pg) found in the initialization script `create-database.sql`、 `create-table.sql`, and use the client connection tool to connect to your PostgreSql service. so you get a database named `shenyu`, which can later be used as a database for the `Shenyu-admin` project.
+
+### Oracle
+
+In [the oracle initialization scripts directory](https://github.com/apache/incubator-shenyu/blob/master/db/init/oracle) found in the initialization script `schema.sql`, Use the client connection tool to connect to your Oracle service to create a database, execute the `schema.sql` script on this database, and initialize the `Shenyu-admin` database. After can be [project configuration file](https://github.com/apache/incubator-shenyu/blob/master/shenyu-admin/src/main/resources/application-o [...]
+
diff --git a/versioned_docs/version-2.4.3/deployment/deployment-cluster.md b/versioned_docs/version-2.4.3/deployment/deployment-cluster.md
index 8095cf5453..b7169dd7eb 100644
--- a/versioned_docs/version-2.4.3/deployment/deployment-cluster.md
+++ b/versioned_docs/version-2.4.3/deployment/deployment-cluster.md
@@ -5,6 +5,8 @@ keywords: ["Gateway Cluster Enviroment", "Cluster Enviroment"]
description: Cluster Delopyment
---
+> Before you read this document, you need to complete some preparations before deploying Shenyu according to the [Deployment Prerequisites document](./deployment-before.md).
+
This aritcle introduces how to delopy the `Shenyu` gateway in cluster enviroment.
> In this part, you can see [ShenYu Binary Packages Deployment](./deployment-package.md) before deploying.
diff --git a/versioned_docs/version-2.4.3/deployment/deployment-custom.md b/versioned_docs/version-2.4.3/deployment/deployment-custom.md
index 2d869fcfc7..2c948e754f 100644
--- a/versioned_docs/version-2.4.3/deployment/deployment-custom.md
+++ b/versioned_docs/version-2.4.3/deployment/deployment-custom.md
@@ -7,6 +7,7 @@ description: Custom Deployment
This article describes how to build your own gateway based on `Apache ShenYu`.
+> Before you read this document, you need to complete some preparations before deploying Shenyu according to the [Deployment Prerequisites document](./deployment-before.md).
### Start Apache ShenYu Admin
diff --git a/versioned_docs/version-2.4.3/deployment/deployment-docker-compose.md b/versioned_docs/version-2.4.3/deployment/deployment-docker-compose.md
index 89c740486e..bb5e708c89 100644
--- a/versioned_docs/version-2.4.3/deployment/deployment-docker-compose.md
+++ b/versioned_docs/version-2.4.3/deployment/deployment-docker-compose.md
@@ -7,6 +7,8 @@ description: Docker-compose Deployment
This article introduces the use of `docker-compose` to deploy the `Apache ShenYu` gateway.
+> Before you read this document, you need to complete some preparations before deploying Shenyu according to the [Deployment Prerequisites document](./deployment-before.md).
+
### Download shell script
```shell
diff --git a/versioned_docs/version-2.4.3/deployment/deployment-docker.md b/versioned_docs/version-2.4.3/deployment/deployment-docker.md
index 94282f723c..791f4ee1a7 100644
--- a/versioned_docs/version-2.4.3/deployment/deployment-docker.md
+++ b/versioned_docs/version-2.4.3/deployment/deployment-docker.md
@@ -7,6 +7,8 @@ description: Docker Deployment
This article introduces the use of `docker` to deploy the `Apache ShenYu` gateway.
+> Before you read this document, you need to complete some preparations before deploying Shenyu according to the [Deployment Prerequisites document](./deployment-before.md).
+
### Start Apache ShenYu Admin
```
diff --git a/versioned_docs/version-2.4.3/deployment/deployment-helm.md b/versioned_docs/version-2.4.3/deployment/deployment-helm.md
index b4e0d410e7..38c7126d0b 100644
--- a/versioned_docs/version-2.4.3/deployment/deployment-helm.md
+++ b/versioned_docs/version-2.4.3/deployment/deployment-helm.md
@@ -6,3 +6,5 @@ description: Helm Deployment
---
This article introduces the use of `helm` to deploy the `Apache ShenYu` gateway.
+
+> Before you read this document, you need to complete some preparations before deploying Shenyu according to the [Deployment Prerequisites document](./deployment-before.md).
diff --git a/versioned_docs/version-2.4.3/deployment/deployment-k8s.md b/versioned_docs/version-2.4.3/deployment/deployment-k8s.md
index 50d4b5b024..ed2f8a4cd3 100644
--- a/versioned_docs/version-2.4.3/deployment/deployment-k8s.md
+++ b/versioned_docs/version-2.4.3/deployment/deployment-k8s.md
@@ -5,8 +5,9 @@ keywords: ["k8s"]
description: k8s Deployment
---
-This article introduces the use of `k8s` to deploy the `Apache ShenYu` gateway.
+> Before you read this document, you need to complete some preparations before deploying Shenyu according to the [Deployment Prerequisites document](./deployment-before.md).
+This article introduces the use of `k8s` to deploy the `Apache ShenYu` gateway.
> Catalog
>
diff --git a/versioned_docs/version-2.4.3/deployment/deployment-local.md b/versioned_docs/version-2.4.3/deployment/deployment-local.md
index c68cd83b4f..01dce11874 100644
--- a/versioned_docs/version-2.4.3/deployment/deployment-local.md
+++ b/versioned_docs/version-2.4.3/deployment/deployment-local.md
@@ -7,6 +7,8 @@ description: Local Deployment
This article introduces how to start the `Apache ShenYu` gateway in the local environment.
+> Before you read this document, you need to complete some preparations before deploying Shenyu according to the [Deployment Prerequisites document](./deployment-before.md).
+
### Environmental preparation
* Install JDK1.8+ locally
diff --git a/versioned_docs/version-2.4.3/deployment/deployment-package.md b/versioned_docs/version-2.4.3/deployment/deployment-package.md
index b20308a508..24d313a4ff 100644
--- a/versioned_docs/version-2.4.3/deployment/deployment-package.md
+++ b/versioned_docs/version-2.4.3/deployment/deployment-package.md
@@ -7,6 +7,7 @@ description: Binary Packages Deployment
This article introduces the deployment of the `Apache ShenYu` gateway using the binary packages.
+> Before you read this document, you need to complete some preparations before deploying Shenyu according to the [Deployment Prerequisites document](./deployment-before.md).
### Start Apache ShenYu Admin
diff --git a/versioned_docs/version-2.4.3/deployment/deployment-quick.md b/versioned_docs/version-2.4.3/deployment/deployment-quick.md
index 5b4e201794..daa5737864 100644
--- a/versioned_docs/version-2.4.3/deployment/deployment-quick.md
+++ b/versioned_docs/version-2.4.3/deployment/deployment-quick.md
@@ -7,6 +7,8 @@ description: Local Quick Deployment
This article introduces how to quick start the `Apache ShenYu` gateway in the standalone environment.
+> Before you read this document, you need to complete some preparations before deploying Shenyu according to the [Deployment Prerequisites document](./deployment-before.md).
+
### Environmental preparation
* Install JDK1.8+ locally