Skip to content

Commit

Permalink
Replace labels with roles (#1473) (#1476)
Browse files Browse the repository at this point in the history
Using the new `role=label--` notation for roles/labels on headings and
block elements.
Cherry-picked from #1473

Co-authored-by: Neil Dewhurst <[email protected]>
  • Loading branch information
renetapopova and recrwplay authored Mar 8, 2024
1 parent b1adb6f commit ab29771
Show file tree
Hide file tree
Showing 21 changed files with 906 additions and 289 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -1913,11 +1913,10 @@ a|Rows: 2
======


[role=label--new-5.6]
[[access-control-dbms-administration-setting]]
== The DBMS `SETTING` privileges

_This feature was introduced in Neo4j 5.6._

The ability to show configuration settings can be granted via the `SHOW SETTING` privilege.
A role with this privilege is allowed to query the configuration settings matched by the <<access-control-name-globbing, name-globbing>>.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -195,11 +195,11 @@ The following image shows the hierarchy between different graph privileges:

image::privileges_hierarchy.svg[title="Graph privileges hierarchy"]


[role=label--new-5.9]
[[access-control-list-supported-privileges]]
== Listing supported privileges

_This feature was introduced in Neo4j 5.9._

Supported privileges can be displayed using the `SHOW SUPPORTED PRIVILEGES` command.
This lists the privileges that are possible to grant or deny on a server, together with the structure of the privilege.

Expand Down
22 changes: 12 additions & 10 deletions modules/ROOT/pages/authentication-authorization/manage-users.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,15 @@ When connected to the DBMS over `bolt`, administration commands are automaticall

There are two types of user states in the `system` database:

* `ACTIVE` state (default for new users):
`ACTIVE` state:: (default for new users)
Users can log into Neo4j and perform queries according to their privileges.

* `SUSPENDED` state label:enterprise-edition[]:
** Native users who authenticate and authorize against the system graph cannot log into Neo4j.
// [role=label--enterprise-edition]
`SUSPENDED` state label:enterprise-edition[]::

* Native users who authenticate and authorize against the system graph cannot log into Neo4j.
If suspended while using Neo4j, they lose all assigned roles with their privileges, including the `PUBLIC` role, until reactivated.
** Users who authenticate and authorize against an external ID provider (e.g., LDAP) can still log in.
* Users who authenticate and authorize against an external ID provider (e.g., LDAP) can still log in.
If suspended while using Neo4j, they retain the roles and the privileges assigned by the external provider, including the `PUBLIC` role.
To prevent any of these, you need to use the mechanisms of their identity provider.

Expand Down Expand Up @@ -341,9 +343,9 @@ GRANT DROP USER
|===


[NOTE]
[NOTE,role=label--enterprise-edition]
====
The `SHOW USER[S] PRIVILEGES` command is only available in Neo4j Enterprise Edition. label:enterprise-edition[]
The `SHOW USER[S] PRIVILEGES` command is only available in Neo4j Enterprise Edition.
====


Expand Down Expand Up @@ -622,9 +624,9 @@ SET STATUS ACTIVE
======

[NOTE]
[NOTE, role=label--enterprise-edition]
====
The `SET STATUS {ACTIVE | SUSPENDED}` and `SET HOME DATABASE` parts of the commands are only available in Neo4j Enterprise Edition. label:enterprise-edition[]
The `SET STATUS {ACTIVE | SUSPENDED}` and `SET HOME DATABASE` parts of the commands are only available in Neo4j Enterprise Edition.
====

The `CREATE USER` command is optionally idempotent, with the default behavior to throw an exception if the user already exists.
Expand Down Expand Up @@ -775,9 +777,9 @@ When altering a user, it is only necessary to specify the changes required.
For example, leaving out the `CHANGE [NOT] REQUIRED` part of the query will leave that unchanged.
====

[NOTE]
[NOTE, role=label--enterprise-edition]
====
The `SET STATUS {ACTIVE | SUSPENDED}`, `SET HOME DATABASE`, and `REMOVE HOME DATABASE` parts of the command are only available in Neo4j Enterprise Edition. label:enterprise-edition[]
The `SET STATUS {ACTIVE | SUSPENDED}`, `SET HOME DATABASE`, and `REMOVE HOME DATABASE` parts of the command are only available in Neo4j Enterprise Edition.
====

The changes to the user will appear on the list provided by `SHOW USERS`:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,9 +109,9 @@ Alternatively, log into Neo4j Browser.
$ bin/cypher-shell -d system
----
+
[NOTE]
[NOTE, role=label--cluster]
====
label:Cluster[] If you have specified a non-default port for your `bolt` connector, add `-a neo4j://<your-cluster-member>:<non-default-bolt-port>` to the `cypher-shell` command to be able to connect to your cluster member.
If you have specified a non-default port for your `bolt` connector, add `-a neo4j://<your-cluster-member>:<non-default-bolt-port>` to the `cypher-shell` command to be able to connect to your cluster member.
====
. Set a new password for the admin user.
In this example, the admin user is named `neo4j`.
Expand Down Expand Up @@ -147,9 +147,9 @@ Alternatively, log into Neo4j Browser.
$ bin/cypher-shell -d system
----
+
[NOTE]
[NOTE, role=label--cluster]
====
label:Cluster[] If you have specified a non-default port for your `bolt` connector, add `-a neo4j://<your-cluster-member>:<non-default-bolt-port>` to the `cypher-shell` command to be able to connect to your cluster member.
If you have specified a non-default port for your `bolt` connector, add `-a neo4j://<your-cluster-member>:<non-default-bolt-port>` to the `cypher-shell` command to be able to connect to your cluster member.
====
. Grant the admin user role to an existing user.
In this example, the user is named `neo4j`.
Expand Down Expand Up @@ -185,9 +185,10 @@ Alternatively, log into Neo4j Browser.
$ bin/cypher-shell -d system
----
+
[role=label--cluster]
[NOTE]
====
label:Cluster[] If you have specified a non-default port for your `bolt` connector, add `-a neo4j://<your-cluster-member>:<non-default-bolt-port>` to the `cypher-shell` command to be able to connect to your cluster member.
If you have specified a non-default port for your `bolt` connector, add `-a neo4j://<your-cluster-member>:<non-default-bolt-port>` to the `cypher-shell` command to be able to connect to your cluster member.
====
. Recreate the admin role with its original capabilities.
+
Expand Down
6 changes: 5 additions & 1 deletion modules/ROOT/pages/cloud-deployments/neo4j-aws.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -126,13 +126,17 @@ After the installation finishes successfully, the CloudFormation template provid

|===


== Cluster version consistency

When the CloudFormation template creates a new Neo4j cluster, an Auto Scaling group (ASG) is created and tagged with the minor version of the installed Neo4j database.
If you add more EC2 instances to your ASG, they will be installed with the same minor version, ensuring that all Neo4j cluster servers are installed with the same version, regardless of when the EC2 instances were created.


[role=label--enterprise-edition]
== Licensing
label:Enterprise[]

// label:Enterprise[]

Installing and starting Neo4j from the AWS marketplace constitutes an acceptance of the Neo4j license agreement.
When deploying Neo4j, users are required to confirm that they either have an enterprise license or accept the terms of the Neo4j evaluation license.
Expand Down
5 changes: 4 additions & 1 deletion modules/ROOT/pages/cloud-deployments/neo4j-azure.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -125,8 +125,11 @@ If the validation fails, it might be because you have chosen VMs that are too la
When the ARM template creates a new Neo4j cluster, a Virtual Machine Scale Set (VMSS) is created and tagged with the minor version of the installed Neo4j database.
If you add more VM instances to your VMSS, they will be installed using the same minor version, ensuring that all Neo4j cluster servers are installed with the same version, regardless of when the VM instances were created.


[role=label--enterprise-edition]
== Licensing
label:Enterprise[]

// label:Enterprise[]

Installing and starting Neo4j from the Azure marketplace constitutes an acceptance of the Neo4j license agreement.
When deploying Neo4j, users are required to confirm that they either have an enterprise license.
Expand Down
5 changes: 4 additions & 1 deletion modules/ROOT/pages/cloud-deployments/neo4j-gcp.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,11 @@ After the installation finishes successfully, the Deployment Manager template pr
The Neo4j Browser can be easily launched in a new window by clicking the button entitled *Log into the Neo4j Browser*.
====


[role=label--enterprise-edition]
== Licensing
label:Enterprise[]

// label:Enterprise[]

Installing and starting Neo4j from the GCP marketplace constitutes an acceptance of the Neo4j license agreement.
When deploying Neo4j, you are required to confirm that you either have an Enterprise license or accept the terms of the Neo4j evaluation license.
Expand Down
3 changes: 2 additions & 1 deletion modules/ROOT/pages/clustering/servers.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,8 @@ When a server is no longer needed, it cannot be removed from the cluster while i
The command `DEALLOCATE DATABASE[S] FROM SERVER[S] _server_[,...]` is used to transition servers to the _Deallocating_ state, reallocating all their hosted databases to other servers in the cluster.
Additionally, servers which are deallocating will not have any further databases allocated to them.

=== Deallocated state label:new[Introduced in 5.15]
[role=label--new-5.15]
=== Deallocated state

When a server is in the deallocated state it no longer hosts any databases any databases besides system and can be removed from the cluster.
Additionally, deallocated servers cannot have any further databases allocated to them.
Expand Down
Loading

0 comments on commit ab29771

Please sign in to comment.