Skip to content

Documents connect being shut off when outbound worker is used #22554

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

Open
wants to merge 1 commit into
base: production
Choose a base branch
from

Conversation

mikenomitch
Copy link
Contributor

@mikenomitch mikenomitch commented May 19, 2025

Summary

When an outbound workers is on, the connect() API no longer works. This adds a note to the documentation explaining this.

In the long-run, we may add an outboundConnect-like API to allow the platform user to handle outbound TCP or allow them to turn it on/off with a toggle. If we do that, then this should be reverted or changed.

Screenshot

Screenshot 2025-05-19 at 9 49 20 AM

Documentation checklist

Copy link
Contributor

hyperlint-ai bot commented May 19, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.


PR Change Summary

Updated documentation to clarify the impact of enabling outbound workers on the connect() API functionality.

  • Added a note explaining that the connect() API is disabled when outbound workers are enabled.
  • Mentioned potential future enhancements regarding outbound TCP handling.
  • Ensured adherence to the documentation style guide.

Modified Files

  • src/content/docs/cloudflare-for-platforms/workers-for-platforms/configuration/outbound-workers.mdx

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

@mikenomitch mikenomitch force-pushed the mikenomitch/connect-wfp branch from f0357fd to 98f3038 Compare May 19, 2025 16:50
@github-actions github-actions bot added size/xs and removed size/m labels May 19, 2025
Copy link
Contributor

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/cloudflare-for-platforms/workers-for-platforms/ @irvinebroque, @angelampcosta, @GregBrimble, @cloudflare/deploy-config, @cloudflare/pcx-technical-writing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants