Document git ssh symlink requirement #2663
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghost
added
the
kind/documentation
tekton-robot
added
the
size/XS
ghost
mentioned this pull request
afrittoli
reviewed
May 21, 2020
docs/auth.md
Outdated
| @@ -108,6 +108,12 @@ When the `Run` executes, before steps execute, a `~/.ssh/config` will be | |||
| generated containing the key configured in the `Secret`. This key is then used | |||
| to authenticate when retrieving any `PipelineResources`. | |||
|
|
|||
| Note: SSH credentials can also be used when invoking vanilla `git` commands | |||
| in your Task's Steps. However, you will first need to symlink `/tekton/home/.ssh` | |||
| to `/root/.ssh` because `ssh` ignores the `$HOME` environment variable, which by | |||
There was a problem hiding this comment.
NIT: Perhaps instead of just /root/.ssh we could say to your user .ssh folder - e.g. /root/.ssh when using root.
There was a problem hiding this comment.
Good call, I've updated to include that, and added a little more detail about why this is necessary. Also turned this change into its own section because the content spans multiple paragraphs.
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: afrittoli The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
tekton-robot
added
approved
When relying on creds-init to generate git ssh credentials a user will need to symlink from /tekton/home/.ssh to /root/.ssh if they're issuing `git` commands in a Step's script or image. This commit documents the need to symlink in auth.md.
afrittoli
reviewed
May 21, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Adds documentation around #2638
When relying on creds-init to generate git ssh credentials
a user will need to symlink from /tekton/home/.ssh to /root/.ssh
if they're issuing
gitcommands in a Step's script or image.This commit documents the need to symlink in auth.md.
Submitter Checklist
These are the criteria that every PR should meet, please check them off as you
review them:
See the contribution guide for more details.
Double check this list of stuff that's easy to miss:
cmddir, please updatethe release Task to build and release this image.
Reviewer Notes
If API changes are included, additive changes must be approved by at least two OWNERS and backwards incompatible changes must be approved by more than 50% of the OWNERS, and they must first be added in a backwards compatible way.