adutra commented on code in PR #2396:
URL: https://github.com/apache/polaris/pull/2396#discussion_r2287659763
##########
Makefile:
##########
@@ -38,8 +38,22 @@ POETRY_VERSION := $(shell cat client/python/pyproject.toml |
grep requires-poetr
##@ General
.PHONY: help
-help: ## Display this help
+help: version ## Display this help
@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make
\033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9\.-]+:.*?##/ { printf "
\033[36m%-40s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n",
substr($$0, 5) } ' $(MAKEFILE_LIST)
+ @printf "\n\033[1mConfigurable Variables:\033[0m\n"
+ @printf " \033[36m%-30s\033[0m \033[33m%-25s\033[0m %s\n"
"BUILD_IMAGE" "$(BUILD_IMAGE)" "Build container images (true/false)"
Review Comment:
Update: the following targets should do the trick:
```make
print-vars:
@printf "\n\033[1mMakefile Variables:\033[0m\n"
@grep -E '^[A-Z][A-Z0-9_]*\s*[?:+]?=' $(MAKEFILE_LIST) | \
sed 's/\s*[?:+]*=.*//' | sort | uniq | \
while read var; do \
printf " \033[36m%-30s\033[0m \033[33m%s\033[0m\n"
"$$var" "$$($(MAKE) --no-print-directory -f $(MAKEFILE_LIST) print-var-$$var
2>/dev/null || echo 'undefined')"; \
done
print-var-%:
@echo $($*)
```
##########
site/content/in-dev/unreleased/getting-started/install-dependencies.md:
##########
@@ -82,7 +102,19 @@ sudo sed -i 's/$releasever/9/g'
/etc/yum.repos.d/docker-ce.repo
sudo dnf -y install docker-ce docker-ce-cli containerd.io docker-buildx-plugin
docker-compose-plugin
```
-### Confirm Docker Installation
+### Podman
+Docker Desktop may not be suitable for you due to licensing restrictions
(check https://docs.docker.com/subscription/desktop-license/), so you can use
alternative Container Tool versions compatible with Docker, for example
[podman](https://podman.io/).
Review Comment:
+1
##########
site/content/in-dev/unreleased/getting-started/quickstart.md:
##########
@@ -37,9 +46,11 @@ cd ~/polaris
:polaris-admin:quarkusAppPartsBuild --rerun \
-Dquarkus.container-image.build=true
```
-- **For standalone**: Omit the `-Dquarkus.container-image.tag` and
`-Dquarkus.container-image.build` options if you do not need to build a Docker
image.
+> **For podman**: Use `-Dquarkus.docker.executable-name=podman` or
`-Dquarkus.container-image.builder=podman` argument.
Review Comment:
The two options are different afaict.
- `quarkus.docker.executable-name=podman` instructs the Docker extension to
use the `podman` executable.
- `quarkus.container-image.builder=podman` instructs Quarkus to use the
Podman extension.
The results might be different. In particular, I wonder if the Podman
extension must be declared somewhere for it to work 🤔
##########
Makefile:
##########
@@ -38,8 +38,22 @@ POETRY_VERSION := $(shell cat client/python/pyproject.toml |
grep requires-poetr
##@ General
.PHONY: help
-help: ## Display this help
+help: version ## Display this help
@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make
\033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9\.-]+:.*?##/ { printf "
\033[36m%-40s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n",
substr($$0, 5) } ' $(MAKEFILE_LIST)
+ @printf "\n\033[1mConfigurable Variables:\033[0m\n"
+ @printf " \033[36m%-30s\033[0m \033[33m%-25s\033[0m %s\n"
"BUILD_IMAGE" "$(BUILD_IMAGE)" "Build container images (true/false)"
Review Comment:
I fear this is going to get out of sync with the actual variables declared
above. How about we just add some comments above to explain what each variable
is used for?
##########
site/content/in-dev/unreleased/getting-started/install-dependencies.md:
##########
@@ -44,19 +44,39 @@ Then, use git to clone the Polaris repo:
git clone https://github.com/apache/polaris.git ~/polaris
```
-## Docker
-
-It is recommended to deploy Polaris inside [Docker](https://www.docker.com/)
for the Quickstart workflow. Instructions for deploying the Quickstart workflow
on the supported Cloud Providers (AWS, Azure, GCP) will be provided only with
Docker. However, non-Docker deployment instructions for local deployments can
also be followed on Cloud Providers.
+## Docker Container Runtime & Docker Compose
+It is recommended to deploy Polaris inside Docker Compatible Container Runtime
for the Quickstart workflow. Instructions for deploying the Quickstart workflow
on the supported Cloud Providers (AWS, Azure, GCP) will be provided only with
Docker. However, non-Docker deployment instructions for local deployments can
also be followed on Cloud Providers.
+### Docker Desktop
Instructions to install Docker can be found on the [Docker
website](https://docs.docker.com/engine/install/). Ensure that Docker and the
Docker Compose plugin are both installed.
-### Docker on MacOS
+#### Docker on MacOS
Docker can be installed using [homebrew](https://brew.sh/):
```shell
brew install --cask docker
```
+#### Docker Compose on MacOS
+```shell
+brew install docker-compose
Review Comment:
Is it still necessary to install `docker-compose`? Afaik all
`docker-compose` commands could be replaced with `docker compose`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscr...@polaris.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
