From 757ab3e5b66964868c849760c98c4020c19471b1 Mon Sep 17 00:00:00 2001 From: Aaron Crawfis Date: Mon, 13 Nov 2023 14:23:26 -0800 Subject: [PATCH] Add docs on simulated environments (#942) * Add simulated reference doc Signed-off-by: Aaron Crawfis * Add simulated environments to overview Signed-off-by: Aaron Crawfis * Update docs/content/reference/resource-schema/core-schema/environment-schema/index.md Co-authored-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> Signed-off-by: Aaron Crawfis --------- Signed-off-by: Aaron Crawfis Signed-off-by: Aaron Crawfis Co-authored-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> --- .../content/guides/deploy-apps/environments/overview/index.md | 4 ++++ .../resource-schema/core-schema/environment-schema/index.md | 1 + 2 files changed, 5 insertions(+) diff --git a/docs/content/guides/deploy-apps/environments/overview/index.md b/docs/content/guides/deploy-apps/environments/overview/index.md index 02f056e5e..23baf7fc5 100644 --- a/docs/content/guides/deploy-apps/environments/overview/index.md +++ b/docs/content/guides/deploy-apps/environments/overview/index.md @@ -41,6 +41,10 @@ Supported identity providers: - [Azure AD workload identity](https://azure.github.io/azure-workload-identity/docs/introduction.html) +### Simulated environments + +You can optionally designate an environment as "simulated". When enabled, a simulated environment will not deploy any output any resources or run any Recipes when an application is deployed. This is useful for dry runs or testing. + ## CLI commands The following commands let you interact with Radius Environments: diff --git a/docs/content/reference/resource-schema/core-schema/environment-schema/index.md b/docs/content/reference/resource-schema/core-schema/environment-schema/index.md index 2e9f8bcf6..e1041b2af 100644 --- a/docs/content/reference/resource-schema/core-schema/environment-schema/index.md +++ b/docs/content/reference/resource-schema/core-schema/environment-schema/index.md @@ -24,6 +24,7 @@ weight: 000 |------|:--------:|-------------|---------| | [compute](#compute) | y | Container runtime configuration. | [See below](#compute) | [recipes](#recipes) | n | Recipes registered to the environment | [See below](#recipes) +| simulated | n | When enabled, a simulated environment will not deploy any output resources or run any Recipes when an application is deployed. This is useful for dry runs or testing. Defaults to `false`. | `true` ### compute