Skip to content

Commit 6899d05

Browse files
authored
Merge branch '4.4' into 4.4-update-version
2 parents d09bb4e + 6aba89c commit 6899d05

File tree

92 files changed

+335
-1043
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

92 files changed

+335
-1043
lines changed

.github/workflows/docs-branch-checks.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,24 +30,24 @@ jobs:
3030
docs-build:
3131
if: ${{ inputs.html || github.event_name == 'push' }}
3232
name: Generate HTML
33-
uses: neo4j/docs-tools/.github/workflows/reusable-docs-build.yml@v1.0.3
33+
uses: neo4j/docs-tools/.github/workflows/reusable-docs-build.yml@v1.2.0
3434
with:
3535
retain-artifacts: 14
3636
deploy-id: 0
3737

3838
docs-verify:
3939
name: Verify HTML
4040
needs: docs-build
41-
uses: neo4j/docs-tools/.github/workflows/reusable-docs-verify.yml@v1.0.3
41+
uses: neo4j/docs-tools/.github/workflows/reusable-docs-verify.yml@v1.2.0
4242

4343
docs-links:
4444
if: ${{ inputs.links || github.event_name == 'push' }}
4545
name: Check links
4646
needs: docs-build
47-
uses: neo4j/docs-tools/.github/workflows/reusable-docs-links.yml@v1.0.3
47+
uses: neo4j/docs-tools/.github/workflows/reusable-docs-links.yml@v1.2.0
4848

4949
docs-lint:
5050
if: ${{ inputs.lint || github.event_name == 'push' }}
5151
name: Lint docs
52-
uses: neo4j/docs-tools/.github/workflows/reusable-docs-lint.yml@v1.0.3
52+
uses: neo4j/docs-tools/.github/workflows/reusable-docs-lint.yml@v1.2.0
5353

.github/workflows/docs-pr-checks.yml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@ name: "Verify docs PR"
44
on:
55
pull_request:
66
branches:
7-
- "dev"
8-
- "5.x"
9-
- "4.[0-9]"
10-
- "3.5"
7+
- 'dev'
8+
- 'main'
9+
- '5.x'
10+
- '4.4'
1111

1212
jobs:
1313

1414
# Generate HTML
1515
docs-build-pr:
16-
uses: neo4j/docs-tools/.github/workflows/reusable-docs-build.yml@v1.1.2
16+
uses: neo4j/docs-tools/.github/workflows/reusable-docs-build.yml@v1.2.0
1717
with:
1818
deploy-id: ${{ github.event.number }}
1919
retain-artifacts: 14
@@ -23,7 +23,7 @@ jobs:
2323
# By default, the job fails if there are errors, passes if there are warnings only.
2424
docs-verify-pr:
2525
needs: docs-build-pr
26-
uses: neo4j/docs-tools/.github/workflows/reusable-docs-verify.yml@v1.1.2
26+
uses: neo4j/docs-tools/.github/workflows/reusable-docs-verify.yml@v1.2.0
2727
with:
2828
failOnWarnings: true
2929

@@ -40,7 +40,7 @@ jobs:
4040
steps:
4141
- name: Get file changes
4242
id: get-file-changes
43-
uses: tj-actions/changed-files@cbda684547adc8c052d50711417fa61b428a9f88 # v41.1.2
43+
uses: tj-actions/changed-files@2f7c5bfce28377bc069a65ba478de0a74aa0ca32 # v46.0.1
4444
with:
4545
separator: ','
4646
files_yaml: |
@@ -55,7 +55,7 @@ jobs:
5555
docs-updates-comment-pr:
5656
if: needs.docs-build-pr.outputs.pages-listed == 'success'
5757
needs: [docs-build-pr, docs-changes-pr]
58-
uses: neo4j/docs-tools/.github/workflows/reusable-docs-pr-changes.yml@v1.1.2
58+
uses: neo4j/docs-tools/.github/workflows/reusable-docs-pr-changes.yml@v1.2.0
5959
with:
6060
pages-modified: ${{ needs.docs-changes-pr.outputs.pages-modified }}
6161
pages-added: ${{ needs.docs-changes-pr.outputs.pages-added }}

.github/workflows/docs-teardown.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ name: "Documentation Teardown"
44
on:
55
pull_request_target:
66
branches:
7-
- "dev"
8-
- "5.x"
9-
- "4.[0-9]"
10-
- "3.5"
7+
- 'dev'
8+
- 'main'
9+
- '5.x'
10+
- '4.4'
1111
types:
1212
- closed
1313

antora.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ asciidoc:
99
neo4j-version: '4.4'
1010
neo4j-version-exact: '4.4.46'
1111
neo4j-buildnumber: '4.4'
12-
neo4j-debian-package-version: 1:4.4.46@
12+
neo4j-debian-package-version: 1:4.4.46@

