Skip to content

Update server.tag documentation #433

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

Merged
merged 5 commits into from
Feb 24, 2023
Merged

Update server.tag documentation #433

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
25b0c19
add note on initial server tags and how to change them using alter se…
jackwaudby Feb 21, 2023
34aab25
add comment on SET OPTIONS override behaviour
jackwaudby Feb 21, 2023
0e05d7a
update enable server with tags
jackwaudby Feb 23, 2023
2063007
Update modules/ROOT/pages/access-control/manage-servers.adoc
jackwaudby Feb 24, 2023
4e10138
Update modules/ROOT/pages/access-control/manage-servers.adoc
jackwaudby Feb 24, 2023
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
19 changes: 19 additions & 0 deletions modules/ROOT/pages/access-control/manage-servers.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,6 +303,10 @@ This may not be specified in combination with `deniedDatabases`.
| list of database names
| Only databases **not** matching the specified names may be hosted on the server.
This may not be specified in combination with `allowedDatabases`.

| tags
| list of server tags
| List of server tags used during database allocation and for load balancing and routing policies.
|===

[NOTE]
Expand All @@ -311,6 +315,11 @@ Composite databases are ignored by both `allowedDatabases` and `deniedDatabases`
The composite databases are available everywhere and hold no data on their own.
====

[NOTE]
====
When a server is enabled, if `tags` are not provided in `OPTIONS`, the default server tags are taken from the setting `initial.server.tags`.
====

[[server-management-alter-server]]
== Modifying servers

Expand Down Expand Up @@ -339,6 +348,10 @@ This may not be specified in combination with `deniedDatabases`.
| list of database names
| Only databases **not** matching the specified names may be hosted on the server.
This may not be specified in combination with `allowedDatabases`.

| tags
| list of server tags
| List of server tags used during database allocation and for load balancing and routing policies.
|===

[NOTE]
Expand All @@ -347,6 +360,12 @@ Composite databases are ignored by both `allowedDatabases` and `deniedDatabases`
The composite databases are available everywhere and hold no data on their own.
====

[NOTE]
====
Input provided to `SET OPTIONS {...}` replaces **all** existing options, rather than being combined with them.
For instance, if `SET OPTIONS {modeConstraint:'SECONDARY'}` is run followed by `SET OPTIONS {allowedDatabases:['foo']}`, the second `ALTER` removes the mode constraint.
====

[[server-management-rename-server]]
== Renaming servers

Expand Down