-
Notifications
You must be signed in to change notification settings - Fork 10.2k
[CF1] locally managed tunnel update instructions #21169
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
Conversation
|
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 SummaryUpdated documentation to include instructions for locally-managed tunnels alongside remotely-managed tunnels.
Modified Files
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 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 What is Hyperlint?Hyperlint is an AI agent that helps you write, edit, and maintain your documentation. Learn more about the Hyperlint AI reviewer and the checks that we can run on your documentation. |
| ## Remotely and locally-managed tunnels | ||
|
|
||
| To update `cloudflared` for a tunnel [created through the dashboard](/cloudflare-one/connections/connect-networks/get-started/create-remote-tunnel/): | ||
| To update `cloudflared` for a [remotely-managed tunnel](/cloudflare-one/connections/connect-networks/get-started/create-remote-tunnel/) created through the dashboard or a [locally-managed tunnel](/cloudflare-one/connections/connect-networks/do-more-with-tunnels/local-management/): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For locally-managed tunnels, the instructions below only apply if the tunnel runs as a service. https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/do-more-with-tunnels/local-management/as-a-service/
There was a problem hiding this 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 we need to mention locally or remotely managed tunnels here. This is simply an instruction on how to update cloudflared, which is analogous for both.
src/content/docs/cloudflare-one/connections/connect-networks/downloads/update-cloudflared.mdx
Outdated
Show resolved
Hide resolved
| Run the following command: | ||
|
|
||
| ```sh | ||
| docker run cloudflare/cloudflared:latest tunnel --no-autoupdate run --token eyJhIjoiYTY3ZTE0ZGFhNWY4ZGNlZWI5MWZlNTQ0OWJhNDk2ZWIiLCJ0IjoiOGU2MTY3MWEtYjQ4ZS00OWI2LWI4OGUtZDNhOWU1NzQzYWIwIiwicyI6Ik5qUTFOR013TnpZdE5qVmxNUzAwWXprNExUZzJaVGd0TXpGalpERTBOelUxWkRBMSJ9 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
add a step explaining how to find your tunnel token. For remotely-managed tunnels: https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/configure-tunnels/remote-tunnel-permissions/
| Updates will cause `cloudflared` to restart which will impact traffic currently being served. You can perform zero-downtime upgrades by using Cloudflare's [Load Balancer product](/cloudflare-one/connections/connect-networks/downloads/update-cloudflared/#update-with-cloudflare-load-balancer) or by using [multiple `cloudflared` instances](/cloudflare-one/connections/connect-networks/downloads/update-cloudflared/#update-with-multiple-cloudflared-instances). | ||
|
|
||
| ## Remotely-managed tunnels | ||
| ## Remotely and locally-managed tunnels |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ## Remotely and locally-managed tunnels | |
| ## Update the cloudflared service |
src/content/docs/cloudflare-one/connections/connect-networks/downloads/update-cloudflared.mdx
Outdated
Show resolved
Hide resolved
…ownloads/update-cloudflared.mdx
| Run the following command: | ||
|
|
||
| ```sh | ||
| docker run cloudflare/cloudflared:latest tunnel --no-autoupdate run --token <token> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To ensure the command runs with the latest cloudflared it needs to use the flag --pull always, so:
docker run --pull always cloudflare/cloudflared:latest tunnel --no-autoupdate run --token <token>
Otherwise, it might use an old image that is already available locally that is not the latest.
Summary
PCX-14143
Documentation checklist