Skip to content

Fix broken links after testing #2333

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.

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
wants to merge 3 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion modules/ROOT/pages/authentication-authorization/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The configuration steps are described in xref:authentication-authorization/sso-i
*Custom-built plugin auth providers*::
A plugin option for building custom integrations.
It is recommended that this option is used as part of a custom delivery as negotiated with link:https://neo4j.com/professional-services/[Neo4j Professional Services].
For more information, see link:{neo4j-docs-base-uri}/java-reference/{page-version}/extending-neo4j/security-plugins#extending-neo4j-security-plugins[Java Reference -> Authentication and authorization plugins].
For more information, see link:{neo4j-docs-base-uri}/java-reference/{page-version}/extending-neo4j/security-plugins/[Java Reference -> Authentication and authorization plugins].

*Kerberos authentication and single sign-on*::
In addition to LDAP, native, and custom providers, Neo4j supports Kerberos for authentication and single sign-on.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -470,7 +470,7 @@ SET AUTH 'ldap' { SET ID 'cn=alice,ou=sales,dc=example,dc=com' }
You can verify that your LDAP configuration is correct, and that the LDAP server responds, by using the LDAP command-line tool `ldapsearch`.

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.
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.
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.

. Verify the authentication and authorization of a user.
For example, `john`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The elevated privileges only apply within the procedure or user-defined function
--
The steps below assume that the procedure or user-defined function is already developed and installed.

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


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ dbms.security.authorization_providers=oidc-newsso,oidc-oldsso,native
. Check connectivity.
Neo4j needs to connect to the identity provider to discover settings and fetch public keys to verify tokens.
Check firewall settings and security controls, and, if necessary, logs to ensure that the Neo4j server is able to connect to the identity provider using HTTPS.
If a proxy is required, this can be https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html#Proxies[configured] in the Java virtual machine using the configuration setting xref:configuration/configuration-settings.adoc#config_server.jvm.additional[server.jvm.additional].
If a proxy is required, this can be link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html#Proxies[configured] in the Java virtual machine using the configuration setting xref:configuration/configuration-settings.adoc#config_server.jvm.additional[server.jvm.additional].
Proxies that require credentials are not supported.

[[auth-sso-map-idp-roles]]
Expand Down
6 changes: 3 additions & 3 deletions modules/ROOT/pages/backup-restore/online-backup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ For more information, see xref:backup-restore/online-backup.adoc#online-backup-c

[NOTE]
====
`neo4j-admin database backup` is not supported in https://neo4j.com/cloud/aura/[Neo4j Aura].
`neo4j-admin database backup` is not supported in link:https://neo4j.com/cloud/aura/[Neo4j Aura].
====

[[backup-command-syntax]]
Expand Down Expand Up @@ -465,9 +465,9 @@ bin/neo4j-admin database backup --to-path=azb://myStorageAccount/myContainer/myD
[[diff-backup-as-parent]]
=== Perform a differential backup using the `--prefer-diff-as-parent` option

By default, a differential backup (`--type=DIFF`) uses the *most recent non-empty* backup -- whether full or differential -- in the directory as its parent.
By default, a differential backup (`--type=DIFF`) uses the *most recent non-empty* backup -- whether full or differential -- in the directory as its parent.

The `--prefer-diff-as-parent` option changes this behavior and forces the backup job to use the *latest differential* backup as the parent, even if a newer full backup exists.
The `--prefer-diff-as-parent` option changes this behavior and forces the backup job to use the *latest differential* backup as the parent, even if a newer full backup exists.

This approach allows you to maintain a chain of differential backups for all transactions and restore to any point in time.
Without this option, the transactions between the last full backup and a previous differential backup cannot be backed up as individual transactions.
Expand Down
10 changes: 5 additions & 5 deletions modules/ROOT/pages/cloud-deployments/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,23 @@ Neo4j's cloud marketplace listings represent a quick and easy way of getting sta

| Amazon Web Services
| xref:cloud-deployments/neo4j-aws.adoc[Neo4j on AWS]
| https://neo4j.com/partners/amazon/[Neo4j in the AWS Marketplace^]
| link:https://neo4j.com/partners/amazon/[Neo4j in the AWS Marketplace]

| Google Cloud
| Google Cloud
| xref:cloud-deployments/neo4j-gcp.adoc[Neo4j on Google Cloud Platform]
| https://neo4j.com/partners/google/[Neo4j in the GCP Marketplace^]
| link:https://neo4j.com/partners/google/[Neo4j in the GCP Marketplace]

| Microsoft Azure
| xref:cloud-deployments/neo4j-azure.adoc[Neo4j on Microsoft Azure]
| https://neo4j.com/partners/microsoft/[Neo4j in the Azure Marketplace^]
| link:https://neo4j.com/partners/microsoft/[Neo4j in the Azure Marketplace]

