1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00

Update docs around private github submodules in automated builds.

Signed-off-by: Jeff Anderson <jeff@docker.com>
This commit is contained in:
Jeff Anderson 2015-02-18 17:06:32 -07:00
parent d338c613bf
commit 390dd4bf3f
6 changed files with 32 additions and 12 deletions

View file

@ -63,13 +63,15 @@ public or private GitHub repositories with a `Dockerfile`.
### GitHub Submodules ### GitHub Submodules
If your GitHub repository contains links to private submodules, you'll If your GitHub repository contains links to private submodules, you'll get an
need to add a deploy key from your Docker Hub repository. error message in your build.
Your Docker Hub deploy key is located under the "Build Details" Normally, the Docker Hub sets up a deploy key in your GitHub repository.
menu on the Automated Build's main page in the Hub. Add this key Unfortunately, GitHub only allows a deploy key to access one single repository.
to your GitHub submodule by visiting the Settings page for the
repository on GitHub and selecting "Deploy keys". To work around this, we will be creating a dedicated user account in GitHub to
attach this key to. A key on a GitHub user account can be given read-only
access to all your repositories.
<table class="table table-bordered"> <table class="table table-bordered">
<thead> <thead>
@ -82,15 +84,33 @@ repository on GitHub and selecting "Deploy keys".
<tbody> <tbody>
<tr> <tr>
<td>1.</td> <td>1.</td>
<td><img src="/docker-hub/hub-images/deploy_key.png"></td> <td><img src="/docker-hub/hub-images/gh_org_members.png"></td>
<td>Your automated build's deploy key is in the "Build Details" menu <td>First, create the new account in GitHub. It should be given read-only
under "Deploy keys".</td> access to the main repository and all submodules that are needed.</td>
</tr> </tr>
<tr> <tr>
<td>2.</td> <td>2.</td>
<td><img src="/docker-hub/hub-images/github_deploy_key.png"></td> <td><img src="/docker-hub/hub-images/gh_team_members.png"></td>
<td>In your GitHub submodule's repository Settings page, add the <td>This can be accomplished by adding the account to a read-only team on
deploy key from your Docker Hub Automated Build.</td> the organization(s) where the main GitHub repository and all submodule
repositories are kept.</td>
</tr>
<tr>
<td>3.</td>
<td><img src="/docker-hub/hub-images/gh_repo_deploy_key.png"></td>
<td>Next, remove the deploy key from the main GitHub repository. This can be done in the GitHub repository's "Deploy keys" Settings section.</td>
</tr>
<tr>
<td>4.</td>
<td><img src="/docker-hub/hub-images/deploy_key.png"></td>
<td>Your automated build's deploy key is in the "Build Details" menu
under "Deploy keys".</td>
</tr>
<tr>
<td>5.</td>
<td><img src="/docker-hub/hub-images/gh_add_ssh_user_key.png"></td>
<td>In your dedicated GitHub User account, add the deploy key from your
Docker Hub Automated Build.</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>

Binary file not shown.

After

Width:  |  Height:  |  Size: 81 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 71 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 66 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB