From 238e15d07f595bbc2fc6ba9dbcf6f6a698a9a5a5 Mon Sep 17 00:00:00 2001 From: dkwon17 Date: Tue, 10 Sep 2024 00:23:01 +0000 Subject: [PATCH] chore: add note about ssh passphrase when mounting bashrc Signed-off-by: dkwon17 --- docs/additional-configuration.adoc | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/additional-configuration.adoc b/docs/additional-configuration.adoc index c02db115b..fc0f29593 100644 --- a/docs/additional-configuration.adoc +++ b/docs/additional-configuration.adoc @@ -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 +