Skip to content

Commit

Permalink
restore CLI docs
Browse files Browse the repository at this point in the history
  • Loading branch information
PalmEmanuel committed Nov 27, 2023
1 parent 25f30ca commit 9dc1ad3
Show file tree
Hide file tree
Showing 62 changed files with 316 additions and 224 deletions.
33 changes: 17 additions & 16 deletions docs/content/reference/cli/rad.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,20 @@ Radius CLI

### SEE ALSO

* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications
* [rad bicep]({{< ref rad_bicep.md >}}) - Manage bicep compiler
* [rad completion]({{< ref rad_completion.md >}}) - Generates shell completion scripts
* [rad credential]({{< ref rad_credential.md >}}) - Manage cloud provider credential for a Radius installation.
* [rad debug-logs]({{< ref rad_debug-logs.md >}}) - Capture logs from Radius control plane for debugging and diagnostics.
* [rad deploy]({{< ref rad_deploy.md >}}) - Deploy a template
* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments
* [rad group]({{< ref rad_group.md >}}) - Manage resource groups
* [rad init]({{< ref rad_init.md >}}) - Initialize Radius
* [rad install]({{< ref rad_install.md >}}) - Installs Radius for a given platform
* [rad recipe]({{< ref rad_recipe.md >}}) - Manage recipes
* [rad resource]({{< ref rad_resource.md >}}) - Manage resources
* [rad run]({{< ref rad_run.md >}}) - Run an application
* [rad uninstall]({{< ref rad_uninstall.md >}}) - Uninstall Radius for a specific platform
* [rad version]({{< ref rad_version.md >}}) - Prints the versions of the rad cli
* [rad workspace]({{< ref rad_workspace.md >}}) - Manage workspaces
* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications
* [rad bicep]({{< ref rad_bicep.md >}}) - Manage bicep compiler
* [rad completion]({{< ref rad_completion.md >}}) - Generates shell completion scripts
* [rad credential]({{< ref rad_credential.md >}}) - Manage cloud provider credential for a Radius installation.
* [rad debug-logs]({{< ref rad_debug-logs.md >}}) - Capture logs from Radius control plane for debugging and diagnostics.
* [rad deploy]({{< ref rad_deploy.md >}}) - Deploy a template
* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments
* [rad group]({{< ref rad_group.md >}}) - Manage resource groups
* [rad init]({{< ref rad_init.md >}}) - Initialize Radius
* [rad install]({{< ref rad_install.md >}}) - Installs Radius for a given platform
* [rad recipe]({{< ref rad_recipe.md >}}) - Manage recipes
* [rad resource]({{< ref rad_resource.md >}}) - Manage resources
* [rad run]({{< ref rad_run.md >}}) - Run an application
* [rad uninstall]({{< ref rad_uninstall.md >}}) - Uninstall Radius for a specific platform
* [rad version]({{< ref rad_version.md >}}) - Prints the versions of the rad cli
* [rad workspace]({{< ref rad_workspace.md >}}) - Manage workspaces

15 changes: 8 additions & 7 deletions docs/content/reference/cli/rad_application.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,11 @@ Manage Radius Applications

### SEE ALSO

* [rad]({{< ref rad.md >}}) - Radius CLI
* [rad application connections]({{< ref rad_application_connections.md >}}) - Shows the connections for an application.
* [rad application delete]({{< ref rad_application_delete.md >}}) - Delete Radius Application
* [rad application list]({{< ref rad_application_list.md >}}) - List Radius Applications
* [rad application show]({{< ref rad_application_show.md >}}) - Show Radius Application details
* [rad application status]({{< ref rad_application_status.md >}}) - Show Radius Application status
* [rad application switch]({{< ref rad_application_switch.md >}}) - Switch the default Radius Application
* [rad]({{< ref rad.md >}}) - Radius CLI
* [rad application connections]({{< ref rad_application_connections.md >}}) - Shows the connections for an application.
* [rad application delete]({{< ref rad_application_delete.md >}}) - Delete Radius Application
* [rad application list]({{< ref rad_application_list.md >}}) - List Radius Applications
* [rad application show]({{< ref rad_application_show.md >}}) - Show Radius Application details
* [rad application status]({{< ref rad_application_status.md >}}) - Show Radius Application status
* [rad application switch]({{< ref rad_application_switch.md >}}) - Switch the default Radius Application