|===

.Other cloud deployment options
[TIP]
====
*Neo4j Aura* is a fully managed Neo4j database, hosted in the cloud and requires no installation.
For more information, see https://neo4j.com/aura/[the Aura product^], https://aura.support.neo4j.com/[support pages^], and the https://www.neo4j.com/docs/aura[Aura documentationˆ].
For more information, see link:https://neo4j.com/aura/[the Aura product], link:https://aura.support.neo4j.com/[support pages], and the link:https://www.neo4j.com/docs/aura[Aura documentation].

//Neo4j can be run in a *Docker* container.
//For information on running Neo4j on Docker, see xref:docker/index.adoc[Docker].
Expand Down
8 changes: 4 additions & 4 deletions modules/ROOT/pages/cloud-deployments/neo4j-aws.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Neo4j can be easily deployed on EC2 instances in Amazon Web Services (AWS) by using the link:https://aws.amazon.com/marketplace/seller-profile?id=23ec694a-d2af-4641-b4d3-b7201ab2f5f9[official listings for Neo4j] on the AWS Marketplace.

The AWS Marketplace listing uses a CloudFormation template maintained by Neo4j.
The template's code is available on link:https://github.com/neo4j-partners/amazon-cloud-formation-neo4j/tree/main/marketplace[GitHub^] and can be customized to meet more complex or bespoke use cases.
The template's code is available on link:https://github.com/neo4j-partners/amazon-cloud-formation-neo4j/tree/main/marketplace[GitHub] and can be customized to meet more complex or bespoke use cases.


[NOTE]
Expand All @@ -16,7 +16,7 @@ The Neo4j AWS Marketplace listings (and listings on GitHub) use CloudFormation t

== Supported Neo4j versions

The Neo4j link:https://aws.amazon.com/marketplace/seller-profile?id=23ec694a-d2af-4641-b4d3-b7201ab2f5f9[AWS marketplace listing^] can be configured to deploy either Neo4j Enterprise Edition 5 or 4.4.
The Neo4j link:https://aws.amazon.com/marketplace/seller-profile?id=23ec694a-d2af-4641-b4d3-b7201ab2f5f9[AWS marketplace listing] can be configured to deploy either Neo4j Enterprise Edition 5 or 4.4.
The CloudFormation template always installs the latest available version.

== Neo4j CloudFormation template
Expand All @@ -32,7 +32,7 @@ The Neo4j CloudFormation template takes several parameters as inputs, deploys a
=== Important considerations

* The deployment of cloud resources will incur costs.
** Refer to the link:https://calculator.aws/#[AWS pricing calculator^]for more information.
** Refer to the link:https://calculator.aws/#[AWS pricing calculator]for more information.

* The Neo4j CloudFormation template deploys a new VPC.
** AWS accounts are limited to an initial quota of 5 VPCs (you can view your current quota by viewing the *Limits* page of the Amazon EC2 console).
Expand Down Expand Up @@ -258,7 +258,7 @@ When deploying Neo4j, users are required to confirm that they either have an ent

If you require the Enterprise version of either Graph Data Science or Bloom, you need to provide a key issued by Neo4j as this will be required during the installation.

To obtain a valid license for either Neo4j, Bloom, or GDS, reach out to your Neo4j account representative or get in touch using the link:https://neo4j.com/contact-us/[contact form^].
To obtain a valid license for either Neo4j, Bloom, or GDS, reach out to your Neo4j account representative or get in touch using the link:https://neo4j.com/contact-us/[contact form].

== Delete CloudFormation Stack and destroy resources

Expand Down
8 changes: 4 additions & 4 deletions modules/ROOT/pages/cloud-deployments/neo4j-azure.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Neo4j can be easily deployed on Virtual Machine instances in Microsoft Azure by using the link:https://azuremarketplace.microsoft.com/en-us/marketplace/apps/neo4j.neo4j-ee?tab=Overview[official listing for Neo4j Enterprise] on the Azure Marketplace.

The Azure Marketplace listing uses an Azure Resource Manager (ARM) template maintained by Neo4j.
The template's code is available on link:https://github.com/neo4j-partners/azure-resource-manager-neo4j/tree/main/marketplace[GitHub^] and can be customized to meet more complex or bespoke use cases.
The template's code is available on link:https://github.com/neo4j-partners/azure-resource-manager-neo4j/tree/main/marketplace[GitHub] and can be customized to meet more complex or bespoke use cases.


[NOTE]
Expand All @@ -16,7 +16,7 @@ The Neo4j Azure Marketplace listings (and listings on GitHub) use Azure Resource

