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
4 changes: 3 additions & 1 deletion CN/modules/ROOT/pages/v5.0/1.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -195,10 +195,12 @@ IvorySQL 的主要代码仓库:
* 潘振浩
* 石卓妍
* 隋戈
* 孙锐克
* 陶郑
* 童水森
* 王硕
* 薛晓刚
* 严少安
* 杨世华
* 赵法威
* 赵法威
* 张哲
2 changes: 1 addition & 1 deletion CN/modules/ROOT/pages/v5.0/3.1.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -148,4 +148,4 @@ TIP: Docker运行IvorySQL时,需要添加额外参数,如 psql -d ivorysql -

现在可以开始使用IvorySQL啦!就是这么简单!

想要获得更多安装方式,请参考xref:master/4.1.adoc[安装指南]
想要获得更多安装方式,请参考xref:v5.0/4.1.adoc[安装指南]
2 changes: 1 addition & 1 deletion CN/modules/ROOT/pages/v5.0/4.1.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ IvorySQL安装方式包括以下5种:
- <<源码安装>>
- <<deb安装>>

本章将详细介绍每种方式的安装、运行及卸载过程。想要更快获得IvorySQL,请参阅xref:master/3.1.adoc#快速开始[快速开始]。
本章将详细介绍每种方式的安装、运行及卸载过程。想要更快获得IvorySQL,请参阅xref:v5.0/3.1.adoc#快速开始[快速开始]。

同样,安装前请先创建一个用户,并赋予其root权限,安装、使用和卸载均以该用户执行。这里以ivorysql用户为例。

Expand Down
8 changes: 4 additions & 4 deletions CN/modules/ROOT/pages/v5.0/4.2.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
== 主节点

=== 安装并启动数据库
yum源快速安装数据库,请参考xref:master/3.1.adoc#从yum源安装ivorysql数据库[从yum源安装ivorysql数据库]。
yum源快速安装数据库,请参考xref:v5.0/3.1.adoc#从yum源安装ivorysql数据库[从yum源安装ivorysql数据库]。

想要获取更多安装方式,请参考xref:master/4.1.adoc[安装指南]。
想要获取更多安装方式,请参考xref:v5.0/4.1.adoc[安装指南]。

[NOTE]
主节点数据库需要安装并**启动**
Expand Down Expand Up @@ -56,9 +56,9 @@ $ pg_ctl restart

== 备节点
=== 安装数据库
Yum源快速安装数据库,请参考xref:master/3.1.adoc#从yum源安装ivorysql数据库[从yum源安装ivorysql数据库]。
Yum源快速安装数据库,请参考xref:v5.0/3.1.adoc#从yum源安装ivorysql数据库[从yum源安装ivorysql数据库]。

想要获取更多安装方式,请参考xref:master/4.1.adoc[安装指南]。
想要获取更多安装方式,请参考xref:v5.0/4.1.adoc[安装指南]。

[NOTE]
备节点数据库只需要安装,**不需要启动**
Expand Down
12 changes: 8 additions & 4 deletions CN/modules/ROOT/pages/v5.0/4.6.2.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,8 @@ Labels: my-label=value2
Annotations: my-annotation: value1
....

NOTE: 使用默认 `ClusterIP` 类型时禁止设置 `nodePort`;该值必须在合法范围内且未被占用。此处提供的注解与标签优先级最高。若通过外部暴露 Service 并依赖 TLS 验证,需使用 IVYO 的 https://github.com/IvorySQL/ivory-operator/blob/master/docs/content/tutorial/customize-cluster.md#customize-tls[自定义 TLS] 功能。
NOTE: 使用默认 `ClusterIP` 类型时禁止设置 `nodePort`;该值必须在合法范围内且未被占用。此处提供的注解与标签优先级最高。若通过外部暴露 Service 并依赖 TLS 验证,需使用 IVYO 的
https://github.com/IvorySQL/ivory-operator/blob/master/docs/content/tutorial/customize-cluster.md#customize-tls[自定义 TLS] 功能。