3 changes: 2 additions & 1 deletion docs/content/reference/cli/rad_application_connections.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,5 @@ rad app connections my-application

### SEE ALSO

* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications
* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications

3 changes: 2 additions & 1 deletion docs/content/reference/cli/rad_application_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,5 @@ rad app delete my-app --group my-group

### SEE ALSO

* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications
* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications

3 changes: 2 additions & 1 deletion docs/content/reference/cli/rad_application_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,5 @@ rad app list --group my-group

### SEE ALSO

* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications
* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications

3 changes: 2 additions & 1 deletion docs/content/reference/cli/rad_application_show.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,5 @@ rad app show my-app --group my-group

### SEE ALSO

* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications
* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications

3 changes: 2 additions & 1 deletion docs/content/reference/cli/rad_application_status.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,5 @@ rad app status my-app --group my-group

### SEE ALSO

* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications
* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications

3 changes: 2 additions & 1 deletion docs/content/reference/cli/rad_application_switch.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,5 @@ rad app switch newApplication

### SEE ALSO

* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications
* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications

9 changes: 5 additions & 4 deletions docs/content/reference/cli/rad_bicep.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ Manage bicep compiler used by Radius

### SEE ALSO

* [rad]({{< ref rad.md >}}) - Radius CLI
* [rad bicep delete]({{< ref rad_bicep_delete.md >}}) - Delete installed bicep compiler
* [rad bicep download]({{< ref rad_bicep_download.md >}}) - Download the bicep compiler
* [rad bicep publish]({{< ref rad_bicep_publish.md >}}) - Publish a Bicep file to an OCI registry.
* [rad]({{< ref rad.md >}}) - Radius CLI
* [rad bicep delete]({{< ref rad_bicep_delete.md >}}) - Delete installed bicep compiler
* [rad bicep download]({{< ref rad_bicep_download.md >}}) - Download the bicep compiler
* [rad bicep publish]({{< ref rad_bicep_publish.md >}}) - Publish a Bicep file to an OCI registry.

3 changes: 2 additions & 1 deletion docs/content/reference/cli/rad_bicep_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,5 @@ rad bicep delete [flags]

### SEE ALSO

* [rad bicep]({{< ref rad_bicep.md >}}) - Manage bicep compiler
* [rad bicep]({{< ref rad_bicep.md >}}) - Manage bicep compiler

3 changes: 2 additions & 1 deletion docs/content/reference/cli/rad_bicep_download.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,5 @@ rad bicep download [flags]

### SEE ALSO

* [rad bicep]({{< ref rad_bicep.md >}}) - Manage bicep compiler
* [rad bicep]({{< ref rad_bicep.md >}}) - Manage bicep compiler

11 changes: 6 additions & 5 deletions docs/content/reference/cli/rad_bicep_publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,22 @@ Publish a Bicep file to an OCI registry.
### Synopsis

Publish a Bicep file to an OCI registry.

This command compiles and publishes a local Bicep file to a remote Open Container Initiative (OCI) registry, such as Azure Container Registry, Docker Hub, or GitHub Container Registry, to later be used as a Bicep registry or for Radius Recipes.

Before publishing, it is expected the user runs docker login (or similar command) and has the proper permission to push to the target OCI registry.
For more information on Bicep modules visit https://learn.microsoft.com/azure/azure-resource-manager/bicep/modules


For more information on Bicep modules visit <https://learn.microsoft.com/azure/azure-resource-manager/bicep/modules>.

```
rad bicep publish [flags]
```

### Examples

```
# Publish a Bicep file to a container registry
rad bicep publish --file ./redis-test.bicep --target br:ghcr.io/myregistry/redis-test:v1
```

### Options
Expand All @@ -48,4 +48,5 @@ rad bicep publish --file ./redis-test.bicep --target br:ghcr.io/myregistry/redis

