From a7a862a1b4841ae274f232bd1614448911d11102 Mon Sep 17 00:00:00 2001 From: rad-ci-bot <103787451+rad-ci-bot@users.noreply.github.com> Date: Wed, 8 Jan 2025 10:39:07 -0800 Subject: [PATCH 1/2] Update auto-generated documentation (#1289) * Autogenerate reference docs Signed-off-by: rad-ci-bot * Update init and env references Signed-off-by: Reshma Abdul Rahim * Update init and env references Signed-off-by: Reshma Abdul Rahim * Delete package-lock.json Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> --------- Signed-off-by: rad-ci-bot Signed-off-by: Reshma Abdul Rahim Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> Co-authored-by: rad-ci-bot Co-authored-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> Co-authored-by: Reshma Abdul Rahim --- .../aws/howto-aws-resources/index.md | 4 +- .../azure/howto-azure-resources/index.md | 2 +- .../containers/howto-keyvault-volume/index.md | 2 +- .../environments/howto-environment/index.md | 12 +++--- .../environments/overview/index.md | 8 ++-- .../howto-aws-provider-access-key/index.md | 4 +- .../howto-aws-provider-irsa/index.md | 4 +- .../howto-azure-provider-sp/index.md | 4 +- .../howto-azure-provider-wi/index.md | 4 +- .../workspaces/howto-workspaces/index.md | 4 +- .../howto-private-bicep-registry/index.md | 2 +- docs/content/guides/recipes/overview/index.md | 2 +- .../terraform/howto-custom-provider/index.md | 2 +- .../terraform/howto-private-registry/index.md | 2 +- docs/content/reference/cli/rad.md | 4 +- docs/content/reference/cli/rad_env.md | 42 ------------------- docs/content/reference/cli/rad_environment.md | 42 +++++++++++++++++++ ...nv_create.md => rad_environment_create.md} | 16 +++---- ...nv_delete.md => rad_environment_delete.md} | 16 +++---- ...ad_env_list.md => rad_environment_list.md} | 16 +++---- ...ad_env_show.md => rad_environment_show.md} | 16 +++---- ...nv_switch.md => rad_environment_switch.md} | 16 +++---- ...nv_update.md => rad_environment_update.md} | 16 +++---- .../cli/{rad_init.md => rad_initialize.md} | 16 +++---- docs/content/tutorials/new-app/index.md | 2 +- .../tutorials/tutorial-recipe/index.md | 2 +- .../install-radius/initialize-radius.md | 4 +- holding-pen/reference-apps/aws-rds/index.md | 2 +- holding-pen/reference-apps/aws-sqs/_index.md | 2 +- 29 files changed, 134 insertions(+), 134 deletions(-) delete mode 100644 docs/content/reference/cli/rad_env.md create mode 100644 docs/content/reference/cli/rad_environment.md rename docs/content/reference/cli/{rad_env_create.md => rad_environment_create.md} (69%) rename docs/content/reference/cli/{rad_env_delete.md => rad_environment_delete.md} (72%) rename docs/content/reference/cli/{rad_env_list.md => rad_environment_list.md} (64%) rename docs/content/reference/cli/{rad_env_show.md => rad_environment_show.md} (69%) rename docs/content/reference/cli/{rad_env_switch.md => rad_environment_switch.md} (59%) rename docs/content/reference/cli/{rad_env_update.md => rad_environment_update.md} (82%) rename docs/content/reference/cli/{rad_init.md => rad_initialize.md} (82%) diff --git a/docs/content/guides/author-apps/aws/howto-aws-resources/index.md b/docs/content/guides/author-apps/aws/howto-aws-resources/index.md index 1c7c05e74..3ad94695d 100644 --- a/docs/content/guides/author-apps/aws/howto-aws-resources/index.md +++ b/docs/content/guides/author-apps/aws/howto-aws-resources/index.md @@ -38,7 +38,7 @@ eksctl create cluster --name --region= Create a [Radius Environment]({{< ref "/guides/deploy-apps/environments/overview" >}}) where you will deploy your application. -Run [`rad init --full`]({{< ref rad_init >}}) to initialize a new environment into your current kubectl context: +Run [`rad init --full`]({{< ref rad_initialize >}}) to initialize a new environment into your current kubectl context: ```bash rad init --full @@ -105,7 +105,7 @@ This creates a container that will be deployed to your Kubernetes cluster. This ## Step 7: Cleanup -1. When you're done with testing, you can use the rad CLI to [delete an environment]({{< ref rad_env_delete.md >}}) to delete all Radius resources running on the EKS Cluster. +1. When you're done with testing, you can use the rad CLI to [delete an environment]({{< ref rad_environment_delete.md >}}) to delete all Radius resources running on the EKS Cluster. 1. Cleanup AWS Resources - AWS resources are not deleted when deleting a Radius Environment, so make sure to delete all resources created in this reference app to prevent additional charges. You can delete these resources in the AWS Console or via the AWS CLI. Instructions to delete an AWS S3 Bucket are available [here](https://docs.aws.amazon.com/AmazonS3/latest/userguide/delete-bucket.html). diff --git a/docs/content/guides/author-apps/azure/howto-azure-resources/index.md b/docs/content/guides/author-apps/azure/howto-azure-resources/index.md index e610a4ed9..6b2129fe4 100644 --- a/docs/content/guides/author-apps/azure/howto-azure-resources/index.md +++ b/docs/content/guides/author-apps/azure/howto-azure-resources/index.md @@ -26,7 +26,7 @@ The steps below will showcase a "rad-ified" version of the existing [Azure AD wo ## Step 1: Initialize Radius -Begin by running [`rad init --full`]({{< ref rad_init >}}). Make sure to configure an Azure cloud provider: +Begin by running [`rad init --full`]({{< ref rad_initialize >}}). Make sure to configure an Azure cloud provider: ```bash rad init --full diff --git a/docs/content/guides/author-apps/containers/howto-keyvault-volume/index.md b/docs/content/guides/author-apps/containers/howto-keyvault-volume/index.md index 628b41751..ec4111c2c 100644 --- a/docs/content/guides/author-apps/containers/howto-keyvault-volume/index.md +++ b/docs/content/guides/author-apps/containers/howto-keyvault-volume/index.md @@ -27,7 +27,7 @@ This how-to guide will provide an overview of how to: ## Step 1: Initialize Radius -Begin by running [`rad init --full`]({{< ref rad_init >}}). Make sure to configure an Azure cloud provider: +Begin by running [`rad init --full`]({{< ref rad_initialize >}}). Make sure to configure an Azure cloud provider: ```bash rad init --full diff --git a/docs/content/guides/deploy-apps/environments/howto-environment/index.md b/docs/content/guides/deploy-apps/environments/howto-environment/index.md index 361eb92ef..f4abd50d0 100644 --- a/docs/content/guides/deploy-apps/environments/howto-environment/index.md +++ b/docs/content/guides/deploy-apps/environments/howto-environment/index.md @@ -20,7 +20,7 @@ Radius Environments can be setup with the rad CLI via two paths: interactive or ## Create a development environment -1. Initialize a new [Radius Environment]({{< ref "/guides/deploy-apps/environments/overview">}}) with [`rad init`]({{< ref rad_init >}}): +1. Initialize a new [Radius Environment]({{< ref "/guides/deploy-apps/environments/overview">}}) with [`rad init`]({{< ref rad_initialize >}}): ```bash rad init ``` @@ -55,7 +55,7 @@ Radius Environments can be setup with the rad CLI via two paths: interactive or contour-contour 1/1 1 1 46s ``` - You can also use [`rad env list`]({{< ref rad_env_list.md >}}) to view your environment: + You can also use [`rad env list`]({{< ref rad_environment_list.md >}}) to view your environment: ```bash rad env list @@ -75,7 +75,7 @@ Radius Environments can be setup with the rad CLI via two paths: interactive or ## Create an environment interactively -1. Initialize a new environment with [`rad init --full`]({{< ref rad_init >}}): +1. Initialize a new environment with [`rad init --full`]({{< ref rad_initialize >}}): ```bash rad init --full @@ -120,7 +120,7 @@ Radius Environments can be setup with the rad CLI via two paths: interactive or contour-contour 1/1 1 1 2m33s ``` -1. Verify an environment was created with [`rad env show`]({{< ref rad_env_show.md >}}): +1. Verify an environment was created with [`rad env show`]({{< ref rad_environment_show.md >}}): ```bash rad env show -o json @@ -185,7 +185,7 @@ Radius can also be installed and an environment created with manual rad CLI comm 1. Create your Radius Environment: - Run [`rad env create`]({{< ref rad_env_create >}}) to create a new environment in your resource group. Specify the `--namespace` flag to select the Kubernetes namespace to deploy resources into: + Run [`rad env create`]({{< ref rad_environment_create >}}) to create a new environment in your resource group. Specify the `--namespace` flag to select the Kubernetes namespace to deploy resources into: ```bash rad env create myEnvironment --group myGroup --namespace my-namespace @@ -213,7 +213,7 @@ Radius can also be installed and an environment created with manual rad CLI comm contour-contour 1/1 1 1 2m33s ``` - You can also use [`rad env list`]({{< ref rad_env_list.md >}}) to see if the created environment gets listed: + You can also use [`rad env list`]({{< ref rad_environment_list.md >}}) to see if the created environment gets listed: ```bash rad env list --group myGroup diff --git a/docs/content/guides/deploy-apps/environments/overview/index.md b/docs/content/guides/deploy-apps/environments/overview/index.md index d3f5a9ecc..29cc3db64 100644 --- a/docs/content/guides/deploy-apps/environments/overview/index.md +++ b/docs/content/guides/deploy-apps/environments/overview/index.md @@ -60,7 +60,7 @@ rad init {{% /codetab %}} {{% codetab %}} -[rad env list]({{< ref rad_env_list >}}) lists all of the environments in your [workspace]({{< ref workspaces >}}): +[rad env list]({{< ref rad_environment_list >}}) lists all of the environments in your [workspace]({{< ref workspaces >}}): ```bash rad env list @@ -68,7 +68,7 @@ rad env list {{% /codetab %}} {{% codetab %}} -[rad env show]({{< ref rad_env_show >}}) prints information on the default or specified environment: +[rad env show]({{< ref rad_environment_show >}}) prints information on the default or specified environment: ```bash rad env show @@ -76,7 +76,7 @@ rad env show {{% /codetab %}} {{% codetab %}} -[rad env delete]({{< ref rad_env_delete >}}) deletes the specified environment: +[rad env delete]({{< ref rad_environment_delete >}}) deletes the specified environment: ```bash rad env delete -e myenv @@ -84,7 +84,7 @@ rad env delete -e myenv {{% /codetab %}} {{% codetab %}} -[rad env switch]({{< ref rad_env_switch >}}) switches the default environment: +[rad env switch]({{< ref rad_environment_switch >}}) switches the default environment: ```bash rad env switch -e myenv diff --git a/docs/content/guides/operations/providers/aws-provider/howto-aws-provider-access-key/index.md b/docs/content/guides/operations/providers/aws-provider/howto-aws-provider-access-key/index.md index c095b1db0..049ee14a4 100644 --- a/docs/content/guides/operations/providers/aws-provider/howto-aws-provider-access-key/index.md +++ b/docs/content/guides/operations/providers/aws-provider/howto-aws-provider-access-key/index.md @@ -21,7 +21,7 @@ The AWS provider allows you to deploy and connect to AWS resources from a Radius ## Interactive configuration -1. Initialize a new environment with [`rad init --full`]({{< ref rad_init >}}): +1. Initialize a new environment with [`rad init --full`]({{< ref rad_initialize >}}): ```bash rad init --full @@ -62,7 +62,7 @@ The AWS provider allows you to deploy and connect to AWS resources from a Radius rad env update myEnvironment --aws-region myAwsRegion --aws-account-id myAwsAccountId ``` - This command updates the configuration of an environment for properties that are able to be changed. For more information visit [`rad env update`]({{< ref rad_env_update >}}) + This command updates the configuration of an environment for properties that are able to be changed. For more information visit [`rad env update`]({{< ref rad_environment_update >}}) 1. Add your AWS cloud provider credentials: diff --git a/docs/content/guides/operations/providers/aws-provider/howto-aws-provider-irsa/index.md b/docs/content/guides/operations/providers/aws-provider/howto-aws-provider-irsa/index.md index 3c7c7d4b0..8e0728616 100644 --- a/docs/content/guides/operations/providers/aws-provider/howto-aws-provider-irsa/index.md +++ b/docs/content/guides/operations/providers/aws-provider/howto-aws-provider-irsa/index.md @@ -76,7 +76,7 @@ Now that the setup is complete, you can install Radius with AWS IRSA enabled. ## Interactive configuration -1. Initialize a new environment with [`rad init --full`]({{< ref rad_init >}}): +1. Initialize a new environment with [`rad init --full`]({{< ref rad_initialize >}}): ```bash rad init --full @@ -127,7 +127,7 @@ Now that the setup is complete, you can install Radius with AWS IRSA enabled. rad env create default ``` -1. Use [`rad env update`]({{< ref rad_env_update >}}) to update your Radius Environment with your your AWS region and AWS account ID: +1. Use [`rad env update`]({{< ref rad_environment_update >}}) to update your Radius Environment with your your AWS region and AWS account ID: ```bash rad env update myEnvironment --aws-region myAwsRegion --aws-account-id myAwsAccountId diff --git a/docs/content/guides/operations/providers/azure-provider/howto-azure-provider-sp/index.md b/docs/content/guides/operations/providers/azure-provider/howto-azure-provider-sp/index.md index 40e4d275d..1b5e968c1 100644 --- a/docs/content/guides/operations/providers/azure-provider/howto-azure-provider-sp/index.md +++ b/docs/content/guides/operations/providers/azure-provider/howto-azure-provider-sp/index.md @@ -21,7 +21,7 @@ The Azure provider allows you to deploy and connect to Azure resources from a se ## Interactive configuration -1. Initialize a new environment with [`rad init --full`]({{< ref rad_init >}}): +1. Initialize a new environment with [`rad init --full`]({{< ref rad_initialize >}}): ```bash rad init --full @@ -66,7 +66,7 @@ The Azure provider allows you to deploy and connect to Azure resources from a se ## Manual configuration -1. Use [`rad env update`]({{< ref rad_env_update >}}) to update your Radius Environment with your Azure subscription ID and Azure resource group: +1. Use [`rad env update`]({{< ref rad_environment_update >}}) to update your Radius Environment with your Azure subscription ID and Azure resource group: ```bash rad env update myEnvironment --azure-subscription-id myAzureSubscriptionId --azure-resource-group myAzureResourceGroup diff --git a/docs/content/guides/operations/providers/azure-provider/howto-azure-provider-wi/index.md b/docs/content/guides/operations/providers/azure-provider/howto-azure-provider-wi/index.md index 71189b566..fc2bd7415 100644 --- a/docs/content/guides/operations/providers/azure-provider/howto-azure-provider-wi/index.md +++ b/docs/content/guides/operations/providers/azure-provider/howto-azure-provider-wi/index.md @@ -34,7 +34,7 @@ Now that the setup is complete, you can now install Radius with Azure workload i ## Interactive configuration -1. Initialize a new environment with [`rad init --full`]({{< ref rad_init >}}): +1. Initialize a new environment with [`rad init --full`]({{< ref rad_initialize >}}): ```bash rad init --full @@ -82,7 +82,7 @@ Now that the setup is complete, you can now install Radius with Azure workload i rad env create default ``` -1. Use [`rad env update`]({{< ref rad_env_update >}}) to update your Radius Environment with your Azure subscription ID and Azure resource group: +1. Use [`rad env update`]({{< ref rad_environment_update >}}) to update your Radius Environment with your Azure subscription ID and Azure resource group: ```bash rad env update myEnvironment --azure-subscription-id myAzureSubscriptionId --azure-resource-group myAzureResourceGroup diff --git a/docs/content/guides/operations/workspaces/howto-workspaces/index.md b/docs/content/guides/operations/workspaces/howto-workspaces/index.md index f2f1b74a9..6640b511b 100644 --- a/docs/content/guides/operations/workspaces/howto-workspaces/index.md +++ b/docs/content/guides/operations/workspaces/howto-workspaces/index.md @@ -28,7 +28,7 @@ When you have multiple environments initialized for different purposes workspace rad group create mygroup ``` -1. Create an environment named `myenvironment` using [`rad env create`]({{< ref rad_env_create >}}): +1. Create an environment named `myenvironment` using [`rad env create`]({{< ref rad_environment_create >}}): ```sh rad env create myenvironment @@ -47,7 +47,7 @@ When you have multiple environments initialized for different purposes workspace rad group create yourgroup ``` -1. Create an environment named `yourenvironment` using [`rad env create`]({{< ref rad_env_create >}}): +1. Create an environment named `yourenvironment` using [`rad env create`]({{< ref rad_environment_create >}}): ```sh rad env create yourenvironment diff --git a/docs/content/guides/recipes/howto-private-bicep-registry/index.md b/docs/content/guides/recipes/howto-private-bicep-registry/index.md index a97b0f4cd..d45492112 100644 --- a/docs/content/guides/recipes/howto-private-bicep-registry/index.md +++ b/docs/content/guides/recipes/howto-private-bicep-registry/index.md @@ -69,4 +69,4 @@ rad env delete my-env - [Recipes overview]({{< ref "/guides/recipes/overview" >}}) - [Radius Environments]({{< ref "/guides/deploy-apps/environments/overview" >}}) - [`rad recipe CLI reference`]({{< ref rad_recipe >}}) -- [`rad env CLI reference`]({{< ref rad_env >}}) \ No newline at end of file +- [`rad env CLI reference`]({{< ref rad_environment >}}) \ No newline at end of file diff --git a/docs/content/guides/recipes/overview/index.md b/docs/content/guides/recipes/overview/index.md index 72e00ac80..d84027aa7 100644 --- a/docs/content/guides/recipes/overview/index.md +++ b/docs/content/guides/recipes/overview/index.md @@ -37,7 +37,7 @@ Use [**rad recipe list**]({{< ref rad_recipe_list >}}) to view the Recipes avail ### Use lightweight "local-dev" Recipes -Radius Environments make it easy to get up and running with Recipes instantly. When you run [`rad init`]({{< ref rad_init >}}) you get a set of containerized local-dev Recipes pre-registered in your environment. These Recipes are designed to help you get started quickly with Recipes using lightweight containers. You can use these Recipes to test your app locally, or deploy them to a dev environment. +Radius Environments make it easy to get up and running with Recipes instantly. When you run [`rad init`]({{< ref rad_initialize >}}) you get a set of containerized local-dev Recipes pre-registered in your environment. These Recipes are designed to help you get started quickly with Recipes using lightweight containers. You can use these Recipes to test your app locally, or deploy them to a dev environment. ### Customize with parameters diff --git a/docs/content/guides/recipes/terraform/howto-custom-provider/index.md b/docs/content/guides/recipes/terraform/howto-custom-provider/index.md index 2835a24f4..49a356218 100644 --- a/docs/content/guides/recipes/terraform/howto-custom-provider/index.md +++ b/docs/content/guides/recipes/terraform/howto-custom-provider/index.md @@ -84,4 +84,4 @@ rad env delete my-env - [Recipes overview]({{< ref "/guides/recipes/overview" >}}) - [Radius Environments]({{< ref "/guides/deploy-apps/environments/overview" >}}) - [`rad recipe CLI reference`]({{< ref rad_recipe >}}) -- [`rad env CLI reference`]({{< ref rad_env >}}) \ No newline at end of file +- [`rad env CLI reference`]({{< ref rad_environment >}}) \ No newline at end of file diff --git a/docs/content/guides/recipes/terraform/howto-private-registry/index.md b/docs/content/guides/recipes/terraform/howto-private-registry/index.md index 3bc857c6b..6241c6728 100644 --- a/docs/content/guides/recipes/terraform/howto-private-registry/index.md +++ b/docs/content/guides/recipes/terraform/howto-private-registry/index.md @@ -79,4 +79,4 @@ rad env delete my-env - [Recipes overview]({{< ref "/guides/recipes/overview" >}}) - [Radius Environments]({{< ref "/guides/deploy-apps/environments/overview" >}}) - [`rad recipe CLI reference`]({{< ref rad_recipe >}}) -- [`rad env CLI reference`]({{< ref rad_env >}}) \ No newline at end of file +- [`rad env CLI reference`]({{< ref rad_environment >}}) \ No newline at end of file diff --git a/docs/content/reference/cli/rad.md b/docs/content/reference/cli/rad.md index b46b19a90..3b442dd2d 100644 --- a/docs/content/reference/cli/rad.md +++ b/docs/content/reference/cli/rad.md @@ -30,9 +30,9 @@ Radius CLI * [rad credential]({{< ref rad_credential.md >}}) - Manage cloud provider credential for a Radius installation. * [rad debug-logs]({{< ref rad_debug-logs.md >}}) - Capture logs from Radius control plane for debugging and diagnostics. * [rad deploy]({{< ref rad_deploy.md >}}) - Deploy a template -* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments +* [rad environment]({{< ref rad_environment.md >}}) - Manage Radius Environments * [rad group]({{< ref rad_group.md >}}) - Manage resource groups -* [rad init]({{< ref rad_init.md >}}) - Initialize Radius +* [rad initialize]({{< ref rad_initialize.md >}}) - Initialize Radius * [rad install]({{< ref rad_install.md >}}) - Installs Radius for a given platform * [rad recipe]({{< ref rad_recipe.md >}}) - Manage recipes * [rad resource]({{< ref rad_resource.md >}}) - Manage resources diff --git a/docs/content/reference/cli/rad_env.md b/docs/content/reference/cli/rad_env.md deleted file mode 100644 index 359aa5e6c..000000000 --- a/docs/content/reference/cli/rad_env.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -type: docs -title: "rad env CLI reference" -linkTitle: "rad env" -slug: rad_env -url: /reference/cli/rad_env/ -description: "Details on the rad env Radius CLI command" ---- -## rad env - -Manage Radius Environments - -### Synopsis - -Manage Radius Environments -Radius Environments are prepared “landing zones” for Radius Applications. Applications deployed to an environment will inherit the container runtime, configuration, and other settings from the environment. - -### Options - -``` - -e, --environment string The environment name - -h, --help help for env - -w, --workspace string The workspace name -``` - -### Options inherited from parent commands - -``` - --config string config file (default "$HOME/.rad/config.yaml") - -o, --output string output format (supported formats are json, table) (default "table") -``` - -### SEE ALSO - -* [rad]({{< ref rad.md >}}) - Radius CLI -* [rad env create]({{< ref rad_env_create.md >}}) - Create a new Radius Environment -* [rad env delete]({{< ref rad_env_delete.md >}}) - Delete environment -* [rad env list]({{< ref rad_env_list.md >}}) - List environments -* [rad env show]({{< ref rad_env_show.md >}}) - Show environment details -* [rad env switch]({{< ref rad_env_switch.md >}}) - Switch the current environment -* [rad env update]({{< ref rad_env_update.md >}}) - Update environment configuration - diff --git a/docs/content/reference/cli/rad_environment.md b/docs/content/reference/cli/rad_environment.md new file mode 100644 index 000000000..98ea40020 --- /dev/null +++ b/docs/content/reference/cli/rad_environment.md @@ -0,0 +1,42 @@ +--- +type: docs +title: "rad environment CLI reference" +linkTitle: "rad environment" +slug: rad_environment +url: /reference/cli/rad_environment/ +description: "Details on the rad environment Radius CLI command" +--- +## rad environment + +Manage Radius Environments + +### Synopsis + +Manage Radius Environments +Radius Environments are prepared “landing zones” for Radius Applications. Applications deployed to an environment will inherit the container runtime, configuration, and other settings from the environment. + +### Options + +``` + -e, --environment string The environment name + -h, --help help for environment + -w, --workspace string The workspace name +``` + +### Options inherited from parent commands + +``` + --config string config file (default "$HOME/.rad/config.yaml") + -o, --output string output format (supported formats are json, table) (default "table") +``` + +### SEE ALSO + +* [rad]({{< ref rad.md >}}) - Radius CLI +* [rad environment create]({{< ref rad_environment_create.md >}}) - Create a new Radius Environment +* [rad environment delete]({{< ref rad_environment_delete.md >}}) - Delete environment +* [rad environment list]({{< ref rad_environment_list.md >}}) - List environments +* [rad environment show]({{< ref rad_environment_show.md >}}) - Show environment details +* [rad environment switch]({{< ref rad_environment_switch.md >}}) - Switch the current environment +* [rad environment update]({{< ref rad_environment_update.md >}}) - Update environment configuration + diff --git a/docs/content/reference/cli/rad_env_create.md b/docs/content/reference/cli/rad_environment_create.md similarity index 69% rename from docs/content/reference/cli/rad_env_create.md rename to docs/content/reference/cli/rad_environment_create.md index 51bdf1e29..227f6bf49 100644 --- a/docs/content/reference/cli/rad_env_create.md +++ b/docs/content/reference/cli/rad_environment_create.md @@ -1,12 +1,12 @@ --- type: docs -title: "rad env create CLI reference" -linkTitle: "rad env create" -slug: rad_env_create -url: /reference/cli/rad_env_create/ -description: "Details on the rad env create Radius CLI command" +title: "rad environment create CLI reference" +linkTitle: "rad environment create" +slug: rad_environment_create +url: /reference/cli/rad_environment_create/ +description: "Details on the rad environment create Radius CLI command" --- -## rad env create +## rad environment create Create a new Radius Environment @@ -17,7 +17,7 @@ Radius Environments are prepared "landing zones" for Radius Applications. Applications deployed to an environment will inherit the container runtime, configuration, and other settings from the environment. ``` -rad env create [envName] [flags] +rad environment create [envName] [flags] ``` ### Examples @@ -45,5 +45,5 @@ rad env create myenv ### SEE ALSO -* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments +* [rad environment]({{< ref rad_environment.md >}}) - Manage Radius Environments diff --git a/docs/content/reference/cli/rad_env_delete.md b/docs/content/reference/cli/rad_environment_delete.md similarity index 72% rename from docs/content/reference/cli/rad_env_delete.md rename to docs/content/reference/cli/rad_environment_delete.md index 04b170eaa..dc3b1e2de 100644 --- a/docs/content/reference/cli/rad_env_delete.md +++ b/docs/content/reference/cli/rad_environment_delete.md @@ -1,12 +1,12 @@ --- type: docs -title: "rad env delete CLI reference" -linkTitle: "rad env delete" -slug: rad_env_delete -url: /reference/cli/rad_env_delete/ -description: "Details on the rad env delete Radius CLI command" +title: "rad environment delete CLI reference" +linkTitle: "rad environment delete" +slug: rad_environment_delete +url: /reference/cli/rad_environment_delete/ +description: "Details on the rad environment delete Radius CLI command" --- -## rad env delete +## rad environment delete Delete environment @@ -15,7 +15,7 @@ Delete environment Delete environment. Deletes the user's default environment by default. ``` -rad env delete [flags] +rad environment delete [flags] ``` ### Examples @@ -55,5 +55,5 @@ rad env delete my-env --group my-env ### SEE ALSO -* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments +* [rad environment]({{< ref rad_environment.md >}}) - Manage Radius Environments diff --git a/docs/content/reference/cli/rad_env_list.md b/docs/content/reference/cli/rad_environment_list.md similarity index 64% rename from docs/content/reference/cli/rad_env_list.md rename to docs/content/reference/cli/rad_environment_list.md index 0d611390c..ca9428295 100644 --- a/docs/content/reference/cli/rad_env_list.md +++ b/docs/content/reference/cli/rad_environment_list.md @@ -1,12 +1,12 @@ --- type: docs -title: "rad env list CLI reference" -linkTitle: "rad env list" -slug: rad_env_list -url: /reference/cli/rad_env_list/ -description: "Details on the rad env list Radius CLI command" +title: "rad environment list CLI reference" +linkTitle: "rad environment list" +slug: rad_environment_list +url: /reference/cli/rad_environment_list/ +description: "Details on the rad environment list Radius CLI command" --- -## rad env list +## rad environment list List environments @@ -15,7 +15,7 @@ List environments List environments using the current, or specified workspace. ``` -rad env list [flags] +rad environment list [flags] ``` ### Examples @@ -45,5 +45,5 @@ rad env list ### SEE ALSO -* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments +* [rad environment]({{< ref rad_environment.md >}}) - Manage Radius Environments diff --git a/docs/content/reference/cli/rad_env_show.md b/docs/content/reference/cli/rad_environment_show.md similarity index 69% rename from docs/content/reference/cli/rad_env_show.md rename to docs/content/reference/cli/rad_environment_show.md index 2da835a0f..f1a0822f2 100644 --- a/docs/content/reference/cli/rad_env_show.md +++ b/docs/content/reference/cli/rad_environment_show.md @@ -1,12 +1,12 @@ --- type: docs -title: "rad env show CLI reference" -linkTitle: "rad env show" -slug: rad_env_show -url: /reference/cli/rad_env_show/ -description: "Details on the rad env show Radius CLI command" +title: "rad environment show CLI reference" +linkTitle: "rad environment show" +slug: rad_environment_show +url: /reference/cli/rad_environment_show/ +description: "Details on the rad environment show Radius CLI command" --- -## rad env show +## rad environment show Show environment details @@ -15,7 +15,7 @@ Show environment details Show environment details. Shows the user's default environment by default. ``` -rad env show [flags] +rad environment show [flags] ``` ### Examples @@ -51,5 +51,5 @@ rad env show my-env --group my-env ### SEE ALSO -* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments +* [rad environment]({{< ref rad_environment.md >}}) - Manage Radius Environments diff --git a/docs/content/reference/cli/rad_env_switch.md b/docs/content/reference/cli/rad_environment_switch.md similarity index 59% rename from docs/content/reference/cli/rad_env_switch.md rename to docs/content/reference/cli/rad_environment_switch.md index 995e21b8f..5f6d289b3 100644 --- a/docs/content/reference/cli/rad_env_switch.md +++ b/docs/content/reference/cli/rad_environment_switch.md @@ -1,12 +1,12 @@ --- type: docs -title: "rad env switch CLI reference" -linkTitle: "rad env switch" -slug: rad_env_switch -url: /reference/cli/rad_env_switch/ -description: "Details on the rad env switch Radius CLI command" +title: "rad environment switch CLI reference" +linkTitle: "rad environment switch" +slug: rad_environment_switch +url: /reference/cli/rad_environment_switch/ +description: "Details on the rad environment switch Radius CLI command" --- -## rad env switch +## rad environment switch Switch the current environment @@ -15,7 +15,7 @@ Switch the current environment Switch the current environment ``` -rad env switch [environment] [flags] +rad environment switch [environment] [flags] ``` ### Examples @@ -41,5 +41,5 @@ rad env switch newEnvironment ### SEE ALSO -* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments +* [rad environment]({{< ref rad_environment.md >}}) - Manage Radius Environments diff --git a/docs/content/reference/cli/rad_env_update.md b/docs/content/reference/cli/rad_environment_update.md similarity index 82% rename from docs/content/reference/cli/rad_env_update.md rename to docs/content/reference/cli/rad_environment_update.md index f6ca94c69..fbbaaf53e 100644 --- a/docs/content/reference/cli/rad_env_update.md +++ b/docs/content/reference/cli/rad_environment_update.md @@ -1,12 +1,12 @@ --- type: docs -title: "rad env update CLI reference" -linkTitle: "rad env update" -slug: rad_env_update -url: /reference/cli/rad_env_update/ -description: "Details on the rad env update Radius CLI command" +title: "rad environment update CLI reference" +linkTitle: "rad environment update" +slug: rad_environment_update +url: /reference/cli/rad_environment_update/ +description: "Details on the rad environment update Radius CLI command" --- -## rad env update +## rad environment update Update environment configuration @@ -23,7 +23,7 @@ All other properties require the environment to be deleted and recreated. ``` -rad env update [environment] [flags] +rad environment update [environment] [flags] ``` ### Examples @@ -68,5 +68,5 @@ rad env update myenv --clear-aws ### SEE ALSO -* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments +* [rad environment]({{< ref rad_environment.md >}}) - Manage Radius Environments diff --git a/docs/content/reference/cli/rad_init.md b/docs/content/reference/cli/rad_initialize.md similarity index 82% rename from docs/content/reference/cli/rad_init.md rename to docs/content/reference/cli/rad_initialize.md index 4e19fe7b1..d36954d59 100644 --- a/docs/content/reference/cli/rad_init.md +++ b/docs/content/reference/cli/rad_initialize.md @@ -1,12 +1,12 @@ --- type: docs -title: "rad init CLI reference" -linkTitle: "rad init" -slug: rad_init -url: /reference/cli/rad_init/ -description: "Details on the rad init Radius CLI command" +title: "rad initialize CLI reference" +linkTitle: "rad initialize" +slug: rad_initialize +url: /reference/cli/rad_initialize/ +description: "Details on the rad initialize Radius CLI command" --- -## rad init +## rad initialize Initialize Radius @@ -23,7 +23,7 @@ Specifying the '--full' flag will cause 'rad init' to prompt the user for all av ``` -rad init [flags] +rad initialize [flags] ``` ### Examples @@ -42,7 +42,7 @@ rad init --full ``` --full Prompt user for all available configuration options - -h, --help help for init + -h, --help help for initialize -o, --output string output format (supported formats are json, table) (default "table") ``` diff --git a/docs/content/tutorials/new-app/index.md b/docs/content/tutorials/new-app/index.md index 1b16d1331..62eb0ec46 100644 --- a/docs/content/tutorials/new-app/index.md +++ b/docs/content/tutorials/new-app/index.md @@ -36,7 +36,7 @@ By the end of the tutorial, you will have created and deployed a new Radius Appl cd myapp ``` -1. Initialize a new Radius Environment with [`rad init`]({{< ref rad_init >}}): +1. Initialize a new Radius Environment with [`rad init`]({{< ref rad_initialize >}}): ```bash rad init diff --git a/docs/content/tutorials/tutorial-recipe/index.md b/docs/content/tutorials/tutorial-recipe/index.md index 963e92eb8..62c11deee 100644 --- a/docs/content/tutorials/tutorial-recipe/index.md +++ b/docs/content/tutorials/tutorial-recipe/index.md @@ -287,7 +287,7 @@ This step requires an Azure subscription or an AWS account to deploy cloud resou ## Step 5: Cleanup your environment -1. You can use the rad CLI to [delete your environment]({{< ref rad_env_delete.md >}}) and all the Radius resources running on your cluster: +1. You can use the rad CLI to [delete your environment]({{< ref rad_environment_delete.md >}}) and all the Radius resources running on your cluster: ```bash rad env delete default --yes diff --git a/docs/shared-content/installation/install-radius/initialize-radius.md b/docs/shared-content/installation/install-radius/initialize-radius.md index ea9146d22..67231c9f1 100644 --- a/docs/shared-content/installation/install-radius/initialize-radius.md +++ b/docs/shared-content/installation/install-radius/initialize-radius.md @@ -11,7 +11,7 @@ Initializing Radius installs the Radius control-plane and creates a Radius Envir kubectl config current-context ``` -1. Initialize a new [Radius Environment]({{< ref "/guides/deploy-apps/environments/overview">}}) with [`rad init`]({{< ref rad_init >}}): +1. Initialize a new [Radius Environment]({{< ref "/guides/deploy-apps/environments/overview">}}) with [`rad init`]({{< ref rad_initialize >}}): ```bash rad init @@ -49,7 +49,7 @@ Initializing Radius installs the Radius control-plane and creates a Radius Envir contour-contour 1/1 1 1 46s ``` - You can also use [`rad env list`]({{< ref rad_env_list.md >}}) to view your environment: + You can also use [`rad env list`]({{< ref rad_environment_list.md >}}) to view your environment: ```bash rad env list diff --git a/holding-pen/reference-apps/aws-rds/index.md b/holding-pen/reference-apps/aws-rds/index.md index d8bfaf3be..5be5d943e 100644 --- a/holding-pen/reference-apps/aws-rds/index.md +++ b/holding-pen/reference-apps/aws-rds/index.md @@ -50,7 +50,7 @@ The setup here ensures that the RDS instance is deployed to the set of subnets a ## Cleanup {{% alert title="Delete environment" color="warning" %}} -If you're done with testing, you can use the rad CLI to [delete an environment]({{< ref rad_env_delete.md >}}) to delete all Radius resources running on the EKS Cluster. +If you're done with testing, you can use the rad CLI to [delete an environment]({{< ref rad_environment_delete.md >}}) to delete all Radius resources running on the EKS Cluster. {{% /alert %}} {{% alert title="Cleanup AWS Resources" color="warning" %}} diff --git a/holding-pen/reference-apps/aws-sqs/_index.md b/holding-pen/reference-apps/aws-sqs/_index.md index d97aee3ec..5f6dee58c 100644 --- a/holding-pen/reference-apps/aws-sqs/_index.md +++ b/holding-pen/reference-apps/aws-sqs/_index.md @@ -53,7 +53,7 @@ This application models two http services: (1) `producer` and (2) `consumer` tha ## Cleanup {{% alert title="Delete environment" color="warning" %}} -If you're done with testing, you can use the rad CLI to [delete an environment]({{< ref rad_env_delete.md >}}) to delete all Radius resources running on the EKS Cluster. +If you're done with testing, you can use the rad CLI to [delete an environment]({{< ref rad_environment_delete.md >}}) to delete all Radius resources running on the EKS Cluster. {{% /alert %}} {{% alert title="Cleanup AWS Resources" color="warning" %}} From 743847be69747d8c1be1bb2d01b78e69660ff70c Mon Sep 17 00:00:00 2001 From: rad-ci-bot <103787451+rad-ci-bot@users.noreply.github.com> Date: Wed, 8 Jan 2025 10:44:23 -0800 Subject: [PATCH 2/2] Autogenerate reference docs (#1348) Signed-off-by: rad-ci-bot Co-authored-by: rad-ci-bot Co-authored-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> --- docs/content/reference/cli/rad_application_graph.md | 1 - docs/content/reference/cli/rad_resource-provider_create.md | 7 +++++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/content/reference/cli/rad_application_graph.md b/docs/content/reference/cli/rad_application_graph.md index da4e1cbe5..7c53ec18d 100644 --- a/docs/content/reference/cli/rad_application_graph.md +++ b/docs/content/reference/cli/rad_application_graph.md @@ -33,7 +33,6 @@ rad app graph my-application ``` -a, --application string The application name - -e, --environment string The environment name -g, --group string The resource group name -h, --help help for graph -w, --workspace string The workspace name diff --git a/docs/content/reference/cli/rad_resource-provider_create.md b/docs/content/reference/cli/rad_resource-provider_create.md index 47ddd323e..cfd0b8810 100644 --- a/docs/content/reference/cli/rad_resource-provider_create.md +++ b/docs/content/reference/cli/rad_resource-provider_create.md @@ -18,7 +18,7 @@ Resource providers are the entities that implement resource types such as 'Appli Creating a resource provider defines new resource types that can be used in applications. -Input can be passed in using a file or inline JSON as the second argument. Prefix the input with '@' to indicate a file path. +Input can be passed in using a JSON or YAML file using the --from-file option. ``` @@ -29,9 +29,12 @@ rad resource-provider create [input] [flags] ``` -# Create a resource provider +# Create a resource provider from YAML file rad resource-provider create --from-file /path/to/input.yaml +# Create a resource provider from JSON file +rad resource-provider create --from-file /path/to/input.json + ``` ### Options