Adding info about Dependency Caching to docs #13265

@@ -380,6 +381,24 @@ The GitHub block describes settings for Pulumi Deployments' GitHub integration.
 }
 ```

+### CacheOptions
+
+Cache Options block defines settings related to dependency caching during Deployments. Reading dependencies from cache makes deployments significantly faster. Learn more about dependency caching on the [FAQ page](/docs/pulumi-cloud/deployments/faq/#dependencycaching).


minor wording things:
The Cache Options block defines settings related to dependency caching during Deployments. Using dependencies from the cache makes deployments significantly faster.

also the url is missing a hyphen: #dependency-caching

seanyeh · 2024-11-07T17:38:13Z

content/docs/pulumi-cloud/deployments/faq.md

+
+When using Pulumi-managed deployment agents, you have the option to speed up deployments using Dependency Caching.
+
+Caching method is simple: during the first deployment, deployment agent will automatically detect downloaded dependencies using lock files, zip them up and store the archive in blob storage. During all consequent deployments, agents will pull such an archive down and unpack it, saving time it would take to redownload those dependencies. When your dependencies change, deployment agents will automatically invalidate an old cache and create a new one.


"The Caching method"
"the deployment agent"
I think you mean "subsequent" in "During all subsequent deployments"?
"saving time it would normally take..."

"invalidate the old cache" (there should only be one old cache)

Articles kill me every time! The biggest flaw of the English language.
Thank you!

seanyeh · 2024-11-07T17:38:33Z

content/docs/pulumi-cloud/deployments/faq.md

+
+Caching method is simple: during the first deployment, deployment agent will automatically detect downloaded dependencies using lock files, zip them up and store the archive in blob storage. During all consequent deployments, agents will pull such an archive down and unpack it, saving time it would take to redownload those dependencies. When your dependencies change, deployment agents will automatically invalidate an old cache and create a new one.
+
+Caches are shared on project level, so all stacks within a project can share the same cache. However, caches are fully isolated and never shared between customers.


"the project level"

seanyeh · 2024-11-07T17:39:17Z

content/docs/pulumi-cloud/deployments/faq.md

+- `.NET`
+- `Python` - ensure that you have `requirements.txt` file in the root of your source code.
+- `Go` - ensure that you have `go.mod` and `go.sum` files in the root of your source code.
+- `NodeJS` - ensure that you have `packageManager` field specified in `package.json` file. For now, only `npm` and `yarn` are supported.


ensure that you have the packageManager field specified in package.json

seanyeh · 2024-11-07T17:40:06Z

content/docs/pulumi-cloud/deployments/faq.md

+Dependency Caching is supported for the following runtimes:
+
+- `.NET`
+- `Python` - ensure that you have `requirements.txt` file in the root of your source code.


you have requirements.txt ~~file~~

seanyeh · 2024-11-07T17:40:20Z

content/docs/pulumi-cloud/deployments/faq.md

+- `Python` - ensure that you have `requirements.txt` file in the root of your source code.
+- `Go` - ensure that you have `go.mod` and `go.sum` files in the root of your source code.
+- `NodeJS` - ensure that you have `packageManager` field specified in `package.json` file. For now, only `npm` and `yarn` are supported.
+  - For `npm`, ensure that you have `package-lock.json` file in the root of your source code.


same, you don't need "file"

seanyeh · 2024-11-07T17:40:34Z

content/docs/pulumi-cloud/deployments/faq.md

+- `Go` - ensure that you have `go.mod` and `go.sum` files in the root of your source code.
+- `NodeJS` - ensure that you have `packageManager` field specified in `package.json` file. For now, only `npm` and `yarn` are supported.
+  - For `npm`, ensure that you have `package-lock.json` file in the root of your source code.
+  - For `yarn`, ensure that you have `yarn.lock` file in the root of your source code.


seanyeh · 2024-11-07T17:41:09Z

content/docs/pulumi-cloud/deployments/faq.md

+  - For `npm`, ensure that you have `package-lock.json` file in the root of your source code.
+  - For `yarn`, ensure that you have `yarn.lock` file in the root of your source code.
+
+To confirm Dependency Caching is working and/or to troubleshoot, check out logs of your deployments, specifically `Restore Cache` and `Save Cache` steps.


specifically the

pulumi-bot · 2024-11-07T18:21:16Z

Your site preview for commit b55e8c5 is ready! 🎉

http://www-testing-pulumi-docs-origin-pr-13265-b55e8c55.s3-website.us-west-2.amazonaws.com.

IaroslavTitov · 2024-11-07T18:23:11Z

Updated according to comments

pulumi-bot · 2024-11-07T19:15:56Z

Your site preview for commit bc3fe11 is ready! 🎉

http://www-testing-pulumi-docs-origin-pr-13265-bc3fe114.s3-website.us-west-2.amazonaws.com.

nyobe · 2024-11-07T19:22:37Z

content/docs/pulumi-cloud/deployments/api.md

+
+This option is only available for Pulumi-managed deployment agents.
+
+* **enable** (boolean): Whether to use Dependency Caching.


it's currently enabled but I can change it to enable. Do we have a preference? (ref)

It should match the API, which is enable

thoward

Thanks for adding to the docs! Looks good except for notes about casing style. I would also add, at minimum, some explanation to the .NET bullet point. Even if it just says ".NET - no special configuration required"

thoward · 2024-11-07T20:38:09Z

content/docs/pulumi-cloud/deployments/faq.md

+
+Dependency Caching is supported for the following runtimes:
+
+- `.NET`


Should this have some description, like the other bullet points?

thoward · 2024-11-07T20:46:19Z

content/docs/pulumi-cloud/deployments/api.md

+
+This option is only available for Pulumi-managed deployment agents.
+
+* **enable** (boolean): Whether to use Dependency Caching.


Link to the new section in FAQ doc.

thoward · 2024-11-07T20:46:25Z

content/docs/pulumi-cloud/deployments/api.md

@@ -380,6 +381,24 @@ The GitHub block describes settings for Pulumi Deployments' GitHub integration.
 }
 ```

