Skip to content
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

Disabling network access #536

Merged
merged 23 commits into from
Dec 18, 2024
Merged

Disabling network access #536

merged 23 commits into from
Dec 18, 2024

Conversation

fiquick
Copy link
Contributor

@fiquick fiquick commented Nov 19, 2024

No description provided.

@fiquick fiquick added the WIP label Nov 19, 2024
@fiquick fiquick changed the title network access Disabling network access Nov 19, 2024
@fiquick
Copy link
Contributor Author

fiquick commented Nov 20, 2024


The Aura Console runs in a separate VPC, separate from the rest of Aura.
An Aura instance can be publicly available, completely private, or configured to allow both public and private access.
To configure network access, you need to be authorized to access the part of [your system's?] infrastructure that runs and handles these instances as well as the networking used to establish secure connections between the database and the application's VPC. This includes the ability to connect over the cloud provider's private link and private endpoint.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@AlexicaWright do you think the original writer meant authorized access to the "customer insfrastructure", "Aura infrastructure" or both?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

User=customer, we speak directly to the user. I think what is meant is that in order to configure access, you need access to either the console, or whatever equivalent the user has in their setup.

. Create a VPC endpoint
. Accept endpoint connection requests and enable private DNS in the cloud provider's console
. Disable public traffic (optional).
If you disable public traffic it is highly recommended to link:https://support.neo4j.com/s/article/13174783967507-How-To-Test-Connectivity-Through-The-Private-Endpoint[Test Connectivity Through The Private Endpoint]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was wondering, if I should put the steps in here? They are available in a KB and it's a major pain point that customer's are not checking their connectivity.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There should not be a link to a Support article. If the information there is needed, better to lift it from there and put it here somewhere.


.Network access visual
[.shadow]
image::network_access.png[]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The shield icon is a bit wonky in UPX designs.

@@ -65,7 +93,7 @@ Aura VPCs can't initiate connections back to your VPCs.
==== Browser and Bloom access over private endpoints

To connect to your instance via Browser or Bloom, you must use a dedicated VPN.
This is because when you disable public access to your instance, this applies to all connections, including those from your computer when using Browser or Bloom.
This is because when you xref:[disable public access] to your instance, this applies to all connections, including those from your computer when using Browser or Bloom.
Copy link
Contributor Author

@fiquick fiquick Nov 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think I should link to the disabling public access section here, and in the xrefs below?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, why not? I think it would be helpful.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You'll need to insert the xref here.

Copy link
Collaborator

@AlexicaWright AlexicaWright left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know about the image though.


The Aura Console runs in a separate VPC, separate from the rest of Aura.
An Aura instance can be publicly available, completely private, or configured to allow both public and private access.
To configure network access, you need to be authorized to access the part of [your system's?] infrastructure that runs and handles these instances as well as the networking used to establish secure connections between the database and the application's VPC. This includes the ability to connect over the cloud provider's private link and private endpoint.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

User=customer, we speak directly to the user. I think what is meant is that in order to configure access, you need access to either the console, or whatever equivalent the user has in their setup.

. Create a VPC endpoint
. Accept endpoint connection requests and enable private DNS in the cloud provider's console
. Disable public traffic (optional).
If you disable public traffic it is highly recommended to link:https://support.neo4j.com/s/article/13174783967507-How-To-Test-Connectivity-Through-The-Private-Endpoint[Test Connectivity Through The Private Endpoint]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There should not be a link to a Support article. If the information there is needed, better to lift it from there and put it here somewhere.

@@ -65,7 +93,7 @@ Aura VPCs can't initiate connections back to your VPCs.
==== Browser and Bloom access over private endpoints

To connect to your instance via Browser or Bloom, you must use a dedicated VPN.
This is because when you disable public access to your instance, this applies to all connections, including those from your computer when using Browser or Bloom.
This is because when you xref:[disable public access] to your instance, this applies to all connections, including those from your computer when using Browser or Bloom.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, why not? I think it would be helpful.

@fiquick
Copy link
Contributor Author

fiquick commented Dec 17, 2024

Hi Jessica, what do you reckon, do you think this in a fit state to merge?

Copy link
Collaborator

@AlexicaWright AlexicaWright left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few suggestions.

@@ -65,7 +93,7 @@ Aura VPCs can't initiate connections back to your VPCs.
==== Browser and Bloom access over private endpoints

To connect to your instance via Browser or Bloom, you must use a dedicated VPN.
This is because when you disable public access to your instance, this applies to all connections, including those from your computer when using Browser or Bloom.
This is because when you xref:[disable public access] to your instance, this applies to all connections, including those from your computer when using Browser or Bloom.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You'll need to insert the xref here.

fiquick and others added 5 commits December 18, 2024 14:37
Co-authored-by: Jessica Wright <49636617+AlexicaWright@users.noreply.github.com>
Co-authored-by: Jessica Wright <49636617+AlexicaWright@users.noreply.github.com>
Co-authored-by: Jessica Wright <49636617+AlexicaWright@users.noreply.github.com>
Co-authored-by: Jessica Wright <49636617+AlexicaWright@users.noreply.github.com>
Co-authored-by: Jessica Wright <49636617+AlexicaWright@users.noreply.github.com>
@neo-technology-commit-status-publisher
Copy link
Collaborator

Thanks for the documentation updates.

The preview documentation has now been torn down - reopening this PR will republish it.

@neo-technology-commit-status-publisher
Copy link
Collaborator

This PR includes documentation updates
View the updated docs at https://neo4j-docs-aura-536.surge.sh

Updated pages:

@fiquick fiquick merged commit 2beed90 into main Dec 18, 2024
4 checks passed
@fiquick fiquick deleted the networkaccesswizard branch December 18, 2024 13:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants