Skip to content

[Workers] Add getting started guide for API and IaC #21008

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 4 commits into
base: production
Choose a base branch
from
Open

[Workers] Add getting started guide for API and IaC #21008

wants to merge 4 commits into from

Conversation

markjmiller
Copy link
Contributor

Summary

There are no official documented examples of how to properly upload a workers script with content and metadata. This is a non-starter for API users. Ideally these examples could live in the API docs themselves, but we can't make custom examples there yet. This doc serves as a practical guide in the meantime that will unblock users.

Documentation checklist

@github-actions github-actions bot added size/m product:workers Related to Workers product labels Mar 20, 2025
@hyperlint-ai Hyperlint AI
Copy link
Contributor

hyperlint-ai bot commented Mar 20, 2025 •
edited
Loading

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

Added a getting started guide for the Workers API and Infrastructure as Code (IaC) to assist users in uploading scripts with content and metadata.

  • Introduced a new guide for uploading Workers scripts using the API and IaC tools.
  • Updated multipart upload metadata documentation with a reference to the new guide.
  • Provided examples for uploading scripts using cURL, cloudflare-typescript, and Terraform.

Modified Files

  • src/content/docs/workers/configuration/multipart-upload-metadata.mdx

Added Files

  • src/content/docs/workers/get-started/api-iac.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.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Mar 20, 2025 •
edited
Loading

Preview URL: https://998da4cf.preview.developers.cloudflare.com
Preview Branch URL: https://markmiller-workers-api-iac.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/workers/platform/infrastructure-as-code/ https://markmiller-workers-api-iac.preview.developers.cloudflare.com/workers/platform/infrastructure-as-code/
https://developers.cloudflare.com/terraform/additional-configurations/link-workers/ https://markmiller-workers-api-iac.preview.developers.cloudflare.com/terraform/additional-configurations/link-workers/
https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/ https://markmiller-workers-api-iac.preview.developers.cloudflare.com/workers/configuration/multipart-upload-metadata/
https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/get-started/user-workers/ https://markmiller-workers-api-iac.preview.developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/get-started/user-workers/

@markjmiller markjmiller force-pushed the markmiller/workers-api-iac branch from 50b9991 to 741a430 Compare March 20, 2025 21:30
@markjmiller markjmiller force-pushed the markmiller/workers-api-iac branch from 741a430 to 958e08f Compare March 20, 2025 22:33
irvinebroque
irvinebroque requested changes Mar 21, 2025
View reviewed changes
Copy link
Contributor

@irvinebroque irvinebroque left a comment

Choose a reason for hiding this comment

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

Let's find right home for this content and do bit more here

@markjmiller markjmiller force-pushed the markmiller/workers-api-iac branch 2 times, most recently from c7df2be to 60ec915 Compare March 21, 2025 16:52
@markjmiller
Copy link
Contributor Author

Let's find right home for this content and do bit more here

@irvinebroque moved to Platform > Managing Workers which feels appropriate

korinne
korinne approved these changes Mar 24, 2025
View reviewed changes
Copy link
Contributor

@korinne korinne left a comment

Choose a reason for hiding this comment

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

Looks good!

@markjmiller markjmiller force-pushed the markmiller/workers-api-iac branch from 5ece160 to f629f24 Compare March 25, 2025 20:03
irvinebroque
irvinebroque reviewed Mar 27, 2025
View reviewed changes
Copy link
Contributor

@irvinebroque irvinebroque left a comment

Choose a reason for hiding this comment

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

Think there is a lot to each of these sections, ex each of these is worthy of a section

Infrastructure-as-Code (Iac)
- Overview
- Terraform
- API SDKs
- Cloudflare REST API

Also things to consider about discoverableility from here:

https://developers.cloudflare.com/terraform/additional-configurations

Also seems like this example really shows how much about multipart upload metadata is bleeding into the SDK API:

https://github.com/cloudflare/cloudflare-typescript/blob/883b9b45d62a5e87c4ffaf4e301e23dd1f3ebc7b/examples/workers/script-upload.ts#L32

lot of stuff in order to just take a file and deploy it to us.

src/content/docs/workers/platform/managing-workers-api-iac.mdx Outdated
}}
/>

### Terraform
Copy link
Contributor

Choose a reason for hiding this comment

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

What guidance do we give on when to use / not to use?

@markjmiller markjmiller force-pushed the markmiller/workers-api-iac branch from f629f24 to ddb8f33 Compare April 14, 2025 17:59
@markjmiller markjmiller requested a review from ranbel as a code owner April 14, 2025 17:59
@github-actions github-actions bot added size/m product:terraform Related to Terraform product and removed size/s labels Apr 14, 2025
@markjmiller markjmiller force-pushed the markmiller/workers-api-iac branch from ddb8f33 to 0ed35ff Compare April 18, 2025 15:12
@markjmiller markjmiller requested review from angelampcosta and a team as code owners April 18, 2025 15:12
@markjmiller markjmiller force-pushed the markmiller/workers-api-iac branch from 0ed35ff to c45a99b Compare April 18, 2025 15:14
@markjmiller markjmiller force-pushed the markmiller/workers-api-iac branch from c45a99b to 372ca8c Compare April 18, 2025 16:06
@markjmiller
Copy link
Contributor Author

Don't merge until...

@kodster28 kodster28 mentioned this pull request Apr 21, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hyperlint-ai hyperlint-ai[bot] hyperlint-ai[bot] left review comments

@jacobbednarz jacobbednarz jacobbednarz approved these changes

@irvinebroque irvinebroque irvinebroque approved these changes

@kodster28 kodster28 kodster28 approved these changes

@korinne korinne korinne approved these changes

@GregBrimble GregBrimble Awaiting requested review from GregBrimble GregBrimble is a code owner

@mikenomitch mikenomitch Awaiting requested review from mikenomitch mikenomitch is a code owner

@WalshyDev WalshyDev Awaiting requested review from WalshyDev WalshyDev is a code owner

@ToriLindsay ToriLindsay Awaiting requested review from ToriLindsay ToriLindsay is a code owner

@ranbel ranbel Awaiting requested review from ranbel ranbel is a code owner

@angelampcosta angelampcosta Awaiting requested review from angelampcosta angelampcosta is a code owner

@kristianfreeman kristianfreeman Awaiting requested review from kristianfreeman kristianfreeman is a code owner

@pedrosousa pedrosousa Awaiting requested review from pedrosousa pedrosousa is a code owner

@haleycode haleycode Awaiting requested review from haleycode haleycode is a code owner

@KianNH KianNH Awaiting requested review from KianNH KianNH is a code owner

Assignees

@irvinebroque irvinebroque

@mikenomitch mikenomitch

@GregBrimble GregBrimble

@WalshyDev WalshyDev

@ToriLindsay ToriLindsay

Labels
product:cloudflare-for-platforms product:terraform Related to Terraform product product:workers Related to Workers product size/m
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
9 participants
@markjmiller @jacobbednarz @irvinebroque @kodster28 @korinne @mikenomitch @GregBrimble @WalshyDev @ToriLindsay