### SEE ALSO

* [rad bicep]({{< ref rad_bicep.md >}}) - Manage bicep compiler
* [rad bicep]({{< ref rad_bicep.md >}}) - Manage bicep compiler

87 changes: 45 additions & 42 deletions docs/content/reference/cli/rad_completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,44 +17,46 @@ rad completion [flags]
### Examples

```
# Installing bash completion on macOS using homebrew
## If running Bash 3.2 included with macOS
brew install bash-completion
## or, if running Bash 4.1+
brew install bash-completion@2
## Add the completion to your completion directory
rad completion bash > $(brew --prefix)/etc/bash_completion.d/rad
source ~/.bash_profile
# Installing bash completion on Linux
## If bash-completion is not installed on Linux, please install the 'bash-completion' package
## via your distribution's package manager.
## Load the rad completion code for bash into the current shell
source <(rad completion bash)
## Write bash completion code to a file and source if from .bash_profile
rad completion bash > ~/.rad/completion.bash.inc
printf "
## rad shell completion
source '$HOME/.rad/completion.bash.inc'
" >> $HOME/.bash_profile
source $HOME/.bash_profile
# Installing zsh completion on macOS using homebrew
## If zsh-completion is not installed on macOS, please install the 'zsh-completion' package
brew install zsh-completions
## Set the rad completion code for zsh[1] to autoload on startup
rad completion zsh > "${fpath[1]}/_rad"
source ~/.zshrc
# Installing zsh completion on Linux
## If zsh-completion is not installed on Linux, please install the 'zsh-completion' package
## via your distribution's package manager.
## Load the rad completion code for zsh into the current shell
source <(rad completion zsh)
# Set the rad completion code for zsh[1] to autoload on startup
rad completion zsh > "${fpath[1]}/_rad"
# Installing powershell completion on Windows
## Create $PROFILE if it not exists
if (!(Test-Path -Path $PROFILE )){ New-Item -Type File -Path $PROFILE -Force }
## Add the completion to your profile
rad completion powershell >> $PROFILE
# Installing bash completion on macOS using homebrew
## If running Bash 3.2 included with macOS
brew install bash-completion
## or, if running Bash 4.1+
brew install bash-completion@2
## Add the completion to your completion directory
rad completion bash > $(brew --prefix)/etc/bash_completion.d/rad
source ~/.bash_profile
# Installing bash completion on Linux
## If bash-completion is not installed on Linux, please install the 'bash-completion' package
## via your distribution's package manager.
## Load the rad completion code for bash into the current shell
source <(rad completion bash)
## Write bash completion code to a file and source if from .bash_profile
rad completion bash > ~/.rad/completion.bash.inc
printf "
## rad shell completion
source '$HOME/.rad/completion.bash.inc'
" >> $HOME/.bash_profile
source $HOME/.bash_profile
# Installing zsh completion on macOS using homebrew
## If zsh-completion is not installed on macOS, please install the 'zsh-completion' package
brew install zsh-completions
## Set the rad completion code for zsh[1] to autoload on startup
rad completion zsh > "${fpath[1]}/_rad"
source ~/.zshrc
# Installing zsh completion on Linux
## If zsh-completion is not installed on Linux, please install the 'zsh-completion' package
## via your distribution's package manager.
## Load the rad completion code for zsh into the current shell
source <(rad completion zsh)
# Set the rad completion code for zsh[1] to autoload on startup
rad completion zsh > "${fpath[1]}/_rad"
# Installing powershell completion on Windows
## Create $PROFILE if it not exists
if (!(Test-Path -Path $PROFILE )){ New-Item -Type File -Path $PROFILE -Force }
## Add the completion to your profile
rad completion powershell >> $PROFILE
```

### Options
Expand All @@ -72,7 +74,8 @@ rad completion [flags]

### SEE ALSO

