Skip to content

Commit 6740b28

Browse files
JPryce-AklundhJPryce-Aklundh
andauthored
New Administration chapter (#494)
This PR collects the various administrative sections currently in Cypher Manual and places them under a new chapter heading. This includes: - database management - database alias management - server management - access control Also included in PR: - xref redirects Corresponding PRs: Operations Manual: neo4j/docs-operations#635 Cheat sheet: neo4j/docs-cheat-sheet#71 --------- Co-authored-by: JPryce-Aklundh <[email protected]>
1 parent e688d3c commit 6740b28

29 files changed

+372
-351
lines changed

modules/ROOT/content-nav.adoc

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -71,22 +71,6 @@
7171
** xref:constraints/syntax.adoc[]
7272
** xref:constraints/examples.adoc[]
7373
74-
* xref:databases.adoc[]
75-
* xref:aliases.adoc[]
76-
77-
* xref:access-control/index.adoc[]
78-
** xref:access-control/manage-users.adoc[]
79-
** xref:access-control/manage-roles.adoc[]
80-
** xref:access-control/manage-privileges.adoc[]
81-
** xref:access-control/manage-servers.adoc[]
82-
** xref:access-control/built-in-roles.adoc[]
83-
** xref:access-control/privileges-reads.adoc[]
84-
** xref:access-control/privileges-writes.adoc[]
85-
** xref:access-control/database-administration.adoc[]
86-
** xref:access-control/dbms-administration.adoc[]
87-
** xref:access-control/limitations.adoc[]
88-
** xref:access-control/privileges-immutable.adoc[]
89-
9074
* xref:query-tuning/index.adoc[]
9175
** xref:query-tuning/query-options.adoc[]
9276
** xref:query-tuning/query-profile.adoc[]
@@ -101,6 +85,22 @@
10185
** xref:execution-plans/operators.adoc[]
10286
** xref:execution-plans/shortestpath-planning.adoc[]
10387
88+
* xref:administration/index.adoc[]
89+
** xref:administration/databases.adoc[]
90+
** xref:administration/aliases.adoc[]
91+
** xref:administration/servers.adoc[]
92+
** xref:administration/access-control/index.adoc[]
93+
*** xref:administration/access-control/manage-users.adoc[]
94+
*** xref:administration/access-control/manage-roles.adoc[]
95+
*** xref:administration/access-control/manage-privileges.adoc[]
96+
*** xref:administration/access-control/built-in-roles.adoc[]
97+
*** xref:administration/access-control/privileges-reads.adoc[]
98+
*** xref:administration/access-control/privileges-writes.adoc[]
99+
*** xref:administration/access-control/database-administration.adoc[]
100+
*** xref:administration/access-control/dbms-administration.adoc[]
101+
*** xref:administration/access-control/limitations.adoc[]
102+
*** xref:administration/access-control/privileges-immutable.adoc[]
103+
104104
* xref:deprecations-additions-removals-compatibility.adoc[]
105105
* xref:keyword-glossary.adoc[]
106106

modules/ROOT/pages/access-control/built-in-roles.adoc renamed to modules/ROOT/pages/administration/access-control/built-in-roles.adoc

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ This section explains the default privileges of the built-in roles in Neo4j and
1111
All of the commands described in this chapter require that the user executing the commands has the rights to do so.
1212
The privileges listed in the following sections are the default set of privileges for each built-in role:
1313

14-
* xref::access-control/built-in-roles.adoc#access-control-built-in-roles-public[The `PUBLIC` role]
15-
* xref::access-control/built-in-roles.adoc#access-control-built-in-roles-reader[The `reader` role]
16-
* xref::access-control/built-in-roles.adoc#access-control-built-in-roles-editor[The `editor` role]
17-
* xref::access-control/built-in-roles.adoc#access-control-built-in-roles-publisher[The `publisher` role]
18-
* xref::access-control/built-in-roles.adoc#access-control-built-in-roles-architect[The `architect` role]
19-
* xref::access-control/built-in-roles.adoc#access-control-built-in-roles-admin[The `admin` role]
14+
* xref::administration/access-control/built-in-roles.adoc#access-control-built-in-roles-public[The `PUBLIC` role]
15+
* xref::administration/access-control/built-in-roles.adoc#access-control-built-in-roles-reader[The `reader` role]
16+
* xref::administration/access-control/built-in-roles.adoc#access-control-built-in-roles-editor[The `editor` role]
17+
* xref::administration/access-control/built-in-roles.adoc#access-control-built-in-roles-publisher[The `publisher` role]
18+
* xref::administration/access-control/built-in-roles.adoc#access-control-built-in-roles-architect[The `architect` role]
19+
* xref::administration/access-control/built-in-roles.adoc#access-control-built-in-roles-admin[The `admin` role]
2020
2121
[[access-control-built-in-roles-public]]
2222
== The `PUBLIC` role
@@ -222,7 +222,7 @@ The resulting `editor` role now has the same privileges as the original built-in
222222
[[access-control-built-in-roles-publisher]]
223223
== The `publisher` role
224224

225-
The `publisher` role can do the same as xref::access-control/built-in-roles.adoc#access-control-built-in-roles-editor[`editor`], as well as create new labels, property keys and relationship types.
225+
The `publisher` role can do the same as xref::administration/access-control/built-in-roles.adoc#access-control-built-in-roles-editor[`editor`], as well as create new labels, property keys and relationship types.
226226

227227

228228
[[access-control-built-in-roles-publisher-list]]
@@ -303,7 +303,7 @@ The resulting `publisher` role now has the same privileges as the original built
303303
[[access-control-built-in-roles-architect]]
304304
== The `architect` role
305305

306-
The `architect` role can do the same as the xref::access-control/built-in-roles.adoc#access-control-built-in-roles-publisher[`publisher`], as well as create and manage indexes and constraints.
306+
The `architect` role can do the same as the xref::administration/access-control/built-in-roles.adoc#access-control-built-in-roles-publisher[`publisher`], as well as create and manage indexes and constraints.
307307

308308

309309
[[access-control-built-in-roles-architect-list]]
@@ -396,24 +396,24 @@ The resulting `architect` role now has the same privileges as the original built
396396
[[access-control-built-in-roles-admin]]
397397
== The `admin` role
398398

399-
The `admin` role can do the same as the xref::access-control/built-in-roles.adoc#access-control-built-in-roles-architect[`architect`], as well as manage databases, aliases, users, roles and privileges.
399+
The `admin` role can do the same as the xref::administration/access-control/built-in-roles.adoc#access-control-built-in-roles-architect[`architect`], as well as manage databases, aliases, users, roles and privileges.
400400

401401
The `admin` role has the ability to perform administrative tasks.
402402
These include the rights to perform the following classes of tasks:
403403

404-
* Manage xref::access-control/database-administration.adoc[database security] to control the rights to perform actions on specific databases:
404+
* Manage xref::administration/access-control/database-administration.adoc[database security] to control the rights to perform actions on specific databases:
405405
** Manage access to a database and the right to start and stop a database.
406406
** Manage xref::indexes-for-search-performance.adoc[indexes] and xref::constraints/index.adoc[constraints].
407407
** Allow the creation of labels, relationship types or property names.
408408
** Manage transactions
409-
* Manage xref::access-control/dbms-administration.adoc[DBMS security] to control the rights to perform actions on the entire system:
410-
** Manage xref::databases.adoc[multiple databases].
411-
** Manage xref::access-control/manage-users.adoc[users] and xref::access-control/manage-roles.adoc[roles].
409+
* Manage xref::administration/access-control/dbms-administration.adoc[DBMS security] to control the rights to perform actions on the entire system:
410+
** Manage xref::administration/databases.adoc[multiple databases].
411+
** Manage xref::administration/access-control/manage-users.adoc[users] and xref::administration/access-control/manage-roles.adoc[roles].
412412
** Change configuration parameters.
413413
** Manage sub-graph privileges.
414414
** Manage procedure security.
415415

416-
These rights are conferred using privileges that can be managed through the xref::access-control/manage-privileges.adoc#access-control-graph-privileges[`GRANT`, `DENY` and `REVOKE` commands].
416+
These rights are conferred using privileges that can be managed through the xref::administration/access-control/manage-privileges.adoc#access-control-graph-privileges[`GRANT`, `DENY` and `REVOKE` commands].
417417

418418

419419
[[access-control-built-in-roles-admin-list]]

modules/ROOT/pages/access-control/database-administration.adoc renamed to modules/ROOT/pages/administration/access-control/database-administration.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The components of the database privilege commands are:
3131
* _mutability_:
3232
** `IMMUTABLE` - When used in conjunction with `GRANT` or `DENY`, specifies that a privilege cannot subsequently be removed unless auth is disabled.
3333
Contrastingly, when `IMMUTABLE` is specified in conjunction with a `REVOKE` command, it will act as a filter and only remove matching _immutable_ privileges.
34-
See also xref:access-control/index.adoc#access-control-privileges-immutable[immutable privileges].
34+
See also xref:administration/access-control/index.adoc#access-control-privileges-immutable[immutable privileges].
3535

3636
* _database-privilege_
3737
** `ACCESS` - allows access to a specific database or remote database alias.
@@ -73,7 +73,7 @@ This can be quite powerful as it allows permissions to be switched from one data
7373

7474
[NOTE]
7575
====
76-
The syntax descriptions use xref:access-control/index.adoc#access-control-syntax[the style] from access control.
76+
More details about the syntax descriptions can be found xref:administration/index.adoc#administration-syntax[here].
7777
====
7878

7979
.General grant +ON DATABASE+ privilege syntax
@@ -625,7 +625,7 @@ a|Rows: 6
625625

626626
[NOTE]
627627
====
628-
Note that `START` and `STOP` privileges are not included in the xref::access-control/database-administration.adoc#access-control-database-administration-all[`ALL DATABASE PRIVILEGES`].
628+
Note that `START` and `STOP` privileges are not included in the xref::administration/access-control/database-administration.adoc#access-control-database-administration-all[`ALL DATABASE PRIVILEGES`].
629629
====
630630

631631

@@ -970,7 +970,7 @@ GRANT [IMMUTABLE] TRANSACTION [MANAGEMENT] [( { * \| user[, ...] } )]
970970

971971
[NOTE]
972972
====
973-
Note that the `TRANSACTION MANAGEMENT` privileges are not included in the xref::access-control/database-administration.adoc#access-control-database-administration-all[`ALL DATABASE PRIVILEGES`].
973+
Note that the `TRANSACTION MANAGEMENT` privileges are not included in the xref::administration/access-control/database-administration.adoc#access-control-database-administration-all[`ALL DATABASE PRIVILEGES`].
974974
====
975975

976976
For example, to grant the role `regularUsers` the ability to list transactions for user `jake` on the database `neo4j`, use:

0 commit comments

Comments
 (0)