[ZEPPELIN-6032] Provide docker-compose-zeppelin-only.yml file for quick start #4776

ParkGyeongTae · 2024-07-23T04:09:34Z

What is this PR for?

I hope the Apache Zeppelin project provides a YAML file that can be run with the docker compose command. If this file is provided, I expect that more users will be able to run it easily.

What type of PR is it?

Improvement

Todos

- Create scripts/docker/zeppelin-quick-start/README.md
- Create scripts/docker/zeppelin-quick-start/docker-compose-zeppelin-only.yml

What is the Jira issue?

https://issues.apache.org/jira/browse/ZEPPELIN-6032

How should this be tested?

Install Docker
cd scripts/docker/zeppelin-quick-start
docker compose -f docker-compose-zeppelin-only.yml up

Screenshots (if appropriate)

Questions:

Does the license files need to update? No.
Is there breaking changes for older versions? No.
Does this needs documentation? No.

JooHyukKim · 2024-07-23T12:48:14Z

it helps users easily run Zeppelin.

If and only if you are talking about running Zeppelin on users' local machine, can we consider making the filename more specific or writing additional instructions?

Current filename docker-compose.yml is too generic for users to know what it's for.

jongyoul · 2024-07-23T13:58:16Z

docker/.env.template

@@ -0,0 +1,2 @@
+ZEPPELIN_IMAGE=apache/zeppelin
+ZEPPELIN_IMAGE_TAG=0.11.2


Suggested change

ZEPPELIN_IMAGE_TAG=0.11.2

ZEPPELIN_IMAGE_TAG=0.11.2-SNAPSHOT

ParkGyeongTae · 2024-07-23T14:57:17Z

it helps users easily run Zeppelin.

If and only if you are talking about running Zeppelin on users' local machine, can we consider making the filename more specific or writing additional instructions?

Current filename docker-compose.yml is too generic for users to know what it's for.

@JooHyukKim
That's a great suggestion. Considering the addition of files containing Spark Cluster or Flink Cluster in the future, it will be necessary to revise to more explicit filenames.
Therefore, I will change it to docker-compose-zeppelin-only.yml and add documentation.

pan3793 · 2024-07-24T02:00:39Z

there are a few set of docker files under scripts/docker, what the difference between those files and the proposed one?

ParkGyeongTae · 2024-07-24T07:23:04Z

there are a few set of docker files under scripts/docker, what the difference between those files and the proposed one?

@pan3793
If the Zeppelin repository provides a docker-compose file, it is expected that more users will be able to use it easily. Furthermore, it is anticipated that users will configure it on their local computers with various open-source projects.
If you have any good suggestions, please let me know.

jongyoul · 2024-08-04T03:49:23Z

I understand @pan3793's worries. I will also keep track of the files and we can discuss the future roadmap. @ParkGyeongTae As the next step, could you please add some descriptions for your docker-compose file on README.md? It would be better to have more details.

jongyoul

LGTM

ParkGyeongTae · 2024-08-04T10:05:25Z

@jongyoul
I will create an issue to add detailed descriptions for the docker-compose file as the next step and proceed with it.

…all files

…Conf in all files" This reverts commit 8d5b3c5.

pan3793 · 2024-08-15T02:32:10Z

it helps users easily run Zeppelin.

I have similar questions about it. it's unclear to me what the use case is:

is it for users to quickly explore Zeppelin with one command? if so, the ZEPPELIN_IMAGE_TAG should use the latest released one instead of the developing SNAPSHOT version, and since you are using docker compose, we just need a preset .env instead of .env.template, this also saves a copy-paste command to allow users to quickly launch the playground.

is it for developers to quickly test their changes? if so, you should leave docs to instruct developers how to apply their changes to the environment, and how to attach the process to debug.

given there was a set of scripts under scripts/vagrant/zeppelin-dev, I would suggest putting those docker files under scripts/docker/zeppelin-<purpose> instead of docker

ParkGyeongTae · 2024-08-15T10:20:47Z

@pan3793
As with other projects, I hope the Zeppelin repository will also provide a docker-compose.yml file. This is to help developers easily run Zeppelin by copying or using this file. I will proceed with the necessary tasks according to your advice.

ParkGyeongTae · 2024-08-17T02:57:49Z

@pan3793 I have modified the path of the docker-compose file and removed the .env file for a quicker start. Please review.

pan3793 · 2024-08-17T08:28:51Z

scripts/docker/zeppelin-quick-start/README.md