* [rad]({{< ref rad.md >}}) - Radius CLI
* [rad completion bash]({{< ref rad_completion_bash.md >}}) - Generates bash completion scripts
* [rad completion powershell]({{< ref rad_completion_powershell.md >}}) - Generates PowerShell completion scripts
* [rad completion zsh]({{< ref rad_completion_zsh.md >}}) - Generates zsh completion scripts
* [rad]({{< ref rad.md >}}) - Radius CLI
* [rad completion bash]({{< ref rad_completion_bash.md >}}) - Generates bash completion scripts
* [rad completion powershell]({{< ref rad_completion_powershell.md >}}) - Generates powershell completion scripts
* [rad completion zsh]({{< ref rad_completion_zsh.md >}}) - Generates zsh completion scripts

3 changes: 2 additions & 1 deletion docs/content/reference/cli/rad_completion_bash.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,5 @@ rad completion bash [flags]

### SEE ALSO

* [rad completion]({{< ref rad_completion.md >}}) - Generates shell completion scripts
* [rad completion]({{< ref rad_completion.md >}}) - Generates shell completion scripts

5 changes: 3 additions & 2 deletions docs/content/reference/cli/rad_completion_powershell.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: "Details on the rad completion powershell Radius CLI command"
---
## rad completion powershell

Generates PowerShell completion scripts
Generates powershell completion scripts

