From 92c9e225101c8ba3c01b068d0a60093f7a72eb20 Mon Sep 17 00:00:00 2001 From: Emanuel Palm Date: Wed, 22 Nov 2023 22:47:24 +0100 Subject: [PATCH] fixed whitespace in CLI reference Signed-off-by: Emanuel Palm --- .../reference/api/resource-policies/_index.md | 1 - docs/content/reference/cli/rad.md | 33 ++++--- docs/content/reference/cli/rad_application.md | 15 ++-- .../cli/rad_application_connections.md | 3 +- .../reference/cli/rad_application_delete.md | 3 +- .../reference/cli/rad_application_list.md | 3 +- .../reference/cli/rad_application_show.md | 3 +- .../reference/cli/rad_application_status.md | 3 +- .../reference/cli/rad_application_switch.md | 3 +- docs/content/reference/cli/rad_bicep.md | 9 +- .../content/reference/cli/rad_bicep_delete.md | 3 +- .../reference/cli/rad_bicep_download.md | 3 +- .../reference/cli/rad_bicep_publish.md | 11 ++- docs/content/reference/cli/rad_completion.md | 87 +++++++++---------- .../reference/cli/rad_completion_bash.md | 3 +- .../cli/rad_completion_powershell.md | 5 +- .../reference/cli/rad_completion_zsh.md | 3 +- docs/content/reference/cli/rad_credential.md | 13 ++- .../reference/cli/rad_credential_list.md | 3 +- .../reference/cli/rad_credential_register.md | 13 ++- .../cli/rad_credential_register_aws.md | 6 +- .../cli/rad_credential_register_azure.md | 7 +- .../reference/cli/rad_credential_show.md | 3 +- .../cli/rad_credential_unregister.md | 3 +- docs/content/reference/cli/rad_debug-logs.md | 6 +- docs/content/reference/cli/rad_deploy.md | 8 +- docs/content/reference/cli/rad_env.md | 15 ++-- docs/content/reference/cli/rad_env_create.md | 3 +- docs/content/reference/cli/rad_env_delete.md | 3 +- docs/content/reference/cli/rad_env_list.md | 3 +- docs/content/reference/cli/rad_env_show.md | 3 +- docs/content/reference/cli/rad_env_switch.md | 3 +- docs/content/reference/cli/rad_env_update.md | 11 ++- docs/content/reference/cli/rad_group.md | 18 ++-- .../content/reference/cli/rad_group_create.md | 4 +- .../content/reference/cli/rad_group_delete.md | 9 +- docs/content/reference/cli/rad_group_list.md | 5 +- docs/content/reference/cli/rad_group_show.md | 4 +- .../content/reference/cli/rad_group_switch.md | 9 +- docs/content/reference/cli/rad_init.md | 7 +- docs/content/reference/cli/rad_install.md | 5 +- .../reference/cli/rad_install_kubernetes.md | 8 +- docs/content/reference/cli/rad_recipe.md | 14 +-- docs/content/reference/cli/rad_recipe_list.md | 3 +- .../reference/cli/rad_recipe_register.md | 14 ++- docs/content/reference/cli/rad_recipe_show.md | 10 +-- .../reference/cli/rad_recipe_unregister.md | 3 +- docs/content/reference/cli/rad_resource.md | 13 ++- .../reference/cli/rad_resource_delete.md | 11 ++- .../reference/cli/rad_resource_expose.md | 3 +- .../reference/cli/rad_resource_list.md | 23 +++-- .../reference/cli/rad_resource_logs.md | 3 +- .../reference/cli/rad_resource_show.md | 23 +++-- docs/content/reference/cli/rad_run.md | 8 +- docs/content/reference/cli/rad_uninstall.md | 5 +- .../reference/cli/rad_uninstall_kubernetes.md | 3 +- docs/content/reference/cli/rad_version.md | 3 +- docs/content/reference/cli/rad_workspace.md | 20 ++--- .../reference/cli/rad_workspace_create.md | 7 +- .../reference/cli/rad_workspace_delete.md | 3 +- .../reference/cli/rad_workspace_list.md | 3 +- .../reference/cli/rad_workspace_show.md | 3 +- .../reference/cli/rad_workspace_switch.md | 3 +- docs/content/reference/limitations.md | 4 +- .../reference/resource-schema/aws/index.md | 2 +- .../extender/snippets/extender-recipe.bicep | 3 - .../gateway/snippets/gateway.bicep | 2 +- .../snippets/dapr-statestore-recipe.bicep | 3 +- 68 files changed, 228 insertions(+), 327 deletions(-) diff --git a/docs/content/reference/api/resource-policies/_index.md b/docs/content/reference/api/resource-policies/_index.md index bcceebe1f..70e282128 100644 --- a/docs/content/reference/api/resource-policies/_index.md +++ b/docs/content/reference/api/resource-policies/_index.md @@ -59,7 +59,6 @@ Each resource type controller decides whether it will retry to process the opera | Applications.Dapr/stateStores | LIST/GET/PUT/PATCH/DELETE | Synchronous | default | | | Applications.Dapr/stateStores | POST ListSecret | Synchronous | default | | - #### Applications.Datastores resource providers | Resource Type | Operation | API Type | Server Timeout (Seconds) | Async Operation retry condition| diff --git a/docs/content/reference/cli/rad.md b/docs/content/reference/cli/rad.md index 3d109460d..d6cf5b7fc 100644 --- a/docs/content/reference/cli/rad.md +++ b/docs/content/reference/cli/rad.md @@ -24,20 +24,19 @@ Radius CLI ### SEE ALSO -* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications -* [rad bicep]({{< ref rad_bicep.md >}}) - Manage bicep compiler -* [rad completion]({{< ref rad_completion.md >}}) - Generates shell completion scripts -* [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 group]({{< ref rad_group.md >}}) - Manage resource groups -* [rad init]({{< ref rad_init.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 -* [rad run]({{< ref rad_run.md >}}) - Run an application -* [rad uninstall]({{< ref rad_uninstall.md >}}) - Uninstall Radius for a specific platform -* [rad version]({{< ref rad_version.md >}}) - Prints the versions of the rad cli -* [rad workspace]({{< ref rad_workspace.md >}}) - Manage workspaces - +* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications +* [rad bicep]({{< ref rad_bicep.md >}}) - Manage bicep compiler +* [rad completion]({{< ref rad_completion.md >}}) - Generates shell completion scripts +* [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 group]({{< ref rad_group.md >}}) - Manage resource groups +* [rad init]({{< ref rad_init.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 +* [rad run]({{< ref rad_run.md >}}) - Run an application +* [rad uninstall]({{< ref rad_uninstall.md >}}) - Uninstall Radius for a specific platform +* [rad version]({{< ref rad_version.md >}}) - Prints the versions of the rad cli +* [rad workspace]({{< ref rad_workspace.md >}}) - Manage workspaces diff --git a/docs/content/reference/cli/rad_application.md b/docs/content/reference/cli/rad_application.md index b0e43281c..65a2ea2fc 100644 --- a/docs/content/reference/cli/rad_application.md +++ b/docs/content/reference/cli/rad_application.md @@ -29,11 +29,10 @@ Manage Radius Applications ### SEE ALSO -* [rad]({{< ref rad.md >}}) - Radius CLI -* [rad application connections]({{< ref rad_application_connections.md >}}) - Shows the connections for an application. -* [rad application delete]({{< ref rad_application_delete.md >}}) - Delete Radius Application -* [rad application list]({{< ref rad_application_list.md >}}) - List Radius Applications -* [rad application show]({{< ref rad_application_show.md >}}) - Show Radius Application details -* [rad application status]({{< ref rad_application_status.md >}}) - Show Radius Application status -* [rad application switch]({{< ref rad_application_switch.md >}}) - Switch the default Radius Application - +* [rad]({{< ref rad.md >}}) - Radius CLI +* [rad application connections]({{< ref rad_application_connections.md >}}) - Shows the connections for an application. +* [rad application delete]({{< ref rad_application_delete.md >}}) - Delete Radius Application +* [rad application list]({{< ref rad_application_list.md >}}) - List Radius Applications +* [rad application show]({{< ref rad_application_show.md >}}) - Show Radius Application details +* [rad application status]({{< ref rad_application_status.md >}}) - Show Radius Application status +* [rad application switch]({{< ref rad_application_switch.md >}}) - Switch the default Radius Application diff --git a/docs/content/reference/cli/rad_application_connections.md b/docs/content/reference/cli/rad_application_connections.md index 8c1c81811..0a5fe92b8 100644 --- a/docs/content/reference/cli/rad_application_connections.md +++ b/docs/content/reference/cli/rad_application_connections.md @@ -48,5 +48,4 @@ rad app connections my-application ### SEE ALSO -* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications - +* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications diff --git a/docs/content/reference/cli/rad_application_delete.md b/docs/content/reference/cli/rad_application_delete.md index 294d5d970..95aa95efc 100644 --- a/docs/content/reference/cli/rad_application_delete.md +++ b/docs/content/reference/cli/rad_application_delete.md @@ -55,5 +55,4 @@ rad app delete my-app --group my-group ### SEE ALSO -* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications - +* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications diff --git a/docs/content/reference/cli/rad_application_list.md b/docs/content/reference/cli/rad_application_list.md index f9544eef2..ac9fcfd18 100644 --- a/docs/content/reference/cli/rad_application_list.md +++ b/docs/content/reference/cli/rad_application_list.md @@ -47,5 +47,4 @@ rad app list --group my-group ### SEE ALSO -* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications - +* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications diff --git a/docs/content/reference/cli/rad_application_show.md b/docs/content/reference/cli/rad_application_show.md index a8dcc10c6..55af4a375 100644 --- a/docs/content/reference/cli/rad_application_show.md +++ b/docs/content/reference/cli/rad_application_show.md @@ -51,5 +51,4 @@ rad app show my-app --group my-group ### SEE ALSO -* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications - +* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications diff --git a/docs/content/reference/cli/rad_application_status.md b/docs/content/reference/cli/rad_application_status.md index 48ae31e34..1105be8ee 100644 --- a/docs/content/reference/cli/rad_application_status.md +++ b/docs/content/reference/cli/rad_application_status.md @@ -51,5 +51,4 @@ rad app status my-app --group my-group ### SEE ALSO -* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications - +* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications diff --git a/docs/content/reference/cli/rad_application_switch.md b/docs/content/reference/cli/rad_application_switch.md index ba7152a8c..3d7de20fa 100644 --- a/docs/content/reference/cli/rad_application_switch.md +++ b/docs/content/reference/cli/rad_application_switch.md @@ -41,5 +41,4 @@ rad app switch newApplication ### SEE ALSO -* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications - +* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications diff --git a/docs/content/reference/cli/rad_bicep.md b/docs/content/reference/cli/rad_bicep.md index bfae05168..bfe74aaa1 100644 --- a/docs/content/reference/cli/rad_bicep.md +++ b/docs/content/reference/cli/rad_bicep.md @@ -29,8 +29,7 @@ Manage bicep compiler used by Radius ### SEE ALSO -* [rad]({{< ref rad.md >}}) - Radius CLI -* [rad bicep delete]({{< ref rad_bicep_delete.md >}}) - Delete installed bicep compiler -* [rad bicep download]({{< ref rad_bicep_download.md >}}) - Download the bicep compiler -* [rad bicep publish]({{< ref rad_bicep_publish.md >}}) - Publish a Bicep file to an OCI registry. - +* [rad]({{< ref rad.md >}}) - Radius CLI +* [rad bicep delete]({{< ref rad_bicep_delete.md >}}) - Delete installed bicep compiler +* [rad bicep download]({{< ref rad_bicep_download.md >}}) - Download the bicep compiler +* [rad bicep publish]({{< ref rad_bicep_publish.md >}}) - Publish a Bicep file to an OCI registry. diff --git a/docs/content/reference/cli/rad_bicep_delete.md b/docs/content/reference/cli/rad_bicep_delete.md index 5c6b089d9..181a524f1 100644 --- a/docs/content/reference/cli/rad_bicep_delete.md +++ b/docs/content/reference/cli/rad_bicep_delete.md @@ -33,5 +33,4 @@ rad bicep delete [flags] ### SEE ALSO -* [rad bicep]({{< ref rad_bicep.md >}}) - Manage bicep compiler - +* [rad bicep]({{< ref rad_bicep.md >}}) - Manage bicep compiler diff --git a/docs/content/reference/cli/rad_bicep_download.md b/docs/content/reference/cli/rad_bicep_download.md index 3a065a0ee..bcb55b6d8 100644 --- a/docs/content/reference/cli/rad_bicep_download.md +++ b/docs/content/reference/cli/rad_bicep_download.md @@ -33,5 +33,4 @@ rad bicep download [flags] ### SEE ALSO -* [rad bicep]({{< ref rad_bicep.md >}}) - Manage bicep compiler - +* [rad bicep]({{< ref rad_bicep.md >}}) - Manage bicep compiler diff --git a/docs/content/reference/cli/rad_bicep_publish.md b/docs/content/reference/cli/rad_bicep_publish.md index db2a3c5ac..d5cad0b44 100644 --- a/docs/content/reference/cli/rad_bicep_publish.md +++ b/docs/content/reference/cli/rad_bicep_publish.md @@ -13,11 +13,13 @@ Publish a Bicep file to an OCI registry. ### Synopsis Publish a Bicep file to an OCI registry. + This command compiles and publishes a local Bicep file to a remote Open Container Initiative (OCI) registry, such as Azure Container Registry, Docker Hub, or GitHub Container Registry, to later be used as a Bicep registry or for Radius Recipes. + Before publishing, it is expected the user runs docker login (or similar command) and has the proper permission to push to the target OCI registry. -For more information on Bicep modules visit https://learn.microsoft.com/azure/azure-resource-manager/bicep/modules - +For more information on Bicep modules visit . + ``` rad bicep publish [flags] ``` @@ -25,10 +27,8 @@ rad bicep publish [flags] ### Examples ``` - # Publish a Bicep file to a container registry rad bicep publish --file ./redis-test.bicep --target br:ghcr.io/myregistry/redis-test:v1 - ``` ### Options @@ -48,5 +48,4 @@ rad bicep publish --file ./redis-test.bicep --target br:ghcr.io/myregistry/redis ### SEE ALSO -* [rad bicep]({{< ref rad_bicep.md >}}) - Manage bicep compiler - +* [rad bicep]({{< ref rad_bicep.md >}}) - Manage bicep compiler diff --git a/docs/content/reference/cli/rad_completion.md b/docs/content/reference/cli/rad_completion.md index 10ef74275..f6e5fbe4f 100644 --- a/docs/content/reference/cli/rad_completion.md +++ b/docs/content/reference/cli/rad_completion.md @@ -17,46 +17,44 @@ rad completion [flags] ### Examples ``` - - # Installing bash completion on macOS using homebrew - ## If running Bash 3.2 included with macOS - brew install bash-completion - ## or, if running Bash 4.1+ - brew install bash-completion@2 - ## Add the completion to your completion directory - rad completion bash > $(brew --prefix)/etc/bash_completion.d/rad - source ~/.bash_profile - # Installing bash completion on Linux - ## If bash-completion is not installed on Linux, please install the 'bash-completion' package - ## via your distribution's package manager. - ## Load the rad completion code for bash into the current shell - source <(rad completion bash) - ## Write bash completion code to a file and source if from .bash_profile - rad completion bash > ~/.rad/completion.bash.inc - printf " - ## rad shell completion - source '$HOME/.rad/completion.bash.inc' - " >> $HOME/.bash_profile - source $HOME/.bash_profile - # Installing zsh completion on macOS using homebrew - ## If zsh-completion is not installed on macOS, please install the 'zsh-completion' package - brew install zsh-completions - ## Set the rad completion code for zsh[1] to autoload on startup - rad completion zsh > "${fpath[1]}/_rad" - source ~/.zshrc - # Installing zsh completion on Linux - ## If zsh-completion is not installed on Linux, please install the 'zsh-completion' package - ## via your distribution's package manager. - ## Load the rad completion code for zsh into the current shell - source <(rad completion zsh) - # Set the rad completion code for zsh[1] to autoload on startup - rad completion zsh > "${fpath[1]}/_rad" - # Installing powershell completion on Windows - ## Create $PROFILE if it not exists - if (!(Test-Path -Path $PROFILE )){ New-Item -Type File -Path $PROFILE -Force } - ## Add the completion to your profile - rad completion powershell >> $PROFILE - + # Installing bash completion on macOS using homebrew + ## If running Bash 3.2 included with macOS + brew install bash-completion + ## or, if running Bash 4.1+ + brew install bash-completion@2 + ## Add the completion to your completion directory + rad completion bash > $(brew --prefix)/etc/bash_completion.d/rad + source ~/.bash_profile + # Installing bash completion on Linux + ## If bash-completion is not installed on Linux, please install the 'bash-completion' package + ## via your distribution's package manager. + ## Load the rad completion code for bash into the current shell + source <(rad completion bash) + ## Write bash completion code to a file and source if from .bash_profile + rad completion bash > ~/.rad/completion.bash.inc + printf " + ## rad shell completion + source '$HOME/.rad/completion.bash.inc' + " >> $HOME/.bash_profile + source $HOME/.bash_profile + # Installing zsh completion on macOS using homebrew + ## If zsh-completion is not installed on macOS, please install the 'zsh-completion' package + brew install zsh-completions + ## Set the rad completion code for zsh[1] to autoload on startup + rad completion zsh > "${fpath[1]}/_rad" + source ~/.zshrc + # Installing zsh completion on Linux + ## If zsh-completion is not installed on Linux, please install the 'zsh-completion' package + ## via your distribution's package manager. + ## Load the rad completion code for zsh into the current shell + source <(rad completion zsh) + # Set the rad completion code for zsh[1] to autoload on startup + rad completion zsh > "${fpath[1]}/_rad" + # Installing powershell completion on Windows + ## Create $PROFILE if it not exists + if (!(Test-Path -Path $PROFILE )){ New-Item -Type File -Path $PROFILE -Force } + ## Add the completion to your profile + rad completion powershell >> $PROFILE ``` ### Options @@ -74,8 +72,7 @@ rad completion [flags] ### SEE ALSO -* [rad]({{< ref rad.md >}}) - Radius CLI -* [rad completion bash]({{< ref rad_completion_bash.md >}}) - Generates bash completion scripts -* [rad completion powershell]({{< ref rad_completion_powershell.md >}}) - Generates powershell completion scripts -* [rad completion zsh]({{< ref rad_completion_zsh.md >}}) - Generates zsh completion scripts - +* [rad]({{< ref rad.md >}}) - Radius CLI +* [rad completion bash]({{< ref rad_completion_bash.md >}}) - Generates bash completion scripts +* [rad completion powershell]({{< ref rad_completion_powershell.md >}}) - Generates PowerShell completion scripts +* [rad completion zsh]({{< ref rad_completion_zsh.md >}}) - Generates zsh completion scripts diff --git a/docs/content/reference/cli/rad_completion_bash.md b/docs/content/reference/cli/rad_completion_bash.md index 0f77b275d..e825c8ba9 100644 --- a/docs/content/reference/cli/rad_completion_bash.md +++ b/docs/content/reference/cli/rad_completion_bash.md @@ -29,5 +29,4 @@ rad completion bash [flags] ### SEE ALSO -* [rad completion]({{< ref rad_completion.md >}}) - Generates shell completion scripts - +* [rad completion]({{< ref rad_completion.md >}}) - Generates shell completion scripts diff --git a/docs/content/reference/cli/rad_completion_powershell.md b/docs/content/reference/cli/rad_completion_powershell.md index 4a2411f4a..c836847bf 100644 --- a/docs/content/reference/cli/rad_completion_powershell.md +++ b/docs/content/reference/cli/rad_completion_powershell.md @@ -8,7 +8,7 @@ description: "Details on the rad completion powershell Radius CLI command" --- ## rad completion powershell -Generates powershell completion scripts +Generates PowerShell completion scripts ``` rad completion powershell [flags] @@ -29,5 +29,4 @@ rad completion powershell [flags] ### SEE ALSO -* [rad completion]({{< ref rad_completion.md >}}) - Generates shell completion scripts - +* [rad completion]({{< ref rad_completion.md >}}) - Generates shell completion scripts diff --git a/docs/content/reference/cli/rad_completion_zsh.md b/docs/content/reference/cli/rad_completion_zsh.md index af95aecef..343a0ca20 100644 --- a/docs/content/reference/cli/rad_completion_zsh.md +++ b/docs/content/reference/cli/rad_completion_zsh.md @@ -29,5 +29,4 @@ rad completion zsh [flags] ### SEE ALSO -* [rad completion]({{< ref rad_completion.md >}}) - Generates shell completion scripts - +* [rad completion]({{< ref rad_completion.md >}}) - Generates shell completion scripts diff --git a/docs/content/reference/cli/rad_credential.md b/docs/content/reference/cli/rad_credential.md index 853ecf1f5..6a0afefb8 100644 --- a/docs/content/reference/cli/rad_credential.md +++ b/docs/content/reference/cli/rad_credential.md @@ -24,7 +24,6 @@ or credentials will affect all Radius Environments and applications of the affec ### Examples ``` - # List configured cloud providers credential rad credential list @@ -42,7 +41,6 @@ rad credential show aws rad credential unregister azure # Delete AWS cloud provider configuration rad credential unregister aws - ``` ### Options @@ -60,9 +58,8 @@ rad credential unregister aws ### SEE ALSO -* [rad]({{< ref rad.md >}}) - Radius CLI -* [rad credential list]({{< ref rad_credential_list.md >}}) - List configured cloud provider credentials -* [rad credential register]({{< ref rad_credential_register.md >}}) - Register(Add or update) cloud provider credential for a Radius installation. -* [rad credential show]({{< ref rad_credential_show.md >}}) - Show details of a configured cloud provider credential -* [rad credential unregister]({{< ref rad_credential_unregister.md >}}) - Unregisters a configured cloud provider credential from the Radius installation - +* [rad]({{< ref rad.md >}}) - Radius CLI +* [rad credential list]({{< ref rad_credential_list.md >}}) - List configured cloud provider credentials +* [rad credential register]({{< ref rad_credential_register.md >}}) - Register(Add or update) cloud provider credential for a Radius installation. +* [rad credential show]({{< ref rad_credential_show.md >}}) - Show details of a configured cloud provider credential +* [rad credential unregister]({{< ref rad_credential_unregister.md >}}) - Unregisters a configured cloud provider credential from the Radius installation diff --git a/docs/content/reference/cli/rad_credential_list.md b/docs/content/reference/cli/rad_credential_list.md index 403eaf155..075192f67 100644 --- a/docs/content/reference/cli/rad_credential_list.md +++ b/docs/content/reference/cli/rad_credential_list.md @@ -50,5 +50,4 @@ rad credential list ### SEE ALSO -* [rad credential]({{< ref rad_credential.md >}}) - Manage cloud provider credential for a Radius installation. - +* [rad credential]({{< ref rad_credential.md >}}) - Manage cloud provider credential for a Radius installation. diff --git a/docs/content/reference/cli/rad_credential_register.md b/docs/content/reference/cli/rad_credential_register.md index 4935ee014..874e31ed5 100644 --- a/docs/content/reference/cli/rad_credential_register.md +++ b/docs/content/reference/cli/rad_credential_register.md @@ -24,12 +24,10 @@ or credentials will affect all Radius Environments and applications of the affec ### Examples ``` - # Register (Add or update) cloud provider credential for Azure with service principal authentication -rad credential register azure --client-id --client-secret --tenant-id +rad credential register azure --client-id --client-secret --tenant-id # Register (Add or Update) cloud provider credential for AWS with IAM authentication -rad credential register aws --access-key-id --secret-access-key - +rad credential register aws --access-key-id --secret-access-key ``` ### Options @@ -47,7 +45,6 @@ rad credential register aws --access-key-id --secret-access-key ### SEE ALSO -* [rad credential]({{< ref rad_credential.md >}}) - Manage cloud provider credential for a Radius installation. -* [rad credential register aws]({{< ref rad_credential_register_aws.md >}}) - Register (Add or update) AWS cloud provider credential for a Radius installation. -* [rad credential register azure]({{< ref rad_credential_register_azure.md >}}) - Register (Add or update) Azure cloud provider credential for a Radius installation. - +- [rad credential]({{< ref rad_credential.md >}}) - Manage cloud provider credential for a Radius installation. +- [rad credential register aws]({{< ref rad_credential_register_aws.md >}}) - Register (Add or update) AWS cloud provider credential for a Radius installation. +- [rad credential register azure]({{< ref rad_credential_register_azure.md >}}) - Register (Add or update) Azure cloud provider credential for a Radius installation. diff --git a/docs/content/reference/cli/rad_credential_register_aws.md b/docs/content/reference/cli/rad_credential_register_aws.md index 813cea694..0d82aa60c 100644 --- a/docs/content/reference/cli/rad_credential_register_aws.md +++ b/docs/content/reference/cli/rad_credential_register_aws.md @@ -17,8 +17,7 @@ Register (Add or update) AWS cloud provider credential for a Radius installation This command is intended for scripting or advanced use-cases. See 'rad init' for a user-friendly way to configure these settings. -Radius will use the provided IAM credential for all interactions with AWS. - +Radius will use the provided IAM credential for all interactions with AWS. Radius cloud providers enable Radius Environments to deploy and integrate with cloud resources (Azure, AWS). The Radius control-plane stores credentials for use when accessing cloud resources. @@ -58,5 +57,4 @@ rad credential register aws --access-key-id --secret-access-key ### SEE ALSO -* [rad credential register]({{< ref rad_credential_register.md >}}) - Register(Add or update) cloud provider credential for a Radius installation. - +* [rad credential register]({{< ref rad_credential_register.md >}}) - Register(Add or update) cloud provider credential for a Radius installation. diff --git a/docs/content/reference/cli/rad_credential_register_azure.md b/docs/content/reference/cli/rad_credential_register_azure.md index 941c180d2..f42329d7c 100644 --- a/docs/content/reference/cli/rad_credential_register_azure.md +++ b/docs/content/reference/cli/rad_credential_register_azure.md @@ -17,15 +17,13 @@ Register (Add or update) Azure cloud provider credential for a Radius installati This command is intended for scripting or advanced use-cases. See 'rad init' for a user-friendly way to configure these settings. -Radius will use the provided service principal for all interactions with Azure, including Bicep deployment, -Radius Environments, and Radius portable resources. +Radius will use the provided service principal for all interactions with Azure, including Bicep deployment, Radius Environments, and Radius portable resources. Radius will use the provided subscription and resource group as the default target scope for Bicep deployment. The provided service principal must have the Contributor or Owner role assigned for the provided resource group in order to create or manage resources contained in the group. The resource group should be created before calling 'rad credential register azure'. - Radius cloud providers enable Radius Environments to deploy and integrate with cloud resources (Azure, AWS). The Radius control-plane stores credentials for use when accessing cloud resources. @@ -65,5 +63,4 @@ rad credential register azure --client-id --client-secret }}) - Register(Add or update) cloud provider credential for a Radius installation. - +- [rad credential register]({{< ref rad_credential_register.md >}}) - Register(Add or update) cloud provider credential for a Radius installation. diff --git a/docs/content/reference/cli/rad_credential_show.md b/docs/content/reference/cli/rad_credential_show.md index 7bb782d8c..5f5150a5d 100644 --- a/docs/content/reference/cli/rad_credential_show.md +++ b/docs/content/reference/cli/rad_credential_show.md @@ -53,5 +53,4 @@ rad credential show aws ### SEE ALSO -* [rad credential]({{< ref rad_credential.md >}}) - Manage cloud provider credential for a Radius installation. - +- [rad credential]({{< ref rad_credential.md >}}) - Manage cloud provider credential for a Radius installation. diff --git a/docs/content/reference/cli/rad_credential_unregister.md b/docs/content/reference/cli/rad_credential_unregister.md index 4d366e021..779a21f80 100644 --- a/docs/content/reference/cli/rad_credential_unregister.md +++ b/docs/content/reference/cli/rad_credential_unregister.md @@ -53,5 +53,4 @@ rad credential unregister aws ### SEE ALSO -* [rad credential]({{< ref rad_credential.md >}}) - Manage cloud provider credential for a Radius installation. - +* [rad credential]({{< ref rad_credential.md >}}) - Manage cloud provider credential for a Radius installation. diff --git a/docs/content/reference/cli/rad_debug-logs.md b/docs/content/reference/cli/rad_debug-logs.md index 18567bd04..12e55f1d7 100644 --- a/docs/content/reference/cli/rad_debug-logs.md +++ b/docs/content/reference/cli/rad_debug-logs.md @@ -13,12 +13,11 @@ Capture logs from Radius control plane for debugging and diagnostics. ### Synopsis Capture logs from Radius control plane for debugging and diagnostics. - + Creates a ZIP file of logs in the current directory. WARNING Please inspect all logs before sending feedback to confirm no private information is included. - ``` rad debug-logs [flags] ``` @@ -39,5 +38,4 @@ rad debug-logs [flags] ### SEE ALSO -* [rad]({{< ref rad.md >}}) - Radius CLI - +* [rad]({{< ref rad.md >}}) - Radius CLI diff --git a/docs/content/reference/cli/rad_deploy.md b/docs/content/reference/cli/rad_deploy.md index 2cd393831..a4081543e 100644 --- a/docs/content/reference/cli/rad_deploy.md +++ b/docs/content/reference/cli/rad_deploy.md @@ -30,8 +30,7 @@ Deploy a Bicep or ARM template https://docs.microsoft.com/en-us/azure/azure-resource-manager/templates/parameter-files You can specify parameters using multiple sources. Parameters can be overridden based on the - order the are provided. Parameters appearing later in the argument list will override those defined earlier. - + order the are provided. Parameters appearing later in the argument list will override those defined earlier. ``` rad deploy [file] [flags] @@ -40,7 +39,6 @@ rad deploy [file] [flags] ### Examples ``` - # deploy a Bicep template rad deploy myapp.bicep @@ -70,7 +68,6 @@ rad deploy myapp.bicep --parameters @myfile.json # specify parameters from multiple sources rad deploy myapp.bicep --parameters @myfile.json --parameters version=latest - ``` ### Options @@ -93,5 +90,4 @@ rad deploy myapp.bicep --parameters @myfile.json --parameters version=latest ### SEE ALSO -* [rad]({{< ref rad.md >}}) - Radius CLI - +- [rad]({{< ref rad.md >}}) - Radius CLI diff --git a/docs/content/reference/cli/rad_env.md b/docs/content/reference/cli/rad_env.md index 359aa5e6c..59be6845c 100644 --- a/docs/content/reference/cli/rad_env.md +++ b/docs/content/reference/cli/rad_env.md @@ -32,11 +32,10 @@ Radius Environments are prepared “landing zones” for Radius Applications. Ap ### 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 - +* [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_env_create.md b/docs/content/reference/cli/rad_env_create.md index 51bdf1e29..245d862f1 100644 --- a/docs/content/reference/cli/rad_env_create.md +++ b/docs/content/reference/cli/rad_env_create.md @@ -45,5 +45,4 @@ rad env create myenv ### SEE ALSO -* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments - +* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments diff --git a/docs/content/reference/cli/rad_env_delete.md b/docs/content/reference/cli/rad_env_delete.md index 04b170eaa..e1c03e9ee 100644 --- a/docs/content/reference/cli/rad_env_delete.md +++ b/docs/content/reference/cli/rad_env_delete.md @@ -55,5 +55,4 @@ rad env delete my-env --group my-env ### SEE ALSO -* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments - +* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments diff --git a/docs/content/reference/cli/rad_env_list.md b/docs/content/reference/cli/rad_env_list.md index 0d611390c..ccaa4cf6e 100644 --- a/docs/content/reference/cli/rad_env_list.md +++ b/docs/content/reference/cli/rad_env_list.md @@ -45,5 +45,4 @@ rad env list ### SEE ALSO -* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments - +* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments diff --git a/docs/content/reference/cli/rad_env_show.md b/docs/content/reference/cli/rad_env_show.md index 2da835a0f..34b490038 100644 --- a/docs/content/reference/cli/rad_env_show.md +++ b/docs/content/reference/cli/rad_env_show.md @@ -51,5 +51,4 @@ rad env show my-env --group my-env ### SEE ALSO -* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments - +* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments diff --git a/docs/content/reference/cli/rad_env_switch.md b/docs/content/reference/cli/rad_env_switch.md index 995e21b8f..e960707ad 100644 --- a/docs/content/reference/cli/rad_env_switch.md +++ b/docs/content/reference/cli/rad_env_switch.md @@ -41,5 +41,4 @@ rad env switch newEnvironment ### SEE ALSO -* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments - +* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments diff --git a/docs/content/reference/cli/rad_env_update.md b/docs/content/reference/cli/rad_env_update.md index f6ca94c69..437163bca 100644 --- a/docs/content/reference/cli/rad_env_update.md +++ b/docs/content/reference/cli/rad_env_update.md @@ -13,14 +13,14 @@ Update environment configuration ### Synopsis Update environment configuration - + This command updates the configuration of an environment for properties that are able to be changed. - + Properties that can be updated include: + - providers (Azure, AWS) - -All other properties require the environment to be deleted and recreated. +All other properties require the environment to be deleted and recreated. ``` rad env update [environment] [flags] @@ -68,5 +68,4 @@ rad env update myenv --clear-aws ### SEE ALSO -* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments - +- [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments diff --git a/docs/content/reference/cli/rad_group.md b/docs/content/reference/cli/rad_group.md index bb7f03c05..1df7f1ff7 100644 --- a/docs/content/reference/cli/rad_group.md +++ b/docs/content/reference/cli/rad_group.md @@ -13,18 +13,16 @@ Manage resource groups ### Synopsis Manage resource groups - + Resource groups are used to organize and manage Radius resources. They often contain resources that share a common lifecycle or unit of deployment. A Radius Application and its resources can span one or more resource groups, and do not have to be in the same resource group as the Radius Environment into which it's being deployed into. Note that these resource groups are separate from the Azure cloud provider and Azure resource groups configured with the cloud provider. - ### Examples ``` - # List resource groups in default workspace rad group list @@ -36,7 +34,6 @@ rad group delete prod # Show details of resource group in default workspace rad group show dev - ``` ### Options @@ -54,10 +51,9 @@ rad group show dev ### SEE ALSO -* [rad]({{< ref rad.md >}}) - Radius CLI -* [rad group create]({{< ref rad_group_create.md >}}) - Create a new resource group -* [rad group delete]({{< ref rad_group_delete.md >}}) - Delete a resource group -* [rad group list]({{< ref rad_group_list.md >}}) - List resource groups within current/specified workspace -* [rad group show]({{< ref rad_group_show.md >}}) - Show the details of a resource group -* [rad group switch]({{< ref rad_group_switch.md >}}) - Switch default resource group scope - +* [rad]({{< ref rad.md >}}) - Radius CLI +* [rad group create]({{< ref rad_group_create.md >}}) - Create a new resource group +* [rad group delete]({{< ref rad_group_delete.md >}}) - Delete a resource group +* [rad group list]({{< ref rad_group_list.md >}}) - List resource groups within current/specified workspace +* [rad group show]({{< ref rad_group_show.md >}}) - Show the details of a resource group +* [rad group switch]({{< ref rad_group_switch.md >}}) - Switch default resource group scope diff --git a/docs/content/reference/cli/rad_group_create.md b/docs/content/reference/cli/rad_group_create.md index a4e22082b..42252cff0 100644 --- a/docs/content/reference/cli/rad_group_create.md +++ b/docs/content/reference/cli/rad_group_create.md @@ -20,7 +20,6 @@ A Radius Application and its resources can span one or more resource groups, and Note that these resource groups are separate from the Azure cloud provider and Azure resource groups configured with the cloud provider. - ``` rad group create resourcegroupname [flags] ``` @@ -48,5 +47,4 @@ rad group create rgprod ### SEE ALSO -* [rad group]({{< ref rad_group.md >}}) - Manage resource groups - +* [rad group]({{< ref rad_group.md >}}) - Manage resource groups diff --git a/docs/content/reference/cli/rad_group_delete.md b/docs/content/reference/cli/rad_group_delete.md index 7730788c5..6f961ec6d 100644 --- a/docs/content/reference/cli/rad_group_delete.md +++ b/docs/content/reference/cli/rad_group_delete.md @@ -12,9 +12,9 @@ Delete a resource group ### Synopsis -Delete a resource group. - - Delete a resource group if it is empty. If not empty, delete the contents and try again +Delete a resource group. + + Delete a resource group if it is empty. If not empty, delete the contents and try again ``` rad group delete resourcegroupname [flags] @@ -44,5 +44,4 @@ rad group delete rgprod ### SEE ALSO -* [rad group]({{< ref rad_group.md >}}) - Manage resource groups - +* [rad group]({{< ref rad_group.md >}}) - Manage resource groups diff --git a/docs/content/reference/cli/rad_group_list.md b/docs/content/reference/cli/rad_group_list.md index 534d9d3ed..91cbccc8c 100644 --- a/docs/content/reference/cli/rad_group_list.md +++ b/docs/content/reference/cli/rad_group_list.md @@ -13,7 +13,7 @@ List resource groups within current/specified workspace ### Synopsis List resource groups within current/specified workspace - + Resource groups are used to organize and manage Radius resources. They often contain resources that share a common lifecycle or unit of deployment. A Radius Application and its resources can span one or more resource groups, and do not have to be in the same resource group as the Radius Environment into which it's being deployed into. @@ -46,5 +46,4 @@ rad group list ### SEE ALSO -* [rad group]({{< ref rad_group.md >}}) - Manage resource groups - +* [rad group]({{< ref rad_group.md >}}) - Manage resource groups diff --git a/docs/content/reference/cli/rad_group_show.md b/docs/content/reference/cli/rad_group_show.md index 8b2865751..3dcf5bc22 100644 --- a/docs/content/reference/cli/rad_group_show.md +++ b/docs/content/reference/cli/rad_group_show.md @@ -20,7 +20,6 @@ A Radius Application and its resources can span one or more resource groups, and Note that these resource groups are separate from the Azure cloud provider and Azure resource groups configured with the cloud provider. - ``` rad group show resourcegroupname [flags] ``` @@ -48,5 +47,4 @@ rad group show rgprod ### SEE ALSO -* [rad group]({{< ref rad_group.md >}}) - Manage resource groups - +* [rad group]({{< ref rad_group.md >}}) - Manage resource groups diff --git a/docs/content/reference/cli/rad_group_switch.md b/docs/content/reference/cli/rad_group_switch.md index 94d8fb7f7..30fe29057 100644 --- a/docs/content/reference/cli/rad_group_switch.md +++ b/docs/content/reference/cli/rad_group_switch.md @@ -13,11 +13,11 @@ Switch default resource group scope ### Synopsis Switch default resource group scope - + Radius workspaces contain a resource group scope, where Radius Applications and resources are deployed by default. The switch command changes the default scope of the workspace to the specified resource group name. - + Resource groups are used to organize and manage Radius resources. They often contain resources that share a common lifecycle or unit of deployment. - + Note that these resource groups are separate from the Azure cloud provider and Azure resource groups configured with the cloud provider. ``` @@ -47,5 +47,4 @@ rad group switch rgprod -w wsprod ### SEE ALSO -* [rad group]({{< ref rad_group.md >}}) - Manage resource groups - +- [rad group]({{< ref rad_group.md >}}) - Manage resource groups diff --git a/docs/content/reference/cli/rad_init.md b/docs/content/reference/cli/rad_init.md index 4e19fe7b1..9d7c442ed 100644 --- a/docs/content/reference/cli/rad_init.md +++ b/docs/content/reference/cli/rad_init.md @@ -12,7 +12,6 @@ Initialize Radius ### Synopsis - Interactively install the Radius control-plane and setup an environment. If an environment already exists, 'rad init' will prompt the user to use the existing environment or create a new one. @@ -21,7 +20,6 @@ By default, 'rad init' will optimize for a developer-focused environment with an Specifying the '--full' flag will cause 'rad init' to prompt the user for all available configuration options such as Kubernetes context, environment name, and cloud providers. This is useful for fully customizing your environment. - ``` rad init [flags] ``` @@ -29,13 +27,11 @@ rad init [flags] ### Examples ``` - ## Create a new development environment named "default" rad init ## Prompt the user for all available options to create a new environment rad init --full - ``` ### Options @@ -54,5 +50,4 @@ rad init --full ### SEE ALSO -* [rad]({{< ref rad.md >}}) - Radius CLI - +* [rad]({{< ref rad.md >}}) - Radius CLI diff --git a/docs/content/reference/cli/rad_install.md b/docs/content/reference/cli/rad_install.md index d1960c43d..056ab5e88 100644 --- a/docs/content/reference/cli/rad_install.md +++ b/docs/content/reference/cli/rad_install.md @@ -29,6 +29,5 @@ Installs Radius for a given platform ### SEE ALSO -* [rad]({{< ref rad.md >}}) - Radius CLI -* [rad install kubernetes]({{< ref rad_install_kubernetes.md >}}) - Installs Radius onto a kubernetes cluster - +* [rad]({{< ref rad.md >}}) - Radius CLI +* [rad install kubernetes]({{< ref rad_install_kubernetes.md >}}) - Installs Radius onto a kubernetes cluster diff --git a/docs/content/reference/cli/rad_install_kubernetes.md b/docs/content/reference/cli/rad_install_kubernetes.md index cfd2502fb..a5932d960 100644 --- a/docs/content/reference/cli/rad_install_kubernetes.md +++ b/docs/content/reference/cli/rad_install_kubernetes.md @@ -15,10 +15,9 @@ Installs Radius onto a kubernetes cluster Install Radius in a Kubernetes cluster using the Radius Helm chart. By default 'rad install kubernetes' will install Radius with the version matching the rad CLI version. -Radius will be installed in the 'radius-system' namespace. For more information visit https://docs.radapp.io/concepts/architecture/ - -Overrides can be set by specifying Helm chart values with the '--set' flag. For more information visit https://docs.radapp.io/operations/platforms/kubernetes/install/. +Radius will be installed in the 'radius-system' namespace. For more information visit +Overrides can be set by specifying Helm chart values with the '--set' flag. For more information visit . ``` rad install kubernetes [flags] @@ -57,5 +56,4 @@ rad install kubernetes --set key=value ### SEE ALSO -* [rad install]({{< ref rad_install.md >}}) - Installs Radius for a given platform - +* [rad install]({{< ref rad_install.md >}}) - Installs Radius for a given platform diff --git a/docs/content/reference/cli/rad_recipe.md b/docs/content/reference/cli/rad_recipe.md index 4ed4bdd4a..2b523af46 100644 --- a/docs/content/reference/cli/rad_recipe.md +++ b/docs/content/reference/cli/rad_recipe.md @@ -13,7 +13,8 @@ Manage recipes ### Synopsis Manage recipes - Recipes automate the deployment of infrastructure and configuration of portable resources. + + Recipes automate the deployment of infrastructure and configuration of portable resources. ### Options @@ -32,9 +33,8 @@ Manage recipes ### SEE ALSO -* [rad]({{< ref rad.md >}}) - Radius CLI -* [rad recipe list]({{< ref rad_recipe_list.md >}}) - List recipes -* [rad recipe register]({{< ref rad_recipe_register.md >}}) - Add a recipe to an environment. -* [rad recipe show]({{< ref rad_recipe_show.md >}}) - Show recipe details -* [rad recipe unregister]({{< ref rad_recipe_unregister.md >}}) - Unregister a recipe from an environment - +* [rad]({{< ref rad.md >}}) - Radius CLI +* [rad recipe list]({{< ref rad_recipe_list.md >}}) - List recipes +* [rad recipe register]({{< ref rad_recipe_register.md >}}) - Add a recipe to an environment. +* [rad recipe show]({{< ref rad_recipe_show.md >}}) - Show recipe details +* [rad recipe unregister]({{< ref rad_recipe_unregister.md >}}) - Unregister a recipe from an environment diff --git a/docs/content/reference/cli/rad_recipe_list.md b/docs/content/reference/cli/rad_recipe_list.md index 4ca115d65..7083e2820 100644 --- a/docs/content/reference/cli/rad_recipe_list.md +++ b/docs/content/reference/cli/rad_recipe_list.md @@ -42,5 +42,4 @@ rad recipe list ### SEE ALSO -* [rad recipe]({{< ref rad_recipe.md >}}) - Manage recipes - +* [rad recipe]({{< ref rad_recipe.md >}}) - Manage recipes diff --git a/docs/content/reference/cli/rad_recipe_register.md b/docs/content/reference/cli/rad_recipe_register.md index 653f49e1f..c4169ee19 100644 --- a/docs/content/reference/cli/rad_recipe_register.md +++ b/docs/content/reference/cli/rad_recipe_register.md @@ -14,11 +14,10 @@ Add a recipe to an environment. Add a recipe to an environment. You can specify parameters using the '--parameter' flag ('-p' for short). Parameters can be passed as: - + - A file containing a single value in JSON format - A key-value-pair passed in the command line - - + ``` rad recipe register [recipe-name] [flags] ``` @@ -29,13 +28,13 @@ rad recipe register [recipe-name] [flags] # Add a recipe to an environment rad recipe register cosmosdb -e env_name -w workspace --template-kind bicep --template-path template_path --resource-type Applications.Datastores/mongoDatabases - + # Specify a parameter rad recipe register cosmosdb -e env_name -w workspace --template-kind bicep --template-path template_path --resource-type Applications.Datastores/mongoDatabases --parameters throughput=400 - + # specify multiple parameters using a JSON parameter file rad recipe register cosmosdb -e env_name -w workspace --template-kind bicep --template-path template_path --resource-type Applications.Datastores/mongoDatabases --parameters @myfile.json - + ``` ### Options @@ -61,5 +60,4 @@ rad recipe register cosmosdb -e env_name -w workspace --template-kind bicep --te ### SEE ALSO -* [rad recipe]({{< ref rad_recipe.md >}}) - Manage recipes - +- [rad recipe]({{< ref rad_recipe.md >}}) - Manage recipes diff --git a/docs/content/reference/cli/rad_recipe_show.md b/docs/content/reference/cli/rad_recipe_show.md index 39efe420c..f56537ff7 100644 --- a/docs/content/reference/cli/rad_recipe_show.md +++ b/docs/content/reference/cli/rad_recipe_show.md @@ -15,9 +15,9 @@ Show recipe details Show recipe details The recipe show command outputs details about a recipe. This includes the name, resource type, parameters, parameter details and template path. - + By default, the command is scoped to the resource group and environment defined in your rad.yaml workspace file. You can optionally override these values through the environment and group flags. - + By default, the command outputs a human-readable table. You can customize the output format with the output flag. ``` @@ -27,13 +27,12 @@ rad recipe show [recipe-name] [flags] ### Examples ``` - # show the details of a recipe rad recipe show redis-prod --resource-type Applications.Datastores/redisCaches # show the details of a recipe, with a JSON output rad recipe show redis-prod --resource-type Applications.Datastores/redisCaches --output json - + # show the details of a recipe, with a specified environment and group rad recipe show redis-dev --resource-type Applications.Datastores/redisCaches --group dev --environment dev ``` @@ -57,5 +56,4 @@ rad recipe show redis-dev --resource-type Applications.Datastores/redisCaches -- ### SEE ALSO -* [rad recipe]({{< ref rad_recipe.md >}}) - Manage recipes - +* [rad recipe]({{< ref rad_recipe.md >}}) - Manage recipes diff --git a/docs/content/reference/cli/rad_recipe_unregister.md b/docs/content/reference/cli/rad_recipe_unregister.md index 0ecf18412..16a238ed5 100644 --- a/docs/content/reference/cli/rad_recipe_unregister.md +++ b/docs/content/reference/cli/rad_recipe_unregister.md @@ -43,5 +43,4 @@ rad recipe unregister cosmosdb ### SEE ALSO -* [rad recipe]({{< ref rad_recipe.md >}}) - Manage recipes - +* [rad recipe]({{< ref rad_recipe.md >}}) - Manage recipes diff --git a/docs/content/reference/cli/rad_resource.md b/docs/content/reference/cli/rad_resource.md index 4c8bfd0c1..42e8a7b79 100644 --- a/docs/content/reference/cli/rad_resource.md +++ b/docs/content/reference/cli/rad_resource.md @@ -31,10 +31,9 @@ Manage resources ### SEE ALSO -* [rad]({{< ref rad.md >}}) - Radius CLI -* [rad resource delete]({{< ref rad_resource_delete.md >}}) - Delete a Radius resource -* [rad resource expose]({{< ref rad_resource_expose.md >}}) - Exposes a resource for network traffic -* [rad resource list]({{< ref rad_resource_list.md >}}) - Lists resources -* [rad resource logs]({{< ref rad_resource_logs.md >}}) - Read logs from a running containers resource -* [rad resource show]({{< ref rad_resource_show.md >}}) - Show Radius resource details - +* [rad]({{< ref rad.md >}}) - Radius CLI +* [rad resource delete]({{< ref rad_resource_delete.md >}}) - Delete a Radius resource +* [rad resource expose]({{< ref rad_resource_expose.md >}}) - Exposes a resource for network traffic +* [rad resource list]({{< ref rad_resource_list.md >}}) - Lists resources +* [rad resource logs]({{< ref rad_resource_logs.md >}}) - Read logs from a running containers resource +* [rad resource show]({{< ref rad_resource_show.md >}}) - Show Radius resource details diff --git a/docs/content/reference/cli/rad_resource_delete.md b/docs/content/reference/cli/rad_resource_delete.md index 1bf5eedf9..5b1287c0f 100644 --- a/docs/content/reference/cli/rad_resource_delete.md +++ b/docs/content/reference/cli/rad_resource_delete.md @@ -22,10 +22,10 @@ rad resource delete [resourceType] [resourceName] [flags] ``` - sample list of resourceType: containers, gateways, httpRoutes, daprPubSubBrokers, extenders, mongoDatabases, rabbitMQMessageQueues, redisCaches, sqlDatabases, daprStateStores, daprSecretStores - - # Delete a container named orders - rad resource delete containers orders + sample list of resourceType: containers, gateways, httpRoutes, daprPubSubBrokers, extenders, mongoDatabases, rabbitMQMessageQueues, redisCaches, sqlDatabases, daprStateStores, daprSecretStores + + # Delete a container named orders + rad resource delete containers orders ``` ### Options @@ -47,5 +47,4 @@ rad resource delete [resourceType] [resourceName] [flags] ### SEE ALSO -* [rad resource]({{< ref rad_resource.md >}}) - Manage resources - +* [rad resource]({{< ref rad_resource.md >}}) - Manage resources diff --git a/docs/content/reference/cli/rad_resource_expose.md b/docs/content/reference/cli/rad_resource_expose.md index 94144a6b2..0490f856f 100644 --- a/docs/content/reference/cli/rad_resource_expose.md +++ b/docs/content/reference/cli/rad_resource_expose.md @@ -52,5 +52,4 @@ rad resource expose --application icecream-store containers orders --port 5000 - ### SEE ALSO -* [rad resource]({{< ref rad_resource.md >}}) - Manage resources - +* [rad resource]({{< ref rad_resource.md >}}) - Manage resources diff --git a/docs/content/reference/cli/rad_resource_list.md b/docs/content/reference/cli/rad_resource_list.md index 066cbc603..b50c2427d 100644 --- a/docs/content/reference/cli/rad_resource_list.md +++ b/docs/content/reference/cli/rad_resource_list.md @@ -21,21 +21,19 @@ rad resource list [resourceType] [flags] ### Examples ``` +sample list of resourceType: containers, gateways, httpRoutes, pubSubBrokers, extenders, mongoDatabases, rabbitMQMessageQueues, redisCaches, sqlDatabases, stateStores, secretStores - sample list of resourceType: containers, gateways, httpRoutes, pubSubBrokers, extenders, mongoDatabases, rabbitMQMessageQueues, redisCaches, sqlDatabases, stateStores, secretStores +# list all resources of a specified type in the default environment - # list all resources of a specified type in the default environment +rad resource list containers +rad resource list gateways +rad resource list httpRoutes - rad resource list containers - rad resource list gateways - rad resource list httpRoutes +# list all resources of a specified type in an application +rad resource list containers --application icecream-store - # list all resources of a specified type in an application - rad resource list containers --application icecream-store - - # list all resources of a specified type in an application (shorthand flag) - rad resource list containers -a icecream-store - +# list all resources of a specified type in an application (shorthand flag) +rad resource list containers -a icecream-store ``` ### Options @@ -56,5 +54,4 @@ rad resource list [resourceType] [flags] ### SEE ALSO -* [rad resource]({{< ref rad_resource.md >}}) - Manage resources - +* [rad resource]({{< ref rad_resource.md >}}) - Manage resources diff --git a/docs/content/reference/cli/rad_resource_logs.md b/docs/content/reference/cli/rad_resource_logs.md index 2fa4f4364..e00a612f7 100644 --- a/docs/content/reference/cli/rad_resource_logs.md +++ b/docs/content/reference/cli/rad_resource_logs.md @@ -62,5 +62,4 @@ rad resource logs containers orders --application icecream-store --container dap ### SEE ALSO -* [rad resource]({{< ref rad_resource.md >}}) - Manage resources - +* [rad resource]({{< ref rad_resource.md >}}) - Manage resources diff --git a/docs/content/reference/cli/rad_resource_show.md b/docs/content/reference/cli/rad_resource_show.md index e9fd9d40a..c107850cf 100644 --- a/docs/content/reference/cli/rad_resource_show.md +++ b/docs/content/reference/cli/rad_resource_show.md @@ -21,21 +21,19 @@ rad resource show [resourceType] [resourceName] [flags] ### Examples ``` +sample list of resourceType: containers, gateways, httpRoutes, daprPubSubBrokers, extenders, mongoDatabases, rabbitMQMessageQueues, redisCaches, sqlDatabases, daprStateStores, daprSecretStores - sample list of resourceType: containers, gateways, httpRoutes, daprPubSubBrokers, extenders, mongoDatabases, rabbitMQMessageQueues, redisCaches, sqlDatabases, daprStateStores, daprSecretStores +# show details of a specified resource in the default environment - # show details of a specified resource in the default environment +rad resource show containers orders +rad resource show gateways orders_gateways +rad resource show httpRoutes orders_routes - rad resource show containers orders - rad resource show gateways orders_gateways - rad resource show httpRoutes orders_routes +# show details of a specified resource in an application +rad resource show containers orders --application icecream-store - # show details of a specified resource in an application - rad resource show containers orders --application icecream-store - - # show details of a specified resource in an application (shorthand flag) - rad resource show containers orders -a icecream-store - +# show details of a specified resource in an application (shorthand flag) +rad resource show containers orders -a icecream-store ``` ### Options @@ -56,5 +54,4 @@ rad resource show [resourceType] [resourceName] [flags] ### SEE ALSO -* [rad resource]({{< ref rad_resource.md >}}) - Manage resources - +* [rad resource]({{< ref rad_resource.md >}}) - Manage resources diff --git a/docs/content/reference/cli/rad_run.md b/docs/content/reference/cli/rad_run.md index 3ca6ea543..d643475bf 100644 --- a/docs/content/reference/cli/rad_run.md +++ b/docs/content/reference/cli/rad_run.md @@ -13,11 +13,10 @@ Run an application ### Synopsis Run an application specified by a Bicep or ARM template - + The run command compiles a Bicep or ARM template and runs it in your default environment (unless otherwise specified). It also automatically port-forwards container ports and streams container logs to a user's terminal. - + The run command accepts the same parameters as the 'rad deploy' command. See the 'rad deploy' help for more information. - ``` rad run [file] [flags] @@ -61,5 +60,4 @@ rad run app.bicep --parameters @myfile.json --parameters version=latest ### SEE ALSO -* [rad]({{< ref rad.md >}}) - Radius CLI - +* [rad]({{< ref rad.md >}}) - Radius CLI diff --git a/docs/content/reference/cli/rad_uninstall.md b/docs/content/reference/cli/rad_uninstall.md index 9af1a62d9..dab28d14b 100644 --- a/docs/content/reference/cli/rad_uninstall.md +++ b/docs/content/reference/cli/rad_uninstall.md @@ -29,6 +29,5 @@ Uninstall Radius for a specific platform ### SEE ALSO -* [rad]({{< ref rad.md >}}) - Radius CLI -* [rad uninstall kubernetes]({{< ref rad_uninstall_kubernetes.md >}}) - Uninstall Radius from a Kubernetes cluster - +* [rad]({{< ref rad.md >}}) - Radius CLI +* [rad uninstall kubernetes]({{< ref rad_uninstall_kubernetes.md >}}) - Uninstall Radius from a Kubernetes cluster diff --git a/docs/content/reference/cli/rad_uninstall_kubernetes.md b/docs/content/reference/cli/rad_uninstall_kubernetes.md index 84ee002d1..f9768963b 100644 --- a/docs/content/reference/cli/rad_uninstall_kubernetes.md +++ b/docs/content/reference/cli/rad_uninstall_kubernetes.md @@ -44,5 +44,4 @@ rad uninstall kubernetes --kubecontext my-kubecontext ### SEE ALSO -* [rad uninstall]({{< ref rad_uninstall.md >}}) - Uninstall Radius for a specific platform - +* [rad uninstall]({{< ref rad_uninstall.md >}}) - Uninstall Radius for a specific platform diff --git a/docs/content/reference/cli/rad_version.md b/docs/content/reference/cli/rad_version.md index cb6c8b0d0..b14652b4d 100644 --- a/docs/content/reference/cli/rad_version.md +++ b/docs/content/reference/cli/rad_version.md @@ -30,5 +30,4 @@ rad version [flags] ### SEE ALSO -* [rad]({{< ref rad.md >}}) - Radius CLI - +* [rad]({{< ref rad.md >}}) - Radius CLI diff --git a/docs/content/reference/cli/rad_workspace.md b/docs/content/reference/cli/rad_workspace.md index c191684f0..86ce70ad4 100644 --- a/docs/content/reference/cli/rad_workspace.md +++ b/docs/content/reference/cli/rad_workspace.md @@ -13,10 +13,9 @@ Manage workspaces ### Synopsis Manage workspaces - Workspaces allow you to manage multiple Radius platforms and environments using a local configuration file. - You can easily define and switch between workspaces to deploy and manage applications across local, test, and production environments. - - + Workspaces allow you to manage multiple Radius platforms and environments using a local configuration file. + You can easily define and switch between workspaces to deploy and manage applications across local, test, and production environments. + ### Examples ``` @@ -44,10 +43,9 @@ rad workspace create kubernetes myworkspace --context kind-kind --group myrg --e ### SEE ALSO -* [rad]({{< ref rad.md >}}) - Radius CLI -* [rad workspace create]({{< ref rad_workspace_create.md >}}) - Create a workspace -* [rad workspace delete]({{< ref rad_workspace_delete.md >}}) - Delete local workspace -* [rad workspace list]({{< ref rad_workspace_list.md >}}) - List local workspaces -* [rad workspace show]({{< ref rad_workspace_show.md >}}) - Show local workspace -* [rad workspace switch]({{< ref rad_workspace_switch.md >}}) - Switch current workspace - +* [rad]({{< ref rad.md >}}) - Radius CLI +* [rad workspace create]({{< ref rad_workspace_create.md >}}) - Create a workspace +* [rad workspace delete]({{< ref rad_workspace_delete.md >}}) - Delete local workspace +* [rad workspace list]({{< ref rad_workspace_list.md >}}) - List local workspaces +* [rad workspace show]({{< ref rad_workspace_show.md >}}) - Show local workspace +* [rad workspace switch]({{< ref rad_workspace_switch.md >}}) - Switch current workspace diff --git a/docs/content/reference/cli/rad_workspace_create.md b/docs/content/reference/cli/rad_workspace_create.md index 834be7c96..e37b83973 100644 --- a/docs/content/reference/cli/rad_workspace_create.md +++ b/docs/content/reference/cli/rad_workspace_create.md @@ -13,10 +13,10 @@ Create a workspace ### Synopsis Create a workspace. - + Available workspaceTypes: kubernetes -Workspaces allow you to manage multiple Radius platforms and environments using a local configuration file. +Workspaces allow you to manage multiple Radius platforms and environments using a local configuration file. You can easily define and switch between workspaces to deploy and manage applications across local, test, and production environments. @@ -54,5 +54,4 @@ rad workspace create kubernetes ### SEE ALSO -* [rad workspace]({{< ref rad_workspace.md >}}) - Manage workspaces - +* [rad workspace]({{< ref rad_workspace.md >}}) - Manage workspaces diff --git a/docs/content/reference/cli/rad_workspace_delete.md b/docs/content/reference/cli/rad_workspace_delete.md index 7ed3cbf6f..8be80514b 100644 --- a/docs/content/reference/cli/rad_workspace_delete.md +++ b/docs/content/reference/cli/rad_workspace_delete.md @@ -45,5 +45,4 @@ rad workspace delete my-workspace ### SEE ALSO -* [rad workspace]({{< ref rad_workspace.md >}}) - Manage workspaces - +* [rad workspace]({{< ref rad_workspace.md >}}) - Manage workspaces diff --git a/docs/content/reference/cli/rad_workspace_list.md b/docs/content/reference/cli/rad_workspace_list.md index b2e100d9c..ea5474c8f 100644 --- a/docs/content/reference/cli/rad_workspace_list.md +++ b/docs/content/reference/cli/rad_workspace_list.md @@ -41,5 +41,4 @@ rad workspace list ### SEE ALSO -* [rad workspace]({{< ref rad_workspace.md >}}) - Manage workspaces - +* [rad workspace]({{< ref rad_workspace.md >}}) - Manage workspaces diff --git a/docs/content/reference/cli/rad_workspace_show.md b/docs/content/reference/cli/rad_workspace_show.md index 1e274d5e2..c62e8871c 100644 --- a/docs/content/reference/cli/rad_workspace_show.md +++ b/docs/content/reference/cli/rad_workspace_show.md @@ -44,5 +44,4 @@ rad workspace show my-workspace ### SEE ALSO -* [rad workspace]({{< ref rad_workspace.md >}}) - Manage workspaces - +* [rad workspace]({{< ref rad_workspace.md >}}) - Manage workspaces diff --git a/docs/content/reference/cli/rad_workspace_switch.md b/docs/content/reference/cli/rad_workspace_switch.md index cfbc4c75c..d7af7e96a 100644 --- a/docs/content/reference/cli/rad_workspace_switch.md +++ b/docs/content/reference/cli/rad_workspace_switch.md @@ -41,5 +41,4 @@ rad workspace switch my-workspace ### SEE ALSO -* [rad workspace]({{< ref rad_workspace.md >}}) - Manage workspaces - +* [rad workspace]({{< ref rad_workspace.md >}}) - Manage workspaces diff --git a/docs/content/reference/limitations.md b/docs/content/reference/limitations.md index c6d3eb56f..4e882b6f8 100644 --- a/docs/content/reference/limitations.md +++ b/docs/content/reference/limitations.md @@ -39,7 +39,7 @@ See [app name constraints]({{< ref "resource-schema.md#common-values" >}}) for m ### Application and resource names are lower-cased after deployment After deploying an application with application name `AppNAME` and container name `CONTAINERname`, casing information about the casing is lost, resulting in names to be lower-cased. The result is: - + ```bash rad application list RESOURCE TYPE @@ -118,5 +118,3 @@ Some of the [AWS resource types](/resource-schema/aws) are 'non-idempotent', thi We are currently building support for non-idempotent resources in Radius. Please like and comment on this [this issue](https://github.com/radius-project/radius/issues/6227) if you are interested in the same. As a workaround, you can try using [Terraform Recipes]({{< ref "/guides/recipes/overview" >}}) to deploy and manage those non-idempotent resource types. - - diff --git a/docs/content/reference/resource-schema/aws/index.md b/docs/content/reference/resource-schema/aws/index.md index 995997ca7..49b8cb51a 100644 --- a/docs/content/reference/resource-schema/aws/index.md +++ b/docs/content/reference/resource-schema/aws/index.md @@ -6,7 +6,7 @@ description: "Learn about the supported AWS resource types in Radius" categories: "Schema" --- -Radius supports AWS resource types that are supported by the [AWS Cloud Control API](https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/what-is-cloudcontrolapi.html) +Radius supports AWS resource types that are supported by the [AWS Cloud Control API](https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/what-is-cloudcontrolapi.html). Following table lists the resource types that are currently supported and the limitations for each of the resource types. diff --git a/docs/content/reference/resource-schema/core-schema/extender/snippets/extender-recipe.bicep b/docs/content/reference/resource-schema/core-schema/extender/snippets/extender-recipe.bicep index 9723169f8..8b436cbe9 100644 --- a/docs/content/reference/resource-schema/core-schema/extender/snippets/extender-recipe.bicep +++ b/docs/content/reference/resource-schema/core-schema/extender/snippets/extender-recipe.bicep @@ -30,6 +30,3 @@ resource publisher 'Applications.Core/containers@2023-10-01-preview' = { } } } - - - diff --git a/docs/content/reference/resource-schema/core-schema/gateway/snippets/gateway.bicep b/docs/content/reference/resource-schema/core-schema/gateway/snippets/gateway.bicep index eefc5fa15..0af5ade47 100644 --- a/docs/content/reference/resource-schema/core-schema/gateway/snippets/gateway.bicep +++ b/docs/content/reference/resource-schema/core-schema/gateway/snippets/gateway.bicep @@ -16,7 +16,7 @@ resource gateway 'Applications.Core/gateways@2023-10-01-preview' = { application: app.id hostname: { // Omitting hostname properties results in gatewayname.appname.PUBLIC_HOSTNAME_OR_IP.nip.io - + // Results in prefix.appname.PUBLIC_HOSTNAME_OR_IP.nip.io prefix: 'prefix' // Alternately you can specify your own hostname that you've configured externally diff --git a/docs/content/reference/resource-schema/dapr-schema/dapr-statestore/snippets/dapr-statestore-recipe.bicep b/docs/content/reference/resource-schema/dapr-schema/dapr-statestore/snippets/dapr-statestore-recipe.bicep index d19dfc521..7726cc1c6 100644 --- a/docs/content/reference/resource-schema/dapr-schema/dapr-statestore/snippets/dapr-statestore-recipe.bicep +++ b/docs/content/reference/resource-schema/dapr-schema/dapr-statestore/snippets/dapr-statestore-recipe.bicep @@ -26,7 +26,7 @@ resource myapp 'Applications.Core/containers@2023-10-01-preview' = { ] } } - + //SAMPLE resource statestore 'Applications.Dapr/stateStores@2023-10-01-preview' = { name: 'statestore' @@ -44,4 +44,3 @@ resource statestore 'Applications.Dapr/stateStores@2023-10-01-preview' = { } } //SAMPLE -