Skip to content

Commit

Permalink
chore: add note about ssh passphrase when mounting bashrc
Browse files Browse the repository at this point in the history
Signed-off-by: dkwon17 <[email protected]>
  • Loading branch information
dkwon17 committed Sep 10, 2024
1 parent cc0c246 commit 238e15d
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/additional-configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,16 @@ kubectl create secret -n "$NAMESPACE" generic git-ssh-key \
--from-file=ssh_config=/tmp/ssh_config \
--from-literal=passphrase="$PASSPHRASE"
----
+
Note: If a passphrase is provided, the DevWorkspace operator adds a postStart event that starts the SSH agent and adds the passphrase.
The DevWorkspace operator also modifies the bashrc file to configure the `SSH_AGENT_PID` and `SSH_AUTH_SOCK` environment variables.
If you are automatically mounting your own bashrc file with a ConfigMap (see link:additional-configuration.adoc#automatically-mounting-volumes-configmaps-and-secrets[Automatically mounting volumes, configmaps, and secrets])
you must add the following in your bashrc file:
+
[source,bash]
----
[ -f /home/user/ssh-environment ] && source /home/user/ssh-environment
----
3. Annotate the secret to configure automatic mounting to DevWorkspaces
+
Expand Down

0 comments on commit 238e15d

Please sign in to comment.