hazza/docker-stacks
1
0
Fork 0
mirror of https://github.com/jupyter/docker-stacks.git synced 2025-10-12 20:42:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1274 from mathbunnyru/asalikhov/rename_cloud_to_hub

Browse Source 
Fix Docker Cloud -> Docker Hub and GitHub Actions related changes
This commit is contained in:
Erik Sundell
2021-05-19 03:42:53 +02:00
committed by GitHub
parent 77ba142f91 86237e3d65
commit b4f6714028
3 changed files with 24 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/contributing/stacks.md
View File

@@ -9,7 +9,7 @@ Following these steps will:
`jupyter/minimal-notebook` image. `jupyter/minimal-notebook` image.
2. Configure GitHub Actions to build and test your image when users submit pull requests to your 2. Configure GitHub Actions to build and test your image when users submit pull requests to your
repository. repository.
3. Configure Docker Cloud to build and host your images for others to use. 3. Configure Docker Hub to build and host your images for others to use.
4. Update the [list of community stacks](../using/selecting.html#community-stacks) in this documentation to include your image. 4. Update the [list of community stacks](../using/selecting.html#community-stacks) in this documentation to include your image.
This approach mirrors how we build and share the core stack images. Feel free to follow it or pave This approach mirrors how we build and share the core stack images. Feel free to follow it or pave
@@ -38,8 +38,8 @@ of the Docker image name after the slash.
stack_name [my-jupyter-stack]: stack_name [my-jupyter-stack]:
``` ```
Enter the user or organization name under which this stack will reside on Docker Cloud / Hub. You Enter the user or organization name under which this stack will reside on Docker Hub. You
must have access to manage this Docker Cloud org to push images here and set up automated must have access to manage this Docker Hub organization to push images here and set up automated
builds. builds.
```lang-none ```lang-none
@@ -104,9 +104,9 @@ From there, you can click on the workflows on the left-hand side of the screen.
4. In the next screen, you will be able to see information about the workflow run and duration. If you click again on the button with the workflow name, you will see the logs for the workflow steps. 4. In the next screen, you will be able to see information about the workflow run and duration. If you click again on the button with the workflow name, you will see the logs for the workflow steps.
![Github actions workflow run screenshot](../_static/github-actions-workflow.png) ![Github actions workflow run screenshot](../_static/github-actions-workflow.png)
## Configuring Docker Cloud ## Configuring Docker Hub
Now, configure Docker Cloud to build your stack image and push it to Docker Hub repository whenever Now, configure Docker Hub to build your stack image and push it to Docker Hub repository whenever
you merge a GitHub pull request to the master branch of your project. you merge a GitHub pull request to the master branch of your project.
1. Visit [https://hub.docker.com/](https://hub.docker.com/) and log in. 1. Visit [https://hub.docker.com/](https://hub.docker.com/) and log in.
@@ -144,7 +144,7 @@ to get a feel for what's possible and best practices.
[Submit pull requests](https://github.com/PointCloudLibrary/pcl/wiki/A-step-by-step-guide-on-preparing-and-submitting-a-pull-request) [Submit pull requests](https://github.com/PointCloudLibrary/pcl/wiki/A-step-by-step-guide-on-preparing-and-submitting-a-pull-request)
to your project repository on GitHub. Ensure your image builds correctly on GitHub actions before merging to to your project repository on GitHub. Ensure your image builds correctly on GitHub actions before merging to
master or main. Refer to Docker Cloud to build your master or main branch that you can `docker pull`. master or main. Refer to Docker Hub to build your master or main branch that you can `docker pull`.
## Sharing Your Image ## Sharing Your Image

61
docs/maintaining/tasks.md
View File

@@ -2,21 +2,15 @@
## Merging Pull Requests ## Merging Pull Requests
To build new images on Docker Cloud and publish them to the Docker Hub registry, do the following: To build new images and publish them to the Docker Hub registry, do the following:
1. Make sure GitHub Actions status checks pas for the PR. 1. Make sure GitHub Actions status checks pass for the PR.
2. Merge the PR. 2. Merge the PR.
3. Monitor the Docker Cloud build status for each of the stacks, starting with 3. Monitor the merge commit GitHub Actions status.
[jupyter/base-notebook](https://cloud.docker.com/app/jupyter/repository/docker/jupyter/base-notebook/general) **Note**: we think, GitHub Actions are quite reliable, so please, investigate, if some error occurs.
and ending with The process of building docker images in PRs is exactly the same after merging to master, except there is an additional `push` step.
[jupyter/all-spark-notebook](https://cloud.docker.com/app/jupyter/repository/docker/jupyter/all-spark-notebook/general). 4. Try to avoid merging another PR to master until all pending builds complete. This way you will know which commit
See the [stack hierarchy diagram](../using/selecting.html#image-relationships) for the current, might have broken the build and also have correct tags for moving tags (like `python` version).
complete build order.
4. Manually click the retry button next to any build that fails to resume that build and any
dependent builds.
5. Try to avoid merging another PR to master until all outstanding builds complete. There's no way
at present to propagate the git SHA to build through the Docker Cloud build trigger API. Every
build trigger works off of master HEAD.
## Updating the Ubuntu Base Image ## Updating the Ubuntu Base Image
@@ -26,55 +20,34 @@ update the pinned SHA in the
Submit it as a regular PR and go through the build process. Expect the build to take a while to Submit it as a regular PR and go through the build process. Expect the build to take a while to
complete: every image layer will rebuild. complete: every image layer will rebuild.
## Adding a New Core Image to Docker Cloud ## Adding a New Core Image to Docker Hub
When there's a new stack definition, do the following before merging the PR with the new stack: When there's a new stack definition, do the following before merging the PR with the new stack:
1. Ensure the PR includes an update to the stack overview diagram 1. Ensure the PR includes an update to the stack overview diagram
[in the documentation](https://github.com/jupyter/docker-stacks/blob/master/docs/using/selecting.md#image-relationships). [in the documentation](https://github.com/jupyter/docker-stacks/blob/master/docs/using/selecting.md#image-relationships).
The image links to the [blockdiag source](http://interactive.blockdiag.com/) used to create it. The image links to the [blockdiag source](http://interactive.blockdiag.com/) used to create it.
2. Ensure the PR updates the Makefile which is used to build the stacks in order on GitHub Actions. 2. Ensure the PR updates the [Makefile](../../Makefile) which is used to build the stacks in order on GitHub Actions.
3. Create a new repository in the `jupyter` org on Docker Cloud named after the stack folder in the 3. Ensure necessary tags / manifests are added for the new image in the [tagging](../../tagging) folder.
4. Create a new repository in the `jupyter` org on Docker Hub named after the stack folder in the
git repo. git repo.
4. Grant the `stacks` team permission to write to the repo. 5. Grant the `stacks` team permission to write to the repo.
5. Click _Builds_ and then _Configure Automated Builds_ for the repository.
6. Select `jupyter/docker-stacks` as the source repository.
7. Choose _Build on Docker Cloud's infrastructure using a Small node_ unless you have reason to
believe a bigger host is required.
8. Update the _Build Context_ in the default build rule to be `/<name-of-the-stack>`.
9. Toggle _Autobuild_ to disabled unless the stack is a new root stack (e.g., like
`jupyter/base-notebook`).
10. If the new stack depends on the build of another stack in the hierarchy:
1. Hit _Save_ and then click _Configure Automated Builds_.
2. At the very bottom, add a build trigger named _Stack hierarchy trigger_.
3. Copy the build trigger URL.
4. Visit the parent repository _Builds_ page and click _Configure Automated Builds_.
5. Add the URL you copied to the _NEXT_BUILD_TRIGGERS_ environment variable comma separated list
of URLs, creating that environment variable if it does not already exist.
6. Hit _Save_.
11. If the new stack should trigger other dependent builds:
1. Add an environment variable named _NEXT_BUILD_TRIGGERS_.
2. Copy the build trigger URLs from the dependent builds into the _NEXT_BUILD_TRIGGERS_ comma
separated list of URLs.
3. Hit _Save_.
12. Adjust other _NEXT_BUILD_TRIGGERS_ values as needed so that the build order matches that in the
stack hierarchy diagram.
## Adding a New Maintainer Account ## Adding a New Maintainer Account
1. Visit <https://cloud.docker.com/app/jupyter/team/stacks/users> 1. Visit <https://hub.docker.com/app/jupyter/team/stacks/users>
2. Add the maintainer's Docker Cloud username. 2. Add the maintainer's Docker Hub username.
3. Visit <https://github.com/orgs/jupyter/teams/docker-image-maintainers/members> 3. Visit <https://github.com/orgs/jupyter/teams/docker-image-maintainers/members>
4. Add the maintainer's GitHub username. 4. Add the maintainer's GitHub username.
## Pushing a Build Manually ## Pushing a Build Manually
If automated builds on Docker Cloud have got you down, do the following to push a build manually: If automated build in Github Actions has got you down, do the following to push a build manually:
1. Clone this repository. 1. Clone this repository.
2. Check out the git SHA you want to build and publish. 2. Check out the git SHA you want to build and publish.
3. `docker login` with your Docker Hub/Cloud credentials. 3. `docker login` with your Docker Hub credentials.
4. Run `make retry/release-all`. 4. Run `make push-all`.
## Enabling a New Doc Language Translation ## Enabling a New Doc Language Translation

2
docs/using/selecting.md
View File

@@ -174,7 +174,7 @@ diagram](../images/inherit.svg)](http://interactive.blockdiag.com/?compression=d
Pull requests to the `jupyter/docker-stacks` repository trigger builds of all images on GitHub Pull requests to the `jupyter/docker-stacks` repository trigger builds of all images on GitHub
Actions. These images are for testing purposes only and are not saved for use. When pull requests Actions. These images are for testing purposes only and are not saved for use. When pull requests
merge to master, all images rebuild on Docker Cloud and become available to `docker pull` from merge to master, all images rebuild on Docker Hub and become available to `docker pull` from
Docker Hub. Docker Hub.
### Versioning ### Versioning