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

Fix README for using multiple deploy keys in docker #164

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Commits on Mar 1, 2023

  1. Fix README for using multiple deploy keys in docker

    ## TL;DR;
    Multiple deploy keys in docker doesn't work after following everything in README. Loading `.gitconfig` into git in docker fixed it.
    
    ## Summary
    We are using multiple Github deploy keys in docker for PIP to install dependencies from multiple private Github repositories. However, after doing everything from the webfactory/ssh-agent README, including adding comment when generating keys and copying `.gitconfig` and `.ssh/` into docker, the multiple deploy keys still didn't work. We print out the verbose log for `git ssh` when doing PIP install by using `RUN --mount=type=ssh GIT_SSH_COMMAND="ssh -v" pip install -r /requirements.txt`. Turns out that it was blindly accepting the first key (repo-a) even though it should use the second key (repo-b) which is way it couldn't fetch from the repo-b. After some research, the webfactory/ssh-agent depends on the customized `.gitconfig` file to map the correct ssh key to the correct repository link. Then we did a `RUN git config -l` in the Dockerfile and the output was empty which means that although we are copying the `.gitconfig` file into the docker image, it was not loaded into git config. So after adding `RUN mv /root/.gitconfig /etc/gitconfig` into the Dockerfile, the PIP install started working. In conclusion, the `.gitconfig` config file doesn't do anything sitting in the `/root` folder.
    
    ### Following was the original error message excluding sensitive information that helped us figure out the root cause:
    ```
    webfactory#24 3.926   debug1: Will attempt key: [email protected]:owner/repo-a.git ED25519 SHA256:*** agent
    webfactory#24 3.927   debug1: Will attempt key: [email protected]:owner/repo-b.git ED25519 SHA256:*** agent
    ...
    webfactory#24 4.013   debug1: Authentications that can continue: publickey
    webfactory#24 4.014   debug1: Next authentication method: publickey
    webfactory#24 4.014   debug1: Offering public key: [email protected]:owner/repo-a.git ED25519 SHA256:*** agent
    webfactory#24 4.047   debug1: Server accepts key: [email protected]:owner/repo-a.git ED25519 SHA256:*** agent
    webfactory#24 4.076   debug1: Authentication succeeded (publickey).
    webfactory#24 4.077   Authenticated to github.com ([140.82.112.3]:22).
    webfactory#24 4.078   debug1: channel 0: new [client-session]
    webfactory#24 4.079   debug1: Entering interactive session.
    webfactory#24 4.079   debug1: pledge: network
    webfactory#24 4.099   debug1: client_input_global_request: rtype [email protected] want_reply 0
    webfactory#24 4.143   debug1: Sending environment.
    webfactory#24 4.144   debug1: Sending env GIT_PROTOCOL = version=2
    webfactory#24 4.145   debug1: Sending env LANG = C.UTF-8
    webfactory#24 4.146   debug1: Sending command: git-upload-pack '/owner/repo-b.git'
    webfactory#24 4.207   debug1: client_input_channel_req: channel 0 rtype exit-status reply 0
    webfactory#24 4.207   ERROR: Repository not found.
    ```
    
    ### Following was the log of successfully using multiple deploy keys in docker:
    ```
    webfactory#28 5.568   debug1: Will attempt key: /root/.ssh/key-*** (repo-b) ED25519 SHA256:*** explicit agent
    ...
    webfactory#28 5.722   debug1: Authentications that can continue: publickey
    webfactory#28 5.722   debug1: Next authentication method: publickey
    webfactory#28 5.722   debug1: Offering public key: /root/.ssh/key-*** (repo-b) ED25519 SHA256:*** explicit agent
    webfactory#28 5.786   debug1: Server accepts key: /root/.ssh/key-*** (repo-b) ED25519 SHA256:*** explicit agent
    webfactory#28 5.846   debug1: Authentication succeeded (publickey).
    webfactory#28 5.846   Authenticated to github.com ([140.82.113.4]:22).
    webfactory#28 5.847   debug1: channel 0: new [client-session]
    webfactory#28 5.847   debug1: Entering interactive session.
    webfactory#28 5.848   debug1: pledge: network
    webfactory#28 5.848   debug1: client_input_global_request: rtype [email protected] want_reply 0
    webfactory#28 5.901   debug1: Sending environment.
    webfactory#28 5.901   debug1: Sending env GIT_PROTOCOL = version=2
    webfactory#28 5.902   debug1: Sending env LANG = C.UTF-8
    webfactory#28 5.902   debug1: Sending command: git-upload-pack 'owner/repo-b.git'
    webfactory#28 6.414   debug1: client_input_channel_req: channel 0 rtype exit-status reply 0
    webfactory#28 6.415   debug1: channel 0: free: client-session, nchannels 1
    webfactory#28 6.416   debug1: fd 0 clearing O_NONBLOCK
    webfactory#28 6.416   debug1: fd 2 clearing O_NONBLOCK
    webfactory#28 6.417   Transferred: sent 12836, received 265192 bytes, in 0.6 seconds
    webfactory#28 6.417   Bytes per second: sent 22608.0, received 467080.7
    webfactory#28 6.418   debug1: Exit status 0
    ```
    ohbriansung authored Mar 1, 2023
    Configuration menu
    Copy the full SHA
    5767c46 View commit details
    Browse the repository at this point in the history