+### CacheOptions


We have inconsistent casing and spacing on various terms here. "CacheOptions" vs "Cache Options" vs cacheOptions vs "cache options"...

For the H3 use sentence casing: "Cache options"
In the paragraph text, don't capitalize (it's not a proper noun): "cache options" or use the specific symbol cacheOptions, depending on wether you're referring to the concept of cache options or the JSON syntax for it.

In paragraph text "during Deployments" should be "during deployments" (we're talking about the action of deploying, not the product name). Usage of "Dependency Caching" here should also be lower case.

thoward · 2024-11-07T20:46:57Z

content/docs/pulumi-cloud/deployments/faq.md

@@ -21,6 +21,25 @@ aliases:

 Deployments run on single-use virtual machines and compute and storage are never shared across runs. We designed our architecture to maximize isolation. In addition, security features like OIDC allow you to fine tune credential scope, lifetime, and expiration policies at a per-deployment level. It is also possible to use [self-hosted runners](/docs/pulumi-cloud/deployments/customer-managed-agents/) if you require additional isolation.

+## Dependency Caching


Title case-> "Dependency Ccaching"

thoward · 2024-11-07T20:49:09Z

content/docs/pulumi-cloud/deployments/faq.md

@@ -21,6 +21,25 @@ aliases:

 Deployments run on single-use virtual machines and compute and storage are never shared across runs. We designed our architecture to maximize isolation. In addition, security features like OIDC allow you to fine tune credential scope, lifetime, and expiration policies at a per-deployment level. It is also possible to use [self-hosted runners](/docs/pulumi-cloud/deployments/customer-managed-agents/) if you require additional isolation.

+## Dependency Caching
+
+When using Pulumi-managed deployment agents, you have the option to speed up deployments using Dependency Caching.


casing/emphasis: "Dependency Caching"->"dependency caching"

Instead of capitalizing the concept of "Dependency Caching" in the text, use it in lower case. However, the first time you introduce a new concept like this, you can use italics to indicate it is a special concept to understand (instead of proper noun casing).

thoward · 2024-11-07T20:49:39Z

content/docs/pulumi-cloud/deployments/faq.md

+
+Caches are shared on the project level, so all stacks within a project can share the same cache. However, caches are fully isolated and never shared between customers.
+
+Dependency Caching is supported for the following runtimes:


casing->"Dependency Ccaching"

IaroslavTitov · 2024-11-07T22:13:16Z

Updated according to comments, thank you for detailed feedback!

pulumi-bot · 2024-11-07T22:17:56Z

Your site preview for commit d1d98e2 is ready! 🎉

http://www-testing-pulumi-docs-origin-pr-13265-d1d98e2a.s3-website.us-west-2.amazonaws.com.

IaroslavTitov temporarily deployed to testing November 6, 2024 19:30 — with GitHub Actions Inactive

IaroslavTitov force-pushed the iaro/cache branch from 1b84c41 to 6344bcd Compare November 6, 2024 21:30

IaroslavTitov temporarily deployed to testing November 6, 2024 21:30 — with GitHub Actions Inactive

IaroslavTitov force-pushed the iaro/cache branch from 6344bcd to 68dd7fe Compare November 6, 2024 21:46

IaroslavTitov temporarily deployed to testing November 6, 2024 21:46 — with GitHub Actions Inactive

Adding info about Dependency Caching to docs

c05a82e

IaroslavTitov force-pushed the iaro/cache branch from 68dd7fe to c05a82e Compare November 6, 2024 21:55

IaroslavTitov temporarily deployed to testing November 6, 2024 21:55 — with GitHub Actions Inactive

IaroslavTitov marked this pull request as ready for review November 7, 2024 16:39

IaroslavTitov requested a review from a team as a code owner November 7, 2024 16:39

IaroslavTitov requested review from nyobe, komalali, seanyeh and dschaller November 7, 2024 16:39

seanyeh approved these changes Nov 7, 2024

View reviewed changes

IaroslavTitov temporarily deployed to testing November 7, 2024 18:15 — with GitHub Actions Inactive

updated grammar

bc3fe11

IaroslavTitov force-pushed the iaro/cache branch from b55e8c5 to bc3fe11 Compare November 7, 2024 19:08

IaroslavTitov temporarily deployed to testing November 7, 2024 19:08 — with GitHub Actions Inactive

nyobe reviewed Nov 7, 2024

View reviewed changes

thoward approved these changes Nov 7, 2024

View reviewed changes

Updated based on Troy's comments

d1d98e2

IaroslavTitov temporarily deployed to testing November 7, 2024 22:11 — with GitHub Actions Inactive

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding info about Dependency Caching to docs #13265

Adding info about Dependency Caching to docs #13265

IaroslavTitov commented Nov 6, 2024

pulumi-bot commented Nov 6, 2024

pulumi-bot commented Nov 6, 2024

pulumi-bot commented Nov 6, 2024

pulumi-bot commented Nov 6, 2024

seanyeh left a comment

seanyeh Nov 7, 2024

seanyeh Nov 7, 2024

IaroslavTitov Nov 7, 2024

seanyeh Nov 7, 2024

seanyeh Nov 7, 2024

seanyeh Nov 7, 2024

seanyeh Nov 7, 2024

seanyeh Nov 7, 2024

seanyeh Nov 7, 2024

pulumi-bot commented Nov 7, 2024

IaroslavTitov commented Nov 7, 2024

pulumi-bot commented Nov 7, 2024

nyobe Nov 7, 2024

IaroslavTitov Nov 7, 2024

thoward left a comment •

edited

Loading

thoward Nov 7, 2024

thoward Nov 7, 2024

thoward Nov 7, 2024

thoward Nov 7, 2024

thoward Nov 7, 2024

thoward Nov 7, 2024

IaroslavTitov commented Nov 7, 2024

pulumi-bot commented Nov 7, 2024


		When using Pulumi-managed deployment agents, you have the option to speed up deployments using Dependency Caching.

		Caching method is simple: during the first deployment, deployment agent will automatically detect downloaded dependencies using lock files, zip them up and store the archive in blob storage. During all consequent deployments, agents will pull such an archive down and unpack it, saving time it would take to redownload those dependencies. When your dependencies change, deployment agents will automatically invalidate an old cache and create a new one.


		Caching method is simple: during the first deployment, deployment agent will automatically detect downloaded dependencies using lock files, zip them up and store the archive in blob storage. During all consequent deployments, agents will pull such an archive down and unpack it, saving time it would take to redownload those dependencies. When your dependencies change, deployment agents will automatically invalidate an old cache and create a new one.

		Caches are shared on project level, so all stacks within a project can share the same cache. However, caches are fully isolated and never shared between customers.


		This option is only available for Pulumi-managed deployment agents.

		* enable (boolean): Whether to use Dependency Caching.


		Dependency Caching is supported for the following runtimes:

		- `.NET`

		@@ -21,6 +21,25 @@ aliases:

		Deployments run on single-use virtual machines and compute and storage are never shared across runs. We designed our architecture to maximize isolation. In addition, security features like OIDC allow you to fine tune credential scope, lifetime, and expiration policies at a per-deployment level. It is also possible to use [self-hosted runners](/docs/pulumi-cloud/deployments/customer-managed-agents/) if you require additional isolation.

		## Dependency Caching


		Caches are shared on the project level, so all stacks within a project can share the same cache. However, caches are fully isolated and never shared between customers.

		Dependency Caching is supported for the following runtimes:

Adding info about Dependency Caching to docs #13265

Are you sure you want to change the base?

Adding info about Dependency Caching to docs #13265

Conversation

IaroslavTitov commented Nov 6, 2024

Proposed changes

Unreleased product version (optional)

Related issues (optional)

pulumi-bot commented Nov 6, 2024

pulumi-bot commented Nov 6, 2024

pulumi-bot commented Nov 6, 2024

pulumi-bot commented Nov 6, 2024

seanyeh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pulumi-bot commented Nov 7, 2024

IaroslavTitov commented Nov 7, 2024

pulumi-bot commented Nov 7, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thoward left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

IaroslavTitov commented Nov 7, 2024

pulumi-bot commented Nov 7, 2024

thoward left a comment •

edited

Loading