Adds section for Worker configuration management options #17935
Conversation
korinne
requested review from
a team,
GregBrimble,
ToriLindsay,
WalshyDev,
irvinebroque and
mikenomitch
as code owners
github-actions
bot
assigned
GregBrimble,
irvinebroque,
mikenomitch,
ToriLindsay and
WalshyDev
![hyperlint-ai[bot]](https://avatars.githubusercontent.com/in/718456?s=60&v=4){kind=small}
There was a problem hiding this comment.
2 files reviewed, 4 total issue(s) found.
Note: We resolved prior Hyperlint review comments because:
We updated our inline suggestion AI.
We do this to avoid keeping outdated or irrelevant comments around. We'll leave a new review with current comments below.
src/content/docs/workers/configuration/configuration-management.mdx
Outdated
Show resolved
Hide resolved
src/content/docs/workers/configuration/configuration-management.mdx
Outdated
Show resolved
Hide resolved
|
|
||
| ### Infrastructure-as-Code (IaC) | ||
|
|
||
| Many teams today have adopted Infrastructure-as-Code (IaC) tooling to ensure that infrastructure changes are tracked over time, maintained in version control, and are consistent across environments. Cloudflare Workers can be configured in both Terraform and Pulumi, using the [Cloudflare Terraform Provider](https://github.com/cloudflare/terraform-provider-cloudflare). |
There was a problem hiding this comment.
Just be direct
| Many teams today have adopted Infrastructure-as-Code (IaC) tooling to ensure that infrastructure changes are tracked over time, maintained in version control, and are consistent across environments. Cloudflare Workers can be configured in both Terraform and Pulumi, using the [Cloudflare Terraform Provider](https://github.com/cloudflare/terraform-provider-cloudflare). | |
| Cloudflare Workers can be configured in both Terraform and Pulumi, using the [Cloudflare Terraform Provider](https://github.com/cloudflare/terraform-provider-cloudflare). |
|
|
||
| * The [Cloudflare Dashboard](https://developers.cloudflare.com/workers/get-started/dashboard/) | ||
| * [Wrangler](https://developers.cloudflare.com/workers/wrangler/), along with a [`wrangler.toml`](https://developers.cloudflare.com/workers/wrangler/configuration/) file | ||
| * Infrastructure-as-Code tools ([Terraform](https://developers.cloudflare.com/terraform/) and [Pulumi](https://developers.cloudflare.com/pulumi/)) |
There was a problem hiding this comment.
One of these doesn't feel like the other, since wrangler.toml is itself its own form of infrstructure as code.
Feels like the distinction here is:
- you can configure stuff using the dashboard or using a configuration file that you commit changes to in your repository (IaC)
- wrangler.toml is the built-in configuration format, a way of doing IaC specific to Workers.
- You can also use Terraform / Pulumi / SST to do this, which lets you define and manage resources beyond just Workers <explain why you'd want to do this instead of wrangler.toml>
| @@ -0,0 +1,102 @@ | |||
| --- | |||
| pcx_content_type: Navigation | |||
| title: Configuration management | |||
There was a problem hiding this comment.
Title should map to something developers recognize
Configuration > Configuration management — I don't quite know what that means
Would suggest taking the top-line content here and put it on the index page for configuration. It's relevant there — you're explaining the ways that you configurae workers, and the sub pages are topics within that.
Then if you need separate page just for Infrastructure-as-code, or just for Terraform, can do that.
Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
|
|
||
| * The [Cloudflare Dashboard](https://developers.cloudflare.com/workers/get-started/dashboard/) | ||
| * [Wrangler](https://developers.cloudflare.com/workers/wrangler/), along with a [`wrangler.toml`](https://developers.cloudflare.com/workers/wrangler/configuration/) file | ||
| * Infrastructure-as-Code tools ([Terraform](https://developers.cloudflare.com/terraform/) and [Pulumi](https://developers.cloudflare.com/pulumi/)) |
There was a problem hiding this comment.
| * Infrastructure-as-Code tools ([Terraform](https://developers.cloudflare.com/terraform/) and [Pulumi](https://developers.cloudflare.com/pulumi/)) | |
| * Infrastructure-as-Code tools ([Terraform](/terraform/) and [Pulumi](/pulumi/)) |
Issues:
- Style Guide - (cloudflare.LinkChecks-warning) Warning: When referring to another page in our docs, use the full relative link (
/1.1.1.1/check/) instead of the full URL (https://developers.cloudflare.com/1.1.1.1/check/) or a local development link (http://localhost:111/1.1.1.1/check/).
Fix Explanation:
The original text uses full URLs for internal links, which goes against the style guide's recommendation to use relative links. By changing the URLs to relative links, we ensure consistency with the style guide and maintain link integrity across different environments.
|
|
||
| * **Scalable, real-time deployments:** The API is excellent for handling high-volume and resource-specific tasks, especially those that require immediate execution. For example, a team might want to automate the creation of specific resources each time a new user account is added. The API can handle tasks like these instantly and in isolation, whereas Infrastructure-as-Code (IaC) is designed for managing an entire infrastructure stack, which can take longer to deploy and can impact other resources. | ||
|
|
||
| * **Advanced management and automation:** Many teams today use the Cloudflare API for tasks that go beyond basic resource management, especially for scenarios where dynamic data is needed. For example, teams can use the API to create an ephemeral Workers KV store, insert dummy data, run automated tests, and tear down the temporary resources. |
There was a problem hiding this comment.
| * **Advanced management and automation:** Many teams today use the Cloudflare API for tasks that go beyond basic resource management, especially for scenarios where dynamic data is needed. For example, teams can use the API to create an ephemeral Workers KV store, insert dummy data, run automated tests, and tear down the temporary resources. | |
| * **Advanced management and automation:** Many teams today use the Cloudflare API for tasks that go beyond basic resource management, especially for scenarios where dynamic data is needed. For example, teams can use the API to create an ephemeral Workers KV store, insert sample data, run automated tests, and tear down the temporary resources. |
Issues:
- Style Guide - (cloudflare.InclusiveLanguage-warning) Warning: Use inclusive language. Consider 'placeholder, sample, fake' instead of 'dummy'.
Fix Explanation:
The term 'dummy' can be replaced with 'sample' to maintain the intended meaning while adhering to inclusive language guidelines. 'Sample' is a neutral term that conveys the idea of data used for testing or demonstration purposes without any negative connotations.
|
Confirmed with @korinne that this could be converted to draft for now. Thank you! |
|
Howdy @korinne, is this PR still relevant? |
|
Closing this out for now, can always re-open if needed. |
7 participants
Summary
Documentation checklist