From 873c430b4362716bf9f6bb873b803095b2255aee Mon Sep 17 00:00:00 2001 From: rad-ci-bot Date: Thu, 4 Jun 2026 22:15:43 +0000 Subject: [PATCH] Autogenerate reference docs Signed-off-by: rad-ci-bot --- .../reference/cli/rad_application_graph.md | 1 + .../reference/cli/rad_application_status.md | 1 + .../reference/cli/rad_environment_create.md | 28 +++++++++++++++---- .../reference/cli/rad_environment_update.md | 4 +-- .../reference/cli/rad_install_kubernetes.md | 7 ++++- .../reference/cli/rad_workspace_create.md | 1 + 6 files changed, 33 insertions(+), 9 deletions(-) diff --git a/docs/content/reference/cli/rad_application_graph.md b/docs/content/reference/cli/rad_application_graph.md index b90741d29..d58dc46e0 100644 --- a/docs/content/reference/cli/rad_application_graph.md +++ b/docs/content/reference/cli/rad_application_graph.md @@ -33,6 +33,7 @@ rad app graph my-application -g, --group string The resource group name -h, --help help for graph -o, --output string output format (supported formats are json, table) (default "table") + --preview Use the Radius.Core preview implementation -w, --workspace string The workspace name ``` diff --git a/docs/content/reference/cli/rad_application_status.md b/docs/content/reference/cli/rad_application_status.md index 8808c6c5e..7a6bf6133 100644 --- a/docs/content/reference/cli/rad_application_status.md +++ b/docs/content/reference/cli/rad_application_status.md @@ -37,6 +37,7 @@ rad app status my-app --group my-group -g, --group string The resource group name -h, --help help for status -o, --output string output format (supported formats are json, table) (default "table") + --preview Use the Radius.Core preview implementation -w, --workspace string The workspace name ``` diff --git a/docs/content/reference/cli/rad_environment_create.md b/docs/content/reference/cli/rad_environment_create.md index 050920fff..4a55be03e 100644 --- a/docs/content/reference/cli/rad_environment_create.md +++ b/docs/content/reference/cli/rad_environment_create.md @@ -23,18 +23,34 @@ rad environment create [envName] [flags] ### Examples ``` + +## Create environment with default namespace rad env create myenv + +## Create environment with a specific namespace +rad env create myenv --kubernetes-namespace mynamespace + +## Create environment with Azure cloud provider +rad env create myenv --azure-subscription-id --azure-resource-group + +## Create environment with AWS cloud provider +rad env create myenv --aws-region --aws-account-id + ``` ### Options ``` - -e, --environment string The environment name - -g, --group string The resource group name - -h, --help help for create - -n, --namespace string The Kubernetes namespace - --preview Use the Radius.Core preview implementation - -w, --workspace string The workspace name + --aws-account-id string The account ID where AWS resources will be deployed + --aws-region string The region where AWS resources will be deployed + --azure-resource-group string The resource group where Azure resources will be deployed + --azure-subscription-id string The subscription ID where Azure resources will be deployed + -e, --environment string The environment name + -g, --group string The resource group name + -h, --help help for create + --kubernetes-namespace string The namespace where Kubernetes resources will be deployed + --preview Use the Radius.Core preview implementation + -w, --workspace string The workspace name ``` ### Options inherited from parent commands diff --git a/docs/content/reference/cli/rad_environment_update.md b/docs/content/reference/cli/rad_environment_update.md index 3209f08b6..083bf8a5c 100644 --- a/docs/content/reference/cli/rad_environment_update.md +++ b/docs/content/reference/cli/rad_environment_update.md @@ -66,8 +66,7 @@ rad env update myenv --recipe-packs pack1,pack2 -e, --environment string The environment name -g, --group string The resource group name -h, --help help for update - --kubernetes-namespace string The namespace where Kubernetes resources will be deployed (preview) - -o, --output string output format (supported formats are json, table) (default "table") + --kubernetes-namespace string The namespace where Kubernetes resources will be deployed --preview Use the Radius.Core preview implementation for environment update. --recipe-packs strings Specify recipe packs to replace the environment's recipe pack list (--preview). Accepts comma-separated values. -w, --workspace string The workspace name @@ -77,6 +76,7 @@ rad env update myenv --recipe-packs pack1,pack2 ``` --config string config file (default "$HOME/.rad/config.yaml") + -o, --output string output format (supported formats are json, table) (default "table") ``` ### SEE ALSO diff --git a/docs/content/reference/cli/rad_install_kubernetes.md b/docs/content/reference/cli/rad_install_kubernetes.md index 8914334da..9eeb8954b 100644 --- a/docs/content/reference/cli/rad_install_kubernetes.md +++ b/docs/content/reference/cli/rad_install_kubernetes.md @@ -15,7 +15,12 @@ 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/technical/architecture/ +Radius will be installed in the 'radius-system' namespace. For more information visit https://docs.radapp.io/concepts#technical-architecture + +This command also ensures that a default resource group named 'default' and a default environment +named 'default' (using the 'default' Kubernetes namespace) exist so the cluster is immediately +ready to deploy applications. If either resource already exists, it is left unchanged; user +customizations are never overwritten, even with '--reinstall'. Overrides can be set by specifying Helm chart values with the '--set' flag. For more information visit https://docs.radapp.io/guides/operations/kubernetes/install/. diff --git a/docs/content/reference/cli/rad_workspace_create.md b/docs/content/reference/cli/rad_workspace_create.md index 834be7c96..2d80a9941 100644 --- a/docs/content/reference/cli/rad_workspace_create.md +++ b/docs/content/reference/cli/rad_workspace_create.md @@ -42,6 +42,7 @@ rad workspace create kubernetes -f, --force Overwrite existing workspace if present -g, --group string The resource group name -h, --help help for create + --preview Use the Radius.Core preview implementation -w, --workspace string The workspace name ```