Skip to content
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

Main custom endpoints #547

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions modules/ROOT/content-nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ AuraDB Start
** xref:auradb/managing-databases/monitoring.adoc[]
** xref:auradb/managing-databases/advanced-metrics.adoc[]
** xref:auradb/managing-databases/migration-readiness.adoc[]
** xref:auradb/managing-databases/custom-endpoints.adoc[]


* xref:auradb/connecting-applications/overview.adoc[Connecting applications]
Expand Down
Binary file added modules/ROOT/images/classic-instance-endpoint.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/ROOT/images/main-endpoints.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
30 changes: 30 additions & 0 deletions modules/ROOT/pages/auradb/managing-databases/custom-endpoints.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
[[aura-custom-endpoints]]
= Custom endpoints
:description: This section describes custom endpoints.

Custom endpoints can be used for database management and migration.

You can create custom endpoints for your instances directly from the console.
This allows you to establish connection to a database using this endpoint instead of the `<dbid>`.

[.shadow]
image::main-endpoints.png[width=800]

*Custom Endpoints* can be found under *Security* in the sidebar of the console.

Use the *Create custom endpoint* button to define your endpoint.
Choose an appropriate name for the endpoint (it can only contain lowercase letters, numbers, and hyphens) and select which instance to assign the endpoint to.

Once a custom endpoint has been assigned to an instance, it will be listed along with existing custom endpoints in the menu in the Project settings.
They can be managed both from this menu as well as from the instance card.

[.shadow]
image::classic-instance-endpoint.png[width=600]

A custom endpoint can be configured to a different instance or deleted.

[NOTE]
====
Once a custom endpoint is created (and thus assigned) or re-assigned to an instance, you have to wait three hours before you can make any further changes to it.
If you re-assign an endpoint, you have the option to undo the re-assignment at any time without waiting.
====
Loading