Commit 86b2339b authored by Peter Parente's avatar Peter Parente

[skip ci] Update README

parent 75be5a4c
...@@ -43,28 +43,30 @@ Starting with [git commit SHA 9bd33dcc8688](https://github.com/jupyter/docker-st ...@@ -43,28 +43,30 @@ Starting with [git commit SHA 9bd33dcc8688](https://github.com/jupyter/docker-st
* `tini -- start-notebook.sh` is the default Docker entrypoint-plus-command in every notebook stack. If you plan to modify it in any way, be sure to check the *Notebook Options* section of your stack's README to understand the consequences. * `tini -- start-notebook.sh` is the default Docker entrypoint-plus-command in every notebook stack. If you plan to modify it in any way, be sure to check the *Notebook Options* section of your stack's README to understand the consequences.
* Every notebook stack is compatible with [JupyterHub](https://jupyterhub.readthedocs.org) 0.5. When running with JupyterHub, you must override the Docker run command to point to the [start-singleuser.sh](minimal-notebook/start-singleuser.sh) script, which starts a single-user instance of the Notebook server. See each stack's README for instructions on running with JupyterHub. * Every notebook stack is compatible with [JupyterHub](https://jupyterhub.readthedocs.org) 0.5. When running with JupyterHub, you must override the Docker run command to point to the [start-singleuser.sh](minimal-notebook/start-singleuser.sh) script, which starts a single-user instance of the Notebook server. See each stack's README for instructions on running with JupyterHub.
* Check the [Docker recipes wiki page](https://github.com/jupyter/docker-stacks/wiki/Docker-Recipes) attached to this project for information about extending and deploying the Docker images defined here. Add to the wiki if you have relevant information. * Check the [Docker recipes wiki page](https://github.com/jupyter/docker-stacks/wiki/Docker-Recipes) attached to this project for information about extending and deploying the Docker images defined here. Add to the wiki if you have relevant information.
* All stacks that derive from minimal notebook have the the conda jpeg package pinned to version 8 until https://github.com/jupyter/docker-stacks/issues/210 is resolved upstream. * All stacks that derive from minimal-notebook have the conda jpeg package pinned to version 8 until https://github.com/jupyter/docker-stacks/issues/210 is resolved upstream.
## Maintainer Workflow ## Maintainer Workflow
**For PRs that impact the definition of one or more stacks:** **For PRs that impact the definition of one or more stacks, do the following:**
1. Pull a PR branch locally. 1. Make sure Travis is green.
2. Try building the affected stack(s). 2. Merge the PR.
3. If everything builds OK locally, merge it. 3. `ssh -i ~/.ssh/your-github-key build@docker-stacks.cloudet.xyz`
4. `ssh -i ~/.ssh/your-github-key build@docker-stacks.cloudet.xyz` 4. Run these commands on that VM.
5. Run these commands on that VM.
``` ```
# join the shared tmux session
tmux a
cd docker-stacks cd docker-stacks
# make sure we're always on clean master from github # make sure we're always on clean master from github
git fetch origin git fetch origin
git reset --hard origin/master git reset --hard origin/master
# if this fails, just run it again and again (idempotent) # retry on failure up to 10 times with a (60 * iteration)
make release-all # second delay in-between
make retry/release-all
``` ```
When `make release-all` successfully pushes the last of its images to Docker Hub (currently `jupyter/all-spark-notebook`), Docker Hub invokes [the webhook](https://github.com/jupyter/docker-stacks/blob/master/internal/docker-stacks-webhook/) which updates the [Docker build history](https://github.com/jupyter/docker-stacks/wiki/Docker-build-history) wiki page. When `make retry/release-all` successfully pushes the last of its images to Docker Hub (currently `jupyter/all-spark-notebook`), Docker Hub invokes [the webhook](https://github.com/jupyter/docker-stacks/blob/master/internal/docker-stacks-webhook/) which updates the [Docker build history](https://github.com/jupyter/docker-stacks/wiki/Docker-build-history) wiki page.
**When there's a security fix in the Debian base image, do the following in place of the last command:** **When there's a security fix in the Debian base image, do the following in place of the last command:**
...@@ -72,8 +74,15 @@ Update the `debian:jessie` SHA in the most-base images (e.g., base-notebook). Su ...@@ -72,8 +74,15 @@ Update the `debian:jessie` SHA in the most-base images (e.g., base-notebook). Su
This will take time as the entire set of stacks will rebuild. This will take time as the entire set of stacks will rebuild.
**When there's a new stack, do the following before trying to `make release-all`:** **When there's a new stack, do the following before trying to `make rety/release-all`:**
1. Create a new repo in the `jupyter` org on Docker Hub named after the stack folder in the git repo. 1. Create a new repo in the `jupyter` org on Docker Hub named after the stack folder in the git repo.
2. Grant the `stacks` team permission to write to the repo. 2. Grant the `stacks` team permission to write to the repo.
3. Copy/paste the short and long descriptions from one of the other docker-stacks repos on Docker Hub. Modify the appropriate values. 3. Copy/paste the short and long descriptions from one of the other docker-stacks repos on Docker Hub. Modify the appropriate values.
**When there's a new maintainer, do the following:**
1. Add the GitHub user to the Jupyter org, *Docker image maintainers* team.
2. Get the GitHub user's public key from https://github.com/<USERNAME>.keys.
3. `ssh -i ~/.ssh/your-github-key build@docker-stacks.cloudet.xyz`
4. Add the user's public key to `~/.ssh/authorized_keys` with his/her GitHub username as the comment after the key.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment