diff --git a/.github/config/en-custom.txt b/.github/config/en-custom.txt index 6a45cf7fd..1385bbaa3 100644 --- a/.github/config/en-custom.txt +++ b/.github/config/en-custom.txt @@ -433,6 +433,12 @@ rabbitMQ azureCache listKeys primaryKey +mygroup +Kubeconfig +unregister +Unregisters +br +myregistry GCP Fargate -untyped \ No newline at end of file +untyped diff --git a/docs/content/reference/cli/rad.md b/docs/content/reference/cli/rad.md new file mode 100644 index 000000000..870bcea6a --- /dev/null +++ b/docs/content/reference/cli/rad.md @@ -0,0 +1,45 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad CLI reference" +linkTitle: "rad" +slug: rad +url: /reference/cli/rad/ +description: "Details on the rad Radius CLI command" +--- +## rad + +Radius CLI + +### Synopsis + +Radius CLI + +### Options + +``` + --config string config file (default "$HOME/.rad/config.yaml") + -h, --help help for rad + -o, --output string output format (supported formats are json, table) (default "table") +``` + +### 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 link 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 + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_application.md b/docs/content/reference/cli/rad_application.md new file mode 100644 index 000000000..8b75c7bb6 --- /dev/null +++ b/docs/content/reference/cli/rad_application.md @@ -0,0 +1,41 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad application CLI reference" +linkTitle: "rad application" +slug: rad_application +url: /reference/cli/rad_application/ +description: "Details on the rad application Radius CLI command" +--- +## rad application + +Manage Radius applications + +### Synopsis + +Manage Radius applications + +### Options + +``` + -h, --help help for application +``` + +### 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 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 + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_application_connections.md b/docs/content/reference/cli/rad_application_connections.md new file mode 100644 index 000000000..c8b026897 --- /dev/null +++ b/docs/content/reference/cli/rad_application_connections.md @@ -0,0 +1,54 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad application connections CLI reference" +linkTitle: "rad application connections" +slug: rad_application_connections +url: /reference/cli/rad_application_connections/ +description: "Details on the rad application connections Radius CLI command" +--- +## rad application connections + +Shows the connections for an application. + +### Synopsis + +Shows the connections for an application + +``` +rad application connections [flags] +``` + +### Examples + +``` + +# Show connections for current application +rad app connections + +# Show connections for specified application +rad app connections my-application +``` + +### Options + +``` + -a, --application string The application name + -e, --environment string The environment name + -g, --group string The resource group name + -h, --help help for connections + -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 application]({{< ref rad_application.md >}}) - Manage Radius applications + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_application_delete.md b/docs/content/reference/cli/rad_application_delete.md new file mode 100644 index 000000000..36bf9e968 --- /dev/null +++ b/docs/content/reference/cli/rad_application_delete.md @@ -0,0 +1,61 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad application delete CLI reference" +linkTitle: "rad application delete" +slug: rad_application_delete +url: /reference/cli/rad_application_delete/ +description: "Details on the rad application delete Radius CLI command" +--- +## rad application delete + +Delete Radius application + +### Synopsis + +Delete the specified Radius application deployed in the default environment + +``` +rad application delete [flags] +``` + +### Examples + +``` + +# Delete current application +rad app delete + +# Delete current application and bypass confirmation prompt +rad app delete --yes + +# Delete specified application +rad app delete my-app + +# Delete specified application in a specified resource group +rad app delete my-app --group my-group + +``` + +### Options + +``` + -a, --application string The application name + -g, --group string The resource group name + -h, --help help for delete + -w, --workspace string The workspace name + -y, --yes The confirmation flag +``` + +### 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 application]({{< ref rad_application.md >}}) - Manage Radius applications + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_application_list.md b/docs/content/reference/cli/rad_application_list.md new file mode 100644 index 000000000..fbfc917c5 --- /dev/null +++ b/docs/content/reference/cli/rad_application_list.md @@ -0,0 +1,53 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad application list CLI reference" +linkTitle: "rad application list" +slug: rad_application_list +url: /reference/cli/rad_application_list/ +description: "Details on the rad application list Radius CLI command" +--- +## rad application list + +List Radius applications + +### Synopsis + +Lists Radius applications deployed in the resource group associated with the default environment + +``` +rad application list [flags] +``` + +### Examples + +``` + +# List applications +rad app list + +# List applications in a specific resource group +rad app list --group my-group + +``` + +### Options + +``` + -g, --group string The resource group name + -h, --help help for list + -o, --output string output format (supported formats are json, table) (default "table") + -w, --workspace string The workspace name +``` + +### Options inherited from parent commands + +``` + --config string config file (default "$HOME/.rad/config.yaml") +``` + +### SEE ALSO + +* [rad application]({{< ref rad_application.md >}}) - Manage Radius applications + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_application_show.md b/docs/content/reference/cli/rad_application_show.md new file mode 100644 index 000000000..ad2dd368c --- /dev/null +++ b/docs/content/reference/cli/rad_application_show.md @@ -0,0 +1,57 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad application show CLI reference" +linkTitle: "rad application show" +slug: rad_application_show +url: /reference/cli/rad_application_show/ +description: "Details on the rad application show Radius CLI command" +--- +## rad application show + +Show Radius application details + +### Synopsis + +Show Radius application details. Shows the user's default application (if configured) by default. + +``` +rad application show [flags] +``` + +### Examples + +``` + +# Show current application +rad app show + +# Show specified application +rad app show my-app + +# Show specified application in a specified resource group +rad app show my-app --group my-group + +``` + +### Options + +``` + -a, --application string The application name + -g, --group string The resource group name + -h, --help help for show + -o, --output string output format (supported formats are json, table) (default "table") + -w, --workspace string The workspace name +``` + +### Options inherited from parent commands + +``` + --config string config file (default "$HOME/.rad/config.yaml") +``` + +### SEE ALSO + +* [rad application]({{< ref rad_application.md >}}) - Manage Radius applications + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_application_status.md b/docs/content/reference/cli/rad_application_status.md new file mode 100644 index 000000000..a36d8b001 --- /dev/null +++ b/docs/content/reference/cli/rad_application_status.md @@ -0,0 +1,57 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad application status CLI reference" +linkTitle: "rad application status" +slug: rad_application_status +url: /reference/cli/rad_application_status/ +description: "Details on the rad application status Radius CLI command" +--- +## rad application status + +Show Radius application status + +### Synopsis + +Show Radius application status, such as public endpoints and resource count. Shows details for the user's default application (if configured) by default. + +``` +rad application status [flags] +``` + +### Examples + +``` + +# Show status of current application +rad app status + +# Show status of specified application +rad app status my-app + +# Show status of specified application in a specified resource group +rad app status my-app --group my-group + +``` + +### Options + +``` + -a, --application string The application name + -g, --group string The resource group name + -h, --help help for status + -o, --output string output format (supported formats are json, table) (default "table") + -w, --workspace string The workspace name +``` + +### Options inherited from parent commands + +``` + --config string config file (default "$HOME/.rad/config.yaml") +``` + +### SEE ALSO + +* [rad application]({{< ref rad_application.md >}}) - Manage Radius applications + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_application_switch.md b/docs/content/reference/cli/rad_application_switch.md new file mode 100644 index 000000000..b4f3f6c60 --- /dev/null +++ b/docs/content/reference/cli/rad_application_switch.md @@ -0,0 +1,47 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad application switch CLI reference" +linkTitle: "rad application switch" +slug: rad_application_switch +url: /reference/cli/rad_application_switch/ +description: "Details on the rad application switch Radius CLI command" +--- +## rad application switch + +Switch the default Radius application + +### Synopsis + +Switches the default Radius application + +``` +rad application switch [flags] +``` + +### Examples + +``` +rad app switch newApplication +``` + +### Options + +``` + -a, --application string The application name + -h, --help help for switch + -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 application]({{< ref rad_application.md >}}) - Manage Radius applications + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_bicep.md b/docs/content/reference/cli/rad_bicep.md new file mode 100644 index 000000000..a79d08f61 --- /dev/null +++ b/docs/content/reference/cli/rad_bicep.md @@ -0,0 +1,38 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad bicep CLI reference" +linkTitle: "rad bicep" +slug: rad_bicep +url: /reference/cli/rad_bicep/ +description: "Details on the rad bicep Radius CLI command" +--- +## rad bicep + +Manage bicep compiler + +### Synopsis + +Manage bicep compiler used by Radius + +### Options + +``` + -h, --help help for bicep +``` + +### 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 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. + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_bicep_delete.md b/docs/content/reference/cli/rad_bicep_delete.md new file mode 100644 index 000000000..a95626c50 --- /dev/null +++ b/docs/content/reference/cli/rad_bicep_delete.md @@ -0,0 +1,39 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad bicep delete CLI reference" +linkTitle: "rad bicep delete" +slug: rad_bicep_delete +url: /reference/cli/rad_bicep_delete/ +description: "Details on the rad bicep delete Radius CLI command" +--- +## rad bicep delete + +Delete installed bicep compiler + +### Synopsis + +Removes the local copy of the bicep compiler + +``` +rad bicep delete [flags] +``` + +### Options + +``` + -h, --help help for delete +``` + +### 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 bicep]({{< ref rad_bicep.md >}}) - Manage bicep compiler + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_bicep_download.md b/docs/content/reference/cli/rad_bicep_download.md new file mode 100644 index 000000000..debbc89f2 --- /dev/null +++ b/docs/content/reference/cli/rad_bicep_download.md @@ -0,0 +1,39 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad bicep download CLI reference" +linkTitle: "rad bicep download" +slug: rad_bicep_download +url: /reference/cli/rad_bicep_download/ +description: "Details on the rad bicep download Radius CLI command" +--- +## rad bicep download + +Download the bicep compiler + +### Synopsis + +Downloads the bicep compiler locally + +``` +rad bicep download [flags] +``` + +### Options + +``` + -h, --help help for download +``` + +### 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 bicep]({{< ref rad_bicep.md >}}) - Manage bicep compiler + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_bicep_publish.md b/docs/content/reference/cli/rad_bicep_publish.md new file mode 100644 index 000000000..1a90f7244 --- /dev/null +++ b/docs/content/reference/cli/rad_bicep_publish.md @@ -0,0 +1,54 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad bicep publish CLI reference" +linkTitle: "rad bicep publish" +slug: rad_bicep_publish +url: /reference/cli/rad_bicep_publish/ +description: "Details on the rad bicep publish Radius CLI command" +--- +## rad bicep publish + +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 + + +``` +rad bicep publish [flags] +``` + +### Examples + +``` + +# Publish a Bicep file to an Azure container registry +rad bicep publish --file ./redis-test.bicep --target br:myregistry.azurecr.io/redis-test:v1 + +``` + +### Options + +``` + --file string path to the local Bicep file, relative to the current working directory. + -h, --help help for publish + --target string remote OCI registry path, in the format 'br:HOST/PATH:TAG'. +``` + +### 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 bicep]({{< ref rad_bicep.md >}}) - Manage bicep compiler + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_completion.md b/docs/content/reference/cli/rad_completion.md new file mode 100644 index 000000000..62a3c36e9 --- /dev/null +++ b/docs/content/reference/cli/rad_completion.md @@ -0,0 +1,83 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad completion CLI reference" +linkTitle: "rad completion" +slug: rad_completion +url: /reference/cli/rad_completion/ +description: "Details on the rad completion Radius CLI command" +--- +## rad completion + +Generates shell completion scripts + +``` +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 + +``` + +### Options + +``` + -h, --help help for completion +``` + +### 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 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 + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_completion_bash.md b/docs/content/reference/cli/rad_completion_bash.md new file mode 100644 index 000000000..bb63d17e5 --- /dev/null +++ b/docs/content/reference/cli/rad_completion_bash.md @@ -0,0 +1,35 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad completion bash CLI reference" +linkTitle: "rad completion bash" +slug: rad_completion_bash +url: /reference/cli/rad_completion_bash/ +description: "Details on the rad completion bash Radius CLI command" +--- +## rad completion bash + +Generates bash completion scripts + +``` +rad completion bash [flags] +``` + +### Options + +``` + -h, --help help for bash +``` + +### 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 completion]({{< ref rad_completion.md >}}) - Generates shell completion scripts + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_completion_powershell.md b/docs/content/reference/cli/rad_completion_powershell.md new file mode 100644 index 000000000..e70e8ecf0 --- /dev/null +++ b/docs/content/reference/cli/rad_completion_powershell.md @@ -0,0 +1,35 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad completion powershell CLI reference" +linkTitle: "rad completion powershell" +slug: rad_completion_powershell +url: /reference/cli/rad_completion_powershell/ +description: "Details on the rad completion powershell Radius CLI command" +--- +## rad completion powershell + +Generates powershell completion scripts + +``` +rad completion powershell [flags] +``` + +### Options + +``` + -h, --help help for powershell +``` + +### 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 completion]({{< ref rad_completion.md >}}) - Generates shell completion scripts + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_completion_zsh.md b/docs/content/reference/cli/rad_completion_zsh.md new file mode 100644 index 000000000..7647873d5 --- /dev/null +++ b/docs/content/reference/cli/rad_completion_zsh.md @@ -0,0 +1,35 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad completion zsh CLI reference" +linkTitle: "rad completion zsh" +slug: rad_completion_zsh +url: /reference/cli/rad_completion_zsh/ +description: "Details on the rad completion zsh Radius CLI command" +--- +## rad completion zsh + +Generates zsh completion scripts + +``` +rad completion zsh [flags] +``` + +### Options + +``` + -h, --help help for zsh +``` + +### 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 completion]({{< ref rad_completion.md >}}) - Generates shell completion scripts + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_credential.md b/docs/content/reference/cli/rad_credential.md new file mode 100644 index 000000000..824065ef8 --- /dev/null +++ b/docs/content/reference/cli/rad_credential.md @@ -0,0 +1,70 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad credential CLI reference" +linkTitle: "rad credential" +slug: rad_credential +url: /reference/cli/rad_credential/ +description: "Details on the rad credential Radius CLI command" +--- +## rad credential + +Manage cloud provider credential for a Radius installation. + +### Synopsis + +Manage cloud provider credential for a Radius installation. + +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. + +Cloud providers are configured per-Radius-installation. Configuration commands will use the current workspace +or the workspace specified by '--workspace' to configure Radius. Modifications to cloud provider configuration +or credentials will affect all Radius environments and applications of the affected installation. + +### Examples + +``` + +# List configured cloud providers credential +rad credential list + +# Register (Add or Update) cloud provider credential for Azure with service principal authentication +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 + +# Show cloud provider credential details for Azure +rad credential show azure +# Show cloud provider credential details for AWS +rad credential show aws + +# Delete Azure cloud provider configuration +rad credential unregister azure +# Delete AWS cloud provider configuration +rad credential unregister aws + +``` + +### Options + +``` + -h, --help help for credential +``` + +### 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 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 + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_credential_list.md b/docs/content/reference/cli/rad_credential_list.md new file mode 100644 index 000000000..1c9ab0eaa --- /dev/null +++ b/docs/content/reference/cli/rad_credential_list.md @@ -0,0 +1,56 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad credential list CLI reference" +linkTitle: "rad credential list" +slug: rad_credential_list +url: /reference/cli/rad_credential_list/ +description: "Details on the rad credential list Radius CLI command" +--- +## rad credential list + +List configured cloud provider credentials + +### Synopsis + +List configured cloud providers credentials. + +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. + +Cloud providers are configured per-Radius-installation. Configuration commands will use the current workspace +or the workspace specified by '--workspace' to configure Radius. Modifications to cloud provider configuration +or credentials will affect all Radius environments and applications of the affected installation. + +``` +rad credential list [flags] +``` + +### Examples + +``` + +# List configured cloud provider credentials +rad credential list + +``` + +### Options + +``` + -h, --help help for list + -o, --output string output format (supported formats are json, table) (default "table") + -w, --workspace string The workspace name +``` + +### Options inherited from parent commands + +``` + --config string config file (default "$HOME/.rad/config.yaml") +``` + +### SEE ALSO + +* [rad credential]({{< ref rad_credential.md >}}) - Manage cloud provider credential for a Radius installation. + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_credential_register.md b/docs/content/reference/cli/rad_credential_register.md new file mode 100644 index 000000000..be6fe49d7 --- /dev/null +++ b/docs/content/reference/cli/rad_credential_register.md @@ -0,0 +1,55 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad credential register CLI reference" +linkTitle: "rad credential register" +slug: rad_credential_register +url: /reference/cli/rad_credential_register/ +description: "Details on the rad credential register Radius CLI command" +--- +## rad credential register + +Register(Add or update) cloud provider credential for a Radius installation. + +### Synopsis + +Register (Add or update) cloud provider configuration for a Radius installation. + +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. + +Cloud providers are configured per-Radius-installation. Configuration commands will use the current workspace +or the workspace specified by '--workspace' to configure Radius. Modifications to cloud provider configuration +or credentials will affect all Radius environments and applications of the affected installation. + +### Examples + +``` + +# Register (Add or update) cloud provider credential for Azure with service principal authentication +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 + +``` + +### Options + +``` + -h, --help help for register +``` + +### 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 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. + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_credential_register_aws.md b/docs/content/reference/cli/rad_credential_register_aws.md new file mode 100644 index 000000000..86e89bae8 --- /dev/null +++ b/docs/content/reference/cli/rad_credential_register_aws.md @@ -0,0 +1,64 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad credential register aws CLI reference" +linkTitle: "rad credential register aws" +slug: rad_credential_register_aws +url: /reference/cli/rad_credential_register_aws/ +description: "Details on the rad credential register aws Radius CLI command" +--- +## rad credential register aws + +Register (Add or update) AWS cloud provider credential for a Radius installation. + +### Synopsis + +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 interations 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. + +Cloud providers are configured per-Radius-installation. Configuration commands will use the current workspace +or the workspace specified by '--workspace' to configure Radius. Modifications to cloud provider configuration +or credentials will affect all Radius environments and applications of the affected installation. + +``` +rad credential register aws [flags] +``` + +### Examples + +``` + +# Register (Add or update) cloud provider credential for AWS with IAM authentication +rad credential register aws --access-key-id --secret-access-key + +``` + +### Options + +``` + --access-key-id string The AWS IAM access key id. + -h, --help help for aws + -o, --output string output format (supported formats are json, table) (default "table") + --secret-access-key string The AWS IAM secret access key. + -w, --workspace string The workspace name +``` + +### Options inherited from parent commands + +``` + --config string config file (default "$HOME/.rad/config.yaml") +``` + +### SEE ALSO + +* [rad credential register]({{< ref rad_credential_register.md >}}) - Register(Add or update) cloud provider credential for a Radius installation. + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_credential_register_azure.md b/docs/content/reference/cli/rad_credential_register_azure.md new file mode 100644 index 000000000..c71f6e882 --- /dev/null +++ b/docs/content/reference/cli/rad_credential_register_azure.md @@ -0,0 +1,71 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad credential register azure CLI reference" +linkTitle: "rad credential register azure" +slug: rad_credential_register_azure +url: /reference/cli/rad_credential_register_azure/ +description: "Details on the rad credential register azure Radius CLI command" +--- +## rad credential register azure + +Register (Add or update) Azure cloud provider credential for a Radius installation. + +### Synopsis + +Register (Add or update) Azure 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 service principal for all interations with Azure, including Bicep deployment, +Radius environments, and Radius links. + +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. + +Cloud providers are configured per-Radius-installation. Configuration commands will use the current workspace +or the workspace specified by '--workspace' to configure Radius. Modifications to cloud provider configuration +or credentials will affect all Radius environments and applications of the affected installation. + +``` +rad credential register azure [flags] +``` + +### Examples + +``` + +# Register (Add or update) cloud provider credential for Azure with service principal authentication +rad credential register azure --client-id --client-secret --tenant-id + +``` + +### Options + +``` + --client-id string The client id or app id of an Azure service principal. + --client-secret string The client secret or password of an Azure service principal. + -h, --help help for azure + -o, --output string output format (supported formats are json, table) (default "table") + --tenant-id string The tenant id of an Azure service principal. + -w, --workspace string The workspace name +``` + +### Options inherited from parent commands + +``` + --config string config file (default "$HOME/.rad/config.yaml") +``` + +### SEE ALSO + +* [rad credential register]({{< ref rad_credential_register.md >}}) - Register(Add or update) cloud provider credential for a Radius installation. + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_credential_show.md b/docs/content/reference/cli/rad_credential_show.md new file mode 100644 index 000000000..545046311 --- /dev/null +++ b/docs/content/reference/cli/rad_credential_show.md @@ -0,0 +1,59 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad credential show CLI reference" +linkTitle: "rad credential show" +slug: rad_credential_show +url: /reference/cli/rad_credential_show/ +description: "Details on the rad credential show Radius CLI command" +--- +## rad credential show + +Show details of a configured cloud provider credential + +### Synopsis + +Show details of a configured cloud provider credential. + +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. + +Cloud providers are configured per-Radius-installation. Configuration commands will use the current workspace +or the workspace specified by '--workspace' to configure Radius. Modifications to cloud provider configuration +or credentials will affect all Radius environments and applications of the affected installation. + +``` +rad credential show [name] [flags] +``` + +### Examples + +``` + +# Show cloud providers details for Azure +rad credential show azure + +# Show cloud providers details for AWS +rad credential show aws + +``` + +### Options + +``` + -h, --help help for show + -o, --output string output format (supported formats are json, table) (default "table") + -w, --workspace string The workspace name +``` + +### Options inherited from parent commands + +``` + --config string config file (default "$HOME/.rad/config.yaml") +``` + +### SEE ALSO + +* [rad credential]({{< ref rad_credential.md >}}) - Manage cloud provider credential for a Radius installation. + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_credential_unregister.md b/docs/content/reference/cli/rad_credential_unregister.md new file mode 100644 index 000000000..3807e91f4 --- /dev/null +++ b/docs/content/reference/cli/rad_credential_unregister.md @@ -0,0 +1,59 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad credential unregister CLI reference" +linkTitle: "rad credential unregister" +slug: rad_credential_unregister +url: /reference/cli/rad_credential_unregister/ +description: "Details on the rad credential unregister Radius CLI command" +--- +## rad credential unregister + +Unregisters a configured cloud provider credential from the Radius installation + +### Synopsis + +Unregisters a configured cloud provider credential from the Radius installation. + +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. + +Cloud providers are configured per-Radius-installation. Configuration commands will use the current workspace +or the workspace specified by '--workspace' to configure Radius. Modifications to cloud provider configuration +or credentials will affect all Radius environments and applications of the affected installation. + +``` +rad credential unregister [flags] +``` + +### Examples + +``` + +# Unregister Azure cloud provider credential +rad credential unregister azure + +# Unregister AWS cloud provider credential +rad credential unregister aws + +``` + +### Options + +``` + -h, --help help for unregister + -o, --output string output format (supported formats are json, table) (default "table") + -w, --workspace string The workspace name +``` + +### Options inherited from parent commands + +``` + --config string config file (default "$HOME/.rad/config.yaml") +``` + +### SEE ALSO + +* [rad credential]({{< ref rad_credential.md >}}) - Manage cloud provider credential for a Radius installation. + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_debug-logs.md b/docs/content/reference/cli/rad_debug-logs.md new file mode 100644 index 000000000..97be7a551 --- /dev/null +++ b/docs/content/reference/cli/rad_debug-logs.md @@ -0,0 +1,45 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad debug-logs CLI reference" +linkTitle: "rad debug-logs" +slug: rad_debug-logs +url: /reference/cli/rad_debug-logs/ +description: "Details on the rad debug-logs Radius CLI command" +--- +## rad debug-logs + +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] +``` + +### Options + +``` + -h, --help help for debug-logs + -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 + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_deploy.md b/docs/content/reference/cli/rad_deploy.md new file mode 100644 index 000000000..1fd06f180 --- /dev/null +++ b/docs/content/reference/cli/rad_deploy.md @@ -0,0 +1,99 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad deploy CLI reference" +linkTitle: "rad deploy" +slug: rad_deploy +url: /reference/cli/rad_deploy/ +description: "Details on the rad deploy Radius CLI command" +--- +## rad deploy + +Deploy a template + +### Synopsis + +Deploy a Bicep or ARM template + + The deploy command compiles a Bicep or ARM template and deploys it to your default environment (unless otherwise specified). + + You can combine Radius types as as well as other types that are available in Bicep such as Azure resources. See + the Radius documentation for information about describing your application and resources with Bicep. + + You can specify parameters using the '--parameter' flag ('-p' for short). Parameters can be passed as: + + - A file containing multiple parameters using the ARM JSON parameter format (see below) + - A file containing a single value in JSON format + - A key-value-pair passed in the command line + + When passing multiple parameters in a single file, use the format described here: + + 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. + + +``` +rad deploy [file] [flags] +``` + +### Examples + +``` + +# deploy a Bicep template +rad deploy myapp.bicep + +# deploy an ARM template (json) +rad deploy myapp.json + +# deploy to a specific workspace +rad deploy myapp.bicep --workspace production + +# deploy using a specific environment +rad deploy myapp.bicep --environment production + +# deploy using a specific environment and resource group +rad deploy myapp.bicep --environment production --group mygroup + +# specify a string parameter +rad deploy myapp.bicep --parameters version=latest + + +# specify a non-string parameter using a JSON file +rad deploy myapp.bicep --parameters configuration=@myfile.json + + +# specify many parameters using an ARM JSON parameter file +rad deploy myapp.bicep --parameters @myfile.json + + +# specify parameters from multiple sources +rad deploy myapp.bicep --parameters @myfile.json --parameters version=latest + +``` + +### Options + +``` + -a, --application string The application name + -e, --environment string The environment name + -g, --group string The resource group name + -h, --help help for deploy + -p, --parameters stringArray Specify parameters for the deployment + -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 + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_env.md b/docs/content/reference/cli/rad_env.md new file mode 100644 index 000000000..39e44e569 --- /dev/null +++ b/docs/content/reference/cli/rad_env.md @@ -0,0 +1,44 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +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 + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_env_create.md b/docs/content/reference/cli/rad_env_create.md new file mode 100644 index 000000000..a04b6ccf6 --- /dev/null +++ b/docs/content/reference/cli/rad_env_create.md @@ -0,0 +1,51 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +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" +--- +## rad env create + +Create a new Radius environment + +### Synopsis + +Create a new Radius environment +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] +``` + +### Examples + +``` +rad env create myenv +``` + +### 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 + -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 env]({{< ref rad_env.md >}}) - Manage Radius environments + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_env_delete.md b/docs/content/reference/cli/rad_env_delete.md new file mode 100644 index 000000000..72e4ff190 --- /dev/null +++ b/docs/content/reference/cli/rad_env_delete.md @@ -0,0 +1,61 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +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" +--- +## rad env delete + +Delete environment + +### Synopsis + +Delete environment. Deletes the user's default environment by default. + +``` +rad env delete [flags] +``` + +### Examples + +``` + +# Delete current enviroment +rad env delete + +# Delete current enviroment and bypass confirmation prompt +rad env delete --yes + +# Delete specified enviroment +rad env delete my-env + +# Delete specified enviroment in a specified resource group +rad env delete my-env --group my-env + +``` + +### Options + +``` + -e, --environment string The environment name + -g, --group string The resource group name + -h, --help help for delete + -o, --output string output format (supported formats are json, table) (default "table") + -w, --workspace string The workspace name + -y, --yes The confirmation flag +``` + +### Options inherited from parent commands + +``` + --config string config file (default "$HOME/.rad/config.yaml") +``` + +### SEE ALSO + +* [rad env]({{< ref rad_env.md >}}) - Manage Radius environments + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_env_list.md b/docs/content/reference/cli/rad_env_list.md new file mode 100644 index 000000000..33e8ffba0 --- /dev/null +++ b/docs/content/reference/cli/rad_env_list.md @@ -0,0 +1,51 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +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" +--- +## rad env list + +List environments + +### Synopsis + +List environments using the current, or specified workspace. + +``` +rad env list [flags] +``` + +### Examples + +``` + +# List enviroments +rad env list + +``` + +### Options + +``` + -g, --group string The resource group name + -h, --help help for list + -o, --output string output format (supported formats are json, table) (default "table") + -w, --workspace string The workspace name +``` + +### Options inherited from parent commands + +``` + --config string config file (default "$HOME/.rad/config.yaml") + -e, --environment string The environment name +``` + +### SEE ALSO + +* [rad env]({{< ref rad_env.md >}}) - Manage Radius environments + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_env_show.md b/docs/content/reference/cli/rad_env_show.md new file mode 100644 index 000000000..c579b54d9 --- /dev/null +++ b/docs/content/reference/cli/rad_env_show.md @@ -0,0 +1,57 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +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" +--- +## rad env show + +Show environment details + +### Synopsis + +Show environment details. Shows the user's default environment by default. + +``` +rad env show [flags] +``` + +### Examples + +``` + +# Show current enviroment +rad env show + +# Show specified enviroment +rad env show my-env + +# Show specified enviroment in a specified resource group +rad env show my-env --group my-env + +``` + +### Options + +``` + -e, --environment string The environment name + -g, --group string The resource group name + -h, --help help for show + -o, --output string output format (supported formats are json, table) (default "table") + -w, --workspace string The workspace name +``` + +### Options inherited from parent commands + +``` + --config string config file (default "$HOME/.rad/config.yaml") +``` + +### SEE ALSO + +* [rad env]({{< ref rad_env.md >}}) - Manage Radius environments + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_env_switch.md b/docs/content/reference/cli/rad_env_switch.md new file mode 100644 index 000000000..b39362c4d --- /dev/null +++ b/docs/content/reference/cli/rad_env_switch.md @@ -0,0 +1,47 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +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" +--- +## rad env switch + +Switch the current environment + +### Synopsis + +Switch the current environment + +``` +rad env switch [environment] [flags] +``` + +### Examples + +``` +rad env switch newEnvironment +``` + +### Options + +``` + -e, --environment string The environment name + -h, --help help for switch + -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 env]({{< ref rad_env.md >}}) - Manage Radius environments + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_env_update.md b/docs/content/reference/cli/rad_env_update.md new file mode 100644 index 000000000..df50b7f0d --- /dev/null +++ b/docs/content/reference/cli/rad_env_update.md @@ -0,0 +1,74 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +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" +--- +## rad env update + +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. + + +``` +rad env update [environment] [flags] +``` + +### Examples + +``` + +## Add Azure cloud provider for deploying Azure resources +rad env update myenv --azure-subscription-id **** --azure-resource-group myrg + +## Add AWS cloud provider for deploying AWS resources +rad env update myenv --aws-region us-west-2 --aws-account-id ***** + +## Remove Azure cloud provider +rad env update myenv --clear-azure + +## Remove AWS cloud provider +rad env update myenv --clear-aws + +``` + +### Options + +``` + --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 + --clear-aws Specify if aws provider needs to be cleared on env + --clear-azure Specify if azure provider needs to be cleared on env + -e, --environment string The environment name + -g, --group string The resource group name + -h, --help help for update + -o, --output string output format (supported formats are json, table) (default "table") + -w, --workspace string The workspace name +``` + +### Options inherited from parent commands + +``` + --config string config file (default "$HOME/.rad/config.yaml") +``` + +### SEE ALSO + +* [rad env]({{< ref rad_env.md >}}) - Manage Radius environments + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_group.md b/docs/content/reference/cli/rad_group.md new file mode 100644 index 000000000..33ada34c7 --- /dev/null +++ b/docs/content/reference/cli/rad_group.md @@ -0,0 +1,65 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad group CLI reference" +linkTitle: "rad group" +slug: rad_group +url: /reference/cli/rad_group/ +description: "Details on the rad group Radius CLI command" +--- +## rad group + +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 + +# Create resource group in specified workspace +rad group create prod -w localWorkspace + +# Delete resource group in default workspace +rad group delete prod + +# Show details of resource group in default workspace +rad group show dev + +``` + +### Options + +``` + -h, --help help for group +``` + +### 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 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 + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_group_create.md b/docs/content/reference/cli/rad_group_create.md new file mode 100644 index 000000000..c09dae298 --- /dev/null +++ b/docs/content/reference/cli/rad_group_create.md @@ -0,0 +1,54 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad group create CLI reference" +linkTitle: "rad group create" +slug: rad_group_create +url: /reference/cli/rad_group_create/ +description: "Details on the rad group create Radius CLI command" +--- +## rad group create + +Create a new resource group + +### Synopsis + +Create a new resource group + +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. + + +``` +rad group create resourcegroupname [flags] +``` + +### Examples + +``` +rad group create rgprod +``` + +### Options + +``` + -g, --group string The resource group name + -h, --help help for create + -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 group]({{< ref rad_group.md >}}) - Manage resource groups + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_group_delete.md b/docs/content/reference/cli/rad_group_delete.md new file mode 100644 index 000000000..e15f981c9 --- /dev/null +++ b/docs/content/reference/cli/rad_group_delete.md @@ -0,0 +1,50 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad group delete CLI reference" +linkTitle: "rad group delete" +slug: rad_group_delete +url: /reference/cli/rad_group_delete/ +description: "Details on the rad group delete Radius CLI command" +--- +## rad group delete + +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 + +``` +rad group delete resourcegroupname [flags] +``` + +### Examples + +``` +rad group delete rgprod +``` + +### Options + +``` + -g, --group string The resource group name + -h, --help help for delete + -w, --workspace string The workspace name + -y, --yes The confirmation flag +``` + +### 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 group]({{< ref rad_group.md >}}) - Manage resource groups + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_group_list.md b/docs/content/reference/cli/rad_group_list.md new file mode 100644 index 000000000..4ef8737cb --- /dev/null +++ b/docs/content/reference/cli/rad_group_list.md @@ -0,0 +1,52 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad group list CLI reference" +linkTitle: "rad group list" +slug: rad_group_list +url: /reference/cli/rad_group_list/ +description: "Details on the rad group list Radius CLI command" +--- +## rad group list + +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. + + Note that these resource groups are separate from the Azure cloud provider and Azure resource groups configured with the cloud provider. + +``` +rad group list [flags] +``` + +### Examples + +``` +rad group list +``` + +### Options + +``` + -h, --help help for list + -o, --output string output format (supported formats are json, table) (default "table") + -w, --workspace string The workspace name +``` + +### Options inherited from parent commands + +``` + --config string config file (default "$HOME/.rad/config.yaml") +``` + +### SEE ALSO + +* [rad group]({{< ref rad_group.md >}}) - Manage resource groups + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_group_show.md b/docs/content/reference/cli/rad_group_show.md new file mode 100644 index 000000000..8cea433fd --- /dev/null +++ b/docs/content/reference/cli/rad_group_show.md @@ -0,0 +1,54 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad group show CLI reference" +linkTitle: "rad group show" +slug: rad_group_show +url: /reference/cli/rad_group_show/ +description: "Details on the rad group show Radius CLI command" +--- +## rad group show + +Show the details of a resource group + +### Synopsis + +Show the details of a resource group + +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. + + +``` +rad group show resourcegroupname [flags] +``` + +### Examples + +``` +rad group show rgprod +``` + +### Options + +``` + -g, --group string The resource group name + -h, --help help for show + -o, --output string output format (supported formats are json, table) (default "table") + -w, --workspace string The workspace name +``` + +### Options inherited from parent commands + +``` + --config string config file (default "$HOME/.rad/config.yaml") +``` + +### SEE ALSO + +* [rad group]({{< ref rad_group.md >}}) - Manage resource groups + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_group_switch.md b/docs/content/reference/cli/rad_group_switch.md new file mode 100644 index 000000000..e47b37cb1 --- /dev/null +++ b/docs/content/reference/cli/rad_group_switch.md @@ -0,0 +1,53 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad group switch CLI reference" +linkTitle: "rad group switch" +slug: rad_group_switch +url: /reference/cli/rad_group_switch/ +description: "Details on the rad group switch Radius CLI command" +--- +## rad group switch + +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. + +``` +rad group switch resourcegroupname [flags] +``` + +### Examples + +``` +rad group switch rgprod -w wsprod +``` + +### Options + +``` + -g, --group string The resource group name + -h, --help help for switch + -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 group]({{< ref rad_group.md >}}) - Manage resource groups + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_init.md b/docs/content/reference/cli/rad_init.md new file mode 100644 index 000000000..0b478cd63 --- /dev/null +++ b/docs/content/reference/cli/rad_init.md @@ -0,0 +1,60 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +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" +--- +## rad init + +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. + +By default, 'rad init' will optimize for a developer-focused environment with an environment named "default" and Recipes that support prototyping, development and testing using lightweight containers. These environments are great for building and testing your application. + +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] +``` + +### 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 + +``` + --full Prompt user for all available configuration options + -h, --help help for init + -o, --output string output format (supported formats are json, table) (default "table") +``` + +### Options inherited from parent commands + +``` + --config string config file (default "$HOME/.rad/config.yaml") +``` + +### SEE ALSO + +* [rad]({{< ref rad.md >}}) - Radius CLI + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_install.md b/docs/content/reference/cli/rad_install.md new file mode 100644 index 000000000..09cafa977 --- /dev/null +++ b/docs/content/reference/cli/rad_install.md @@ -0,0 +1,36 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad install CLI reference" +linkTitle: "rad install" +slug: rad_install +url: /reference/cli/rad_install/ +description: "Details on the rad install Radius CLI command" +--- +## rad install + +Installs Radius for a given platform + +### Synopsis + +Installs Radius for a given platform + +### Options + +``` + -h, --help help for install +``` + +### 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 install kubernetes]({{< ref rad_install_kubernetes.md >}}) - Installs Radius onto a kubernetes cluster + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_install_kubernetes.md b/docs/content/reference/cli/rad_install_kubernetes.md new file mode 100644 index 000000000..f1c1bc6f3 --- /dev/null +++ b/docs/content/reference/cli/rad_install_kubernetes.md @@ -0,0 +1,63 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad install kubernetes CLI reference" +linkTitle: "rad install kubernetes" +slug: rad_install_kubernetes +url: /reference/cli/rad_install_kubernetes/ +description: "Details on the rad install kubernetes Radius CLI command" +--- +## rad install kubernetes + +Installs Radius onto a kubernetes cluster + +### Synopsis + +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.dev/concepts/architecture/ + +Overrides can be set by specifying Helm chart values with the '--set' flag. For more information visit https://docs.radapp.dev/operations/platforms/kubernetes/install/. + + +``` +rad install kubernetes [flags] +``` + +### Examples + +``` +# Install Radius with default settings in current Kubernetes context +rad install kubernetes + +# Install Radius with default settings in specified Kubernetes context +rad install kubernetes --kubecontext mycluster + +# Install Radius with overrides in the current Kubernetes context +rad install kubernetes --set key=value + +``` + +### Options + +``` + --chart string Specify a file path to a helm chart to install Radius from + -h, --help help for kubernetes + --kubecontext string The Kubernetes context to use, will use the default if unset + --reinstall Specify to force reinstallation of Radius + --set stringArray Set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) +``` + +### 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 install]({{< ref rad_install.md >}}) - Installs Radius for a given platform + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_recipe.md b/docs/content/reference/cli/rad_recipe.md new file mode 100644 index 000000000..83287935e --- /dev/null +++ b/docs/content/reference/cli/rad_recipe.md @@ -0,0 +1,42 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad recipe CLI reference" +linkTitle: "rad recipe" +slug: rad_recipe +url: /reference/cli/rad_recipe/ +description: "Details on the rad recipe Radius CLI command" +--- +## rad recipe + +Manage link recipes + +### Synopsis + +Manage link recipes + Link recipes automate the deployment of infrastructure and configuration of links. + +### Options + +``` + -e, --environment string The environment name + -h, --help help for recipe + -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 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 + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_recipe_list.md b/docs/content/reference/cli/rad_recipe_list.md new file mode 100644 index 000000000..c6c94a686 --- /dev/null +++ b/docs/content/reference/cli/rad_recipe_list.md @@ -0,0 +1,48 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad recipe list CLI reference" +linkTitle: "rad recipe list" +slug: rad_recipe_list +url: /reference/cli/rad_recipe_list/ +description: "Details on the rad recipe list Radius CLI command" +--- +## rad recipe list + +List recipes + +### Synopsis + +List recipes within an environment + +``` +rad recipe list [flags] +``` + +### Examples + +``` +rad recipe list +``` + +### Options + +``` + -e, --environment string The environment name + -g, --group string The resource group name + -h, --help help for list + -o, --output string output format (supported formats are json, table) (default "table") + -w, --workspace string The workspace name +``` + +### Options inherited from parent commands + +``` + --config string config file (default "$HOME/.rad/config.yaml") +``` + +### SEE ALSO + +* [rad recipe]({{< ref rad_recipe.md >}}) - Manage link recipes + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_recipe_register.md b/docs/content/reference/cli/rad_recipe_register.md new file mode 100644 index 000000000..2fb06decc --- /dev/null +++ b/docs/content/reference/cli/rad_recipe_register.md @@ -0,0 +1,67 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad recipe register CLI reference" +linkTitle: "rad recipe register" +slug: rad_recipe_register +url: /reference/cli/rad_recipe_register/ +description: "Details on the rad recipe register Radius CLI command" +--- +## rad recipe register + +Add a recipe to an environment. + +### Synopsis + +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] +``` + +### Examples + +``` + +# Add a recipe to an environment +rad recipe register cosmosdb -e env_name -w workspace --template-kind bicep --template-path template_path --link-type Applications.Link/mongoDatabases + +# Specify a parameter +rad recipe register cosmosdb -e env_name -w workspace --template-kind bicep --template-path template_path --link-type Applications.Link/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 --link-type Applications.Link/mongoDatabases --parameters @myfile.json + +``` + +### Options + +``` + -e, --environment string The environment name + -g, --group string The resource group name + -h, --help help for register + --link-type string specify the type of the link this recipe can be consumed by + -o, --output string output format (supported formats are json, table) (default "table") + -p, --parameters stringArray Specify parameters for the deployment + --template-kind string specify the kind for the template provided by the recipe. + --template-path string specify the path to the template provided by the recipe. + --template-version string specify the version for the terraform module. + -w, --workspace string The workspace name +``` + +### Options inherited from parent commands + +``` + --config string config file (default "$HOME/.rad/config.yaml") +``` + +### SEE ALSO + +* [rad recipe]({{< ref rad_recipe.md >}}) - Manage link recipes + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_recipe_show.md b/docs/content/reference/cli/rad_recipe_show.md new file mode 100644 index 000000000..c77684e3e --- /dev/null +++ b/docs/content/reference/cli/rad_recipe_show.md @@ -0,0 +1,63 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad recipe show CLI reference" +linkTitle: "rad recipe show" +slug: rad_recipe_show +url: /reference/cli/rad_recipe_show/ +description: "Details on the rad recipe show Radius CLI command" +--- +## rad recipe show + +Show recipe details + +### Synopsis + +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. + +``` +rad recipe show [recipe-name] [flags] +``` + +### Examples + +``` + +# show the details of a recipe +rad recipe show redis-prod + +# show the details of a recipe, with a JSON output +rad recipe show redis-prod --output json + +# show the details of a recipe, with a specified environment and group +rad recipe show redis-dev --group dev --environment dev +``` + +### Options + +``` + -e, --environment string The environment name + -g, --group string The resource group name + -h, --help help for show + --link-type string Specify the type of the link this recipe can be consumed by + -o, --output string output format (supported formats are json, table) (default "table") + -w, --workspace string The workspace name +``` + +### Options inherited from parent commands + +``` + --config string config file (default "$HOME/.rad/config.yaml") +``` + +### SEE ALSO + +* [rad recipe]({{< ref rad_recipe.md >}}) - Manage link recipes + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_recipe_unregister.md b/docs/content/reference/cli/rad_recipe_unregister.md new file mode 100644 index 000000000..4e8baad12 --- /dev/null +++ b/docs/content/reference/cli/rad_recipe_unregister.md @@ -0,0 +1,49 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad recipe unregister CLI reference" +linkTitle: "rad recipe unregister" +slug: rad_recipe_unregister +url: /reference/cli/rad_recipe_unregister/ +description: "Details on the rad recipe unregister Radius CLI command" +--- +## rad recipe unregister + +Unregister a recipe from an environment + +### Synopsis + +Unregister a recipe from an environment + +``` +rad recipe unregister [recipe-name] [flags] +``` + +### Examples + +``` +rad recipe unregister cosmosdb +``` + +### Options + +``` + -e, --environment string The environment name + -g, --group string The resource group name + -h, --help help for unregister + --link-type string Specify the type of the link this recipe can be consumed by + -o, --output string output format (supported formats are json, table) (default "table") + -w, --workspace string The workspace name +``` + +### Options inherited from parent commands + +``` + --config string config file (default "$HOME/.rad/config.yaml") +``` + +### SEE ALSO + +* [rad recipe]({{< ref rad_recipe.md >}}) - Manage link recipes + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_resource.md b/docs/content/reference/cli/rad_resource.md new file mode 100644 index 000000000..6e33741c2 --- /dev/null +++ b/docs/content/reference/cli/rad_resource.md @@ -0,0 +1,42 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad resource CLI reference" +linkTitle: "rad resource" +slug: rad_resource +url: /reference/cli/rad_resource/ +description: "Details on the rad resource Radius CLI command" +--- +## rad resource + +Manage resources + +### Synopsis + +Manage resources + +### Options + +``` + -a, --application string The application name + -h, --help help for resource + -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 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 + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_resource_delete.md b/docs/content/reference/cli/rad_resource_delete.md new file mode 100644 index 000000000..5cc3b68dd --- /dev/null +++ b/docs/content/reference/cli/rad_resource_delete.md @@ -0,0 +1,53 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad resource delete CLI reference" +linkTitle: "rad resource delete" +slug: rad_resource_delete +url: /reference/cli/rad_resource_delete/ +description: "Details on the rad resource delete Radius CLI command" +--- +## rad resource delete + +Delete a Radius resource + +### Synopsis + +Deletes a Radius resource with the given name + +``` +rad resource delete [resourceType] [resourceName] [flags] +``` + +### Examples + +``` + + 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 + +``` + -g, --group string The resource group name + -h, --help help for delete + -o, --output string output format (supported formats are json, table) (default "table") + -w, --workspace string The workspace name + -y, --yes The confirmation flag +``` + +### Options inherited from parent commands + +``` + -a, --application string The application name + --config string config file (default "$HOME/.rad/config.yaml") +``` + +### SEE ALSO + +* [rad resource]({{< ref rad_resource.md >}}) - Manage resources + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_resource_expose.md b/docs/content/reference/cli/rad_resource_expose.md new file mode 100644 index 000000000..1b60de425 --- /dev/null +++ b/docs/content/reference/cli/rad_resource_expose.md @@ -0,0 +1,58 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad resource expose CLI reference" +linkTitle: "rad resource expose" +slug: rad_resource_expose +url: /reference/cli/rad_resource_expose/ +description: "Details on the rad resource expose Radius CLI command" +--- +## rad resource expose + +Exposes a resource for network traffic + +### Synopsis + +Exposes a port inside a resource for network traffic using a local port. +This command is useful for testing resources that accept network traffic but are not exposed to the public internet. Exposing a port for testing allows you to send TCP traffic from your local machine to the resource. + +Press CTRL+C to exit the command and terminate the tunnel. + +``` +rad resource expose [type] [resource] [flags] +``` + +### Examples + +``` +# expose port 80 on the 'orders' resource of the 'icecream-store' application +# on local port 5000 +rad resource expose --application icecream-store containers orders --port 5000 --remote-port 80 +``` + +### Options + +``` + -g, --group string The resource group name + -h, --help help for expose + -p, --port int specify the local port (default -1) + --remote-port int specify the remote port (default -1) + --replica string specify the replica to expose + -r, --resource string The resource name + -t, --type string The resource type +``` + +### Options inherited from parent commands + +``` + -a, --application string The application name + --config string config file (default "$HOME/.rad/config.yaml") + -o, --output string output format (supported formats are json, table) (default "table") + -w, --workspace string The workspace name +``` + +### SEE ALSO + +* [rad resource]({{< ref rad_resource.md >}}) - Manage resources + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_resource_list.md b/docs/content/reference/cli/rad_resource_list.md new file mode 100644 index 000000000..7fb9d900e --- /dev/null +++ b/docs/content/reference/cli/rad_resource_list.md @@ -0,0 +1,62 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad resource list CLI reference" +linkTitle: "rad resource list" +slug: rad_resource_list +url: /reference/cli/rad_resource_list/ +description: "Details on the rad resource list Radius CLI command" +--- +## rad resource list + +Lists resources + +### Synopsis + +List all resources of specified type + +``` +rad resource list [resourceType] [flags] +``` + +### Examples + +``` + + sample list of resourceType: containers, gateways, httpRoutes, daprPubSubBrokers, extenders, mongoDatabases, rabbitMQMessageQueues, redisCaches, sqlDatabases, daprStateStores, daprSecretStores + + # list all resources of a specified type in the default environment + + 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 (shorthand flag) + rad resource list containers -a icecream-store + +``` + +### Options + +``` + -a, --application string The application name + -g, --group string The resource group name + -h, --help help for list + -o, --output string output format (supported formats are json, table) (default "table") + -w, --workspace string The workspace name +``` + +### Options inherited from parent commands + +``` + --config string config file (default "$HOME/.rad/config.yaml") +``` + +### SEE ALSO + +* [rad resource]({{< ref rad_resource.md >}}) - Manage resources + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_resource_logs.md b/docs/content/reference/cli/rad_resource_logs.md new file mode 100644 index 000000000..2ccfdbcdf --- /dev/null +++ b/docs/content/reference/cli/rad_resource_logs.md @@ -0,0 +1,68 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad resource logs CLI reference" +linkTitle: "rad resource logs" +slug: rad_resource_logs +url: /reference/cli/rad_resource_logs/ +description: "Details on the rad resource logs Radius CLI command" +--- +## rad resource logs + +Read logs from a running containers resource + +### Synopsis + +Reads logs from a running resource. Currently only supports the resource type 'Applications.Core/containers'. +This command allows you to access logs of a deployed application and output those logs to the local console. + +'rad resource logs' will output all currently available logs for the resource and then exit. + +'rad resource logs' will output logs from the resource's primary container. In scenarios like Dapr where multiple containers are in use, the '--container \' option can specify the desired container. + +Specify the '--follow' option to stream additional logs as they are emitted by the resource. When following, press CTRL+C to exit the command and terminate the stream. + +``` +rad resource logs [resource] [flags] +``` + +### Examples + +``` +# read logs from the 'webapp' resource of the current default app +rad resource logs containers webapp + +# read logs from the 'orders' resource of the 'icecream-store' application +rad resource logs containers orders --application icecream-store + +# stream logs from the 'orders' resource of the 'icecream-store' application +rad resource logs containers orders --application icecream-store --follow + +# read logs from the 'daprd' sidecar container of the 'orders' resource of the 'icecream-store' application +rad resource logs containers orders --application icecream-store --container daprd +``` + +### Options + +``` + --container string specify the container from which logs should be streamed + -f, --follow specify that logs should be stream until the command is canceled + -g, --group string The resource group name + -h, --help help for logs + --replica string specify the replica to collect logs from +``` + +### Options inherited from parent commands + +``` + -a, --application string The application name + --config string config file (default "$HOME/.rad/config.yaml") + -o, --output string output format (supported formats are json, table) (default "table") + -w, --workspace string The workspace name +``` + +### SEE ALSO + +* [rad resource]({{< ref rad_resource.md >}}) - Manage resources + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_resource_show.md b/docs/content/reference/cli/rad_resource_show.md new file mode 100644 index 000000000..c261f6ec3 --- /dev/null +++ b/docs/content/reference/cli/rad_resource_show.md @@ -0,0 +1,62 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad resource show CLI reference" +linkTitle: "rad resource show" +slug: rad_resource_show +url: /reference/cli/rad_resource_show/ +description: "Details on the rad resource show Radius CLI command" +--- +## rad resource show + +Show Radius resource details + +### Synopsis + +Show details of the specified Radius resource + +``` +rad resource show [resourceType] [resourceName] [flags] +``` + +### Examples + +``` + + 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 + + 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 (shorthand flag) + rad resource show containers orders -a icecream-store + +``` + +### Options + +``` + -g, --group string The resource group name + -h, --help help for show + -o, --output string output format (supported formats are json, table) (default "table") + -w, --workspace string The workspace name +``` + +### Options inherited from parent commands + +``` + -a, --application string The application name + --config string config file (default "$HOME/.rad/config.yaml") +``` + +### SEE ALSO + +* [rad resource]({{< ref rad_resource.md >}}) - Manage resources + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_run.md b/docs/content/reference/cli/rad_run.md new file mode 100644 index 000000000..871a137ab --- /dev/null +++ b/docs/content/reference/cli/rad_run.md @@ -0,0 +1,67 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad run CLI reference" +linkTitle: "rad run" +slug: rad_run +url: /reference/cli/rad_run/ +description: "Details on the rad run Radius CLI command" +--- +## rad run + +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] +``` + +### Examples + +``` + +# Run app.bicep +rad run app.bicep + +# Run in a specific environment +rad run app.bicep --environment prod + +# Run app.bicep and specify a string parameter +rad run app.bicep --parameters version=latest + +# Run app.bicep and specify parameters from multiple sources +rad run app.bicep --parameters @myfile.json --parameters version=latest + +``` + +### Options + +``` + -a, --application string The application name + -e, --environment string The environment name + -g, --group string The resource group name + -h, --help help for run + -p, --parameters stringArray Specify parameters for the deployment + -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 + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_uninstall.md b/docs/content/reference/cli/rad_uninstall.md new file mode 100644 index 000000000..4958d1cca --- /dev/null +++ b/docs/content/reference/cli/rad_uninstall.md @@ -0,0 +1,36 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad uninstall CLI reference" +linkTitle: "rad uninstall" +slug: rad_uninstall +url: /reference/cli/rad_uninstall/ +description: "Details on the rad uninstall Radius CLI command" +--- +## rad uninstall + +Uninstall Radius for a specific platform + +### Synopsis + +Uninstall Radius for a specific platform + +### Options + +``` + -h, --help help for uninstall +``` + +### 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 uninstall kubernetes]({{< ref rad_uninstall_kubernetes.md >}}) - Uninstall Radius from a Kubernetes cluster + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_uninstall_kubernetes.md b/docs/content/reference/cli/rad_uninstall_kubernetes.md new file mode 100644 index 000000000..14c370071 --- /dev/null +++ b/docs/content/reference/cli/rad_uninstall_kubernetes.md @@ -0,0 +1,50 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad uninstall kubernetes CLI reference" +linkTitle: "rad uninstall kubernetes" +slug: rad_uninstall_kubernetes +url: /reference/cli/rad_uninstall_kubernetes/ +description: "Details on the rad uninstall kubernetes Radius CLI command" +--- +## rad uninstall kubernetes + +Uninstall Radius from a Kubernetes cluster + +### Synopsis + +Uninstall Radius from a Kubernetes cluster. + +``` +rad uninstall kubernetes [flags] +``` + +### Examples + +``` +# uninstall Radius from the current Kubernetes cluster +rad uninstall kubernetes + +# uninstall Radius from a specific Kubernetes cluster based on the Kubeconfig context +rad uninstall kubernetes --kubecontext my-kubecontext +``` + +### Options + +``` + -h, --help help for kubernetes + --kubecontext string The Kubernetes context to use, will use the default if unset +``` + +### 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 uninstall]({{< ref rad_uninstall.md >}}) - Uninstall Radius for a specific platform + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_version.md b/docs/content/reference/cli/rad_version.md new file mode 100644 index 000000000..7e6942d23 --- /dev/null +++ b/docs/content/reference/cli/rad_version.md @@ -0,0 +1,36 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad version CLI reference" +linkTitle: "rad version" +slug: rad_version +url: /reference/cli/rad_version/ +description: "Details on the rad version Radius CLI command" +--- +## rad version + +Prints the versions of the rad cli + +``` +rad version [flags] +``` + +### Options + +``` + --cli Use this flag to only show the rad CLI version + -h, --help help for version +``` + +### 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 + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_workspace.md b/docs/content/reference/cli/rad_workspace.md new file mode 100644 index 000000000..0e087eaef --- /dev/null +++ b/docs/content/reference/cli/rad_workspace.md @@ -0,0 +1,55 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad workspace CLI reference" +linkTitle: "rad workspace" +slug: rad_workspace +url: /reference/cli/rad_workspace/ +description: "Details on the rad workspace Radius CLI command" +--- +## rad workspace + +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. + + +### Examples + +``` + +# Create workspace with no default resource group or environment set +rad workspace create kubernetes myworkspace --context kind-kind +# Create workspace with default resource group and environment set +rad workspace create kubernetes myworkspace --context kind-kind --group myrg --environment myenv + +``` + +### Options + +``` + -h, --help help for workspace + -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 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 + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_workspace_create.md b/docs/content/reference/cli/rad_workspace_create.md new file mode 100644 index 000000000..a8ef380cb --- /dev/null +++ b/docs/content/reference/cli/rad_workspace_create.md @@ -0,0 +1,60 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad workspace create CLI reference" +linkTitle: "rad workspace create" +slug: rad_workspace_create +url: /reference/cli/rad_workspace_create/ +description: "Details on the rad workspace create Radius CLI command" +--- +## rad workspace create + +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. + +You can easily define and switch between workspaces to deploy and manage applications across local, test, and production environments. + +``` +rad workspace create [workspaceType] [workspaceName] [flags] +``` + +### Examples + +``` + +# Create a workspace with name 'myworkspace' and kubernetes context 'aks' +rad workspace create kubernetes myworkspace --context aks +# Create a workspace with name of current kubernetes context in current kubernetes context +rad workspace create kubernetes +``` + +### Options + +``` + -c, --context string the Kubernetes context to use, will use the default if unset + -e, --environment string The environment name + -f, --force Overwrite existing workspace if present + -g, --group string The resource group name + -h, --help help for create + -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 workspace]({{< ref rad_workspace.md >}}) - Manage workspaces + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_workspace_delete.md b/docs/content/reference/cli/rad_workspace_delete.md new file mode 100644 index 000000000..100ba16fc --- /dev/null +++ b/docs/content/reference/cli/rad_workspace_delete.md @@ -0,0 +1,51 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad workspace delete CLI reference" +linkTitle: "rad workspace delete" +slug: rad_workspace_delete +url: /reference/cli/rad_workspace_delete/ +description: "Details on the rad workspace delete Radius CLI command" +--- +## rad workspace delete + +Delete local workspace + +### Synopsis + +Delete local workspace + +``` +rad workspace delete [flags] +``` + +### Examples + +``` +# Delete current workspace +rad workspace delete + +# Delete named workspace +rad workspace delete my-workspace +``` + +### Options + +``` + -h, --help help for delete + -w, --workspace string The workspace name + -y, --yes The confirmation flag +``` + +### 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 workspace]({{< ref rad_workspace.md >}}) - Manage workspaces + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_workspace_list.md b/docs/content/reference/cli/rad_workspace_list.md new file mode 100644 index 000000000..5fd7174c1 --- /dev/null +++ b/docs/content/reference/cli/rad_workspace_list.md @@ -0,0 +1,47 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad workspace list CLI reference" +linkTitle: "rad workspace list" +slug: rad_workspace_list +url: /reference/cli/rad_workspace_list/ +description: "Details on the rad workspace list Radius CLI command" +--- +## rad workspace list + +List local workspaces + +### Synopsis + +List local workspaces + +``` +rad workspace list [flags] +``` + +### Examples + +``` +# List workspaces +rad workspace list +``` + +### Options + +``` + -h, --help help for list + -o, --output string output format (supported formats are json, table) (default "table") +``` + +### Options inherited from parent commands + +``` + --config string config file (default "$HOME/.rad/config.yaml") + -w, --workspace string The workspace name +``` + +### SEE ALSO + +* [rad workspace]({{< ref rad_workspace.md >}}) - Manage workspaces + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_workspace_show.md b/docs/content/reference/cli/rad_workspace_show.md new file mode 100644 index 000000000..9ba404038 --- /dev/null +++ b/docs/content/reference/cli/rad_workspace_show.md @@ -0,0 +1,50 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad workspace show CLI reference" +linkTitle: "rad workspace show" +slug: rad_workspace_show +url: /reference/cli/rad_workspace_show/ +description: "Details on the rad workspace show Radius CLI command" +--- +## rad workspace show + +Show local workspace + +### Synopsis + +Show local workspace + +``` +rad workspace show [flags] +``` + +### Examples + +``` +# Show current workspace +rad workspace show + +# Show named workspace +rad workspace show my-workspace +``` + +### Options + +``` + -h, --help help for show + -o, --output string output format (supported formats are json, table) (default "table") + -w, --workspace string The workspace name +``` + +### Options inherited from parent commands + +``` + --config string config file (default "$HOME/.rad/config.yaml") +``` + +### SEE ALSO + +* [rad workspace]({{< ref rad_workspace.md >}}) - Manage workspaces + +###### Auto generated by spf13/cobra on 15-Aug-2023 diff --git a/docs/content/reference/cli/rad_workspace_switch.md b/docs/content/reference/cli/rad_workspace_switch.md new file mode 100644 index 000000000..911e4a85b --- /dev/null +++ b/docs/content/reference/cli/rad_workspace_switch.md @@ -0,0 +1,47 @@ +--- +type: docs +date: 2023-08-15T23:32:25Z +title: "rad workspace switch CLI reference" +linkTitle: "rad workspace switch" +slug: rad_workspace_switch +url: /reference/cli/rad_workspace_switch/ +description: "Details on the rad workspace switch Radius CLI command" +--- +## rad workspace switch + +Switch current workspace + +### Synopsis + +Switch current workspace + +``` +rad workspace switch [flags] +``` + +### Examples + +``` +# Switch current workspace +rad workspace switch my-workspace +``` + +### Options + +``` + -h, --help help for switch + -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 workspace]({{< ref rad_workspace.md >}}) - Manage workspaces + +###### Auto generated by spf13/cobra on 15-Aug-2023