[#connect-app]
=== 连接应用程序
Expand Down Expand Up @@ -1371,7 +1372,8 @@ spec:

===== 流式备用集群

流式备用集群依赖于通过网络到主集群的经过身份验证的连接。主集群应可通过网络访问并允许 TLS 身份验证(默认启用 TLS)。在以下清单中,我们将 `standby.enabled` 设置为 `true`,并提供了指向主集群的 `host` 和 `port`。我们还定义了 `customTLSSecret` 和 `customReplicationTLSSecret` 以提供允许备用集群向主集群进行身份验证的证书。对于这种类型的备用集群,您必须使用 https://github.com/IvorySQL/ivory-operator/blob/master/docs/content/tutorial/customize-cluster.md#customize-tls[自定义 TLS]:
流式备用集群依赖于通过网络到主集群的经过身份验证的连接。主集群应可通过网络访问并允许 TLS 身份验证(默认启用 TLS)。在以下清单中,我们将 `standby.enabled` 设置为 `true`,并提供了指向主集群的 `host` 和 `port`。我们还定义了 `customTLSSecret` 和 `customReplicationTLSSecret` 以提供允许备用集群向主集群进行身份验证的证书。对于这种类型的备用集群,您必须使用
https://github.com/IvorySQL/ivory-operator/blob/master/docs/content/tutorial/customize-cluster.md#customize-tls[自定义 TLS]:

----
apiVersion: ivory-operator.ivorysql.org/v1beta1
Expand Down Expand Up @@ -1814,7 +1816,8 @@ kubectl apply -k kustomize/keycloak
Kubernetes 将检测到更改并开始部署新的 Keycloak Pod。完成后,Keycloak 现在将通过 PgBouncer 连接池连接到 Ivory!

=== TLS
IVYO 通过 TLS 部署每个集群和组件。这包括 PgBouncer 连接池。如果您使用自己的 https://github.com/IvorySQL/ivory-operator/blob/master/docs/content/tutorial/customize-cluster.md#customize-tls[自定义 TLS 设置],则需要在 `spec.proxy.pgBouncer.customTLSSecret` 中为 PgBouncer 提供 Secret 引用。
IVYO 通过 TLS 部署每个集群和组件。这包括 PgBouncer 连接池。如果您使用自己的
https://github.com/IvorySQL/ivory-operator/blob/master/docs/content/tutorial/customize-cluster.md#customize-tls[自定义 TLS 设置],则需要在 `spec.proxy.pgBouncer.customTLSSecret` 中为 PgBouncer 提供 Secret 引用。

PgBouncer 的 TLS 证书应具有与 PgBouncer Service 名称匹配的通用名称 (CN)。这是集群的名称,后缀为 `-pgbouncer`。例如,对于我们的 `hippo` 集群,这将是 `hippo-pgbouncer`。对于 `keycloakdb` 示例,它将是 `keycloakdb-pgBouncer`。

Expand Down Expand Up @@ -2059,7 +2062,8 @@ IVYO 会自动检测并加载对 IvorySQL 服务器和复制 Secret 内容的更

[IMPORTANT]
====
更改 IvorySQL 证书颁发机构时,请确保同时更新 https://github.com/IvorySQL/ivory-operator/blob/master/docs/content/tutorial/customize-cluster.md#customize-tls[`customReplicationTLSSecret`]。
更改 IvorySQL 证书颁发机构时,请确保同时更新
https://github.com/IvorySQL/ivory-operator/blob/master/docs/content/tutorial/customize-cluster.md#customize-tls[`customReplicationTLSSecret`]。
====

=== 更改主节点
Expand Down
20 changes: 10 additions & 10 deletions CN/modules/ROOT/pages/v5.0/5.0.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,16 @@ IvorySQL 作为一款兼容 Oracle 且基于 PostgreSQL 的高级开源数据库
[cols="1,2,1,3,3"]
|====
|*序号*|*插件名称*|*版本*|*功能描述*|*适用场景*
| 1 | xref:master/5.1.adoc[postgis] | 3.5.4 | 为 IvorySQL 提供地理空间数据支持,包括空间索引、空间函数和地理对象存储 | 地理信息系统(GIS)、地图服务、位置数据分析
| 2 | xref:master/5.2.adoc[pgvector] | 0.8.1 | 支持向量相似性搜索,可用于存储和检索高维向量数据| AI 应用、图像检索、推荐系统、语义搜索
| 3 | xref:master/5.3.adoc[pgddl (DDL Extractor)] | 0.31 | 提取数据库中的 DDL(数据定义语言)语句,便于版本管理和迁移 | 数据库版本控制、CI/CD 集成、结构比对与同步
| 4 | xref:master/5.4.adoc[pg_cron]​ | 1.6.0 | 提供数据库内部的定时任务调度功能,支持定期执行SQL语句 | 数据清理、定期统计、自动化维护任务
| 5 | xref:master/5.5.adoc[pgsql-http]​ | 1.7.0 | 允许在SQL中发起HTTP请求,与外部Web服务进行交互 | 数据采集、API集成、微服务调用
| 6 | xref:master/5.6.adoc[plpgsql_check] | 2.8 | 提供PL/pgSQL代码的静态分析功能,可在开发阶段发现潜在错误 | 存储过程开发、代码质量检查、调试优化
| 7 | xref:master/5.7.adoc[pgroonga] | 4.0.4 | 提供​非英语语言全文搜索功能,满足高性能应用的需求 | 中日韩等语言的全文搜索功能
| 8 | xref:master/5.8.adoc[pgaudit] | 18.0 | 提供细粒度的审计功能,记录数据库操作日志,便于安全审计和合规性检查 | 数据库安全审计、合规性检查、审计报告生成
| 9 | xref:master/5.9.adoc[pgrouting] | 3.8.0 | 提供地理空间数据的路由计算功能,支持多种算法和数据格式 | 地理空间分析、路径规划、物流优化
| 10 | xref:master/5.10.adoc[system_stats] | 3.2 | 提供用于访问系统级统计信息的函数 | 系统监控
| 1 | xref:v5.0/5.1.adoc[postgis] | 3.5.4 | 为 IvorySQL 提供地理空间数据支持,包括空间索引、空间函数和地理对象存储 | 地理信息系统(GIS)、地图服务、位置数据分析
| 2 | xref:v5.0/5.2.adoc[pgvector] | 0.8.1 | 支持向量相似性搜索,可用于存储和检索高维向量数据| AI 应用、图像检索、推荐系统、语义搜索
| 3 | xref:v5.0/5.3.adoc[pgddl (DDL Extractor)] | 0.31 | 提取数据库中的 DDL(数据定义语言)语句,便于版本管理和迁移 | 数据库版本控制、CI/CD 集成、结构比对与同步
| 4 | xref:v5.0/5.4.adoc[pg_cron]​ | 1.6.0 | 提供数据库内部的定时任务调度功能,支持定期执行SQL语句 | 数据清理、定期统计、自动化维护任务
| 5 | xref:v5.0/5.5.adoc[pgsql-http]​ | 1.7.0 | 允许在SQL中发起HTTP请求,与外部Web服务进行交互 | 数据采集、API集成、微服务调用
| 6 | xref:v5.0/5.6.adoc[plpgsql_check] | 2.8 | 提供PL/pgSQL代码的静态分析功能,可在开发阶段发现潜在错误 | 存储过程开发、代码质量检查、调试优化
| 7 | xref:v5.0/5.7.adoc[pgroonga] | 4.0.4 | 提供​非英语语言全文搜索功能,满足高性能应用的需求 | 中日韩等语言的全文搜索功能
| 8 | xref:v5.0/5.8.adoc[pgaudit] | 18.0 | 提供细粒度的审计功能,记录数据库操作日志,便于安全审计和合规性检查 | 数据库安全审计、合规性检查、审计报告生成
| 9 | xref:v5.0/5.9.adoc[pgrouting] | 3.8.0 | 提供地理空间数据的路由计算功能,支持多种算法和数据格式 | 地理空间分析、路径规划、物流优化
| 10 | xref:v5.0/5.10.adoc[system_stats] | 3.2 | 提供用于访问系统级统计信息的函数 | 系统监控
|====

这些插件均经过 IvorySQL 团队的测试和适配,确保在 IvorySQL 环境下稳定运行。用户可以根据业务需求选择合适的插件,进一步提升数据库系统的能力和灵活性。
Expand Down
2 changes: 2 additions & 0 deletions EN/modules/ROOT/pages/v5.0/1.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,7 @@ The following individuals (in alphabetical order) have contributed to this relea
* msdnchina
* omstack
* otegami
* Ruike Sun
* rophy
* Shaolin Chu
* Shawn Yan
Expand All @@ -200,6 +201,7 @@ The following individuals (in alphabetical order) have contributed to this relea
* Yanliang Lei
* Yasir Hussain Shah
* Yuan Li
* Zhe Zhang
* Zheng Tao
* Zhenhao Pan
* Zhuoyan Shi
2 changes: 1 addition & 1 deletion EN/modules/ROOT/pages/v5.0/3.1.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -143,4 +143,4 @@ TIP: When running IvorySQL in Docker, additional parameters need to be added, li

Now you can start your journey of IvorySQL! Enjoy!

To explore additional installation methods, please refer to the xref:v5.0/6.adoc[Installation].
To explore additional installation methods, please refer to the xref:v5.0/4.1.adoc[Installation].
2 changes: 1 addition & 1 deletion EN/modules/ROOT/pages/v5.0/4.1.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The installation methods for IvorySQL include the following five:
- <<deb-installation>>


This chapter will provide detailed instructions on the installation, execution, and uninstallation processes for each method. For a quicker access to IvorySQL, please refer to xref:v5.0/3.adoc#quick-installation[Quick installation].
This chapter will provide detailed instructions on the installation, execution, and uninstallation processes for each method. For a quicker access to IvorySQL, please refer to xref:v5.0/3.1.adoc#quick-installation[Quick installation].

Before getting started, please create an user and grant it root privileges. All the installation steps will be performed by this user. Here we just name it 'ivorysql'.

Expand Down
8 changes: 4 additions & 4 deletions EN/modules/ROOT/pages/v5.0/4.2.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ This chapter is a demo to show you how to build an IvorySQL cluster. Just take a
== Primary node

=== Installing and start database
For quick database installation by yum, please refer to xref:v5.0/3.adoc#quick-installation[Quick installation]。
For quick database installation by yum, please refer to xref:v5.0/3.1.adoc#quick-installation[Quick installation]。

For more installation options, please refer to xref:v5.0/6.adoc#Installation[Installation]。
For more installation options, please refer to xref:v5.0/4.1.adoc#Installation[Installation]。
[NOTE]
The master node database needs to be installed and **started**.

Expand Down Expand Up @@ -55,9 +55,9 @@ $ pg_ctl restart

== Standby node
=== Installing database
For quick database installation by yum, please refer to xref:v5.0/3.adoc#quick-installation[Quick installation]。
For quick database installation by yum, please refer to xref:v5.0/3.1.adoc#quick-installation[Quick installation]。

For more installation options, please refer to xref:v5.0/6.adoc#Installation[Installation]。
For more installation options, please refer to xref:v5.0/4.1.adoc#Installation[Installation]。

[NOTE]
The standby node database only needs to be installed and **not started**.
Expand Down
8 changes: 5 additions & 3 deletions EN/modules/ROOT/pages/v5.0/4.6.2.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,8 @@ and not otherwise in use or the operation will fail. Additionally, be aware that
will win in case of conflicts with any annotations or labels a user configures elsewhere.

Finally, if you are exposing your Services externally and are relying on TLS
verification, you will need to use the https://github.com/IvorySQL/ivory-operator/blob/master/docs/content/tutorial/customize-cluster.md#customize-tls[custom TLS]
verification, you will need to use the
https://github.com/IvorySQL/ivory-operator/blob/master/docs/content/tutorial/customize-cluster.md#customize-tls[custom TLS]
features of IVYO).

