From ba61522778490dc6ae9e2002c3f8cc2dd45168a4 Mon Sep 17 00:00:00 2001 From: Kate Mueller Date: Mon, 19 Aug 2024 12:25:26 -0400 Subject: [PATCH] DOC-1008: Update SSH credential to medium tier template (#2322) --- docs/integrations/builtin/credentials/ssh.md | 36 +++++++++++--------- 1 file changed, 20 insertions(+), 16 deletions(-) diff --git a/docs/integrations/builtin/credentials/ssh.md b/docs/integrations/builtin/credentials/ssh.md index eb42aef33e5..9c6e5f04d4a 100644 --- a/docs/integrations/builtin/credentials/ssh.md +++ b/docs/integrations/builtin/credentials/ssh.md @@ -15,14 +15,14 @@ You can use these credentials to authenticate the following nodes: ## Prerequisites - Create a remote server with SSH enabled. -- Create one of the following: - - A user account that can `ssh` into the server: Use with [password authentication](#using-password). - - An SSH key for the server or service: Use with [private key authentication](#using-private-key). +- Create a user account that can `ssh` into the server using one of the following: + - Their own [password](#using-password) + - An SSH [private key](#using-private-key) ## Supported authentication methods -- Password -- Private key +- [Password](#using-password): Use this method if you have a user account that can `ssh` into the server using their own password. +- [Private key](#using-private-key): Use this method if you have a user account that uses an SSH key for the server or service. ## Related resources @@ -31,20 +31,24 @@ Secure Shell (SSH) protocol is a method for securely sending commands over a net ## Using password -To configure this credential, you'll need: +Use this method if you have a user account that can `ssh` into the server using their own password. -- A **Host**: Enter the IP address of the server you are connecting to. -- A **Port**: Enter the port to use for this connection. SSH uses port 22 by default. -- A **Username**: Enter the username for the user account with `ssh` access on the server. -- A **Password**: Enter the password for that user account. +To configure this credential, you'll need to: + +1. Enter the IP address of the server you're connecting to as the **Host**. +2. Enter the **Port** to use for the connection. SSH uses port `22` by default. +3. Enter the **Username** for a user account with `ssh` access on the server. +4. Enter the **Password** for that user account. ## Using private key -To configure this credential, you'll need: +Use this method if you have a user account that uses an SSH key for the server or service. -- A **Host**: Enter the IP address of the server you are connecting to. -- A **Port**: Enter the port to use for this connection. SSH uses port 22 by default. -- A **Username**: Enter the username of the account that generated the private key. -- An SSH **Private Key**: Enter the entire contents of your SSH private key. -- _Optional:_ If you created a **Passphrase** for the key, enter the passphrase. If you didn't create a passphrase for the key, leave blank. +To configure this credential, you'll need to: +1. Enter the IP address of the server you're connecting to as the **Host**. +2. Enter the **Port** to use for the connection. SSH uses port `22` by default. +3. Enter the **Username** of the account that generated the private key. +4. Enter the entire contents of your SSH **Private Key**. +5. If you created a **Passphrase** for the **Private Key**, enter the passphrase. + - If you didn't create a passphrase for the key, leave blank.