FANNG1 commented on code in PR #4113:
URL: https://github.com/apache/gravitino/pull/4113#discussion_r1700290923
##########
docs/iceberg-rest-service.md:
##########
@@ -12,62 +12,75 @@ The Apache Gravitino Iceberg REST Server follows the
[Apache Iceberg REST API sp
### Capabilities
-- Supports the Apache Iceberg REST API defined in Iceberg 1.3.1, and supports
all namespace and table interfaces. `Token`, and `Config` interfaces aren't
supported yet.
+- Supports the Apache Iceberg REST API defined in Iceberg 1.5, and supports
all namespace and table interfaces. The following interfaces are not
implemented yet:
+ - token
+ - view
+ - multi table transaction
+ - pagination
- Works as a catalog proxy, supporting `Hive` and `JDBC` as catalog backend.
- Provides a pluggable metrics store interface to store and delete Iceberg
metrics.
- When writing to HDFS, the Gravitino Iceberg REST catalog service can only
operate as the specified HDFS user and
doesn't support proxying to other HDFS users. See [How to access Apache
Hadoop](gravitino-server-config.md#how-to-access-apache-hadoop) for more
details.
:::info
-Builds with Apache Iceberg `1.3.1`. The Apache Iceberg table format version is
`1` by default.
Builds with Hadoop 2.10.x. There may be compatibility issues when accessing
Hadoop 3.x clusters.
:::
-## Apache Gravitino Iceberg REST catalog service configuration
+## Server management
-Assuming the Gravitino server is deployed in the `GRAVITINO_HOME` directory,
you can locate the configuration options in
[`$GRAVITINO_HOME/conf/gravitino.conf`](gravitino-server-config.md). There are
four configuration properties for the Iceberg REST catalog service:
+Iceberg REST server could start as a standalone server or an auxiliary service
in Gravitino server. There are some differences like below:
-1. [**REST Catalog Server
Configuration**](#rest-catalog-server-configuration): you can specify the HTTP
server properties like host and port.
+| | Standalone server
| Auxiliary service in Gravitino server
|
+|-------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|
+| How to build package | `./gradlew compileIcebergRESTServer -x test` build
a standalone Iceberg REST server in
`distribution/gravitino-iceberg-rest-server` directory. | `./gradlew
compileDistribution -x test` build Gravitino server and Iceberg REST server in
`distribution/package` directory. |
+| How to assemble package | `./gradlew assembleIcebergRESTServer -x test`
build a tar file with Iceberg REST server only in `distribution` directory.
| `./gradlew assembleDistribution -x test` build a tar file
with Gravitino server and Iceberg REST server `distribution` directory. |
+| How to start server | `./bin/gravitino-iceberg-rest-server.sh start`
| `./bin/gravitino.sh start`
|
+| Configuration files | `./conf/gravitino-iceberg-rest-server.conf`,
`conf/log4j2.properties`
| `./conf/gravitino.conf`, `conf/log4j2.properties`
|
-2. [**Gravitino Iceberg metrics store
Configuration**](#iceberg-metrics-store-configuration): you could implement a
custom Iceberg metrics store and set corresponding configuration.
+You could modify environment variables in `conf/gravitino-env.sh` and check
the log files in `./log/gravitino-iceberg-rest-server.log`,
`./log/gravitino-iceberg-rest-server.out` for both mode.
-3. [**Gravitino Iceberg Catalog backend
Configuration**](#gravitino-iceberg-catalog-backend-configuration): you have
the option to set the specified catalog-backend to either `jdbc` or `hive`.
+## Apache Gravitino Iceberg REST catalog server configuration
-4. [**Other Iceberg Catalog Properties Defined by Apache
Iceberg**](#other-apache-iceberg-catalog-properties): allows you to configure
additional properties defined by Apache Iceberg.
+The configuration settings for the Gravitino Iceberg REST server are identical
for both the standalone server and the auxiliary server in the Gravitino
system. Starting from version `0.6.0`, using the prefix
`gravitino.auxService.iceberg-rest.` for the auxiliary server configuration is
deprecated. If both `gravitino.auxService.iceberg-rest.key` and
`gravitino.iceberg-rest.key` are present, the `gravitino.iceberg-rest.key` will
take precedence. The following configurations are shown with
`gravitino.iceberg-rest.` prefix.
-Please refer to the following sections for details.
+### Configuration to enable Iceberg REST service in Gravitino server.
+
+| Configuration item | Description
| Default value | Required | Since Version |
+|------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|----------|---------------|
+| `gravitino.auxService.names` | The auxiliary service name of the
Gravitino Iceberg REST catalog service. Use **`iceberg-rest`**.
| (none) | Yes | 0.2.0
|
+| `gravitino.iceberg-rest.classpath` | The classpath of the Gravitino Iceberg
REST catalog service; includes the directory containing jars and configuration.
It supports both absolute and relative paths, for example,
`iceberg-rest-server/libs, iceberg-rest-server/conf` | (none) | Yes
| 0.2.0 |
+
+Please note that, it only takes affect in `gravitino.conf`, you doesn't need
to specify the above configurations if start as a standalone server.
Review Comment:
updated
##########
docs/iceberg-rest-service.md:
##########
@@ -12,62 +12,75 @@ The Apache Gravitino Iceberg REST Server follows the
[Apache Iceberg REST API sp
### Capabilities
-- Supports the Apache Iceberg REST API defined in Iceberg 1.3.1, and supports
all namespace and table interfaces. `Token`, and `Config` interfaces aren't
supported yet.
+- Supports the Apache Iceberg REST API defined in Iceberg 1.5, and supports
all namespace and table interfaces. The following interfaces are not
implemented yet:
+ - token
+ - view
+ - multi table transaction
+ - pagination
- Works as a catalog proxy, supporting `Hive` and `JDBC` as catalog backend.
- Provides a pluggable metrics store interface to store and delete Iceberg
metrics.
- When writing to HDFS, the Gravitino Iceberg REST catalog service can only
operate as the specified HDFS user and
doesn't support proxying to other HDFS users. See [How to access Apache
Hadoop](gravitino-server-config.md#how-to-access-apache-hadoop) for more
details.
:::info
-Builds with Apache Iceberg `1.3.1`. The Apache Iceberg table format version is
`1` by default.
Builds with Hadoop 2.10.x. There may be compatibility issues when accessing
Hadoop 3.x clusters.
:::
-## Apache Gravitino Iceberg REST catalog service configuration
+## Server management
-Assuming the Gravitino server is deployed in the `GRAVITINO_HOME` directory,
you can locate the configuration options in
[`$GRAVITINO_HOME/conf/gravitino.conf`](gravitino-server-config.md). There are
four configuration properties for the Iceberg REST catalog service:
+Iceberg REST server could start as a standalone server or an auxiliary service
in Gravitino server. There are some differences like below:
-1. [**REST Catalog Server
Configuration**](#rest-catalog-server-configuration): you can specify the HTTP
server properties like host and port.
+| | Standalone server
| Auxiliary service in Gravitino server
|
+|-------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|
+| How to build package | `./gradlew compileIcebergRESTServer -x test` build
a standalone Iceberg REST server in
`distribution/gravitino-iceberg-rest-server` directory. | `./gradlew
compileDistribution -x test` build Gravitino server and Iceberg REST server in
`distribution/package` directory. |
+| How to assemble package | `./gradlew assembleIcebergRESTServer -x test`
build a tar file with Iceberg REST server only in `distribution` directory.
| `./gradlew assembleDistribution -x test` build a tar file
with Gravitino server and Iceberg REST server `distribution` directory. |
+| How to start server | `./bin/gravitino-iceberg-rest-server.sh start`
| `./bin/gravitino.sh start`
|
+| Configuration files | `./conf/gravitino-iceberg-rest-server.conf`,
`conf/log4j2.properties`
| `./conf/gravitino.conf`, `conf/log4j2.properties`
|
-2. [**Gravitino Iceberg metrics store
Configuration**](#iceberg-metrics-store-configuration): you could implement a
custom Iceberg metrics store and set corresponding configuration.
+You could modify environment variables in `conf/gravitino-env.sh` and check
the log files in `./log/gravitino-iceberg-rest-server.log`,
`./log/gravitino-iceberg-rest-server.out` for both mode.
-3. [**Gravitino Iceberg Catalog backend
Configuration**](#gravitino-iceberg-catalog-backend-configuration): you have
the option to set the specified catalog-backend to either `jdbc` or `hive`.
+## Apache Gravitino Iceberg REST catalog server configuration
-4. [**Other Iceberg Catalog Properties Defined by Apache
Iceberg**](#other-apache-iceberg-catalog-properties): allows you to configure
additional properties defined by Apache Iceberg.
+The configuration settings for the Gravitino Iceberg REST server are identical
for both the standalone server and the auxiliary server in the Gravitino
system. Starting from version `0.6.0`, using the prefix
`gravitino.auxService.iceberg-rest.` for the auxiliary server configuration is
deprecated. If both `gravitino.auxService.iceberg-rest.key` and
`gravitino.iceberg-rest.key` are present, the `gravitino.iceberg-rest.key` will
take precedence. The following configurations are shown with
`gravitino.iceberg-rest.` prefix.
Review Comment:
done
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
