Skip to content

Simplify getting started example for Ceph#3587

Merged
MonkeyCanCode merged 2 commits intoapache:mainfrom
MonkeyCanCode:ceph_getting_started_example
Jan 28, 2026
Merged

Simplify getting started example for Ceph#3587
MonkeyCanCode merged 2 commits intoapache:mainfrom
MonkeyCanCode:ceph_getting_started_example

Conversation

@MonkeyCanCode
Copy link
Contributor

So currently users can just do docker compose up -d on ceph example due to the non-deterministic bucket creation service (as it is simply sleep for 5 seconds without proper service check). Also, the current README.md is a bit length and ask users to run various command to start services in-order (which is a bit un-necessary as the right ordering are already been defined via depends_on.

This PR simplify the doc a bit to allow user to run a single command to start the services. Also, a small nit fixing for using dash instead of underscore for service name (setup_bucket to bucket-setup). Beside this, I also added a gitignore to exclude files created by this docker compose.

Here is error users can get if run docker compose up -d (which is failing silently):

+ echo '>>> Waiting for RGW to become ready...'
+ sleep 5
>>> Waiting for RGW to become ready...
+ echo '>>> Create bucket if not exist...'
+ aws s3 mb s3://polaris-storage
>>> Create bucket if not exist...
make_bucket failed: s3://polaris-storage Could not connect to the endpoint URL: "http://rgw1:7480/polaris-storage"
+ true
+ tail -f /dev/null

And here is the output with current PR (matching output layout to the other docker-compose files for this specific service and ensure service):

Creating Ceph bucket...
make_bucket: polaris-storage
2026-01-28 01:50:49 polaris-storage
Bucket setup complete.

Checklist

  • 🛡️ Don't disclose security issues! (contact [email protected])
  • 🔗 Clearly explained why the changes are needed, or linked related issues: Fixes #
  • 🧪 Added/updated tests with good coverage, or manually tested (and explained how)
  • 💡 Added comments for complex logic
  • 🧾 Updated CHANGELOG.md (if needed)
  • 📚 Updated documentation in site/content/in-dev/unreleased (if needed)

@MonkeyCanCode
Copy link
Contributor Author

@snazy thanks for the review and all comments had being addressed. Please take another look.

@github-project-automation github-project-automation bot moved this from PRs In Progress to Ready to merge in Basic Kanban Board Jan 28, 2026
@MonkeyCanCode MonkeyCanCode merged commit 215b236 into apache:main Jan 28, 2026
15 checks passed
@github-project-automation github-project-automation bot moved this from Ready to merge to Done in Basic Kanban Board Jan 28, 2026
snazy added a commit to snazy/polaris that referenced this pull request Feb 11, 2026
* Nit: fix shell-check warnings for await-s3.sh (apache#3593)

* Nit: add upgrade notes for develocity plugin (apache#3599)

* fix(deps): update dependency org.apache.hive:hive-exec to v2.3.10 (apache#3580)

* fix(deps): update dependency com.google.cloud:google-cloud-storage-bom to v2.62.1 (apache#3600)

* Change quick start example from MinIO to RustFS backend (apache#3586)

* chore(deps): update gradle/actions digest to f29f5a9 (apache#3602)

* Simplify getting started example for Ceph (apache#3587)

* Simplify getting started example for Ceph

* Simplify getting started example for Ceph

* fix(deps): update dependency io.smallrye.config:smallrye-config-core to v3.16.0 (apache#3604)

* chore(deps): update docker.io/mongo docker tag to v8.2.4 (apache#3606)

* fix(deps): update dependency net.ltgt.gradle:gradle-errorprone-plugin to v5 (apache#3605)

* chore(deps): update plugin com.gradle.develocity to v4.3.2 (apache#3598)

* chore(deps): update localstack/localstack docker tag to v4.13 (apache#3609)

* Guides: use `sql` code block (apache#3590)

Replaces the "anonymous" code blocks with `sql` code blocks, which is easier to "copy + paste" for users.

* Spark guide: document the launch command in the Markdown (apache#3592)

Replaces the "invisible" launch-docker.sh script with a "visible" `shell` code block, so the commands are immediately visible to users.

* Minio guide: fix service dependencies (apache#3594)

Use the "long" options for compose service dependencies, and adds the explicit option `restart: no` option for setup tasks, which is necessary to let docker-compose correctly interpret the termination of such tasks.

* Ozone guide: Fix service dependencies (apache#3595)

Use the "long" options for compose service dependencies, add healthchecks, uses more healthcheck-retries for slow-ish machines, and adds the explicit option `restart: no` option for setup tasks, which is necessary to let docker-compose correctly interpret the termination of such tasks.

* Rustfs guide: fix service dependencies (apache#3596)

Just adds a necessary service dependency

* Telemetry guide: fix setup-polaris service (apache#3597)

Fixes the polaris-setup service to use the "working" way/syntax, in alignment to other guides.

* Site-workflow: add `workflow_call` trigger (apache#3520)

This trigger allows the Hugo Site publication workflow to be called from the `versioned-docs` branch.

This change also introduces a concurrency group to prevent concurrent site publications.

Contributed to apache#3516

Co-authored-by: Dmitri Bourlatchkov <[email protected]>

* [Issue 3209] Surface Intermediate Data as part of Polaris Events (apache#3456)

Adds a RequestScoped annotation to AttributeMap, which allows us to inject this bean into intermediary business logic and be able to patch data from there back out to the PolarisEvent.

@dimas-b had a great idea that we may be able to retire the Delegator model eventually by setting a "closing" hook on the RequestScoped bean - but for simplicity, I am introducing this smaller change that will solve the GH issue linked first and will investigate that approach later.

* Getting-Started: Jaeger upgraded from V1 to V2 (apache#3603)

* Jaeger V2

* Jaeger V2

* Update Gradle to 9.3.1 (apache#3615)

* Last merged commit 90ba09c

---------

Co-authored-by: Mend Renovate <[email protected]>
Co-authored-by: Yong Zheng <[email protected]>
Co-authored-by: Dmitri Bourlatchkov <[email protected]>
Co-authored-by: Adnan Hemani <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants