Add more getting-started examples with Polaris#859
Conversation
adutra
requested review from
RussellSpitzer,
ashvina,
collado-mike,
dennishuo,
dimas-b,
ebyhr,
eric-maynard,
flyrain,
jackye1995,
jbonofre,
snazy,
takidau and
vvcephei
as code owners
adutra
force-pushed
the
docker-compose-examples
branch
from
774a688 to
f56dd77
Compare
docker/elipselink/README.md
Outdated
| ```shell | ||
| ./gradlew clean :polaris-quarkus-server:assemble :polaris-quarkus-admin:assemble \ | ||
| -PeclipseLinkDeps=org.postgresql:postgresql:42.7.4 \ | ||
| -Dquarkus.container-image.build=true |
There was a problem hiding this comment.
nit: would it make sense to override the image name/tag to indicate it's with PostgreSQL?
docker/elipselink/README.md
Outdated
|
|
||
| ```shell | ||
| podman compose -f docker/eclipselink/docker-compose.yml up | ||
| docker compose -f docker/eclipselink/docker-compose.yml up |
There was a problem hiding this comment.
nit: making separate blocks of text makes copy-paste into shell easier -- GH renders the copy widget, but it copies the whole block of text :)
README.md
Outdated
| The Polaris codebase contains some docker compose examples to quickly get started with Polaris, | ||
| using different configurations. Check the `./docker` directory for more information. |
There was a problem hiding this comment.
There are Spark and Trino docker compose examples under the directory ./getting-started. Can we consolidate all docker compose examples into one place?
There was a problem hiding this comment.
Of course, great idea! I'm sorry I didn't think about it before 🤦♂️
I will move everything to .getting-started.
There was a problem hiding this comment.
Yes good point. I think it makes sense to gather everything in getting started and optionally point to getting started.
docker/README.md
Outdated
| - [Docker](https://docs.docker.com/get-docker/) or [Podman](https://podman.io/docs/installation) | ||
| - [Docker Compose](https://docs.docker.com/compose/install/) | ||
| or [Podman Compose](https://docs.podman.io/en/v5.1.1/markdown/podman-compose.1.html) |
There was a problem hiding this comment.
Do we need both docker-compose and podman-compose? I'd prefer to keep docker-compose only if there is no strong reason to introduce podman. Any new stack introduced to the projects may add maintenance burden. We should keep it minimum as much as possible.
| # under the License. | ||
| # | ||
|
|
||
| services: |
There was a problem hiding this comment.
This is pretty cool for POC and even production deployment. Thanks for doing this!
docker/in-memory/docker-compose.yml
Outdated
| # under the License. | ||
| # | ||
|
|
||
| services: |
There was a problem hiding this comment.
I didn't see much value of having this. The both local run and docker run described in the top-level readme already covered it. Do we need this?
There was a problem hiding this comment.
Seems like we can combine this with trino and spark getting-started examples? So we will have 2 light-weighted examples with trino and spark, and one production-like example with Postgres and Spark-sql?
adutra
changed the title
|
Moved new examples to I also fixed the Spark example. @HonahX I didn't touch the Trino example since I know you are already on it :-) |
|
LGTM overall. Thanks a lot, @adutra, for putting this together! With the comprehensive set of doc updates and Docker Compose examples, I believe we can now deprecate the existing Quick Start page, by replacing it with these updated materials. This isn't a blocker though. We could do that in a followup PR. This change will provide a great starting point for new users and developers, making it easier for them to get up and running. Great work, and this is a solid step forward! |
5 participants
I hope everyone will find these examples useful.
The Eclipselink example can also serve for now as the de facto test for Eclipselink integration, since there is no such test in our automated tests suite.
I'm already preparing a Minio example, but that requires #32 and #389.