```
rad completion powershell [flags]
Expand All @@ -29,4 +29,5 @@ rad completion powershell [flags]

### SEE ALSO

* [rad completion]({{< ref rad_completion.md >}}) - Generates shell completion scripts
* [rad completion]({{< ref rad_completion.md >}}) - Generates shell completion scripts

3 changes: 2 additions & 1 deletion docs/content/reference/cli/rad_completion_zsh.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,5 @@ rad completion zsh [flags]

### SEE ALSO

* [rad completion]({{< ref rad_completion.md >}}) - Generates shell completion scripts
* [rad completion]({{< ref rad_completion.md >}}) - Generates shell completion scripts

13 changes: 8 additions & 5 deletions docs/content/reference/cli/rad_credential.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ or credentials will affect all Radius Environments and applications of the affec
### Examples

```
# List configured cloud providers credential
rad credential list
Expand All @@ -41,6 +42,7 @@ rad credential show aws
rad credential unregister azure
# Delete AWS cloud provider configuration
rad credential unregister aws
```

### Options
Expand All @@ -58,8 +60,9 @@ rad credential unregister aws

### SEE ALSO

* [rad]({{< ref rad.md >}}) - Radius CLI
* [rad credential list]({{< ref rad_credential_list.md >}}) - List configured cloud provider credentials
* [rad credential register]({{< ref rad_credential_register.md >}}) - Register(Add or update) cloud provider credential for a Radius installation.
* [rad credential show]({{< ref rad_credential_show.md >}}) - Show details of a configured cloud provider credential
* [rad credential unregister]({{< ref rad_credential_unregister.md >}}) - Unregisters a configured cloud provider credential from the Radius installation
* [rad]({{< ref rad.md >}}) - Radius CLI
* [rad credential list]({{< ref rad_credential_list.md >}}) - List configured cloud provider credentials
* [rad credential register]({{< ref rad_credential_register.md >}}) - Register(Add or update) cloud provider credential for a Radius installation.
* [rad credential show]({{< ref rad_credential_show.md >}}) - Show details of a configured cloud provider credential
* [rad credential unregister]({{< ref rad_credential_unregister.md >}}) - Unregisters a configured cloud provider credential from the Radius installation

3 changes: 2 additions & 1 deletion docs/content/reference/cli/rad_credential_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,5 @@ rad credential list

### SEE ALSO

* [rad credential]({{< ref rad_credential.md >}}) - Manage cloud provider credential for a Radius installation.
* [rad credential]({{< ref rad_credential.md >}}) - Manage cloud provider credential for a Radius installation.

13 changes: 8 additions & 5 deletions docs/content/reference/cli/rad_credential_register.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,12 @@ or credentials will affect all Radius Environments and applications of the affec
### Examples

```
# Register (Add or update) cloud provider credential for Azure with service principal authentication
rad credential register azure --client-id <client id> --client-secret <client secret> --tenant-id <tenant id>
rad credential register azure --client-id <client id> --client-secret <client secret> --tenant-id <tenant id>
# Register (Add or Update) cloud provider credential for AWS with IAM authentication
rad credential register aws --access-key-id <access-key-id> --secret-access-key <secret-access-key>
rad credential register aws --access-key-id <access-key-id> --secret-access-key <secret-access-key>
```

### Options
Expand All @@ -45,6 +47,7 @@ rad credential register aws --access-key-id <access-key-id> --secret-access-key

### SEE ALSO

* [rad credential]({{< ref rad_credential.md >}}) - Manage cloud provider credential for a Radius installation.
* [rad credential register aws]({{< ref rad_credential_register_aws.md >}}) - Register (Add or update) AWS cloud provider credential for a Radius installation.
* [rad credential register azure]({{< ref rad_credential_register_azure.md >}}) - Register (Add or update) Azure cloud provider credential for a Radius installation.
* [rad credential]({{< ref rad_credential.md >}}) - Manage cloud provider credential for a Radius installation.
* [rad credential register aws]({{< ref rad_credential_register_aws.md >}}) - Register (Add or update) AWS cloud provider credential for a Radius installation.
* [rad credential register azure]({{< ref rad_credential_register_azure.md >}}) - Register (Add or update) Azure cloud provider credential for a Radius installation.

6 changes: 4 additions & 2 deletions docs/content/reference/cli/rad_credential_register_aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ Register (Add or update) AWS cloud provider credential for a Radius installation
This command is intended for scripting or advanced use-cases. See 'rad init' for a user-friendly way
to configure these settings.

Radius will use the provided IAM credential for all interactions with AWS.
Radius will use the provided IAM credential for all interactions with AWS.


Radius cloud providers enable Radius Environments to deploy and integrate with cloud resources (Azure, AWS).
The Radius control-plane stores credentials for use when accessing cloud resources.
Expand Down Expand Up @@ -57,4 +58,5 @@ rad credential register aws --access-key-id <access-key-id> --secret-access-key

### SEE ALSO

* [rad credential register]({{< ref rad_credential_register.md >}}) - Register(Add or update) cloud provider credential for a Radius installation.
* [rad credential register]({{< ref rad_credential_register.md >}}) - Register(Add or update) cloud provider credential for a Radius installation.

7 changes: 5 additions & 2 deletions docs/content/reference/cli/rad_credential_register_azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,15 @@ Register (Add or update) Azure cloud provider credential for a Radius installati
This command is intended for scripting or advanced use-cases. See 'rad init' for a user-friendly way
to configure these settings.

Radius will use the provided service principal for all interactions with Azure, including Bicep deployment, Radius Environments, and Radius portable resources.
Radius will use the provided service principal for all interactions with Azure, including Bicep deployment,
Radius Environments, and Radius portable resources.

Radius will use the provided subscription and resource group as the default target scope for Bicep deployment.
The provided service principal must have the Contributor or Owner role assigned for the provided resource group
in order to create or manage resources contained in the group. The resource group should be created before
calling 'rad credential register azure'.


Radius cloud providers enable Radius Environments to deploy and integrate with cloud resources (Azure, AWS).
The Radius control-plane stores credentials for use when accessing cloud resources.

Expand Down Expand Up @@ -63,4 +65,5 @@ rad credential register azure --client-id <client id/app id> --client-secret <cl

### SEE ALSO

* [rad credential register]({{< ref rad_credential_register.md >}}) - Register(Add or update) cloud provider credential for a Radius installation.
* [rad credential register]({{< ref rad_credential_register.md >}}) - Register(Add or update) cloud provider credential for a Radius installation.

3 changes: 2 additions & 1 deletion docs/content/reference/cli/rad_credential_show.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,5 @@ rad credential show aws

### SEE ALSO

* [rad credential]({{< ref rad_credential.md >}}) - Manage cloud provider credential for a Radius installation.
* [rad credential]({{< ref rad_credential.md >}}) - Manage cloud provider credential for a Radius installation.

Loading

0 comments on commit 9dc1ad3

Please sign in to comment.