Skip to content

Commit

Permalink
Autogenerate reference docs
Browse files Browse the repository at this point in the history
Signed-off-by: rad-ci-bot <[email protected]>
  • Loading branch information
rad-ci-bot committed Nov 14, 2024
1 parent 3b6c23f commit 335fbb3
Show file tree
Hide file tree
Showing 19 changed files with 539 additions and 52 deletions.
2 changes: 2 additions & 0 deletions docs/content/reference/cli/rad.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
34 changes: 17 additions & 17 deletions docs/content/reference/cli/rad_deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion docs/content/reference/cli/rad_group_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
10 changes: 5 additions & 5 deletions docs/content/reference/cli/rad_group_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
10 changes: 5 additions & 5 deletions docs/content/reference/cli/rad_group_switch.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
38 changes: 38 additions & 0 deletions docs/content/reference/cli/rad_resource-provider.md
Original file line number Diff line number Diff line change
@@ -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

55 changes: 55 additions & 0 deletions docs/content/reference/cli/rad_resource-provider_create.md
Original file line number Diff line number Diff line change
@@ -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

56 changes: 56 additions & 0 deletions docs/content/reference/cli/rad_resource-provider_delete.md
Original file line number Diff line number Diff line change
@@ -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

48 changes: 48 additions & 0 deletions docs/content/reference/cli/rad_resource-provider_list.md
Original file line number Diff line number Diff line change
@@ -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

48 changes: 48 additions & 0 deletions docs/content/reference/cli/rad_resource-provider_show.md
Original file line number Diff line number Diff line change
@@ -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

37 changes: 37 additions & 0 deletions docs/content/reference/cli/rad_resource-type.md
Original file line number Diff line number Diff line change
@@ -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

Loading

0 comments on commit 335fbb3

Please sign in to comment.