Skip to content

docs: updated and added OIDC credential forwarding COPS-264, COPS-284, COPS-319 #2692

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.

Sign up for GitHub

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

Open
evelinadanielsson wants to merge 24 commits into
base: dev
Choose a base branch
from
Open

docs: updated and added OIDC credential forwarding COPS-264, COPS-284, COPS-319 #2692

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
d93610e
docs: updated and added OIDC credential forwarding
evelinadanielsson Oct 30, 2025
9df769a
docs: include oidc credential forwarding figure
evelinadanielsson Nov 10, 2025
88299cb
docs: add credentials column to show aliases
evelinadanielsson Nov 10, 2025
07bb533
docs: add info about altering alias command not supporting change of …
evelinadanielsson Nov 17, 2025
1a5e7f8
editorial updates
renetapopova Nov 27, 2025
3095df5
add the diagram file
renetapopova Nov 27, 2025
f68e2e3
Editorial changes
renetapopova Dec 2, 2025
b23d74e
replace the diagrams
renetapopova Dec 2, 2025
e680761
further editorial changes to fix inconsistencies
renetapopova Dec 2, 2025
9de18d7
update the diagrams
renetapopova Dec 4, 2025
90e6234
apply some suggestions from review
renetapopova Dec 4, 2025
8f21930
apply suggestions from review
renetapopova Dec 5, 2025
79bd5b5
fix broken links
renetapopova Dec 5, 2025
331ca0e
an attempt to incorporate the comments from the review
renetapopova Dec 9, 2025
c6f1711
remove a leftover formatting
renetapopova Dec 9, 2025
29a0070
firther improvements
renetapopova Dec 9, 2025
4a756b3
further improvements
renetapopova Dec 9, 2025
ba22956
fixed a few more inconsistencies
renetapopova Dec 9, 2025
f92c786
further improvements
renetapopova Dec 9, 2025
082180c
Update modules/ROOT/pages/database-administration/aliases/remote-data…
renetapopova Dec 10, 2025
6b68373
docs: fixing descriptive steps and adding info
evelinadanielsson Dec 12, 2025
2360dc0
docs: add oidc cred forwarding to database management command syntax …
evelinadanielsson Dec 12, 2025
3c8951c
Apply suggestions from code review
evelinadanielsson Dec 15, 2025
59bb408
docs: rewrote caution block
evelinadanielsson Dec 15, 2025
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
56 changes: 56 additions & 0 deletions modules/ROOT/images/remote-alias-credential-forwarding-overview.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
83 changes: 42 additions & 41 deletions modules/ROOT/images/remote-alias-overview.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
54 changes: 27 additions & 27 deletions ...T/pages/database-administration/aliases/manage-aliases-composite-databases.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,12 @@ SHOW ALIASES FOR DATABASE
.Result
[role="queryresult"]
----
+--------------------------------------------------------------------------------------------------+
| name | composite | database | location | url | user |
+--------------------------------------------------------------------------------------------------+
| "library.romance" | "library" | "romance-books" | "remote" | "neo4j+s://location:7687" | "alice" |
| "library.sci-fi" | "library" | "sci-fi-books" | "local" | NULL | NULL |
+--------------------------------------------------------------------------------------------------+
+--------------------------------------------------------------------------------------------------------------------------------+
| name | composite | database | location | url | credentials | user |
+--------------------------------------------------------------------------------------------------------------------------------+
| "library.romance" | "library" | "romance-books" | "remote" | "neo4j+s://location:7687" | "STORED NATIVE CREDENTIALS" | "alice" |
| "library.sci-fi" | "library" | "sci-fi-books" | "local" | NULL | NULL | NULL |
+--------------------------------------------------------------------------------------------------------------------------------+
----