=== Connect an Application
Expand Down Expand Up @@ -2030,7 +2031,8 @@ cluster should be accessible via the network and allow TLS authentication (TLS i
In the following manifest, we have `standby.enabled` set to `true` and have provided both the `host`
and `port` that point to the primary cluster. We have also defined `customTLSSecret` and
`customReplicationTLSSecret` to provide certs that allow the standby to authenticate to the primary.
For this type of standby, you must use https://github.com/IvorySQL/ivory-operator/blob/master/docs/content/tutorial/customize-cluster.md#customize-tls[custom TLS]:
For this type of standby, you must use
https://github.com/IvorySQL/ivory-operator/blob/master/docs/content/tutorial/customize-cluster.md#customize-tls[custom TLS]:

[source,yaml]
----
Expand Down Expand Up @@ -2557,7 +2559,7 @@ Kubernetes will detect the changes and begin to deploy a new Keycloak Pod. When

=== TLS

IVYO deploys every cluster and component over TLS. This includes the PgBouncer connection pooler. If you are using your own xref:./customize-cluster.md#customize-tls[custom TLS setup], you will need to provide a Secret reference for a TLS key / certificate pair for PgBouncer in `spec.proxy.pgBouncer.customTLSSecret`.
IVYO deploys every cluster and component over TLS. This includes the PgBouncer connection pooler. If you are using your own custom TLS setup, you will need to provide a Secret reference for a TLS key / certificate pair for PgBouncer in `spec.proxy.pgBouncer.customTLSSecret`.

Your TLS certificate for PgBouncer should have a Common Name (CN) setting that matches the PgBouncer Service name. This is the name of the cluster suffixed with `-pgbouncer`. For example, for our `hippo` cluster this would be `hippo-pgbouncer`. For the `keycloakdb` example, it would be `keycloakdb-pgbouncer`.

Expand Down
20 changes: 10 additions & 10 deletions EN/modules/ROOT/pages/v5.0/5.0.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,16 @@ IvorySQL, as an advanced open-source database compatible with Oracle and based o
[cols="1,2,1,3,3"]
|====
|*Index*|*Plugin Name*|*Version*|*Function Description*|*Use Cases*
|*1*| xref:master/5.1.adoc[postgis] | 3.5.4 | Provides geospatial data support for IvorySQL, including spatial indexes, spatial functions, and geographic object storage | Geographic Information Systems (GIS), map services, location data analysis
|*2*| xref:master/5.2.adoc[pgvector] | 0.8.1 | Supports vector similarity search, can be used to store and retrieve high-dimensional vector data| AI applications, image retrieval, recommendation systems, semantic search
|*3*| xref:master/5.3.adoc[pgddl (DDL Extractor)] | 0.31 | Extracts DDL (Data Definition Language) statements from databases, facilitating version management and migration | Database version control, CI/CD integration, structure comparison and synchronization
|*4*| xref:master/5.4.adoc[pg_cron]​ | 1.6.0 | Provides database-internal scheduled task scheduling functionality, supports regular SQL statement execution | Data cleanup, regular statistics, automated maintenance tasks
|*5*| xref:master/5.5.adoc[pgsql-http]​ | 1.7.0 | Allows HTTP requests to be initiated in SQL, interacting with external web services | Data collection, API integration, microservice calls
|*6*| xref:master/5.6.adoc[plpgsql_check] | 2.8 | Provides static analysis functionality for PL/pgSQL code, can detect potential errors during development | Stored procedure development, code quality checking, debugging and optimization
|*7*| xref:master/5.7.adoc[pgroonga] | 4.0.4 | Provides full-text search functionality for non-English languages, meeting the needs of high-performance applications | Full-text search capabilities for languages like Chinese, Japanese, and Korean
|*8*| xref:master/5.8.adoc[pgaudit] | 18.0 | Provides fine-grained auditing, recording database operation logs to support security auditing and compliance checks | Database security auditing, compliance checks, audit report generation
|*9*| xref:master/5.9.adoc[pgrouting] | 3.8.0 | Provides routing computation for geospatial data, supporting multiple algorithms and data formats | Geospatial analysis, route planning, logistics optimization
|*10*| xref:master/5.10.adoc[system_stats] | 3.2 | Provide functions for accessing system-level statistics. | system monitor
|*1*| xref:v5.0/5.1.adoc[postgis] | 3.5.4 | Provides geospatial data support for IvorySQL, including spatial indexes, spatial functions, and geographic object storage | Geographic Information Systems (GIS), map services, location data analysis
|*2*| xref:v5.0/5.2.adoc[pgvector] | 0.8.1 | Supports vector similarity search, can be used to store and retrieve high-dimensional vector data| AI applications, image retrieval, recommendation systems, semantic search
|*3*| xref:v5.0/5.3.adoc[pgddl (DDL Extractor)] | 0.31 | Extracts DDL (Data Definition Language) statements from databases, facilitating version management and migration | Database version control, CI/CD integration, structure comparison and synchronization
|*4*| xref:v5.0/5.4.adoc[pg_cron]​ | 1.6.0 | Provides database-internal scheduled task scheduling functionality, supports regular SQL statement execution | Data cleanup, regular statistics, automated maintenance tasks
|*5*| xref:v5.0/5.5.adoc[pgsql-http]​ | 1.7.0 | Allows HTTP requests to be initiated in SQL, interacting with external web services | Data collection, API integration, microservice calls
|*6*| xref:v5.0/5.6.adoc[plpgsql_check] | 2.8 | Provides static analysis functionality for PL/pgSQL code, can detect potential errors during development | Stored procedure development, code quality checking, debugging and optimization
|*7*| xref:v5.0/5.7.adoc[pgroonga] | 4.0.4 | Provides full-text search functionality for non-English languages, meeting the needs of high-performance applications | Full-text search capabilities for languages like Chinese, Japanese, and Korean
|*8*| xref:v5.0/5.8.adoc[pgaudit] | 18.0 | Provides fine-grained auditing, recording database operation logs to support security auditing and compliance checks | Database security auditing, compliance checks, audit report generation
|*9*| xref:v5.0/5.9.adoc[pgrouting] | 3.8.0 | Provides routing computation for geospatial data, supporting multiple algorithms and data formats | Geospatial analysis, route planning, logistics optimization
|*10*| xref:v5.0/5.10.adoc[system_stats] | 3.2 | Provide functions for accessing system-level statistics. | system monitor
|====

These plugins have all been tested and adapted by the IvorySQL team to ensure stable operation in the IvorySQL environment. Users can select appropriate plugins based on business needs to further enhance the capabilities and flexibility of the database system.
Expand Down
Loading