Skip to content

Document how to increase the Uplink tunnel limit - #39

Open
welteki wants to merge 1 commit into
inlets:masterfrom
welteki:document-uplink-tunnel-limit
Open

welteki wants to merge 1 commit into
inlets:masterfrom
welteki:document-uplink-tunnel-limit

Conversation

@welteki

@welteki welteki commented Oct 30, 2026

Copy link
Copy Markdown
Member

Description

Document how to request a higher Uplink tunnel license limit by email.
Link to the Billing Management API for approved automated capacity management.

Motivation and Context

Users reaching their licensed tunnel limit need clear instructions for
requesting more capacity.

  • I have raised an issue to propose this change (required)

How Has This Been Tested?

Ran git diff --check and verified the added links and troubleshooting
anchor. A rendered build was not run because MkDocs is not installed.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I've read the CONTRIBUTION guide
  • I have signed-off my commits with git commit -s

Users reaching their licensed tunnel limit need a clear way to request
more capacity. Direct them to email the inlets team and link the billing
API for approved automated capacity management.

Signed-off-by: Han Verstraete (OpenFaaS Ltd) <han@openfaas.com>
@reviewfn

reviewfn Bot commented Oct 30, 2026

Copy link
Copy Markdown

AI Pull Request Overview

Disclaimer: This review was generated by automated AI and may contain errors. Do not trust its outputs without human verification.

Summary

  • Documents the email path for requesting a higher Inlets Uplink tunnel limit.
  • Links tunnel-limit troubleshooting to the approved Billing Management API workflow.
  • Adds a direct troubleshooting anchor from the tunnel-server common-issues list.
  • The new links and MkDocs admonition use formats already supported by the site configuration.
  • New commits must not contain AI authorship indicators; the scoped commit complies with this policy.

Approval rating (1-10)

9/10. The focused documentation change is clear, discoverable from troubleshooting, and consistent with the existing billing API access requirements.

Summary per file

Summary per file
File path Summary
docs/uplink/billing-management-api.md Adds email guidance for manual capacity increases and distinguishes approved API automation.
docs/uplink/troubleshooting.md Adds tunnel-limit remediation instructions and links to the Billing Management API.

Overall Assessment

The change is ready to merge. It closes a practical gap for users who encounter the licensed tunnel limit, provides both manual and automated paths without conflating their access requirements, and introduces no evident rendering or navigation regression.

Detailed Review

Detailed Review

Content review

No blocking findings.

  • The title and scope of each existing page remain aligned with the additions: troubleshooting supplies the immediate remedy, while the API page clarifies the alternative automation path.
  • The troubleshooting flow is coherent: the common symptom now links directly to a clearly named subsection beside the relevant operator diagnostics.
  • The instructions are actionable and concise, with a direct support address and an explicit warning that API access requires a separate agreement and approval.
  • The relative Billing Management API link, generated heading anchor, mailto: link, and admonition syntax are consistent with the repository's MkDocs structure.

AI agent details.

Agent processing time: 32.345s
Environment preparation time: 3.292s
Total time from webhook: 39.621s

This branch has not been deployed

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

1 participant