Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[#596] feat(doc): Add doc for Hadoop access #602

Merged
merged 5 commits into from
Oct 26, 2023
Merged

[#596] feat(doc): Add doc for Hadoop access #602

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a9bbb4a
add hadoop env
mchades Oct 26, 2023
3649ac9
feedback the review
mchades Oct 26, 2023
de93da3
remove variable
mchades Oct 26, 2023
529d51a
add resove ways
mchades Oct 26, 2023
b1e300a
add iceberg doc
mchades Oct 26, 2023
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
1 change: 1 addition & 0 deletions conf/gravitino-env.sh.template
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@
# export GRAVITINO_CONF_DIR
# export GRAVITINO_LOG_DIR # Where log files are stored. PWD by default.
# export GRAVITINO_MEM # Gravitino jvm mem options Default -Xms1024m -Xmx1024m -XX:MaxMetaspaceSize=512m
HADOOP_USER_NAME=gravitino
mchades marked this conversation as resolved.
Show resolved Hide resolved
11 changes: 11 additions & 0 deletions docs/gravitino-server-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,14 @@ The following table lists the configuration items in the `gravitino.conf` file.
|-----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|---------------|
| `gravitino.catalog.cache.evictionIntervalMs` | The interval in milliseconds to evict the catalog cache, default 3600000ms(1h) | `3600000` | 0.1.0 |
| `gravitino.catalog.classloader.isolated` | Whether to use an isolated classloader for catalog, if it's true, all catalog-related libraries and configurations will be loaded by an isolated classloader NOT by AppClassLoader. Default value is `true` | `true` | 0.1.0 |

## How to set up runtime environment variables

Gravitino server also supports setting up runtime environment variables by editing the `gravitino-env.sh` file, which is located in the `conf` directory.

### Hadoop environment variables
mchades marked this conversation as resolved.
Show resolved Hide resolved

Currently, Gravitino server use `gravitino` as default Hadoop username, since Gravitino need to access Hadoop(HDFS, YARN etc.) while
performing certain operations, please make sure that `gravitino` have the necessary permissions for accessing HDFS or
you can change the value of `HADOOP_USER_NAME` by editing the `gravitino-env.sh` file before starting the Gravitino
server.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think what you need to write is to explain the limitation of current Gravitino, and describe the workaround solutions to users, and tell users we will add user impersonation support in future.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have updated the doc, how about the current describtion?

4 changes: 2 additions & 2 deletions docs/integration-test.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Before running the tests, make sure Docker is installed.
Additionally, the Gravitino Server and third-party data source Docker runtime environments will use certain ports. Ensure that these ports are not already in use:

- Gravitino Server: Port `8090`
- Hive Docker runtime environment: Ports are `22`, `7180`, `8088`, `8888`, `9000`, `9083`, `10000`, `10002`, `50070`, and `50075`
- Hive Docker runtime environment: Ports are `22`, `7180`, `8088`, `8888`, `9000`, `9083`, `10000`, `10002`, `50010`, `50070`, and `50075`

## Debugging Gravitino Server and Integration Tests

Expand All @@ -118,7 +118,7 @@ To debug the Gravitino Server and integration tests, you have two modes: `embedd
- If you only debug integration test codes, You don't have to do any setup to debug directly
- If you need to debug Gravitino server codes, follow these steps:
- Enable the `GRAVITINO_DEBUG_OPTS` environment variable in the `distribution/package/conf/gravitino-env.sh` file to enable remote JVM debugging
- Manually start the Gravitino Server using the `./distribution/package/bin/gravitino-server.sh start` command
- Manually start the Gravitino Server using the `./distribution/package/bin/gravitino.sh start` command
- Select `gravitino.server.main` module classpath in the `Remote JVM Debug` to attach the Gravitino Server process and debug it

## Running on GitHub Actions
Expand Down