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

Private link tutorial #490

Closed
wants to merge 24 commits into from
Closed

Private link tutorial #490

wants to merge 24 commits into from

Conversation

fiquick
Copy link
Contributor

@fiquick fiquick commented Oct 11, 2024

No description provided.

@fiquick
Copy link
Contributor Author

fiquick commented Oct 11, 2024

@fiquick fiquick requested a review from AlexicaWright October 11, 2024 15:43
@fiquick fiquick changed the title draft private link work Private link tutorial Oct 11, 2024
@AlexicaWright
Copy link
Collaborator

This contains useful information about how a private link works but that's not what a tutorial is nor is it what was requested on the Trello card. What was requested was a tutorial on how to set up a private link from the Aura console. This is described here: https://support.neo4j.com/s/article/Configuring-PrivateLink-on-Aura-Console-A-Step-by-Step-Guide and you can just rewrite those steps a little and make it suitable for the docs.

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 think this is quite ready for review, but since you asked, I've reviewed all the way to the end, but it looks like you will continue?
Please be mindful of we vs you as well as proper clustering terminology.

modules/ROOT/pages/tutorials/private-link.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/tutorials/private-link.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/tutorials/private-link.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/tutorials/private-link.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/tutorials/private-link.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/tutorials/private-link.adoc Outdated Show resolved Hide resolved
Comment on lines +70 to +75
And then there’s a trickier step, but it's the most important thing.
*The private DNS.*
You should configure this private DNS.
If you are using AWS, then AWS will create this private DNS for you.
For Google or Azure, you have to manually create this private DNS.
Add the Wildcard DNS entry *.production-orch-0000.neo4j.io and point it to the cloud IP endpoint.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This needs a rewrite.

It receives network packets, but doesn't open them and forwards them to the Neo4j private ingress via the private link.
However, the private ingress only accepts packets from a recognized FQDN.

For example, http://abcd1234-core-1.production-orch-0000.neo4j.io/
Copy link
Collaborator

Choose a reason for hiding this comment

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

Again with the core.

modules/ROOT/pages/tutorials/private-link.adoc Outdated Show resolved Hide resolved

Once the private ingress, private link, and private endpoint with the DNS entry are configured, the application will attempt to reach the IP address.

And then it will try to go and check the private link, like “hey, what is the private DNS address for this AFQDN?”
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is a work in progress, I assume?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, maybe it can say:

"Once the private ingress, private link, and private endpoint with the DNS entry are configured, the application will attempt to reach the IP address. Then it will check the private link, to check the private DNS address for the AFQDN.

Then the private DNS will tell the application to go to the IP address of the endpoint."

Thanks for all the feedback @AlexicaWright 🙌

@fiquick fiquick added the WIP label Oct 17, 2024
@fiquick
Copy link
Contributor Author

fiquick commented Oct 18, 2024

Doesn't have the step-by-step
But can keep this as a PR
This was requested a tutorial on this topic

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

@fiquick fiquick closed this Oct 25, 2024
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