== Supported Neo4j versions

The Neo4j link:https://azuremarketplace.microsoft.com/en-us/marketplace/apps/neo4j.neo4j-ee?tab=Overview[Azure marketplace listing^] can be configured to deploy either Neo4j Enterprise Edition 5 or 4.4.
The Neo4j link:https://azuremarketplace.microsoft.com/en-us/marketplace/apps/neo4j.neo4j-ee?tab=Overview[Azure marketplace listing] can be configured to deploy either Neo4j Enterprise Edition 5 or 4.4.
The ARM template always installs the latest available version.

== Neo4j ARM template
Expand All @@ -28,7 +28,7 @@ The Neo4j ARM template takes several parameters as inputs, deploys a set of clou
=== Important considerations

* The deployment of cloud resources incurs costs.
** Refer to the link:https://azure.microsoft.com/en-gb/pricing/calculator/[Azure pricing calculator^]for more information.
** Refer to the link:https://azure.microsoft.com/en-gb/pricing/calculator/[Azure pricing calculator]for more information.

* You need to create a resource group.
** You need to choose an empty resource group or create a new one.
Expand Down Expand Up @@ -135,7 +135,7 @@ When deploying Neo4j, users are required to confirm that they either have an ent

If you require the Enterprise version of either Graph Data Science or Bloom, you need to provide a key issued by Neo4j as this will be required during the installation.

To obtain a valid license for either Neo4j, Bloom, or GDS, reach out to your Neo4j account representative or get in touch using the link:https://neo4j.com/contact-us/[contact form^].
To obtain a valid license for either Neo4j, Bloom, or GDS, reach out to your Neo4j account representative or get in touch using the link:https://neo4j.com/contact-us/[contact form].

== Delete Azure deployment Stack and destroy resources

Expand Down
10 changes: 5 additions & 5 deletions modules/ROOT/pages/cloud-deployments/neo4j-gcp.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
[[gcp]]
= Neo4j on GCP

Neo4j Edition can be easily deployed on Virtual Machines in Google Cloud Platform (GCP) by using the link:https://console.cloud.google.com/marketplace/product/neo4j/neo4j-enterprise-edition[official listing for Neo4j Enterprise Edition] or https://console.cloud.google.com/marketplace/product/neo4j/neo4j-community-edition?project=cohesive-point-368015[Neo4j Community Edition] on the GCP Marketplace].
Neo4j Edition can be easily deployed on Virtual Machines in Google Cloud Platform (GCP) by using the link:https://console.cloud.google.com/marketplace/product/neo4j/neo4j-enterprise-edition[official listing for Neo4j Enterprise Edition] or link:https://console.cloud.google.com/marketplace/product/neo4j/neo4j-community-edition?project=cohesive-point-368015[Neo4j Community Edition] on the GCP Marketplace].

The GCP Marketplace listing uses a Deployment Manager template maintained by Neo4j.
The template's code is available on link:https://github.com/neo4j-partners/google-deployment-manager-neo4j[GitHub^] and can be customized to meet more complex or bespoke use cases.
The template's code is available on link:https://github.com/neo4j-partners/google-deployment-manager-neo4j[GitHub] and can be customized to meet more complex or bespoke use cases.


[NOTE]
Expand All @@ -16,7 +16,7 @@ The Neo4j GCP Marketplace listings (and listings on GitHub) use Deployment Manag

== Supported Neo4j versions

The Neo4j link:https://console.cloud.google.com/marketplace/product/neo4j/neo4j-enterprise-edition[GCP marketplace listing^] can be configured to deploy either Neo4j Enterprise Edition 5, or 4.4, or Neo4j Community Edition 5.
The Neo4j link:https://console.cloud.google.com/marketplace/product/neo4j/neo4j-enterprise-edition[GCP marketplace listing] can be configured to deploy either Neo4j Enterprise Edition 5, or 4.4, or Neo4j Community Edition 5.
The Deployment Manager template always installs the latest available version.

== Neo4j Deployment Manager template
Expand All @@ -27,7 +27,7 @@ The Neo4j Deployment Manager template takes several parameters as inputs, deploy
=== Important considerations

* The deployment of cloud resources incurs costs.
** Refer to the link:https://cloud.google.com/products/calculator/[GCP pricing calculator^]for more information.
** Refer to the link:https://cloud.google.com/products/calculator/[GCP pricing calculator]for more information.

* The Neo4j Deployment Manager template deploys a new VPC, containing a single subnet based in the requested region.
** Unlike Azure and AWS where subnets are aligned to specific zones, GCP subnets are regional (and VPCs are global).
Expand Down Expand Up @@ -128,7 +128,7 @@ When deploying Neo4j, you are required to confirm that you either have an Enterp

If you require the Enterprise version of either Graph Data Science or Bloom, you need to provide a key issued by Neo4j as this is required during the installation.

To obtain a valid license for either Neo4j, Bloom, or GDS, reach out to your Neo4j account representative or get in touch using the link:https://neo4j.com/contact-us/[contact form^].
To obtain a valid license for either Neo4j, Bloom, or GDS, reach out to your Neo4j account representative or get in touch using the link:https://neo4j.com/contact-us/[contact form].

== Delete deployment and destroy resources

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Executing an operation and getting back a successful response means that the req
Servers can become aware the same operation at different times, since the `system` database is just another Raft group, where followers and replicas can lag behind the leader in some situations.
Eventually, the new state gets propagated to all healthy servers, and they take action on it.

If you want to be sure that each server has processed an administrative operation before running the next action, you can use the link:{neo4j-docs-base-uri}/cypher-manual/current/administration/databases/#administration-wait-nowait[`WAIT`] keyword.
If you want to be sure that each server has processed an administrative operation before running the next action, you can use the xref:database-administration/standard-databases/wait-options.adoc[`WAIT`] keyword.
`WAIT` makes the statement not return until all servers have seen the transaction, and their reconciler has finished processing it.

.Example of database creation with `WAIT`
Expand All @@ -40,6 +40,6 @@ For instance, some servers might be offline when a database is created, or a dis
In this situation, the operation has not _failed_ as a whole, since the database may even be running (although with less fault tolerance than you intended).

Some failed operations can just be re-tried: for example, `START DATABASE` can be re-run if not all members started successfully, and you think the cause of that has been resolved.
Other failures only require the underlying problem to be resolved.
Other failures only require the underlying problem to be resolved.
When the issue is fixed, the reconciler will make the intended change, because it is still trying to achieve the requested state.
For example, if a new server fails during a `DEALLOCATE DATABASES FROM SERVER` (meaning a database cannot be safely moved), fixing the new server should be enough to resolve the problem, as the new server will start its copy of the database as soon as the target is ready, allowing the deallocating server to shut down its copy.
10 changes: 5 additions & 5 deletions modules/ROOT/pages/clustering/setup/discovery.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -104,23 +104,23 @@ The configured server uses all the addresses from the SRV record to join or form
[[clustering-discovery-k8s]]
=== Discovery in Kubernetes

A special case is when a cluster is running in https://kubernetes.io/[Kubernetes^] and each server is running as a Kubernetes service.
Then, the addresses of the other servers can be obtained using the List Service API, as described in the https://kubernetes.io/docs/reference/kubernetes-api/[Kubernetes API documentation^].
A special case is when a cluster is running in link:https://kubernetes.io/[Kubernetes] and each server is running as a Kubernetes service.
Then, the addresses of the other servers can be obtained using the List Service API, as described in the link:https://kubernetes.io/docs/reference/kubernetes-api/[Kubernetes API documentation].

The following settings are used to configure for this scenario:

* Set `dbms.cluster.discovery.resolver_type=K8S`.
* Set `xref:configuration/configuration-settings.adoc#config_dbms.kubernetes.label_selector[dbms.kubernetes.label_selector]` to the label selector for the cluster services.
For more information, see the https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors[Kubernetes official documentation^].
For more information, see the link:https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors[Kubernetes official documentation].
* Set xref:configuration/configuration-settings.adoc#config_dbms.kubernetes.discovery.service_port_name[`dbms.kubernetes.discovery.service_port_name]` to the name of the service port used in the Kubernetes service definition for the Core's discovery port.
For more information, see the https://kubernetes.io/docs/reference/kubernetes-api/service-resources/service-v1/[Kubernetes official documentation^].
For more information, see the link:https://kubernetes.io/docs/reference/kubernetes-api/service-resources/service-v1/[Kubernetes official documentation].

With this configuration, `dbms.cluster.endpoints` is not used and any value assigned to it is ignored.

[NOTE]
====
* The pod running Neo4j must use a service account that has permission to list services.
For further information, see the Kubernetes documentation on https://kubernetes.io/docs/reference/access-authn-authz/rbac/[RBAC authorization^] or https://kubernetes.io/docs/reference/access-authn-authz/abac/[ABAC authorization^].
For further information, see the Kubernetes documentation on link:https://kubernetes.io/docs/reference/access-authn-authz/rbac/[RBAC authorization] or link:https://kubernetes.io/docs/reference/access-authn-authz/abac/[ABAC authorization].
* The configured `server.cluster.advertised_address` must exactly match the Kubernetes-internal DNS name, which is of the form `<service-name>.<namespace>.svc.cluster.local`.
====

Expand Down
Loading