Repository navigation
docs: add Network Load Balancer section - #157
Open
dlotterman wants to merge 9 commits into
Open
dlotterman wants to merge 9 commits into
dlotterman wants to merge 9 commits into
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
Add a top-level NLB section next to ALB for the Network Load Balancer early access: overview, listeners and routes, addresses and hostnames, health checks, traffic handling, operations, observability, troubleshooting, limits and quotas, and limitations and roadmap. The operations page walks through preparing a backend, creating an NLB, and connecting to it. Add a page for pointing a Datum DNS domain at an NLB. Every behaviour is checked against production NLBs: status conditions and their messages, UnsupportedCapability errors, quotas, health check timing, flow hashing, source address, the 1392-byte UDP payload limit, DNS publishing and withdrawal, and delete ordering. The backend, create and connect steps were followed verbatim in a fresh project. Update existing pages that said raw TCP and UDP exposure isn't available, link the NLB from the platform, gVPC, Compute and ALB pages, document UDP ports on network services, and point the NLB changelog entries at the new section. The October 30 entry said IPv4 was available; production refuses it, so it now says IPv4 isn't available yet.
Remove domain-dns/point-to-nlb and move its steps to the end of nlb/operations, where the NLB's other how-tos already live. Keep the concepts in nlb/addresses-and-hostnames and point the guides index and the DNS operations page at the new location.
# Conflicts: # changelog.mdx
Drop the Concepts group. No other category groups its pages that way, so list listeners and routes, addresses and hostnames, health checks, and traffic handling as regular pages in the NLB section.
Replace the Listeners and routes and Addresses and hostnames pages with one Configuration page, as other categories have. Move adding, changing, and removing a listener, and pointing your own domain at an NLB, from Operations to Configuration. Operations now covers preparing a backend, creating, checking, connecting to, and deleting an NLB.
The own-domain steps moved from NLB Operations to NLB Configuration.
- Configuration: open with one annotated manifest, drop the repeated YAML and status-field tables, and make Add a listener complete: the network service port, the address request and listener, and the route. - Operations: replace the inline Python echo server with socat from the netshoot image, say up front that testing from your own computer needs IPv6, and warn that an NLB publishes a port to the whole internet. - Health checks: say that leaving rotation doesn't drain an Instance. Its open TCP connections end within about 5 seconds. - Trim repeated early-access notes and status explanations. Tested in production: the Operations manifests word for word, adding a UDP listener with a TCP health port, and an Instance failing its check while it held an open connection (twice).
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a top-level NLB section next to ALB for the Network Load Balancer early access, plus a DNS page. It also updates the existing pages that still said raw TCP and UDP exposure isn't available. This supersedes #149.
New pages
nlb/:domain-dns/point-to-nlb.mdx:CNAME/ALIASrecords to an NLB hostname with Datum DNS.Changes to existing pages
How this was checked
Each behavior the pages describe was tested against production NLBs in throwaway projects, which are deleted:
UnsupportedCapabilityerrorThe operations steps for preparing a backend, creating an NLB, and connecting were then followed word for word in a fresh project.
mint broken-links --check-anchorsfinds no broken links in the new or changed pages. It still flags three#find-the-clients-ip-addresslinks inalb/request-handling.mdxandguides/alb-as-httpd.mdx, which are already broken onmainand untouched here.Worth confirming before merge
withdrawalPending. It istrueon healthy, serving addresses. The docs describe it as for Datum's own use.BackendClaimConflictmessage. It mentions "Galactic", an internal name:Galactic cannot return traffic to two NLB VIPs on one socket.datumctl nlb. The docs use manifests and the Cloud Portal only. network-services-operator#757 merged intocodex/nlb-plugin-base, which isn't onmain, and no PR is open to merge it.