diff --git a/docs/content/reference/cli/rad.md b/docs/content/reference/cli/rad.md index 3d109460d..b46b19a90 100644 --- a/docs/content/reference/cli/rad.md +++ b/docs/content/reference/cli/rad.md @@ -36,6 +36,8 @@ Radius CLI * [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 resource-provider]({{< ref rad_resource-provider.md >}}) - Manage resource providers +* [rad resource-type]({{< ref rad_resource-type.md >}}) - Manage resource types * [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 diff --git a/docs/content/reference/cli/rad_deploy.md b/docs/content/reference/cli/rad_deploy.md index ae77d6a2f..b8c5dba5a 100644 --- a/docs/content/reference/cli/rad_deploy.md +++ b/docs/content/reference/cli/rad_deploy.md @@ -14,24 +14,24 @@ Deploy a template 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. +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] diff --git a/docs/content/reference/cli/rad_group_delete.md b/docs/content/reference/cli/rad_group_delete.md index 7730788c5..b8c5afd67 100644 --- a/docs/content/reference/cli/rad_group_delete.md +++ b/docs/content/reference/cli/rad_group_delete.md @@ -14,7 +14,7 @@ Delete a resource group Delete a resource group. - Delete a resource group if it is empty. If not empty, delete the contents and try again +Delete a resource group if it is empty. If not empty, delete the contents and try again ``` rad group delete resourcegroupname [flags] diff --git a/docs/content/reference/cli/rad_group_list.md b/docs/content/reference/cli/rad_group_list.md index 534d9d3ed..e99ae9b64 100644 --- a/docs/content/reference/cli/rad_group_list.md +++ b/docs/content/reference/cli/rad_group_list.md @@ -14,11 +14,11 @@ List resource groups within current/specified workspace 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. +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] diff --git a/docs/content/reference/cli/rad_group_switch.md b/docs/content/reference/cli/rad_group_switch.md index 94d8fb7f7..b8950ada1 100644 --- a/docs/content/reference/cli/rad_group_switch.md +++ b/docs/content/reference/cli/rad_group_switch.md @@ -14,11 +14,11 @@ Switch default resource group scope 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. +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] diff --git a/docs/content/reference/cli/rad_resource-provider.md b/docs/content/reference/cli/rad_resource-provider.md new file mode 100644 index 000000000..8ba5ab864 --- /dev/null +++ b/docs/content/reference/cli/rad_resource-provider.md @@ -0,0 +1,38 @@ +--- +type: docs +title: "rad resource-provider CLI reference" +linkTitle: "rad resource-provider" +slug: rad_resource-provider +url: /reference/cli/rad_resource-provider/ +description: "Details on the rad resource-provider Radius CLI command" +--- +## rad resource-provider + +Manage resource providers + +### Synopsis + +Manage resource providers + +### Options + +``` + -h, --help help for resource-provider + -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-provider create]({{< ref rad_resource-provider_create.md >}}) - Create or update a resource provider +* [rad resource-provider delete]({{< ref rad_resource-provider_delete.md >}}) - Delete resource provider +* [rad resource-provider list]({{< ref rad_resource-provider_list.md >}}) - List resource providers +* [rad resource-provider show]({{< ref rad_resource-provider_show.md >}}) - Show resource provider + diff --git a/docs/content/reference/cli/rad_resource-provider_create.md b/docs/content/reference/cli/rad_resource-provider_create.md new file mode 100644 index 000000000..47ddd323e --- /dev/null +++ b/docs/content/reference/cli/rad_resource-provider_create.md @@ -0,0 +1,55 @@ +--- +type: docs +title: "rad resource-provider create CLI reference" +linkTitle: "rad resource-provider create" +slug: rad_resource-provider_create +url: /reference/cli/rad_resource-provider_create/ +description: "Details on the rad resource-provider create Radius CLI command" +--- +## rad resource-provider create + +Create or update a resource provider + +### Synopsis + +Create or update a resource provider + +Resource providers are the entities that implement resource types such as 'Applications.Core/containers'. Resource providers can be defined, registered, and unregistered by users. + +Creating a resource provider defines new resource types that can be used in applications. + +Input can be passed in using a file or inline JSON as the second argument. Prefix the input with '@' to indicate a file path. + + +``` +rad resource-provider create [input] [flags] +``` + +### Examples + +``` + +# Create a resource provider +rad resource-provider create --from-file /path/to/input.yaml + +``` + +### Options + +``` + -f, --from-file string The input file. May be an absolute path or a path relative to the current working directory + -h, --help help for create + -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-provider]({{< ref rad_resource-provider.md >}}) - Manage resource providers + diff --git a/docs/content/reference/cli/rad_resource-provider_delete.md b/docs/content/reference/cli/rad_resource-provider_delete.md new file mode 100644 index 000000000..f541a5e6f --- /dev/null +++ b/docs/content/reference/cli/rad_resource-provider_delete.md @@ -0,0 +1,56 @@ +--- +type: docs +title: "rad resource-provider delete CLI reference" +linkTitle: "rad resource-provider delete" +slug: rad_resource-provider_delete +url: /reference/cli/rad_resource-provider_delete/ +description: "Details on the rad resource-provider delete Radius CLI command" +--- +## rad resource-provider delete + +Delete resource provider + +### Synopsis + +Delete resource provider + +Resource providers are the entities that implement resource types such as 'Applications.Core/containers'. Resource providers can be created and deleted by users. + +Deleting a resource provider will delete all resource types that it defines. For example, deleting 'Applications.Core' will delete 'Applications.Core/containers' and all other resource types defined by 'Applications.Core'. + +Deleting a resource type will delete all resources of the types. For example, deleting 'Applications.Core/containers' will delete all containers. + +``` +rad resource-provider delete [resource provider namespace] [flags] +``` + +### Examples + +``` + +# Delete a resource provider +rad resource-provider delete Applications.Core + +# Delete a resource provider (bypass confirmation) +rad resource-provider delete Applications.Core --yes +``` + +### Options + +``` + -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 resource-provider]({{< ref rad_resource-provider.md >}}) - Manage resource providers + diff --git a/docs/content/reference/cli/rad_resource-provider_list.md b/docs/content/reference/cli/rad_resource-provider_list.md new file mode 100644 index 000000000..6bdac4572 --- /dev/null +++ b/docs/content/reference/cli/rad_resource-provider_list.md @@ -0,0 +1,48 @@ +--- +type: docs +title: "rad resource-provider list CLI reference" +linkTitle: "rad resource-provider list" +slug: rad_resource-provider_list +url: /reference/cli/rad_resource-provider_list/ +description: "Details on the rad resource-provider list Radius CLI command" +--- +## rad resource-provider list + +List resource providers + +### Synopsis + +List resource providers + +Resource providers are the entities that implement resource types such as 'Applications.Core/containers'. Resource providers can be created and deleted by users. + +``` +rad resource-provider list [flags] +``` + +### Examples + +``` + +# List all resource providers +rad resource-provider 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 resource-provider]({{< ref rad_resource-provider.md >}}) - Manage resource providers + diff --git a/docs/content/reference/cli/rad_resource-provider_show.md b/docs/content/reference/cli/rad_resource-provider_show.md new file mode 100644 index 000000000..edc0076a2 --- /dev/null +++ b/docs/content/reference/cli/rad_resource-provider_show.md @@ -0,0 +1,48 @@ +--- +type: docs +title: "rad resource-provider show CLI reference" +linkTitle: "rad resource-provider show" +slug: rad_resource-provider_show +url: /reference/cli/rad_resource-provider_show/ +description: "Details on the rad resource-provider show Radius CLI command" +--- +## rad resource-provider show + +Show resource provider + +### Synopsis + +Show resource provider + +Resource providers are the entities that implement resource types such as 'Applications.Core/containers'. Resource providers can be created and deleted by users. + +``` +rad resource-provider show [resource provider namespace] [flags] +``` + +### Examples + +``` + +# Show a resource provider +rad resource-provider show Applications.Core +``` + +### 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 resource-provider]({{< ref rad_resource-provider.md >}}) - Manage resource providers + diff --git a/docs/content/reference/cli/rad_resource-type.md b/docs/content/reference/cli/rad_resource-type.md new file mode 100644 index 000000000..4a832051b --- /dev/null +++ b/docs/content/reference/cli/rad_resource-type.md @@ -0,0 +1,37 @@ +--- +type: docs +title: "rad resource-type CLI reference" +linkTitle: "rad resource-type" +slug: rad_resource-type +url: /reference/cli/rad_resource-type/ +description: "Details on the rad resource-type Radius CLI command" +--- +## rad resource-type + +Manage resource types + +### Synopsis + +Manage resource types + +### Options + +``` + -h, --help help for resource-type + -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-type delete]({{< ref rad_resource-type_delete.md >}}) - Delete resource provider +* [rad resource-type list]({{< ref rad_resource-type_list.md >}}) - List resource resource types +* [rad resource-type show]({{< ref rad_resource-type_show.md >}}) - Show resource resource type + diff --git a/docs/content/reference/cli/rad_resource-type_delete.md b/docs/content/reference/cli/rad_resource-type_delete.md new file mode 100644 index 000000000..6b0c652be --- /dev/null +++ b/docs/content/reference/cli/rad_resource-type_delete.md @@ -0,0 +1,54 @@ +--- +type: docs +title: "rad resource-type delete CLI reference" +linkTitle: "rad resource-type delete" +slug: rad_resource-type_delete +url: /reference/cli/rad_resource-type_delete/ +description: "Details on the rad resource-type delete Radius CLI command" +--- +## rad resource-type delete + +Delete resource provider + +### Synopsis + +Delete resource provider + +Resource types are the entities that implement resource types such as 'Applications.Core/containers'. Each resource type can define multiple API versions, and each API version defines a schema that resource instances conform to. Resource providers can be created and deleted by users. + +Deleting a resource type will delete all resources of the specifed resource type. For example, deleting 'Applications.Core/containers' will delete all containers. + +``` +rad resource-type delete [resource type] [flags] +``` + +### Examples + +``` + +# Delete a resource type +rad resource-type delete Applications.Core/containers + +# Delete a resource type (bypass confirmation) +rad resource-type delete Applications.Core/containers --yes +``` + +### Options + +``` + -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 resource-type]({{< ref rad_resource-type.md >}}) - Manage resource types + diff --git a/docs/content/reference/cli/rad_resource-type_list.md b/docs/content/reference/cli/rad_resource-type_list.md new file mode 100644 index 000000000..c264d782e --- /dev/null +++ b/docs/content/reference/cli/rad_resource-type_list.md @@ -0,0 +1,48 @@ +--- +type: docs +title: "rad resource-type list CLI reference" +linkTitle: "rad resource-type list" +slug: rad_resource-type_list +url: /reference/cli/rad_resource-type_list/ +description: "Details on the rad resource-type list Radius CLI command" +--- +## rad resource-type list + +List resource resource types + +### Synopsis + +List resource resource types + +Resource types are the entities that can be created and managed by Radius such as 'Applications.Core/containers'. Each resource type can define multiple API versions, and each API version defines a schema that resource instances conform to. Resource types can be configured using resource providers. + +``` +rad resource-type list [flags] +``` + +### Examples + +``` + +# List all resource types +rad resource-type 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 resource-type]({{< ref rad_resource-type.md >}}) - Manage resource types + diff --git a/docs/content/reference/cli/rad_resource-type_show.md b/docs/content/reference/cli/rad_resource-type_show.md new file mode 100644 index 000000000..c1fff993e --- /dev/null +++ b/docs/content/reference/cli/rad_resource-type_show.md @@ -0,0 +1,48 @@ +--- +type: docs +title: "rad resource-type show CLI reference" +linkTitle: "rad resource-type show" +slug: rad_resource-type_show +url: /reference/cli/rad_resource-type_show/ +description: "Details on the rad resource-type show Radius CLI command" +--- +## rad resource-type show + +Show resource resource type + +### Synopsis + +Show resource resource type + +Resource types are the entities that can be created and managed by Radius such as 'Applications.Core/containers'. Each resource type can define multiple API versions, and each API version defines a schema that resource instances conform to. Resource types can be configured using resource providers. + +``` +rad resource-type show [resource type] [flags] +``` + +### Examples + +``` + +# Show a resource type +rad resource-type show 'Applications.Core/containers' +``` + +### 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 resource-type]({{< ref rad_resource-type.md >}}) - Manage resource types + diff --git a/docs/content/reference/cli/rad_resource.md b/docs/content/reference/cli/rad_resource.md index 4c8bfd0c1..e31c52195 100644 --- a/docs/content/reference/cli/rad_resource.md +++ b/docs/content/reference/cli/rad_resource.md @@ -32,6 +32,7 @@ Manage resources ### SEE ALSO * [rad]({{< ref rad.md >}}) - Radius CLI +* [rad resource create]({{< ref rad_resource_create.md >}}) - Create or update a resource * [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 diff --git a/docs/content/reference/cli/rad_resource_create.md b/docs/content/reference/cli/rad_resource_create.md new file mode 100644 index 000000000..2bef961fe --- /dev/null +++ b/docs/content/reference/cli/rad_resource_create.md @@ -0,0 +1,52 @@ +--- +type: docs +title: "rad resource create CLI reference" +linkTitle: "rad resource create" +slug: rad_resource_create +url: /reference/cli/rad_resource_create/ +description: "Details on the rad resource create Radius CLI command" +--- +## rad resource create + +Create or update a resource + +### Synopsis + +Create or update a resource + +Resources are the primary entities that make up applications. + +Input can be passed via the -f flag to specify a file name. + +``` +rad resource create [resource type] [name] -f [inputfilepath] [flags] +``` + +### Examples + +``` + +# Create a resource (from file) +rad resource create 'Applications.Core/containers' mycontainer -f /path/to/input.json +``` + +### Options + +``` + -f, --from-file string The input file. May be an absolute path or a path relative to the current working directory + -h, --help help for create + -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 + diff --git a/docs/content/reference/cli/rad_resource_delete.md b/docs/content/reference/cli/rad_resource_delete.md index 61a7076b4..fda98285f 100644 --- a/docs/content/reference/cli/rad_resource_delete.md +++ b/docs/content/reference/cli/rad_resource_delete.md @@ -22,10 +22,10 @@ rad resource delete [resourceType] [resourceName] [flags] ``` - sample list of resourceType: containers, gateways, daprPubSubBrokers, extenders, mongoDatabases, rabbitMQMessageQueues, redisCaches, sqlDatabases, daprStateStores, daprSecretStores - - # Delete a container named orders - rad resource delete containers orders +sample list of resourceType: containers, gateways, daprPubSubBrokers, extenders, mongoDatabases, rabbitMQMessageQueues, redisCaches, sqlDatabases, daprStateStores, daprSecretStores + +# Delete a container named orders +rad resource delete containers orders ``` ### Options diff --git a/docs/content/reference/cli/rad_resource_list.md b/docs/content/reference/cli/rad_resource_list.md index fa502acdd..01c8167de 100644 --- a/docs/content/reference/cli/rad_resource_list.md +++ b/docs/content/reference/cli/rad_resource_list.md @@ -22,19 +22,19 @@ rad resource list [resourceType] [flags] ``` - sample list of resourceType: containers, gateways, pubSubBrokers, extenders, mongoDatabases, rabbitMQMessageQueues, redisCaches, sqlDatabases, stateStores, secretStores +sample list of resourceType: containers, gateways, pubSubBrokers, extenders, mongoDatabases, rabbitMQMessageQueues, redisCaches, sqlDatabases, stateStores, secretStores - # list all resources of a specified type in the default environment +# list all resources of a specified type in the default environment - rad resource list containers - rad resource list gateways +rad resource list containers +rad resource list gateways + +# list all resources of a specified type in an application +rad resource list containers --application icecream-store + +# list all resources of a specified type in an application (shorthand flag) +rad resource list containers -a icecream-store - # list all resources of a specified type in an application - 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 diff --git a/docs/content/reference/cli/rad_resource_show.md b/docs/content/reference/cli/rad_resource_show.md index acd1e6a14..b002cb5fe 100644 --- a/docs/content/reference/cli/rad_resource_show.md +++ b/docs/content/reference/cli/rad_resource_show.md @@ -22,19 +22,19 @@ rad resource show [resourceType] [resourceName] [flags] ``` - sample list of resourceType: containers, gateways, daprPubSubBrokers, extenders, mongoDatabases, rabbitMQMessageQueues, redisCaches, sqlDatabases, daprStateStores, daprSecretStores +sample list of resourceType: containers, gateways, daprPubSubBrokers, extenders, mongoDatabases, rabbitMQMessageQueues, redisCaches, sqlDatabases, daprStateStores, daprSecretStores - # show details of a specified resource in the default environment +# show details of a specified resource in the default environment - rad resource show containers orders - rad resource show gateways orders_gateways +rad resource show containers orders +rad resource show gateways orders_gateways + +# show details of a specified resource in an application +rad resource show containers orders --application icecream-store + +# show details of a specified resource in an application (shorthand flag) +rad resource show containers orders -a icecream-store - # show details of a specified resource in an application - 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