Skip to content

Commit

Permalink
[MINOR] docs: improve Gravitino document (#2128)
Browse files Browse the repository at this point in the history
### What changes were proposed in this pull request?
1. Gravitino supports JDK8, JDK11, JDK17
2. export 9001 to Gravitino docker image example
3. Iceberg REST service HTTP port is not required.

### Why are the changes needed?
Fix: # (issue)

### Does this PR introduce _any_ user-facing change?
no

### How was this patch tested?
just document

Co-authored-by: FANNG <xiaojing@datastrato.com>
  • Loading branch information
jerryshao and FANNG1 authored Feb 6, 2024
1 parent 5df3447 commit 9b9243b
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/docker-image-details.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ You can deploy the service with the Gravitino Docker image.
Container startup commands

```shell
docker run --rm -d -p 8090:8090 datastrato/gravitino
docker run --rm -d -p 8090:8090 -p 9001:9001 datastrato/gravitino
```

Changelog
Expand Down
2 changes: 1 addition & 1 deletion docs/iceberg-rest-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Please refer to the following sections for details.
| `gravitino.auxService.names` | The auxiliary service name of the Gravitino Iceberg REST catalog service, use **`iceberg-rest`** for the Gravitino Iceberg REST catalog service. | (none) | Yes | 0.2.0 |
| `gravitino.auxService.iceberg-rest.classpath` | The classpath of the Gravitino Iceberg REST catalog service, includes the directory containing jars and configuration. It supports both absolute paths and relative paths, for example, `catalogs/lakehouse-iceberg/libs, catalogs/lakehouse-iceberg/conf` | (none) | Yes | 0.2.0 |
| `gravitino.auxService.iceberg-rest.host` | The host of the Gravitino Iceberg REST catalog service. | `0.0.0.0` | No | 0.2.0 |
| `gravitino.auxService.iceberg-rest.httpPort` | The port of the Gravitino Iceberg REST catalog service. | `9001` | Yes | 0.2.0 |
| `gravitino.auxService.iceberg-rest.httpPort` | The port of the Gravitino Iceberg REST catalog service. | `9001` | No | 0.2.0 |
| `gravitino.auxService.iceberg-rest.minThreads` | The minimum number of threads in the thread pool used by the Jetty web server. `minThreads` is 8 if the value is less than 8. | `Math.max(Math.min(Runtime.getRuntime().availableProcessors() * 2, 100), 8)` | No | 0.2.0 |
| `gravitino.auxService.iceberg-rest.maxThreads` | The maximum number of threads in the thread pool used by the Jetty web server. `maxThreads` is 8 if the value is less than 8, and `maxThreads` must be greater than or equal to `minThreads`. | `Math.max(Runtime.getRuntime().availableProcessors() * 4, 400)` | No | 0.2.0 |
| `gravitino.auxService.iceberg-rest.threadPoolWorkQueueSize` | The size of the queue in the thread pool used by Gravitino Iceberg REST catalog service. | `100` | No | 0.2.0 |
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ metadata access for data and AI assets.
You can get Gravitino from the [GitHub release page](https://github.com/datastrato/gravitino/releases),
or you can build Gravitino from source code, please see [How to build Gravitino](./how-to-build.md).

Gravitino runs on both Linux and macOS, and requires Java 8. Gravitino trino-connector runs with
Gravitino runs on both Linux and macOS platforms, and it requires the installation of Java 8, Java 11, or Java 17. Gravitino trino-connector runs with
Trino, and requires Java 17. This should include JVMs on x86_64 and
ARM64. It's easy to run locally on one machine --- all you need is to have `java` installed on
ARM64. It's easy to run locally on one machine, all you need is to have `java` installed on
your system `PATH`, or the `JAVA_HOME` environment variable pointing to a Java installation.

See [How to install Gravitino](./how-to-install.md) to learn how to install Gravitino server.
Expand Down

0 comments on commit 9b9243b

Please sign in to comment.