Skip to content

[ZEPPELIN-5248] - Add local docker-compose support and updated readme instructions#4054

Closed
omrisk wants to merge 2 commits intoapache:masterfrom
omrisk:ZEPPELIN-5248-docker-support-for-local-documentation
Closed

[ZEPPELIN-5248] - Add local docker-compose support and updated readme instructions#4054
omrisk wants to merge 2 commits intoapache:masterfrom
omrisk:ZEPPELIN-5248-docker-support-for-local-documentation

Conversation

@omrisk
Copy link
Contributor

@omrisk omrisk commented Feb 11, 2021

What is this PR for?

To make it easier for new contributors to build and test documentation changes, will add support to build and serve locally using docker.

What type of PR is it?

Improvement

Todos

  • - Task

What is the Jira issue?

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

How should this be tested?

  • Automated CI
  • Can be tested by following updated README instructions to run docker-compose up locally

Screenshots (if appropriate)

Screen Shot 2021-02-11 at 15 00 31

Questions:

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

@omrisk omrisk changed the title Add local docker-compose support and updated readme instructions [ZEPPELIN-5248] - Add local docker-compose support and updated readme instructions Feb 11, 2021
@Leemoonsoo
Copy link
Member

Thank @omrisk for the contribution!

I tested this on

image
(I had to change the 'version' field of 'docker-compose.yml' from '3.8' to '3.3' in this docker version. After the change, worked well without problem)

as well as with the latest Docker engine
image

@omrisk Looks like rat plugin fails due to missing license header on docker-compose.yml file. Could you try to add a license header? (e.g. https://github.com/apache/zeppelin/blob/master/k8s/zeppelin-server.yaml#L1-L16)

@Reamer
Copy link
Contributor

Reamer commented Feb 12, 2021

I think docker-compose is unnecessary as we only have one container.
A simple docker command should be enough, no need for docker-compose.

@omrisk
Copy link
Contributor Author

omrisk commented Feb 12, 2021

@Reamer , I though the docker-compose may be simpler :)
I'll convert to a docker command (also one less file to maintain).
Just consider that will mean that each launch of this will re-build the docker container (about a minute to start).

@Reamer
Copy link
Contributor

Reamer commented Feb 12, 2021

Just consider that will mean that each launch of this will re-build the docker container (about a minute to start).

I think this is bearable as long as you don't have to restart the container for every change in the docs.

@omrisk
Copy link
Contributor Author

omrisk commented Feb 12, 2021

@Reamer , ok. The command I added mounts the doc directory to the container so it watches the files for changes (same as if you launch it using the current jekyll implementation)

@Reamer
Copy link
Contributor

Reamer commented Feb 12, 2021

LGTM

@zjffdu
Copy link
Contributor

zjffdu commented Feb 20, 2021

LGTM, I tested it and it works very well

@asfgit asfgit closed this in 9259620 Feb 22, 2021
asfgit pushed a commit that referenced this pull request Feb 22, 2021
… instructions

### What is this PR for?
To make it easier for new contributors to build and test documentation changes, will add support to build and serve locally using docker.

### What type of PR is it?
Improvement

### Todos
* [ ] - Task

### What is the Jira issue?
https://issues.apache.org/jira/browse/ZEPPELIN-5248

### How should this be tested?
* Automated CI
* Can be tested by following updated README instructions to run `docker-compose up` locally
*
### Screenshots (if appropriate)
![Screen Shot 2021-02-11 at 15 00 31](https://user-images.githubusercontent.com/23058747/107643677-2443c680-6c7f-11eb-9266-ea51bd19e643.png)

### Questions:
* Does the licenses files need update? no
* Is there breaking changes for older versions? no
* Does this needs documentation? no

Author: OmriK <omri.keefe@dynamicyield.com>

Closes #4054 from omrisk/ZEPPELIN-5248-docker-support-for-local-documentation and squashes the following commits:

cbb9061 [OmriK] Convert to single command docker run, remove docker-compose.yml
d4cf003 [OmriK] Add local docker-compose support and updated readme instructions

(cherry picked from commit 9259620)
Signed-off-by: Jeff Zhang <zjffdu@apache.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants