This is an automated email from the ASF dual-hosted git repository.
kevinjqliu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iceberg.git
The following commit(s) were added to refs/heads/main by this push:
new 1a8fa1e56b Docs: Document CATALOG_* env vars in iceberg-rest-fixture
README (#16007)
1a8fa1e56b is described below
commit 1a8fa1e56bf81ed1780817bd63cdccfe1a71281f
Author: Rexwell Minnis <[email protected]>
AuthorDate: Sat May 9 13:19:34 2026 -0400
Docs: Document CATALOG_* env vars in iceberg-rest-fixture README (#16007)
The REST fixture supports configuration via CATALOG_* environment variables
through the standard prefix translation (CATALOG_ stripped, single _ → .,
double __ → -, lowercased). Without docs, users discover this only by
reading source.
This adds a Configuration section that:
- Spells out the CATALOG_* convention with a small mapping table
- Shows the working form to override the catalog name
(CATALOG_CATALOG_NAME=mycatalog)
- Notes the in-memory SQLite default when catalog-impl + uri are unset
Docs-only — no code change. Refs #14972 (closed).
---
docker/iceberg-rest-fixture/README.md | 33 +++++++++++++++++++++++++++++++++
1 file changed, 33 insertions(+)
diff --git a/docker/iceberg-rest-fixture/README.md
b/docker/iceberg-rest-fixture/README.md
index 3805cc2468..5e02a2b471 100644
--- a/docker/iceberg-rest-fixture/README.md
+++ b/docker/iceberg-rest-fixture/README.md
@@ -23,6 +23,39 @@ For converting different catalog implementations into a rest
one.
Adapter for wrapping the existing catalog backends over REST.
+## Configuration
+
+All configuration is provided via environment variables.
+
+### Backend catalog properties
+
+Catalog properties can be set via `CATALOG_*` environment variables. The
+`CATALOG_` prefix is stripped; single underscores become dots (`.`); double
+underscores become dashes (`-`). Names are lowercased.
+
+| Env var | Catalog property |
+|---|---|
+| `CATALOG_CATALOG_NAME` | `catalog.name` |
+| `CATALOG_WAREHOUSE` | `warehouse` |
+| `CATALOG_URI` | `uri` |
+| `CATALOG_CATALOG__IMPL` | `catalog-impl` |
+| `CATALOG_IO__IMPL` | `io-impl` |
+| `CATALOG_JDBC_USER` | `jdbc.user` |
+
+If `catalog-impl` and `uri` are unset, the fixture defaults to an in-memory
+SQLite `JdbcCatalog`.
+
+### Catalog name
+
+By default, the fixture serves a catalog named `rest_backend`. To match a
+name expected by a specific engine (for example, a catalog created via Trino
+or PyIceberg), override the `catalog.name` property:
+
+```bash
+docker run -e CATALOG_CATALOG_NAME=mycatalog -p 8181:8181
apache/iceberg-rest-fixture
+```
+
+
## Build the Docker Image
When making changes to the local files and test them out, you can build the
image locally:
