Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update rad CLI documentation #728

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/content/reference/cli/rad.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Radius CLI
* [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 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This command is intended for scripting or advanced use-cases. See 'rad init' for
to configure these settings.

Radius will use the provided service principal for all interactions with Azure, including Bicep deployment,
Radius environments, and Radius links.
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
Expand Down
6 changes: 3 additions & 3 deletions docs/content/reference/cli/rad_recipe.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ description: "Details on the rad recipe Radius CLI command"
---
## rad recipe

Manage link recipes
Manage recipes

### Synopsis

Manage link recipes
Link recipes automate the deployment of infrastructure and configuration of links.
Manage recipes
Recipes automate the deployment of infrastructure and configuration of portable resources.

### Options

Expand Down
2 changes: 1 addition & 1 deletion docs/content/reference/cli/rad_recipe_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,5 +42,5 @@ rad recipe list

### SEE ALSO

* [rad recipe]({{< ref rad_recipe.md >}}) - Manage link recipes
* [rad recipe]({{< ref rad_recipe.md >}}) - Manage recipes

10 changes: 5 additions & 5 deletions docs/content/reference/cli/rad_recipe_register.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ rad recipe register [recipe-name] [flags]
```

# Add a recipe to an environment
rad recipe register cosmosdb -e env_name -w workspace --template-kind bicep --template-path template_path --link-type Applications.Link/mongoDatabases
rad recipe register cosmosdb -e env_name -w workspace --template-kind bicep --template-path template_path --link-type Applications.Datastores/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
rad recipe register cosmosdb -e env_name -w workspace --template-kind bicep --template-path template_path --link-type Applications.Datastores/mongoDatabases --parameters throughput=400

# specify multiple parameters using a JSON parameter file
rad recipe register cosmosdb -e env_name -w workspace --template-kind bicep --template-path template_path --link-type Applications.Link/mongoDatabases --parameters @myfile.json
rad recipe register cosmosdb -e env_name -w workspace --template-kind bicep --template-path template_path --link-type Applications.Datastores/mongoDatabases --parameters @myfile.json

```

Expand All @@ -44,7 +44,7 @@ rad recipe register cosmosdb -e env_name -w workspace --template-kind bicep --te
-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
--link-type string specify the type of the portable resource 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.
Expand All @@ -61,5 +61,5 @@ rad recipe register cosmosdb -e env_name -w workspace --template-kind bicep --te

### SEE ALSO

* [rad recipe]({{< ref rad_recipe.md >}}) - Manage link recipes
* [rad recipe]({{< ref rad_recipe.md >}}) - Manage recipes

2 changes: 1 addition & 1 deletion docs/content/reference/cli/rad_recipe_show.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,5 +57,5 @@ rad recipe show redis-dev --group dev --environment dev

### SEE ALSO

* [rad recipe]({{< ref rad_recipe.md >}}) - Manage link recipes
* [rad recipe]({{< ref rad_recipe.md >}}) - Manage recipes

2 changes: 1 addition & 1 deletion docs/content/reference/cli/rad_recipe_unregister.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,5 +43,5 @@ rad recipe unregister cosmosdb

### SEE ALSO

* [rad recipe]({{< ref rad_recipe.md >}}) - Manage link recipes
* [rad recipe]({{< ref rad_recipe.md >}}) - Manage recipes

Loading