FANNG1 commented on code in PR #9228: URL: https://github.com/apache/gravitino/pull/9228#discussion_r2559848201
########## AGENTS.md: ########## @@ -0,0 +1,462 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +# AGENTS.md + +This file provides guidance to AI coding agents collaborating on the Apache Gravitino repository. + +## Project Overview + +Apache Gravitino is a high-performance, geo-distributed, and federated metadata lake. It manages metadata directly in different sources, types, and regions, providing users with unified metadata access for data and AI assets. + +Gravitino acts as a centralized metadata management layer that: +- Provides unified metadata access across diverse data sources (Hive, MySQL, Iceberg, Kafka, etc.) +- Enables end-to-end data governance with access control, auditing, and discovery +- Supports geo-distributed architectures for multi-region and multi-cloud deployments +- Integrates seamlessly with query engines like Trino and Spark +- Manages both data assets and AI model metadata + +## Project Requirements + +- Always use English in code, documentation, examples, and comments +- Follow Apache Software Foundation guidelines and best practices +- Code should be clean, maintainable, efficient, and well-documented +- All public APIs must have comprehensive documentation +- Maintain backward compatibility - breaking changes require careful consideration +- Write meaningful tests for all features and bug fixes - **code without tests will not be merged** +- Follow the project's coding standards and use Spotless for formatting + +## Architecture + +The project is organized as a Gradle multi-module project with the following key components: + +### Core Modules +- `api/` - Public API definitions and interfaces for Gravitino +- `common/` - Common utilities, types, and shared code across modules +- `core/` - Core Gravitino server implementation and metadata management logic +- `server/` - REST API server implementation and HTTP endpoints +- `server-common/` - Shared server utilities and configurations + +### Client Modules +- `clients/client-java/` - Java client library for Gravitino API +- `clients/client-python/` - Python client library with bindings +- `clients/cli/` - Command-line interface for Gravitino +- `clients/filesystem-hadoop3/` - Hadoop FileSystem implementation +- `clients/filesystem-fuse/` - FUSE filesystem integration (optional) + +### Catalog Implementations +- `catalogs/catalog-common/` - Base classes and utilities for catalog implementations +- `catalogs/catalog-hive/` - Apache Hive metastore catalog +- `catalogs/catalog-lakehouse-iceberg/` - Apache Iceberg catalog +- `catalogs/catalog-lakehouse-paimon/` - Apache Paimon catalog +- `catalogs/catalog-lakehouse-hudi/` - Apache Hudi catalog +- `catalogs/catalog-lakehouse-generic/` - Generic lakehouse catalog +- `catalogs/catalog-jdbc-mysql/` - MySQL catalog +- `catalogs/catalog-jdbc-postgresql/` - PostgreSQL catalog +- `catalogs/catalog-jdbc-doris/` - Apache Doris catalog +- `catalogs/catalog-kafka/` - Apache Kafka catalog +- `catalogs/catalog-fileset/` - Fileset catalog for file-based data +- `catalogs/catalog-model/` - AI model catalog + +### Integration Connectors +- `spark-connector/` - Spark connector for Gravitino (Spark 3.3, 3.4, 3.5) +- `flink-connector/` - Apache Flink connector (Scala 2.12 only) +- `trino-connector/` - Trino connector for federated queries + +### Standalone Services +- `iceberg/iceberg-rest-server/` - Standalone Iceberg REST catalog service +- `lance/lance-rest-server/` - Lance format REST server + +### Authorization +- `authorizations/authorization-common/` - Authorization framework +- `authorizations/authorization-ranger/` - Apache Ranger integration +- `authorizations/authorization-chain/` - Chain-based authorization + +### Other Components +- `web/` - Web UI frontend (Next.js/React) +- `docs/` - Documentation source files +- `integration-test/` - End-to-end integration tests Review Comment: `integration-test/` only include the base tools for integration-test. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
