This is an automated email from the ASF dual-hosted git repository.
yzheng 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 215b2365b Simplify getting started example for Ceph (#3587)
215b2365b is described below
commit 215b2365b1a4304c914365c840f595e4c90a11f9
Author: Yong Zheng <[email protected]>
AuthorDate: Wed Jan 28 14:05:28 2026 -0600
Simplify getting started example for Ceph (#3587)
* Simplify getting started example for Ceph
* Simplify getting started example for Ceph
---
getting-started/ceph/.gitignore | 22 +++++++++++++++++++++
getting-started/ceph/README.md | 34 +++++----------------------------
getting-started/ceph/docker-compose.yml | 21 ++++++++++++--------
3 files changed, 40 insertions(+), 37 deletions(-)
diff --git a/getting-started/ceph/.gitignore b/getting-started/ceph/.gitignore
new file mode 100644
index 000000000..740b9a701
--- /dev/null
+++ b/getting-started/ceph/.gitignore
@@ -0,0 +1,22 @@
+#
+# 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.
+#
+
+# Ceph
+bootstrap-osd/*
+ceph-conf/ceph.client.admin.keyring
\ No newline at end of file
diff --git a/getting-started/ceph/README.md b/getting-started/ceph/README.md
index b70da3ee5..785c52ae0 100644
--- a/getting-started/ceph/README.md
+++ b/getting-started/ceph/README.md
@@ -47,23 +47,14 @@ Note: this example pulls the `apache/polaris:latest` image,
but assumes the imag
cp .env.example .env
```
-### 2. Start monitor and manager
+### 2. Start the docker compose group by running the following command:
```shell
-docker compose up -d mon1 mgr
+docker compose up -d
```
-### 3. Start OSD
-```shell
-docker compose up -d osd1
-```
-
-### 4. Start RGW
-```shell
-docker compose up -d rgw1
-```
#### Check status
```shell
-docker exec --interactive --tty ceph-mon1-1 ceph -s
+docker exec ceph-mon1-1 ceph -s
```
You should see something like:
```yaml
@@ -81,22 +72,7 @@ services:
rgw: 1 daemon active (1 hosts, 1 zones)
```
-### 5. Create bucket for Polaris storage
-```shell
-docker compose up -d setup_bucket
-```
-
-### 6. Run Polaris service
-```shell
-docker compose up -d polaris
-```
-
-### 7. Setup polaris catalog
-```shell
-docker compose up -d polaris-setup
-```
-
-## 8. Connecting From Spark
+### 3. Connecting From Spark
```shell
bin/spark-sql \
@@ -121,7 +97,7 @@ Note: `s3cr3t` is defined as the password for the `root`
user in the `docker-com
Note: The `client.region` configuration is required for the AWS S3 client to
work, but it is not used in this example
since Ceph does not require a specific region.
-## 9. Running Queries
+### 4. Running Queries
Run inside the Spark SQL shell:
diff --git a/getting-started/ceph/docker-compose.yml
b/getting-started/ceph/docker-compose.yml
index ae7d3cf14..db54e0fad 100644
--- a/getting-started/ceph/docker-compose.yml
+++ b/getting-started/ceph/docker-compose.yml
@@ -126,11 +126,18 @@ services:
- ./ceph-conf:/etc/ceph
depends_on:
- osd1
+ healthcheck:
+ test: ["CMD", "curl", "-f", "http://localhost:7480";]
+ interval: 2s
+ timeout: 10s
+ retries: 10
+ start_period: 10s
- setup_bucket:
+ bucket-setup:
image: amazon/aws-cli:2.33.8
depends_on:
- - rgw1
+ rgw1:
+ condition: service_healthy
environment:
AWS_ACCESS_KEY_ID: ${RGW_ACCESS_KEY}
AWS_SECRET_ACCESS_KEY: ${RGW_SECRET_KEY}
@@ -141,12 +148,10 @@ services:
command:
- "-c"
- >-
- set -ex;
- echo ">>> Waiting for RGW to become ready...";
- sleep 5;
- echo ">>> Create bucket if not exist...";
- aws s3 mb s3://${S3_POLARIS_BUCKET} || true;
- tail -f /dev/null;
+ echo Creating Ceph bucket...;
+ aws s3 mb s3://${S3_POLARIS_BUCKET};
+ aws s3 ls;
+ echo Bucket setup complete.;
polaris:
image: apache/polaris:latest