modules/ROOT/content-nav.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,6 @@
6969
*** xref:kubernetes/operations/scaling.adoc[]
7070
*** xref:kubernetes/operations/image-pull-secret.adoc[]
7171
*** xref:kubernetes/operations/assign-neo4j-pods.adoc[]
72-
** Deploy a multi-data center Neo4j cluster
73-
*** xref:kubernetes/multi-dc-cluster/aks.adoc[]
7472
** xref:kubernetes/troubleshooting.adoc[]
7573
7674
* xref:configuration/index.adoc[]
-800 KB
Binary file not shown.

modules/ROOT/pages/authentication-authorization/access-control.adoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
[role=enterprise-edition]
22
[[auth-access-control]]
33
= Fine-grained access control
4-
:description: Describes an example that illustrates various aspects of security and fine-grained access control.
4+
:description: Describes an example that illustrates various aspects of security and fine-grained access control.
55

66
When creating a database, administrators may want to establish which users have the ability to access certain information.
77

8-
As described in xref:authentication-authorization/built-in-roles/auth-built-in-roles[Built-in roles], Neo4j already offers preset roles configured to specific permissions (i.e. read, edit, or write).
8+
As described in xref:authentication-authorization/built-in-roles.adoc[Built-in roles], Neo4j already offers preset roles configured to specific permissions (i.e. read, edit, or write).
99
While these built-in roles cover many common daily scenarios, it is also possible to create custom roles for specific needs.
1010

1111
This page contains an example that illustrates various aspects of security and fine-grained access control.
@@ -35,7 +35,7 @@ They can be described using the properties:
3535
* `description`
3636

3737
`(:Disease)`::
38-
Known illnesses mapped in a catalog found in the database.
38+
Known illnesses mapped in a catalog found in the database.
3939
They can be described using the properties:
4040
+
4141
* `name`
@@ -85,7 +85,7 @@ This allows users to be created entirely within the database security model, a s
8585
For more information, see link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/administration/access-control/[Cypher Manual -> Access control].
8686

8787
The following examples show two different approaches to using Neo4j security features to support the _healthcare_ database application.
88-
The first approach uses xref:authentication-authorization/built-in-roles/auth-built-in-roles[Built-in roles], whereas the second uses more advanced resources with fine-grained privileges for <<auth-access-control-using-privileges, sub-graph access control>>.
88+
The first approach uses xref:authentication-authorization/built-in-roles.adoc[Built-in roles], whereas the second uses more advanced resources with fine-grained privileges for <<auth-access-control-using-privileges, sub-graph access control>>.
8989

9090
In this example, consider five users of the _healthcare_ database:
9191

@@ -122,13 +122,13 @@ Neo4j comes with built-in roles that cover a number of common needs:
122122
* `architect` - Has all the capabilities of the publisher as well as the ability to manage indexes and constraints.
123123
* `admin` - Can perform architect actions as well as manage databases, users, roles, and privileges.
124124

125-
Consider Charlie from the example of users.
125+
Consider Charlie from the example of users.
126126
As a researcher, they do not need write access to the database, so they are assigned the `reader` role.
127127

128-
On the other hand, Alice (the doctor), Daniel (the nurse), and Bob (the receptionist) all need to update the database with new patient information, but do not need to expand the schema with new labels, relationship types, property names or indexes.
128+
On the other hand, Alice (the doctor), Daniel (the nurse), and Bob (the receptionist) all need to update the database with new patient information, but do not need to expand the schema with new labels, relationship types, property names or indexes.
129129
For this reason, they are all assigned the `editor` role.
130130

131-
Tina, the IT administrator who installs and manages the database, needs to be assigned the `admin` role.
131+
Tina, the IT administrator who installs and manages the database, needs to be assigned the `admin` role.
132132

133133
Here is how to grant roles to the users:
134134

@@ -171,11 +171,11 @@ Has the permission to save _diagnoses_ to the database, but not expand the schem
171171
Receptionist::
172172
Should be able to read and write all patient data, but not be able to see the symptoms, diseases, or diagnoses.
173173
Researcher::
174-
Should be able to perform statistical analysis of all data, except patients’ personal information, to which they should have restricted access.
174+
Should be able to perform statistical analysis of all data, except patients’ personal information, to which they should have restricted access.
175175
To illustrate two different ways of setting up the same effective privileges, two roles are created for comparison.
176176
Nurse::
177177
Should be able to perform all tasks that both the doctor and the receptionist can do.
178-
Granting both roles (doctor and receptionist) to the nurse does not work as expected.
178+
Granting both roles (doctor and receptionist) to the nurse does not work as expected.
179179
This is explained in the section dedicated to the creation of the `nurse` role.
180180
Junior nurse::
181181
While the senior nurse is able to save diagnoses just as a doctor can, some (junior) nurses might not be allowed to do that.
@@ -679,7 +679,7 @@ RETURN n.name, n.ssn, n.address, n.dateOfBirth;
679679

680680
[[detach-delete-restricted-user]]
681681

682-
With the `receptionist` role, Bob can delete any new patient nodes they have just created, but they are not able to delete patients that have already received diagnoses since those are connected to parts of the graph that Bob cannot see.
682+
With the `receptionist` role, Bob can delete any new patient nodes they have just created, but they are not able to delete patients that have already received diagnoses since those are connected to parts of the graph that Bob cannot see.
683683
Here is a demonstration of both scenarios:
684684

