This is an automated email from the ASF dual-hosted git repository.
dimas pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/polaris.git
The following commit(s) were added to refs/heads/main by this push:
new f056e22f7 Add getting started docs for Apache Ozone (#2989)
f056e22f7 is described below
commit f056e22f7f3a7c53e233bef1b88d204d6a8e4d79
Author: Dmitri Bourlatchkov <[email protected]>
AuthorDate: Thu Nov 6 12:03:35 2025 -0500
Add getting started docs for Apache Ozone (#2989)
Closes #2207
---
.../creating-a-catalog/s3/catalog-ozone.md | 69 ++++++++++++++++++++++
1 file changed, 69 insertions(+)
diff --git
a/site/content/in-dev/unreleased/getting-started/creating-a-catalog/s3/catalog-ozone.md
b/site/content/in-dev/unreleased/getting-started/creating-a-catalog/s3/catalog-ozone.md
new file mode 100644
index 000000000..6d3790f52
--- /dev/null
+++
b/site/content/in-dev/unreleased/getting-started/creating-a-catalog/s3/catalog-ozone.md
@@ -0,0 +1,69 @@
+---
+#
+# 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.
+#
+title: Creating a catalog on Apache Ozone
+linkTitle: Ozone
+type: docs
+weight: 150
+---
+
+When creating a catalog based on [Apache Ozone](https://ozone.apache.org/)
storage it is important to
+configure the `endpoint` property to point to your own storage cluster. If the
`endpoint` property is
+not set, Polaris will attempt to contact AWS storage services (which is
certain to fail in this case).
+
+Note: the `--no-sts` CLI option instructs Polaris to avoid calling STS
endpoints with `AssumeRoles`
+requests. This means that both Polaris and its clients (engines) will have to
use distinct (local)
+credentials for accessing storage. Engines should _not_ request credential
vending in this case
+(should not use the `X-Iceberg-Access-Delegation=vended-credentials` header).
+
+Note: the region setting is not required by Ozone, but it is set in this
example for the sake of
+simplicity as it is usually required by the AWS SDK (used internally by
Polaris). One can also
+set the `AWS_REGION` environment variable in the Polaris server process and
avoid setting region
+as a catalog property.
+
+Note: the name `quickstart_catalog` from the example below is referenced in
other Getting Started
+examples, but of course, it can be any valid catalog name.
+
+```shell
+CLIENT_ID=root
+CLIENT_SECRET=s3cr3t
+DEFAULT_BASE_LOCATION=s3://example-bucket/my_data
+
+./polaris \
+ --client-id ${CLIENT_ID} \
+ --client-secret ${CLIENT_SECRET} \
+ catalogs \
+ create \
+ --storage-type s3 \
+ --endpoint http://127.0.0.1:9878
+ --no-sts
+ --path-style-access
+ --default-base-location ${DEFAULT_BASE_LOCATION} \
+ --region irrelevant \
+ quickstart_catalog
+```
+
+In more complex deployments it may be necessary to configure different
endpoints for S3 requests
+and for STS (AssumeRole) requests. This can be achieved via the
`--sts-endpoint` CLI option.
+
+Additionally, the `--endpoint-internal` CLI option cane be used to set the S3
endpoint for use by
+the Polaris Server itself, if it needs to be different from the endpoint used
by clients / engines.
+
+A usable Apache Ozone example for `docker-compose` is available in the Polaris
source code under the
+[getting-started/ozone](https://github.com/apache/polaris/tree/main/getting-started/ozone)
module.
