This is an automated email from the ASF dual-hosted git repository. jmclean pushed a commit to branch readme in repository https://gitbox.apache.org/repos/asf/gravitino.git
commit 25127d1c9c17aee5196785d3c75bd41fde43fcc4 Author: Justin Mclean <[email protected]> AuthorDate: Thu Aug 7 15:33:13 2025 +1000 update README --- README.md | 122 +++++++++++++++++++++++++++++++++----------------------------- 1 file changed, 66 insertions(+), 56 deletions(-) diff --git a/README.md b/README.md index 79d8ec5ce6..3571291c8c 100644 --- a/README.md +++ b/README.md @@ -34,102 +34,112 @@ Apache Gravitino is a high-performance, geo-distributed, and federated metadata  -Gravitino aims to provide several key features: -* Unified Metadata Management: Gravitino provides a unified model and API to manage different types of metadata, including relational (e.g., Hive, MySQL) and file-based (e.g., HDFS, S3) metadata sources. -* End-to-End Data Governance: Gravitino offers a unified governance layer for managing metadata with features like access control, auditing, and discovery. -* Direct Metadata Management: Gravitino connects directly to metadata sources via connectors, ensuring changes are instantly reflected between Gravitino and the underlying systems. -* Geo-Distribution Support: Gravitino enables deployment across multiple regions or clouds, allowing instances to share metadata for a global cross-region view. -* Multi-Engine Support: Gravitino supports query engines enabling metadata access without modifying SQL dialects. -* AI Asset Management (WIP): Gravitino is expanding to manage both data and AI assets, with support for AI models and features currently in development. +## 🚀 Key Features -## Contributing to Apache Gravitino +- **Unified Metadata Management**: Manage diverse metadata sources through a single model and API (e.g., Hive, MySQL, HDFS, S3). +- **End-to-End Data Governance**: Features like access control, auditing, and discovery across all metadata assets. +- **Direct Metadata Integration**: Changes in underlying systems are immediately reflected via Gravitino’s connectors. +- **Geo-Distribution Support**: Share metadata across regions and clouds to support global architectures. +- **Multi-Engine Compatibility**: Seamlessly integrates with query engines without modifying SQL dialects. +- **AI Asset Management (WIP)**: Support for AI model and feature tracking. -Gravitino is open source software available under the Apache 2.0 license. For information on contributing to Gravitino, please see the [Contribution guidelines](https://gravitino.apache.org/contrib/). +## 🌐 Common Use Cases -## Online documentation +- Federated metadata discovery across data lakes and data warehouses +- Multi-region metadata synchronization for hybrid or multi-cloud setups +- Data and AI asset governance with unified audit and access control +- Plug-and-play access for engines like Trino or Spark +- Support for evolving metadata standards, including AI model lineage -The latest Gravitino documentation is available on our [official website](https://gravitino.apache.org/docs/latest/). This README file only contains basic setup instructions. +## 📚 Documentation -## Building Apache Gravitino +The latest Gravitino documentation is available at [gravitino.apache.org/docs/latest](https://gravitino.apache.org/docs/latest/). -You can build Gravitino using Gradle. Currently, you can build Gravitino on Linux and macOS, and Windows isn't supported. +This README provides a basic overview; visit the site for full installation, configuration, and development documentation. -To build Gravitino, please run: +## 🧪 Quick Start -```shell -./gradlew clean build -x test -``` +### Use Gravitino Playground (Recommended) -If you want to build a distribution package, please run: - -```shell -./gradlew compileDistribution -x test -``` +Gravitino provides a Docker Compose–based playground for a full-stack experience. +Clone or download the [Gravitino Playground repository](https://github.com/apache/gravitino-playground) and follow its [README](https://github.com/apache/gravitino-playground/blob/main/README.md). -to build a distribution package. +### Run Gravitino Locally -Or: +1. [Download](https://gravitino.apache.org/downloads) and extract a binary release. +2. Edit `conf/gravitino.conf` to configure settings. +3. Start the server: -```shell -./gradlew assembleDistribution -x test +```bash +./bin/gravitino.sh start ``` -to build a compressed distribution package. +4. To stop: -The directory `distribution` contains the generated binary distribution package. +```bash +./bin/gravitino.sh stop +``` -Please see [How to build Gravitino](https://gravitino.apache.org/docs/latest/how-to-build/) for details on building and testing Gravitino. +Press `CTRL+C` to stop. -## Quick start +## 🧊 Iceberg REST Catalog -### Use Gravitino playground +Gravitino provides a native Iceberg REST catalog service. +See: [Iceberg REST catalog service](https://gravitino.apache.org/docs/latest/iceberg-rest-service/) -This is the recommended approach. Gravitino provides a docker-compose-based playground where you can experience a whole system alongside other components. Clone or download the [Gravitino playground repository](https://github.com/apache/gravitino-playground) and then follow the [README](https://github.com/apache/gravitino-playground/blob/main/README.md), to get everything running. +## 🔌 Trino Integration -### Configure and start Gravitino server in local +Gravitino includes a Trino connector for federated metadata access. +See: [Using Trino with Gravitino](https://gravitino.apache.org/docs/latest/trino-connector/index/) -To start Gravitino on your machine, download a binary package from the [download page](https://gravitino.apache.org/downloads) and decompress the package. +## 🛠️ Building from Source -Before starting the Gravitino server, configure its settings by editing the `gravitino.conf` file located in the `conf` directory. This file follows the standard properties file format, allowing you to modify the server configuration as needed. +Gravitino uses Gradle. Windows is not currently supported. -To start the Gravitino server, please run: +Clean build without tests: -```shell -./bin/gravitino.sh start +```bash +./gradlew clean build -x test ``` -To stop the Gravitino server, please run: +Build a distribution: -```shell -./bin/gravitino.sh stop +```bash +./gradlew compileDistribution -x test ``` -Alternatively, to run the Gravitino server in the frontend, please run: +Or compressed package: -```shell -./bin/gravitino.sh run +```bash +./gradlew assembleDistribution -x test ``` -And press `CTRL+C` to stop the Gravitino server. +Artifacts are output to the `distribution/` directory. + +More build options: [How to build Gravitino](https://gravitino.apache.org/docs/latest/how-to-build/) + +## 👨💻 Developer Resources -### Gravitino Iceberg REST catalog service +- [How to build Gravitino](https://gravitino.apache.org/docs/latest/how-to-build/) +- [How to test Gravitino](https://gravitino.apache.org/docs/latest/how-to-test/) +- [Publish Docker images](https://gravitino.apache.org/docs/latest/publish-docker-images) -Gravitino provides Iceberg REST catalog service to manage Iceberg efficiently. For more details, refer to [Gravitino Iceberg REST catalog service](https://gravitino.apache.org/docs/latest/iceberg-rest-service/). +## 🤝 Contributing -### Using Trino with Apache Gravitino +We welcome all kinds of contributions—code, documentation, testing, connectors, and more! -Gravitino provides a Trino connector for accessing metadata within Gravitino. To use Trino with Gravitino, please follow the [trino-gravitino-connector doc](https://gravitino.apache.org/docs/latest/trino-connector/index/). +To get started, please read our [CONTRIBUTING.md](CONTRIBUTING.md) guide. -## Development guide +## 🔗 ASF Resources -1. [How to build Gravitino](https://gravitino.apache.org/docs/latest/how-to-build/) -2. [How to test Gravitino](https://gravitino.apache.org/docs/latest/how-to-test/) -3. [How to publish Docker images](https://gravitino.apache.org/docs/latest/publish-docker-images) +- 📬 Mailing List: [[email protected]](mailto:[email protected]) ([subscribe](mailto:[email protected])) +- 🐞 Issue Tracker: [GitHub Issues](https://github.com/apache/gravitino/issues) -## License +## 🪪 License -Gravitino is licensed under the Apache License Version 2.0. For details, see the [LICENSE](LICENSE). +Apache Gravitino is licensed under the Apache License, Version 2.0. +See the [LICENSE](LICENSE) file for details. -<sub>Apache®, Apache Gravitino™, Apache Hadoop®, Apache Hive™, Apache Iceberg™, Apache Kafka®, Apache Spark™, Apache Submarine™, Apache Thrift™ and Apache Zeppelin™ are either registered trademarks or trademarks of the Apache Software Foundation in the United States and/or other countries.</sub> +<sub>Apache®, Apache Gravitino™, Apache Hadoop®, Apache Hive™, Apache Iceberg™, Apache Kafka®, Apache Spark™, Apache Submarine™, Apache Thrift™, and Apache Zeppelin™ are trademarks of the Apache Software Foundation in the United States and/or other countries.</sub> <img src="https://analytics.apache.org/matomo.php?idsite=62&rec=1&bots=1&action_name=ReadMe"; style="border:0;" alt="" />
