Skip to content

Commit

Permalink
[ apache#1417] improve(doc): Check getting started document (apache#1589
Browse files Browse the repository at this point in the history
)

What changes were proposed in this pull request?
Improved Getting Started document

Why are the changes needed?
For clear and correct instructions

Fix: apache#1417 

Does this PR introduce any user-facing change?
N/A

How was this patch tested?
N/A.
  • Loading branch information
hiirrxnn authored Jan 25, 2024
1 parent 65ef6dd commit a2896be
Showing 1 changed file with 58 additions and 2 deletions.
60 changes: 58 additions & 2 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,44 @@ or locally see [Installing Gravitino playground locally](#installing-gravitino-p

If you are using AWS and want to access the instance remotely, be sure to read [Accessing Gravitino on AWS externally](#accessing-gravitino-on-aws-externally)

### Index

1. **Installation methods**
- Explore different installation methods, from using Docker to setting up Gravitino on cloud platforms or locally.

2. **Java Development Kit (JDK)**
- Ensure you have the required Java Development Kit (JDK) installed to run Gravitino successfully.

3. **Configuring and starting Gravitino**
- Learn how to configure Gravitino, install it from binary releases or Docker images, and start the Gravitino server.

4. **Getting started on AWS and GCP**
- Detailed steps for setting up Gravitino on Amazon Web Services (AWS) and Google Cloud Platform (GCP), including instance setup, Java installation, and Gravitino deployment.

5. **Getting started locally**
- Instructions for using Gravitino locally on macOS or Linux, covering JDK installation and Gravitino setup.

6. **Integrating with Apache Hive**
- Information on installing and configuring Apache Hive on AWS, GCP, and locally. Docker container options for quick setup are also provided.

7. **Gravitino Playground**
- Explore a bundled Docker image for a Gravitino playground, incorporating various tools like Apache Hive, Apache Hadoop, Trino, MySQL, and PostgreSQL.

8. **Using REST to interact with Gravitino**
- Examples of interacting with Gravitino via REST commands, demonstrating how to create and modify metadata.

9. **Accessing Gravitino on AWS externally**
- Guidelines for accessing Gravitino externally when deployed on AWS, including necessary configurations and considerations.

10. **Next steps**
- Concluding thoughts and suggesting next steps for users who have completed the setup.


## Getting started on Amazon Web Services

To begin using Gravitino on AWS, follow these steps:

1. In the AWS console, launch a new instance. Select `Ubuntu` as the operating system and `t2.xlarge` as the instance type. Create a key pair named *Gravitino.pem* for SSH access and download it. Allow HTTP and HTTPS traffic, if you want to connect to the instance remotely. Set the Elastic Block Store storage to 20GiB. Leave all other settings as their defaults. Other operating systems and instance types may work, but they have yet to be fully tested.
1. In the AWS console, launch a new instance. Select `Ubuntu` as the operating system and `t2.xlarge` as the instance type. Create a key pair named *Gravitino.pem* for SSH access and download it. Allow HTTP and HTTPS traffic, if you want to connect to the instance remotely. Set the Elastic Block Store storage to 20GiB. Leave all other settings at their defaults. Other operating systems and instance types may work, but they have yet to be fully tested.

2. Start the instance and connect to it via SSH using the downloaded .pem file:

Expand Down Expand Up @@ -183,7 +216,7 @@ Gravitino provides a bundle of Docker images to launch a Gravitino playground, w
includes Apache Hive, Apache Hadoop, Trino, MySQL, PostgreSQL, and Gravitino. You can use
Docker compose to start them all.
Installing Docker and Docker Compose is a requirement for using the playground.
Installing Docker and Docker Compose is a requirement for using the playground.
```shell
sudo apt install docker docker-compose
Expand Down Expand Up @@ -282,3 +315,26 @@ webserver.host` parameter from `127.0.0.1` to your AWS instance's private IP4 ad
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.

### Next steps:

1. **Explore documentation:**
- Delve deeper into the Gravitino documentation for advanced features and configuration options.
- Check out : https://datastrato.ai/docs/0.3.1/

2. **Community engagement:**
- Join the Gravitino community forums to connect with other users, share experiences, and seek assistance if needed.
- Check out our GitHub repository : https://github.com/datastrato
- Check out our Discourse group : https://gravitino.discourse.group/

3. **Read our blogs:**
- Check out : https://datastrato.ai/blog

4. **Continuous updates:**
- Stay informed about Gravitino updates and new releases to benefit from the latest features, optimizations, and security
enhancements.
- Check out our Website : https://datastrato.ai/
- Check out our Twitter page : https://twitter.com/datastrato


This document is just a beginning. You're welcome to customize your Gravitino setup based on your requirements and explore the vast possibilities this powerful tool offers. If you encounter any issues or have questions, you can always connect with the Gravitino community for assistance.

0 comments on commit a2896be

Please sign in to comment.