Skip to content

Commit

Permalink
[#6600] Docs: restructure the getting started docs (#6596)
Browse files Browse the repository at this point in the history
Related: #6600 

This PR restructures the getting-started tutorial. Changes include:

- push the getting started tutorial into a separate directory;
- remove duplicated instructions on install and configuration;
- rework the flow of information for clarity and conciseness.

Co-authored-by: Jerry Shao <[email protected]>
  • Loading branch information
tengqm and jerryshao authored Mar 6, 2025
1 parent 6451189 commit 548ec8d
Show file tree
Hide file tree
Showing 8 changed files with 379 additions and 370 deletions.
339 changes: 0 additions & 339 deletions docs/getting-started.md

This file was deleted.

36 changes: 36 additions & 0 deletions docs/getting-started/aws-remote-access.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: "Remote Access for Apache Gravitino on AWS"
slug: /getting-started/aws-remote-access
license: "This software is licensed under the Apache License version 2."
---

## Accessing Apache Gravitino on AWS externally

When you deploy Gravitino on AWS, accessing it externally requires
some additional configuration due to how AWS networking works.

AWS assigns your instance a public IP address, but Gravitino can't bind to that address.
To resolve this, you must find the internal IP address assigned to your AWS instance.
You can locate the private IP address in the AWS console, or by running the following command:

```shell
ip a
```

Once you have identified the internal address, edit the Gravitino configuration to bind to that address.
Open the file `<gravitino-home>/conf/gravitino.conf` and change the `gravitino.server.webserver.host`
parameter from `127.0.0.1` to your AWS instance's private IP4 address;
or you can use '0.0.0.0'. '0.0.0.0' in this context means the host's IP address.
Restart the Gravitino server for the change to take effect.

```shell
<gravitino-home>/bin/gravitino.sh restart
```

You'll also need to open port 8090 in the security group of your AWS instance to access Gravitino.
To access Hive you need to open port 10000 in the security group.

After completing these steps, you should be able to access the Gravitino REST interface
from either the command line or a web browser on your local computer.
You can also connect to Hive via DBeaver or any other database IDE.

Loading

0 comments on commit 548ec8d

Please sign in to comment.