From 3491c359b9a42689188ecc1076a2af30c8f152e7 Mon Sep 17 00:00:00 2001 From: Christian Berendt Date: Fri, 15 Mar 2024 17:28:35 +0100 Subject: [PATCH] Add sshconfig_extra parameter to the configuration guide Signed-off-by: Christian Berendt --- .../configuration-guide/commons/sshconfig.md | 26 +++++++++++++------ 1 file changed, 18 insertions(+), 8 deletions(-) diff --git a/docs/guides/configuration-guide/commons/sshconfig.md b/docs/guides/configuration-guide/commons/sshconfig.md index e5632f6887..ec825cd1e3 100644 --- a/docs/guides/configuration-guide/commons/sshconfig.md +++ b/docs/guides/configuration-guide/commons/sshconfig.md @@ -7,6 +7,16 @@ sidebar_label: SSH Config With the `osism.commons.sshconfig` role, it is possible to manage a SSH config file in the home directory of the operator user. +## Extra config + +The `sshconfig_extra` parameter can be used to add any other SSH configuration to the `.ssh/config` file. + +```yaml +sshconfig_extra: | + Host github.com + ProxyCommand nc -X connect -x :> ssh.github.com 443 +``` + ## Example In the [testbed](https://github.com/osism/testbed) @@ -44,11 +54,11 @@ Host testbed-node-2 ## Defaults -**Parameter** | **Default** | **Description** ------------------------------|----------------------------------------|--------------------- -`sshconfig_groupname` | `all` | All nodes in this group are included. -`sshconfig_order` | `20` | The `.ssh/config.d` directory is used to prepare the `.ssh/config` file. You can add your own files in this directory. Everything with a filename prefix smaller than `sshconfig_order` is placed at the beginning of the assembled `.ssh/config` file. Anything with a filename prefix greater than `sshconfig_order` goes at the end. -`sshconfig_port` | `22` | The SSH port. -`sshconfig_private_key_file` | `/opt/ansible/secrets/id_rsa.operator` | The identity file to use. The file itself must already exist there. The file is created by the `osism.services.manager` role. -`sshconfig_user` | `"{{ operator_user }}"` | The user in which home directory the `.ssh/config` file will be generated. - +| Parameter | Default | Description | +|:-----------------------------|:---------------------------------------|:---------------------| +| `sshconfig_groupname` | `all` | All nodes in this group are included. +| `sshconfig_order` | `20` | The `.ssh/config.d` directory is used to prepare the `.ssh/config` file. You can add your own files in this directory. Everything with a filename prefix smaller than `sshconfig_order` is placed at the beginning of the assembled `.ssh/config` file. Anything with a filename prefix greater than `sshconfig_order` goes at the end. | +| `sshconfig_port` | `22` | The SSH port. | +| `sshconfig_private_key_file` | `/opt/ansible/secrets/id_rsa.operator` | The identity file to use. The file itself must already exist there. The file is created by the `osism.services.manager` role. | +| `sshconfig_user` | `"{{ operator_user }}"` | The user in which home directory the `.ssh/config` file will be generated. | +| `sshconfig_extra` | `""` | Add additional SSH configuration to the end of the `.ssh/config` file. | \ No newline at end of file