685685
[source, cypher]

modules/ROOT/pages/authentication-authorization/introduction.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
[role=enterprise-edition]
22
[[auth-introduction]]
33
= Introduction
4-
:description: This page provides an overview of authentication and authorization in Neo4j.
4+
:description: This page provides an overview of authentication and authorization in Neo4j.
55

6-
This page provides an overview of authentication and authorization in Neo4j.
6+
This page provides an overview of authentication and authorization in Neo4j.
77
Authorization is managed using role-based access control (_RBAC_).
88
Permissions that define access control are assigned to roles, which are in turn assigned to users.
99

@@ -39,7 +39,7 @@ Neo4j supports the popular OpenID Connect mechanism for integrating with identit
3939
*Custom-built plugin auth providers*::
4040
For clients with specific requirements not satisfied with either native or LDAP, Neo4j provides a plugin option for building custom integrations.
4141
It is recommended that this option is used as part of a custom delivery as negotiated with Neo4j Professional Services.
42-
The plugin is described in link:{neo4j-docs-base-uri}/java-reference/{page-version}/extending-neo4j/security-plugins#extending-neo4j-security-plugins[Java Reference -> Authentication and authorization plugins].
42+
The plugin is described in link:{neo4j-docs-base-uri}/java-reference/{page-version}/extending-neo4j/security-plugins[Java Reference -> Authentication and authorization plugins].
4343

4444

4545
*Kerberos authentication and single sign-on*::

modules/ROOT/pages/authentication-authorization/ldap-integration.adoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[role=enterprise-edition]
22
[[auth-ldap-integration]]
33
= Integration with LDAP directory services
4-
:description: This page describes Neo4j support for integrating with LDAP systems.
4+
:description: This page describes Neo4j support for integrating with LDAP systems.
55

66
This page describes Neo4j support for integrating with LDAP systems.
77
The following topics are covered:
@@ -108,8 +108,9 @@ dbms.security.authorization_providers=ldap,native
108108

109109
To access the user and role management procedures, you have to map the LDAP groups to the xref:authentication-authorization/built-in-roles.adoc[Neo4j built-in] and custom-defined roles.
110110
To do that, you need to know what privileges the Neo4j roles have, and based on these privileges, to create the mapping to the groups defined in the LDAP server.
111-
The map must be formatted as a semicolon separated list of key-value pairs, where the key is a comma-separated list of the LDAP group names and the value is a comma-separated list of the corresponding role names.
112-
For example, `group1=role1;group2=role2;group3=role3,role4,role5;group4,group5=role6`.
111+
The map must be formatted as a semicolon separated list of key-value pairs, where the key is a LDAP group name and the value is a comma-separated list of the corresponding role names.
112+
113+
For example, `group1=role1;group2=role2;group3=role3,role4,role5;group4=role6;group5=role6`.
113114

114115
.Example of LDAP groups to Neo4j roles mapping
115116
====
@@ -305,7 +306,7 @@ For more information, see xref:authentication-authorization/ldap-integration.ado
305306
You can verify that your LDAP configuration is correct, and that the LDAP server responds, by using the LDAP command-line tool `ldapsearch`.
306307

307308
The `ldapsearch` command accepts the LDAP configuration setting values as input and verifies both the authentication (using the `simple` mechanism) and authorization of a user.
308-
See the https://docs.ldap.com/ldap-sdk/docs/tool-usages/ldapsearch.html[ldapsearch official documentation^] for more advanced usage and how to use SASL authentication mechanisms.
309+
See the link:https://docs.ldap.com/ldap-sdk/docs/tool-usages/ldapsearch.html[ldapsearch official documentation] for more advanced usage and how to use SASL authentication mechanisms.
309310

310311
. Verify the authentication and authorization of a user.
311312
For example, `john`.

modules/ROOT/pages/authentication-authorization/manage-execute-permissions.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[role=enterprise-edition]
22
[[auth-manage-execute-permissions]]
33
= Manage procedure and user-defined function permissions
4-
:description: This section describes how access control works with procedures and user-defined functions in Neo4j.
4+
:description: This section describes how access control works with procedures and user-defined functions in Neo4j.
55

66
To be able to run a procedure or user-defined function, the user needs to have the corresponding execute privilege.
77
Procedures and user-defined functions are executed according to the same security rules as regular Cypher statements,
@@ -15,7 +15,7 @@ The elevated privileges only apply within the procedure or user-defined function
1515
--
1616
The steps below assume that the procedure or user-defined function is already developed and installed.
1717

18-
Please refer to link:{neo4j-docs-base-uri}/java-reference/{page-version}/extending-neo4j#extending-neo4j[Java Reference -> Extending Neo4j] for a description on creating and using user-defined procedures and functions.
18+
Please refer to link:{neo4j-docs-base-uri}/java-reference/{page-version}/extending-neo4j[Java Reference -> Extending Neo4j] for a description on creating and using user-defined procedures and functions.
1919
--
2020

2121

0 commit comments

Comments
 (0)