+### Zeppelin Only
+#### Run docker-compose
+```bash
+docker-compose -f docker-compose-zeppelin-only.yml up


docker-compose was deprecated for a long time and removed in the recent Docker Desktop versions, use v2 docker compose instead.

@pan3793 I have made the changes.

jongyoul · 2024-08-25T05:10:09Z

@pan3793 Could you please help to review it?

pan3793 · 2024-08-26T02:51:16Z

scripts/docker/zeppelin-quick-start/docker-compose-zeppelin-only.yml

+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+version: "3.8"


I tested this patch locally and found

WARN[0000] /Users/chengpan/Projects/apache-zeppelin/scripts/docker/zeppelin-quick-start/docker-compose-zeppelin-only.yml: version is obsolete

according to https://forums.docker.com/t/docker-compose-yml-version-is-obsolete/141313 let's delete this line.

@pan3793 I have completed this task.

pan3793 · 2024-08-26T02:53:21Z

scripts/docker/zeppelin-quick-start/docker-compose-zeppelin-only.yml

+  zeppelin-server:
+    hostname: zeppelin
+    container_name: zeppelin
+    image: apache/zeppelin:0.11.2


! zeppelin-server The requested image's platform (linux/amd64) does not match the detected host platform (linux/arm64/v8) and no specific platform was requested

I tested it in an Apple Silicon machine, seems we don't provide arm64 image, this is a thing we can improve later

I will complete this task later.

this is another story, and should be done in another PR.

I plan to create a new issue for this task and proceed with it.

pan3793

@ParkGyeongTae the change lgtm except to one nit, please update the PR title and description to match your change.

pan3793 · 2024-08-26T12:55:55Z

Thanks, merged to master

ParkGyeongTae · 2024-08-26T12:57:44Z

@pan3793 Thank you for your review. :)

[ZEPPELIN-6032] Add files: docker-compose.yml, .env.template

2d3820d

jongyoul reviewed Jul 23, 2024

View reviewed changes

ParkGyeongTae added 2 commits July 24, 2024 00:15

[ZEPPELIN-6032] Fix ZEPPELIN_IMAGE_TAG and docker-compose filename

a142d33

[ZEPPELIN-6032] Add README.md

7e07833

[ZEPPELIN-6032] Add Apache License to .env.template

12a7316

jongyoul previously approved these changes Aug 4, 2024

View reviewed changes

[ZEPPELIN-6037] Unify the ZeppelinConfiguration variable to zConf in …

8d5b3c5

…all files

ParkGyeongTae dismissed jongyoul’s stale review via 8d5b3c5 August 4, 2024 13:09

ParkGyeongTae and others added 2 commits August 4, 2024 22:51

Revert "[ZEPPELIN-6037] Unify the ZeppelinConfiguration variable to z…

c00dff9

…Conf in all files" This reverts commit 8d5b3c5.

Merge branch 'apache:master' into master

32adebb

Merge branch 'apache:master' into master

0aef20a

[ZEPPELIN-6032] Moving docker compose file

431cb01

pan3793 reviewed Aug 17, 2024

View reviewed changes

[ZEPPELIN-6032] Change the docker-compose command to docker compose

4f3a92e

pan3793 reviewed Aug 26, 2024

View reviewed changes

pan3793 previously approved these changes Aug 26, 2024

View reviewed changes

[ZEPPELIN-6032] Remove the version from the YAML file

55b772d

ParkGyeongTae dismissed pan3793’s stale review via 55b772d August 26, 2024 12:34

ParkGyeongTae changed the title ~~[ZEPPELIN-6032] Add files: docker-compose.yml, .env.template~~ [ZEPPELIN-6032] Provide docker-compose-zeppelin-only.yml file for quick start Aug 26, 2024

pan3793 approved these changes Aug 26, 2024

View reviewed changes

pan3793 merged commit 9078044 into apache:master Aug 26, 2024
28 checks passed

		@@ -0,0 +1,2 @@
		ZEPPELIN_IMAGE=apache/zeppelin
		ZEPPELIN_IMAGE_TAG=0.11.2

[ZEPPELIN-6032] Provide docker-compose-zeppelin-only.yml file for quick start #4776

[ZEPPELIN-6032] Provide docker-compose-zeppelin-only.yml file for quick start #4776

Uh oh!

Conversation

ParkGyeongTae commented Jul 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What is this PR for?

What type of PR is it?

Todos

What is the Jira issue?

How should this be tested?

Screenshots (if appropriate)

Questions:

Uh oh!

JooHyukKim commented Jul 23, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ParkGyeongTae commented Jul 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pan3793 commented Jul 24, 2024

Uh oh!

ParkGyeongTae commented Jul 24, 2024

Uh oh!

jongyoul commented Aug 4, 2024

Uh oh!

jongyoul left a comment

Choose a reason for hiding this comment

Uh oh!

ParkGyeongTae commented Aug 4, 2024

Uh oh!

pan3793 commented Aug 15, 2024

Uh oh!

ParkGyeongTae commented Aug 15, 2024

Uh oh!

ParkGyeongTae commented Aug 17, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jongyoul commented Aug 25, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pan3793 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

pan3793 commented Aug 26, 2024

Uh oh!

ParkGyeongTae commented Aug 26, 2024

Uh oh!

Uh oh!

ParkGyeongTae commented Jul 23, 2024 •

edited

Loading

ParkGyeongTae commented Jul 23, 2024 •

edited

Loading