Skip to content

Commit

Permalink
🎉 Source MSSQL: Added support for connection via SSH tunnels (#5966)
Browse files Browse the repository at this point in the history
correction of remarks
  • Loading branch information
alexandr-shegeda committed Sep 20, 2021
1 parent 79e67ea commit 4c50b76
Showing 1 changed file with 15 additions and 12 deletions.
27 changes: 15 additions & 12 deletions docs/integrations/sources/mssql.md
Original file line number Diff line number Diff line change
Expand Up @@ -238,29 +238,32 @@ Using this feature requires additional configuration, when creating the source.
configuration means.

1. Configure all fields for the source as you normally would, except `SSH Tunnel Method`.
2. `SSH Tunnel Method` defaults to `No Tunnel` (meaning a direct connection). If you want to use an SSH Tunnel
choose `SSH Key Authentication` or `Password Authentication`.
1. Choose `Key Authentication` if you will be using an RSA Private as your secrets for establishing the SSH Tunnel (see
below for more information on generating this key).
2. Choose `Password Authentication` if you will be using a password as your secret for establishing the SSH Tunnel.
2. `SSH Tunnel Method` defaults to `No Tunnel` (meaning a direct connection). If you want to use an
SSH Tunnel choose `SSH Key Authentication` or `Password Authentication`.
1. Choose `Key Authentication` if you will be using an RSA private key as your secret for
establishing the SSH Tunnel (see below for more information on generating this key).
2. Choose `Password Authentication` if you will be using a password as your secret for establishing
the SSH Tunnel.
3. `SSH Tunnel Jump Server Host` refers to the intermediate (bastion) server that Airbyte will connect to. This should
be a hostname or an IP Address.
4. `SSH Connection Port` is the port on the bastion server with which to make the SSH connection. The default port for
SSH connections is `22`, so unless you have explicitly changed something, go with the default.
5. `SSH Login Username` is the username that Airbyte should use when connection to the bastion server. This is NOT the
MSSQL username.
6. If you are using `Password Authentication`, then `SSH Login Username` should be set to the password of the User from
the previous step. If you are using `SSH Key Authentication` leave this blank. Again, this is not the MSSQL password,
but the password for the OS-user that Airbyte is using to perform commands on the bastion.
7. If you are using `SSH Key Authentication`, then `SSH Private Key` should be set to the RSA Private Key that you are
using to create the SSH connection. This should be the full contents of the key file starting
with `-----BEGIN RSA PRIVATE KEY-----` and ending with `-----END RSA PRIVATE KEY-----`.
6. If you are using `Password Authentication`, then `SSH Login Username` should be set to the
password of the User from the previous step. If you are using `SSH Key Authentication` leave this
blank. Again, this is not the MSSQL password, but the password for the OS-user that Airbyte is
using to perform commands on the bastion.
7. If you are using `SSH Key Authentication`, then `SSH Private Key` should be set to the RSA
private Key that you are using to create the SSH connection. This should be the full contents of
the key file starting with `-----BEGIN RSA PRIVATE KEY-----` and ending
with `-----END RSA PRIVATE KEY-----`.

## Changelog

| Version | Date | Pull Request | Subject |
| :------ | :-------- | :----- | :------ |
| 0.3.6 | 2021-09-17 | [6318](https://github.com/airbytehq/airbyte/pull/6318) | Added option to connect to DB via SSH|
| 0.3.6 | 2021-09-17 | [6318](https://github.com/airbytehq/airbyte/pull/6318) | Added option to connect to DB via SSH |
| 0.3.4 | 2021-08-13 | [4699](https://github.com/airbytehq/airbyte/pull/4699) | Added json config validator |
| 0.3.3 | 2021-07-05 | [4689](https://github.com/airbytehq/airbyte/pull/4689) | Add CDC support |
| 0.3.2 | 2021-06-09 | [3179](https://github.com/airbytehq/airbyte/pull/3973) | Add AIRBYTE_ENTRYPOINT for Kubernetes support |
Expand Down

0 comments on commit 4c50b76

Please sign in to comment.