Skip to content

Commit 6addced

Browse files
committed
chore: Document SSH passphrase injection as an experimental feature
Signed-off-by: Andrew Obuchowicz <[email protected]>
1 parent def3656 commit 6addced

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/additional-configuration.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ Prerequisites:
189189
** The steps below assume the following environment variables are set:
190190
*** `$SSH_KEY`: path on disk to private key for SSH keypair (e.g. `~/.ssh/id_ed25519`)
191191
*** `$SSH_PUB_KEY`: path on disk to public key for SSH keypair (e.g. `~/.ssh/id_ed25519.pub`)
192-
*** `$PASSPHRASE`: SSH keypair passphrase (optional)
192+
*** `$PASSPHRASE`: SSH keypair passphrase (optional). *Note:* requires setting `config.enableExperimentalFeatures: true` in the DevWorkspaceOperatorConfig.
193193
*** `$NAMESPACE`: namespace where workspaces using the SSH keypair will be started.
194194
195195
Process:
@@ -225,6 +225,8 @@ you must add the following in your `~/.bashrc`:
225225
----
226226
[ -f $HOME/ssh-environment ] && source $HOME/ssh-environment
227227
----
228+
+
229+
*Note:* Specifying a passphrase for an SSH key is an experimental feature and is controlled by the DevWorkspaceOperatorConfig's `config.enableExperimentalFeatures` field.
228230
229231
3. Annotate the secret to configure automatic mounting to DevWorkspaces
230232
+

0 commit comments

Comments
 (0)