For a description of all the returned columns of this command, and for ways in which the `SHOW ALIASES FOR DATABASE` command can be filtered for aliases, see xref:database-administration/aliases/manage-aliases-standard-databases.adoc#manage-aliases-list[list aliases for standard databases].
Expand Down Expand Up @@ -105,12 +105,12 @@ WHERE composite = 'garden'
.Result
[role="queryresult"]
----
+-----------------------------------------------------------------------------------------------------+
| name | composite | database | location | url | user |
+-----------------------------------------------------------------------------------------------------+
| "garden.flowers" | "garden" | "perennial-flowers" | "local" | NULL | NULL |
| "garden.trees" | "garden" | "trees" | "remote" | "neo4j+s://location:7687" | "alice" |
+-----------------------------------------------------------------------------------------------------+
+-----------------------------------------------------------------------------------------------------------------------------------+
| name | composite | database | location | url | credentials | user |
+-----------------------------------------------------------------------------------------------------------------------------------+
| "garden.flowers" | "garden" | "perennial-flowers" | "local" | NULL | NULL | NULL |
| "garden.trees" | "garden" | "trees" | "remote" | "neo4j+s://location:7687" | "STORED NATIVE CREDENTIALS" | "alice" |
+-----------------------------------------------------------------------------------------------------------------------------------+
----

Database aliases cannot target a composite database.
Expand Down Expand Up @@ -159,14 +159,14 @@ SHOW ALIASES FOR DATABASE YIELD *
.Result
[role="queryresult"]
----
+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| name | composite | database | location | url | user | driver | defaultLanguage | properties |
+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| "garden.flowers" | "garden" | "perennial-flowers" | "local" | NULL | NULL | NULL | NULL | {perennial: TRUE} |
| "garden.trees" | "garden" | "updatedtrees" | "remote" | "neo4j+s://location:7687" | "alice" | {} | NULL | {treeversion: 2} |
| "library.romance" | "library" | "romance-books" | "remote" | "neo4j+s://location:7687" | "alice" | {} | NULL | {} |
| "library.sci-fi" | "library" | "sci-fi-books" | "local" | NULL | NULL | NULL | NULL | {} |
+-----------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| name | composite | database | location | url | credentials | user | driver | defaultLanguage | properties |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| "garden.flowers" | "garden" | "perennial-flowers" | "local" | NULL | NULL | NULL | NULL | NULL | {perennial: TRUE} |
| "garden.trees" | "garden" | "updatedtrees" | "remote" | "neo4j+s://location:7687" | "STORED NATIVE CREDENTIALS" | "alice" | {} | NULL | {treeversion: 2} |
| "library.romance" | "library" | "romance-books" | "remote" | "neo4j+s://location:7687" | "STORED NATIVE CREDENTIALS" | "alice" | {} | NULL | {} |
| "library.sci-fi" | "library" | "sci-fi-books" | "local" | NULL | NULL | NULL | NULL | NULL | {} |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
----

[[delete-composite-database-alias]]
Expand All @@ -192,13 +192,13 @@ SHOW ALIASES FOR DATABASE
.Result
[role="queryresult"]
----
+--------------------------------------------------------------------------------------------------+
| name | composite | database | location | url | user |
+--------------------------------------------------------------------------------------------------+
| "garden.trees" | "garden" | "updatedtrees" | "remote" | "neo4j+s://location:7687" | "alice" |
| "library.romance" | "library" | "romance-books" | "remote" | "neo4j+s://location:7687" | "alice" |
| "library.sci-fi" | "library" | "sci-fi-books" | "local" | NULL | NULL |
+--------------------------------------------------------------------------------------------------+
+--------------------------------------------------------------------------------------------------------------------------------+
| name | composite | database | location | url | credentials | user |
+--------------------------------------------------------------------------------------------------------------------------------+
| "garden.trees" | "garden" | "updatedtrees" | "remote" | "neo4j+s://location:7687" | "STORED NATIVE CREDENTIALS" | "alice" |
| "library.romance" | "library" | "romance-books" | "remote" | "neo4j+s://location:7687" | "STORED NATIVE CREDENTIALS" | "alice" |
| "library.sci-fi" | "library" | "sci-fi-books" | "local" | NULL | NULL | NULL |
+--------------------------------------------------------------------------------------------------------------------------------+
----

Additionally, deleted aliases will no longer appear in the `constituents` column for the `SHOW DATABASE` command.
Expand Down
Loading