Adapt main README.md to Quarkus #836
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adutra
requested review from
ashvina,
dennishuo,
dimas-b,
eric-maynard,
jackye1995,
jbonofre,
vvcephei,
collado-mike,
snazy,
RussellSpitzer,
takidau,
flyrain and
ebyhr
as code owners
dimas-b
reviewed
Jan 21, 2025
README.md
Outdated
| Then, you can run the regression tests using the following command: | ||
|
|
||
| ```shell | ||
| POLARIS_HOST=localhost ./regtests/run.sh |
There was a problem hiding this comment.
nit: env POLARIS_HOST=localhost ./regtests/run.sh is more portable, I believe
flyrain
approved these changes
Jan 23, 2025
README.md
Outdated
Comment on lines
64
to
66
|
|
||
| For local development, you can run the following commands: | ||
|
|
There was a problem hiding this comment.
Is this necessary, considering the following commands and their accompanying comments are already clear and self-explanatory?
README.md
Outdated
Comment on lines
85
to
100
| #### Running in Docker | ||
|
|
||
| Please note: there are no official Docker images for Apache Polaris yet. For now, you can build the | ||
| Docker images locally. | ||
|
|
||
| To build the Polaris server Docker image locally: | ||
|
|
||
| ```shell | ||
| ./gradlew clean :polaris-quarkus-server:assemble -Dquarkus.container-image.build=true | ||
| ``` | ||
|
|
||
| To run the Polaris server Docker image: | ||
|
|
||
| ```shell | ||
| docker run -p 8181:8181 -p 8182:8182 apache/polaris:latest | ||
| ``` |
There was a problem hiding this comment.
Can we simplify it a bit like this?
Suggested change
| #### Running in Docker | |
| Please note: there are no official Docker images for Apache Polaris yet. For now, you can build the | |
| Docker images locally. | |
| To build the Polaris server Docker image locally: | |
| ```shell | |
| ./gradlew clean :polaris-quarkus-server:assemble -Dquarkus.container-image.build=true | |
| ``` | |
| To run the Polaris server Docker image: | |
| ```shell | |
| docker run -p 8181:8181 -p 8182:8182 apache/polaris:latest | |
| ``` | |
| #### Running in Docker | |
| - `./gradlew clean :polaris-quarkus-server:assemble -Dquarkus.container-image.build=true` - To build the image locally. | |
| - `docker run -p 8181:8181 -p 8182:8182 apache/polaris:latest` - To run the image. |
README.md
Outdated
Comment on lines
107
to
109
| connections between a local machine and a pod within the cluster for both service and metrics | ||
| endpoints. | ||
| - Currently supported metrics and health endpoints: |
There was a problem hiding this comment.
Can we simplify a bit like this?
Suggested change
| connections between a local machine and a pod within the cluster for both service and metrics | |
| endpoints. | |
| - Currently supported metrics and health endpoints: | |
| connections between a local machine and a pod within the cluster for both service and health/metrics | |
| endpoints: |
README.md
Outdated
Comment on lines
139
to
148
| The above command will by default run Polaris with the Docker image `apache/polaris:latest`; if you | ||
| want to use a different image, you can modify the `docker-compose.yaml` file prior to running it; | ||
| alternatively, you can use the following commands to override the image: | ||
|
|
||
| ```shell | ||
| cat <<EOF > /tmp/polaris-image.yml | ||
| services: { polaris: { image: localhost:5001/apache/polaris:latest } } | ||
| EOF | ||
| docker compose -f regtests/docker-compose.yml -f /tmp/polaris-image.yml up --build --exit-code-from regtest | ||
| ``` |
There was a problem hiding this comment.
I'd prefer to not mention it in the main readme, either leaving for users/developers to figure out by themselves or moving this to the readme file under the directory regtests.
adutra
changed the title
jbonofre
approved these changes
Jan 23, 2025
flyrain
approved these changes
Jan 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Needs #610 because the instructions for regtests will change.