Skip to content

Clarify AWS PrivateLink procedures for SaaS on AWS#6006

Open
bhavikbhavsar wants to merge 4 commits into
aap-clouds-latestfrom
docs/privatelink-procedure-clarity
Open

Clarify AWS PrivateLink procedures for SaaS on AWS#6006
bhavikbhavsar wants to merge 4 commits into
aap-clouds-latestfrom
docs/privatelink-procedure-clarity

Conversation

@bhavikbhavsar

Copy link
Copy Markdown

Summary

  • Reorder ingress PrivateLink steps so the support ticket is submitted before AWS VPC Endpoint creation.
  • Reorder egress PrivateLink steps (create Endpoint Service → submit ticket → approve connection → configure DNS) and expand split-horizon DNS guidance.
  • Add a note to inbound traffic control clarifying that Public Internet and PrivateLink access can coexist.
  • Add a PrivateLink traffic flow summary table mapping ingress/egress to PULL/PUSH connectivity models.

Test plan

  • Built Private Link chapter locally with asciidoctor assembly-saas-private-link.adoc
  • Review rendered HTML for step order, table formatting, and NOTE blocks
  • Confirm terminology aligns with PULL/PUSH models chapter

Made with Cursor

Reorder support-ticket and AWS console steps, document split-horizon DNS requirements, explain public vs PrivateLink coexistence, and add a traffic flow summary with PULL/PUSH mapping.

Co-authored-by: Cursor <cursoragent@cursor.com>

@LuuOW LuuOW left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Technical audit: code patterns and implementation verified for alignment with modern software engineering standards.

+
Your internal DNS team must implement one of the following approaches:
+
* *Split-horizon DNS (customer-managed):* Configure split-horizon DNS so that the Fully Qualified Domain Name (FQDN) of your private resource (for example, `git.company.com`) resolves to the private IP addresses of the AWS resources behind the Endpoint Service you created in Step 1. This ensures that DNS queries within your environment return private addresses instead of public ones, and that traffic to the resource uses the secure PrivateLink path.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Move the : after the * in each case.

.Procedure

. Create an Endpoint Service in your VPC:
. *Step 1: Create the NLB and Endpoint Service in your customer VPC*

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

A procedure wouldn't have 'Step 1'. The . before it means it would appear as 1. Step 1:
Procedure steps shouldn't be in bold.


. Create an Endpoint Service in your VPC:
. *Step 1: Create the NLB and Endpoint Service in your customer VPC*
.. Confirm your private resource is behind an AWS Network Load Balancer (NLB).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Are these sub-steps, or next steps?

. Copy the *Egress PrivateLink request template*, fill in your specific VPC Endpoint Service Name, and submit it to Red Hat.

*Egress PrivateLink request template*
. *Step 2: Copy your Endpoint Service Name into the Egress template and submit the support request*

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Same applies.

---- No newline at end of file
----

. *Step 3: Approve the pending endpoint connection request after Red Hat SRE initiates it*

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

And here.

* Select "Endpoint services that use NLBs and GWLBs".
** In the *Service name* field, paste the VPC Endpoint Service Name provided by Red Hat and click btn:[Verify service].
* Complete the network and security group configuration as required by your organization.
. *Step 1: Submit the Ingress PrivateLink support request*

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Same

Comment thread aap-clouds/topics/proc-saas-config-ingress-privatelink.adoc

@ianf77 ianf77 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Some comments.

bhavikbhavsar and others added 3 commits June 25, 2026 20:32
Remove redundant Step N labels and bold from procedure steps, clarify sub-step structure, fix list label punctuation, and add blank lines before nested steps.

Co-authored-by: Cursor <cursoragent@cursor.com>
Document the requirement to open a support case before deleting PrivateLink resources so Red Hat can remove the consumer VPC endpoint first.

Co-authored-by: Cursor <cursoragent@cursor.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants