Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ZEPPELIN-5191] Fix the wrong Docker image name in zeppelin-server.yaml #4439

Merged
merged 3 commits into from Oct 24, 2022

Conversation

maziyarpanahi
Copy link
Contributor

@maziyarpanahi maziyarpanahi commented Aug 4, 2022

  • There has never been any Docker image named zeppelin-interpreter or zeppelin-server.
  • The latest version also should be 0.10.1

What is this PR for?

A few sentences describing the overall goals of the pull request's commits.
First time? Check out the contributing guide - https://zeppelin.apache.org/contribution/contributions.html

All the examples inside and outside Zeppelin website/docs point to simply using zeppelin-server.yaml for K8s cluster :

curl -s -O https://raw.githubusercontent.com/apache/zeppelin/master/k8s/zeppelin-server.yaml
kubectl apply -f zeppelin-server.yaml

There are lots of issues on StackOverFlow and 1 on Jira that indicate the Docker images mentioned in this YAML simply don't exist on Docker Hub.

What type of PR is it?

Documentation
Please leave your type of PR only

Todos

  • - Task

What is the Jira issue?

How should this be tested?

  • Strongly recommended: add automated unit tests for any new or changed behavior
  • Outline any manual steps to test the PR here.

I have tested this on a live K8s cluster (OpenStack) and it created a Zeppelin server successfully, also creates Spark and other interpreters in the cluster upon request without any issue:

curl -s -O https://raw.githubusercontent.com/apache/zeppelin/master/k8s/zeppelin-server.yaml

Screenshots (if appropriate)

Questions:

  • Does the licenses files need to update?
  • Is there breaking changes for older versions?
  • Does this needs documentation?

- There has never been any Docker image named `zeppelin-interpreter` or `zeppelin-server`.
- The latest version also should be 0.10.1
@jongyoul
Copy link
Member

@maziyarpanahi Hello, BTW what is this?

curl -s -O https://raw.githubusercontent.com/apache/zeppelin/master/k8s/zeppelin-server.yaml

@maziyarpanahi
Copy link
Contributor Author

@maziyarpanahi Hello, BTW what is this?

curl -s -O https://raw.githubusercontent.com/apache/zeppelin/master/k8s/zeppelin-server.yaml

Apologies, I forgot the next line:

curl -s -O https://raw.githubusercontent.com/apache/zeppelin/master/k8s/zeppelin-server.yaml
kubectl apply -f zeppelin-server.yaml

I wanted to make sure everything in this quick start works as expected: https://zeppelin.apache.org/docs/0.10.1/quickstart/kubernetes.html#quickstart

@Reamer
Copy link
Contributor

Reamer commented Aug 26, 2022

Hello @maziyarpanahi

Zeppelin is quite complex and I agree that the documentation is not very useful.

On the whole, I would like to get rid of the apache/zeppelin docker image as it is not really suitable for K8s.

I envision the following process:
Automatically build the zeppelin-distribution image.
Then build both the zeppelin-server image and the zeppelin-interpreter image on top of it.

Can you perhaps perform the process as an outsider and adjust the documentation accordingly.

@maziyarpanahi
Copy link
Contributor Author

Hello @maziyarpanahi

Zeppelin is quite complex and I agree that the documentation is not very useful.

On the whole, I would like to get rid of the apache/zeppelin docker image as it is not really suitable for K8s.

I envision the following process: Automatically build the zeppelin-distribution image. Then build both the zeppelin-server image and the zeppelin-interpreter image on top of it.

Can you perhaps perform the process as an outsider and adjust the documentation accordingly.

Hi @Reamer

Yes, I will follow these steps to

  • build custom images for server and interpreter based on zeppelin-distribution image
  • download the default zeppelin-server.yaml
  • change the images for the server and interpreter to point to these custom local images

I'll share the process here before we decide how to update the docs to reflect these steps. (it should be straightforward)

- How to build zeppelin-distribution
- How to build zeppelin-server
- How to build zeppelin-interpreter
- How to use ./k8s/zeppelin-server.yaml script to correctly launch Zeppelin on Kubernetes cluster
@maziyarpanahi
Copy link
Contributor Author

Hi @Reamer

I have added the steps to build zeppelin-distribution, zeppelin-server, and zeppelin-interpreter to be set inside ./k8s/zeppelin-server.yaml script.

Please let me know if you want me to adjust something further.

@Reamer
Copy link
Contributor

Reamer commented Oct 10, 2022

Very good, that is how I imagined it.

I would remove the change in k8s/zeppelin-server.yaml and put a reminder in the documentation to adjust the images in the YAML-File.

This commit will remove the step-by-step editing of zeppelin-server.yaml and replacing it with a simple reminder to adjust the names in this file
@maziyarpanahi
Copy link
Contributor Author

Very good, that is how I imagined it.

I would remove the change in k8s/zeppelin-server.yaml and put a reminder in the documentation to adjust the images in the YAML-File.

Thanks @Reamer
I have removed the parts showing how to remove and replaced it with a simple reminder to adjust the images' names

Copy link
Contributor

@Reamer Reamer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Reamer Reamer merged commit b56b60a into apache:master Oct 24, 2022
proceane pushed a commit to proceane/zeppelin that referenced this pull request Feb 16, 2023
…ml (apache#4439)

* Fix the wrong Docker image name

- There has never been any Docker image named `zeppelin-interpreter` or `zeppelin-server`.
- The latest version also should be 0.10.1

* Add more instructions for running Zeppelin on K8s

- How to build zeppelin-distribution
- How to build zeppelin-server
- How to build zeppelin-interpreter
- How to use ./k8s/zeppelin-server.yaml script to correctly launch Zeppelin on Kubernetes cluster

* Adding a reminder to adjust images' names

This commit will remove the step-by-step editing of zeppelin-server.yaml and replacing it with a simple reminder to adjust the names in this file
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants