This is an automated email from the ASF dual-hosted git repository.
vinishjail97 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-xtable.git
The following commit(s) were added to refs/heads/main by this push:
new 31ac06fb [MINOR] Document the deployment scope of xtable-service (#914)
31ac06fb is described below
commit 31ac06fbb9b05898e200874534560132575caf1f
Author: Vinish Reddy <[email protected]>
AuthorDate: Wed Aug 26 00:17:56 2026 +0530
[MINOR] Document the deployment scope of xtable-service (#914)
The README does not state where the service is meant to run. The service has
no authentication layer, and it is not described in the user documentation
at
https://xtable.apache.org.
Add a short section stating the intended scope: local testing and trusted
internal networks, not multi-tenant or internet-facing use.
---
xtable-service/README.md | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/xtable-service/README.md b/xtable-service/README.md
index 9b4db827..65fb672c 100644
--- a/xtable-service/README.md
+++ b/xtable-service/README.md
@@ -22,6 +22,17 @@
The `rest-service-open-api.yaml` defines the api contract for running table
format conversion using XTable's REST service.
See XTable's `spec` module for more details:
https://github.com/apache/incubator-xtable/tree/main/spec
+## Deployment scope and security
+
+The service is a developer utility for local testing and for trusted internal
+deployments. It is not hardened for multi-tenant or internet-facing use, and
it is
+not described in the user documentation at https://xtable.apache.org.
+
+It ships with no authentication and no authorization. Any client that can
reach the
+port can start a conversion against any storage path the service credentials
can read
+or write. Run it on loopback, or only inside a network you control, and put
your own
+authentication in front of it if you expose it at all.
+
## How to run the service locally
#### Before running the service, ensure that you have the required credentials
set in your enviroment needed to read and write to cloud storage.
