This is an automated email from the ASF dual-hosted git repository.
yuqi4733 pushed a commit to branch branch-1.2
in repository https://gitbox.apache.org/repos/asf/gravitino.git
The following commit(s) were added to refs/heads/branch-1.2 by this push:
new dd26624777 [Cherry-pick to branch-1.2] [#10029] improvement(docs):
Refine docs about catalogs in folder `catalogs-contrib` (#10065) (#10118)
dd26624777 is described below
commit dd266247776bb6c9d01ab342fd569a640be64967
Author: github-actions[bot]
<41898282+github-actions[bot]@users.noreply.github.com>
AuthorDate: Tue Mar 3 09:45:47 2026 +0800
[Cherry-pick to branch-1.2] [#10029] improvement(docs): Refine docs about
catalogs in folder `catalogs-contrib` (#10065) (#10118)
**Cherry-pick Information:**
- Original commit: fcaded2a74105319b0167b6390262f70f4e4aec6
- Target branch: `branch-1.2`
- Status: ✅ Clean cherry-pick (no conflicts)
Co-authored-by: Qi Yu <[email protected]>
---
docs/how-to-build.md | 7 +++++--
docs/how-to-install.md | 10 +++++++++-
docs/index.md | 5 ++++-
docs/jdbc-oceanbase-catalog.md | 3 ++-
4 files changed, 20 insertions(+), 5 deletions(-)
diff --git a/docs/how-to-build.md b/docs/how-to-build.md
index 5f4f078776..4a30e489e4 100644
--- a/docs/how-to-build.md
+++ b/docs/how-to-build.md
@@ -99,7 +99,8 @@ license: "This software is licensed under the Apache License
version 2."
./gradlew compileDistribution
```
- The `compileDistribution` command creates a `distribution` directory in the
Gravitino root directory.
+ The `compileDistribution` command creates a `distribution` directory in the
Gravitino root directory. It contains two subdirectories: `package` and
`package-all`. The difference between these two subdirectories is that
`package` is the **Gravitino server distribution package**, while `package-all`
contains extra catalogs in `catalogs-contrib` and all contents in `package`.
+ So, if you want to use catalogs in `catalogs-contrib`, you should use the
distribution package in `package-all`.
:::note
The `./gradlew clean` command deletes the `distribution` directory.
@@ -111,7 +112,9 @@ license: "This software is licensed under the Apache
License version 2."
./gradlew assembleDistribution
```
- The `assembleDistribution` command creates `gravitino-{version}-bin.tar.gz`
and `gravitino-{version}-bin.tar.gz.sha256` under the `distribution` directory.
+ The `assembleDistribution` command creates `gravitino-{version}-bin.tar.gz`,
`gravitino-{version}-bin.tar.gz.sha256`, `gravitino-{version}-bin-all.tar.gz`,
`gravitino-{version}-bin-all.tar.gz.sha256` under the `distribution` directory.
+
+ About the difference between `gravitino-{version}-bin.tar.gz` and
`gravitino-{version}-bin-all.tar.gz`, please refer to the explanation of the
difference between `package` and `package-all` in the previous step.
You can deploy these to your production environment.
diff --git a/docs/how-to-install.md b/docs/how-to-install.md
index 06cda65af4..13252e2b24 100644
--- a/docs/how-to-install.md
+++ b/docs/how-to-install.md
@@ -38,8 +38,10 @@ The Gravitino binary distribution package contains the
following files:
| └── hive/ # Apache Hive catalog
dependencies and configurations.
| └── jdbc-doris/ # JDBC doris catalog
dependencies and configurations.
| └── jdbc-mysql/ # JDBC MySQL catalog
dependencies and configurations.
+ | └── jdbc-starrocks/ # JDBC Starrocks catalog
dependencies and configurations.
| └── jdbc-postgresql/ # JDBC PostgreSQL catalog
dependencies and configurations.
- | └── kafka/ # Apache Kafka PostgreSQL
catalog dependencies and configurations.
+ | └── jdbc-hudi/ # Hudi catalog dependencies
and configurations.
+ | └── kafka/ # Apache Kafka catalog
dependencies and configurations.
| └── lakehouse-iceberg/ # Apache Iceberg catalog
dependencies and configurations.
| └── lakehouse-paimon/ # Apache Paimon catalog
dependencies and configurations.
| └── model/ # Model catalog dependencies
and configurations.
@@ -55,6 +57,12 @@ The Gravitino binary distribution package contains the
following files:
└── scripts/ # Extra scripts for Gravitino.
```
+:::note
+Catalogs `OceanBase` and `ClickHouse` are not included in the Gravitino binary
distribution package (see above) by default due to package size limitations and
License compatibility issues since 1.2.0.
+If you want to use these two catalogs, please build the Gravitino binary
distribution package by yourself and use tarball
`gravitino-<version>-bin-all.tar.gz`, which contains all catalogs including
those in the `catalogs-contrib` module.
+For more details about it, please refer to [Reorg catalogs
structure](https://github.com/apache/gravitino/pull/9781)
+:::
+
#### Initialize the RDBMS (Optional)
If you want to use the relational backend storage, you need to initialize the
RDBMS first. For the details on initializing the RDBMS, please check [How to
use relational backend storage](./how-to-use-relational-backend-storage.md).
diff --git a/docs/index.md b/docs/index.md
index 911adef2c0..84ca875ef3 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -85,7 +85,7 @@ Gravitino currently supports the following catalogs:
* [**MySQL catalog**](./jdbc-mysql-catalog.md)
* [**Paimon catalog**](./lakehouse-paimon-catalog.md)
* [**PostgreSQL catalog**](./jdbc-postgresql-catalog.md)
-* [**OceanBase catalog**](./jdbc-oceanbase-catalog.md)
+* [**OceanBase catalog**](./jdbc-oceanbase-catalog.md)\*
* [**StarRocks catalog**](./jdbc-starrocks-catalog.md)
* [**ClickHouse catalog**](./jdbc-clickhouse-catalog.md)\*
* [**Lakehouse generic catalog**](./lakehouse-generic-catalog.md)
@@ -104,6 +104,9 @@ If you want to operate table and partition statistics, you
can refer to the [doc
* [**Model catalog**](./model-catalog.md)
+Catalogs with an asterisk (\*) aren’t in the standard release tarball and
Docker image since 1.2.0. In 1.2.0, Gravitino introduces
+folder `catalogs-contrib` to host the contributed catalogs, which aren’t in
the standard release but can be built and used separately. See [how to build
Gravitino](./how-to-build.md#quick-start) for details.
+
## Apache Gravitino playground
To experience Gravitino with other components easily, Gravitino provides a
playground to run.
diff --git a/docs/jdbc-oceanbase-catalog.md b/docs/jdbc-oceanbase-catalog.md
index 2a1f37475f..d55e9f96ec 100644
--- a/docs/jdbc-oceanbase-catalog.md
+++ b/docs/jdbc-oceanbase-catalog.md
@@ -16,7 +16,8 @@ import TabItem from '@theme/TabItem';
Apache Gravitino provides the ability to manage OceanBase metadata.
:::caution
-Gravitino saves some system information in schema and table comment, like
`(From Gravitino, DO NOT EDIT: gravitino.v1.uid1078334182909406185)`, please
don't change or remove this message.
+1. Gravitino saves some system information in schema and table comment, like
`(From Gravitino, DO NOT EDIT: gravitino.v1.uid1078334182909406185)`, please
don't change or remove this message.
+2. Since 1.2.0, OceanBase catalog is not included in standard Gravitino
distribution, but you can still build it from source if you need it. Check
[build from source](./how-to-build.md) for more details.
:::
## Catalog
