-
Notifications
You must be signed in to change notification settings - Fork 1.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update Oracle client docs for Teleport v17.2.0+ #49994
Open
Tener
wants to merge
5
commits into
master
Choose a base branch
from
tener/oracle-client-docs
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
af148d5
Update Oracle client docs for Teleport v17.2.0+
Tener a466e57
Merge branch 'master' into tener/oracle-client-docs
Tener 0be5c3c
remove docs for deprecated extension
Tener dfb9e8c
Run images through ImageOptim
ravicious 710d129
Add `@2x` suffix to high DPI images
ravicious File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
File renamed without changes
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -501,31 +501,160 @@ Click "Proceed", then click "Finish". | |
|
||
(!docs/pages/includes/database-access/gui-clients/spanner-reuse-port-note.mdx!) | ||
|
||
## Oracle SQL Developer | ||
## Oracle graphical clients | ||
|
||
The Oracle integration works only in the authenticated proxy mode. Start a local proxy for connections to your Oracle database by using the command below: | ||
|
||
``` | ||
tsh proxy db --tunnel --port 1521 --db-user=<user> --db-name=<db-name> oracle | ||
> tsh proxy db --tunnel --port 11555 --db-user=<user> --db-name=<db-name> oracle | ||
|
||
Started authenticated tunnel for the Oracle database "oracle" in cluster "teleport.example.com" on 127.0.0.1:11555. | ||
``` | ||
|
||
<Notice type="tip"> | ||
This command uses the local port 1521, but you can choose any port, or let | ||
`tsh` pick a local port at random if you omit the `--port` flag. | ||
You should specify a port to avoid the need to reconfigure your GUI client again | ||
later. | ||
The command above uses the local port 11555, but you can choose any available port. Leaving `--port` empty will cause `tsh` to pick a random one. | ||
</Notice> | ||
|
||
The local proxy supports TCP and TCPS modes. Different clients prefer different modes. | ||
|
||
TCP: | ||
- requires no username or password | ||
- generally easier to configure | ||
|
||
TCPS: | ||
- requires no username or password | ||
- depends on automatically created wallet | ||
- uses JDBC URL for configuration | ||
|
||
<Notice type="warning"> | ||
Teleport versions earlier than 17.2.0 support only a limited range of clients and only offer TCPS mode. `tsh` will automatically detect this situation and warn the user. We recommend updating to the latest version of Teleport to access full client support and additional connection options. | ||
</Notice> | ||
|
||
### Oracle SQL Developer (standalone) | ||
|
||
In "Connections" click the "+" button for a new database connection: | ||
|
||
![Oracle SQL Developer Add Database Connection](../../img/database-access/guides/oracle/oracle-sql-developer-add-database.png) | ||
![Oracle SQL Developer Add Database Connection](../../img/database-access/guides/oracle/sql-developer-standalone-add-database.png) | ||
|
||
Next, set the name and username from the `--db-user` parameter. Set connection type to "Custom JDBC" and | ||
set the "Custom JDBC URL" from the `tsh proxy db` command. | ||
|
||
![Oracle SQL Developer](../../img/database-access/guides/oracle/oracle-sql-developer-general.png) | ||
![Oracle SQL Developer](../../img/database-access/guides/oracle/sql-developer-standalone-conn-details-tcps.png) | ||
|
||
Now you can click "Test" to check your configuration. | ||
|
||
![Oracle SQL Developer Success](../../img/database-access/guides/oracle/oracle-sql-developer-success.png) | ||
![Oracle SQL Developer Success](../../img/database-access/guides/oracle/sql-developer-standalone-success.png) | ||
|
||
### Oracle SQL Developer (VS Code extension) | ||
|
||
Install the extension from [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=Oracle.sql-developer). | ||
|
||
Both TCP and TCPS modes can be used. | ||
|
||
<Tabs> | ||
<TabItem label="TCP"> | ||
|
||
Open the extension toolbar and click on "Create Connection" button. | ||
|
||
![SQL Developer (VS Code) Start](../../img/database-access/guides/oracle/[email protected]) | ||
|
||
Enter the following connection details: | ||
|
||
| Field | Value | | ||
|-----------------|------------------------| | ||
| Connection name | Choose unique name | | ||
| User name | `/` | | ||
| Password | `/` | | ||
| Save Password | Mark checkbox | | ||
| Connection type | Basic | | ||
| Host name | `localhost` | | ||
| Port number | `--port` flag value | | ||
| Type | Service Name | | ||
| Service name | `--db-name` flag value | | ||
|
||
Test and create the connection. | ||
|
||
![SQL Developer (VS Code) Connection Details (basic)](../../img/database-access/guides/oracle/[email protected]) | ||
|
||
The new connection should appear on the list. | ||
|
||
<Figure width="400"> | ||
![SQL Developer (VS Code) Connected (basic)](../../img/database-access/guides/oracle/[email protected]) | ||
</Figure> | ||
|
||
</TabItem> | ||
|
||
<TabItem label="TCPS"> | ||
|
||
Open the extension toolbar and click on "Create Connection" button. | ||
|
||
![SQL Developer (VS Code) Start](../../img/database-access/guides/oracle/[email protected]) | ||
|
||
Enter the following connection details: | ||
|
||
| Field | Value | | ||
|------------------|---------------------------------| | ||
| Connection name | (choose per your preference) | | ||
| User name | `/` | | ||
| Password | `/` | | ||
| Save Password | Mark the checkbox | | ||
| Connection type | "Custom JDBC" | | ||
| Custom JDBC URL | Copy from `tsh proxy db` output | | ||
|
||
Test and create the connection. | ||
|
||
![SQL Developer (VS Code) Connection Details (JDBC)](../../img/database-access/guides/oracle/[email protected]) | ||
|
||
The new connection should appear on the list. | ||
|
||
<Figure width="400"> | ||
![SQL Developer (VS Code) Connected (JDBC)](../../img/database-access/guides/oracle/[email protected]) | ||
</Figure> | ||
|
||
|
||
</TabItem> | ||
</Tabs> | ||
|
||
### Toad | ||
|
||
Add new login record in the logins dialog. | ||
|
||
![Toad Add Login Record](../../img/database-access/guides/oracle/[email protected]) | ||
|
||
Enter the connection details in "Direct" tab: | ||
|
||
| Field | Value | | ||
|-----------------|------------------------------| | ||
| Host name | `127.0.0.1` | | ||
| Port number | `--port` flag value | | ||
| Service name | `--db-name` flag value | | ||
| User name | `EXTERNAL` | | ||
| Password | (leave empty) | | ||
| Connection name | (choose per your preference) | | ||
|
||
Test the connection to verify the setup. | ||
|
||
![Toad Add Login Tested](../../img/database-access/guides/oracle/[email protected]) | ||
|
||
The newly added login should appear on the login list. | ||
|
||
![Toad Login List](../../img/database-access/guides/oracle/[email protected]) | ||
|
||
<Notice type="tip"> | ||
You can also configure Toad to use an external Oracle client. Both native and external clients are supported. | ||
</Notice> | ||
|
||
### DBeaver | ||
|
||
Click on the "New Database Connection" button. | ||
|
||
![DBeaver new connection button](../../img/database-access/guides/oracle/[email protected]) | ||
|
||
Select "Oracle" from the driver list. You may use the search toolbar to narrow down the list. | ||
![DBeaver connect to a database](../../img/database-access/guides/oracle/[email protected]) | ||
|
||
Choose "Custom" connection type and paste the JDBC connection string printed by `tsh proxy db`. | ||
![DBeaver JDBC details](../../img/database-access/guides/oracle/[email protected]) | ||
|
||
Test the connection to verify the setup. Finalize by clicking "Finish". | ||
|
||
Congratulations! You have just connected to your Oracle instance. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I allowed myself to run images from this PR through ImageOptim. This reduced their size by half, without reducing quality.
I also added
@2x
suffix to the new images that are high DPI. This makes the doc engine handle them better when you click on an image. Make your browser fullscreen and then compare the old version vs the new version by clicking on an image.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you!