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 auto-generated documentation #1396

Closed
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 @@ -25,7 +25,7 @@ Radius CLI
### SEE ALSO

* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications
* [rad bicep]({{< ref rad_bicep.md >}}) - Manage bicep compiler
* [rad bicep]({{< ref rad_bicep.md >}}) - Handle bicep-specific tasks for Radius
* [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.
Expand Down
5 changes: 3 additions & 2 deletions docs/content/reference/cli/rad_bicep.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ description: "Details on the rad bicep Radius CLI command"
---
## rad bicep

Manage bicep compiler
Handle bicep-specific tasks for Radius

### Synopsis

Manage bicep compiler used by Radius
Handle bicep-specific tasks for Radius

### Options

Expand All @@ -32,6 +32,7 @@ Manage bicep compiler used by Radius
* [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 generate-kubernetes-manifest]({{< ref rad_bicep_generate-kubernetes-manifest.md >}}) - Generate a DeploymentTemplate Custom Resource.
* [rad bicep publish]({{< ref rad_bicep_publish.md >}}) - Publish a Bicep file to an OCI registry.
* [rad bicep publish-extension]({{< ref rad_bicep_publish-extension.md >}}) - Generate or publish a Bicep extension for a set of resource types.

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

### SEE ALSO

* [rad bicep]({{< ref rad_bicep.md >}}) - Manage bicep compiler
* [rad bicep]({{< ref rad_bicep.md >}}) - Handle bicep-specific tasks for Radius

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

### SEE ALSO

* [rad bicep]({{< ref rad_bicep.md >}}) - Manage bicep compiler
* [rad bicep]({{< ref rad_bicep.md >}}) - Handle bicep-specific tasks for Radius

Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
type: docs
title: "rad bicep generate-kubernetes-manifest CLI reference"
linkTitle: "rad bicep generate-kubernetes-manifest"
slug: rad_bicep_generate-kubernetes-manifest
url: /reference/cli/rad_bicep_generate-kubernetes-manifest/
description: "Details on the rad bicep generate-kubernetes-manifest Radius CLI command"
---
## rad bicep generate-kubernetes-manifest

Generate a DeploymentTemplate Custom Resource.

### Synopsis

Generate a DeploymentTemplate Custom Resource.

This command compiles a Bicep template with the given parameters and outputs a DeploymentTemplate Custom Resource.

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 they are provided. Parameters appearing later in the argument list will override those defined earlier.


```
rad bicep generate-kubernetes-manifest [file] [flags]
```

### Examples

```

# Generate a DeploymentTemplate Custom Resource from a Bicep file.
rad bicep generate-kubernetes-manifest app.bicep --parameters @app.bicepparam --parameters tag=latest --destination-file app.yaml --resource-group default

```

### Options

```
--aws-scope string Scope for AWS deployment.
--azure-scope string Scope for Azure deployment.
-d, --destination-file string Path of the generated DeploymentTemplate yaml file created by running this command.
-g, --group string The resource group name
-h, --help help for generate-kubernetes-manifest
-p, --parameters stringArray Specify parameters for the deployment
```

### 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 >}}) - Handle bicep-specific tasks for Radius

Original file line number Diff line number Diff line change
Expand Up @@ -55,5 +55,5 @@ bicep publish-extension ./Example.Provider.yaml --target br:ghcr.io/myregistry/e

### SEE ALSO

* [rad bicep]({{< ref rad_bicep.md >}}) - Manage bicep compiler
* [rad bicep]({{< ref rad_bicep.md >}}) - Handle bicep-specific tasks for Radius

2 changes: 1 addition & 1 deletion docs/content/reference/cli/rad_bicep_publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,5 +49,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 >}}) - Handle bicep-specific tasks for Radius

2 changes: 1 addition & 1 deletion docs/content/reference/cli/rad_deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ 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.
order they are provided. Parameters appearing later in the argument list will override those defined earlier.


```
Expand Down
2 changes: 1 addition & 1 deletion docs/content/reference/cli/rad_resource-type.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Manage resource types

* [rad]({{< ref rad.md >}}) - Radius CLI
* [rad resource-type create]({{< ref rad_resource-type_create.md >}}) - Create or update a resource type
* [rad resource-type delete]({{< ref rad_resource-type_delete.md >}}) - Delete resource provider
* [rad resource-type delete]({{< ref rad_resource-type_delete.md >}}) - Delete resource protypevider
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nithyatsu -There is a typo in this. Can you update the CLI doc

* [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

4 changes: 2 additions & 2 deletions docs/content/reference/cli/rad_resource-type_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ description: "Details on the rad resource-type delete Radius CLI command"
---
## rad resource-type delete

Delete resource provider
Delete resource protypevider

### Synopsis

Delete resource provider
Delete resource type

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.

Expand Down
8 changes: 4 additions & 4 deletions docs/content/reference/cli/rad_resource_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ rad resource delete [resourceType] [resourceName] [flags]
### Examples

```
sample list of resourceType: Applications.Core/containers, Applications.Core/gateways, Applications.Dapr/daprPubSubBrokers, Applications.Core/extenders, Applications.Datastores/mongoDatabases, Applications.Messaging/rabbitMQMessageQueues, Applications.Datastores/redisCaches, Applications.Datastores/sqlDatabases, Applications.Dapr/daprStateStores, Applications.Dapr/daprSecretStores
# Delete a container named orders
rad resource delete Applications.Core/containers orders
sample list of resourceType: Applications.Core/containers, Applications.Core/gateways, Applications.Dapr/daprPubSubBrokers, Applications.Core/extenders, Applications.Datastores/mongoDatabases, Applications.Messaging/rabbitMQMessageQueues, Applications.Datastores/redisCaches, Applications.Datastores/sqlDatabases, Applications.Dapr/daprStateStores, Applications.Dapr/daprSecretStores

# Delete a container named orders
rad resource delete Applications.Core/containers orders
```

### Options
Expand Down
10 changes: 5 additions & 5 deletions docs/content/reference/cli/rad_resource_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,18 @@ rad resource list [resourceType] [flags]

```

sample list of resourceType: containers, gateways, pubSubBrokers, extenders, mongoDatabases, rabbitMQMessageQueues, redisCaches, sqlDatabases, stateStores, secretStores
sample list of resourceType: Applications.Core/containers, Applications.Core/gateways, Applications.Dapr/daprPubSubBrokers, Applications.Core/extenders, Applications.Datastores/mongoDatabases, Applications.Messaging/rabbitMQMessageQueues, Applications.Datastores/redisCaches, Applications.Datastores/sqlDatabases, Applications.Dapr/daprStateStores, Applications.Dapr/daprSecretStores

# list all resources of a specified type in the default environment

rad resource list containers
rad resource list gateways
rad resource list Applications.Core/containers
rad resource list Applications.Core/gateways

# list all resources of a specified type in an application
rad resource list containers --application icecream-store
rad resource list Applications.Core/containers --application icecream-store

# list all resources of a specified type in an application (shorthand flag)
rad resource list containers -a icecream-store
rad resource list Applications.Core/containers -a icecream-store

```

Expand Down
10 changes: 5 additions & 5 deletions docs/content/reference/cli/rad_resource_show.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,18 @@ rad resource show [resourceType] [resourceName] [flags]

```

sample list of resourceType: containers, gateways, daprPubSubBrokers, extenders, mongoDatabases, rabbitMQMessageQueues, redisCaches, sqlDatabases, daprStateStores, daprSecretStores
sample list of resourceType: Applications.Core/containers, Applications.Core/gateways, Applications.Dapr/daprPubSubBrokers, Applications.Core/extenders, Applications.Datastores/mongoDatabases, Applications.Messaging/rabbitMQMessageQueues, Applications.Datastores/redisCaches, Applications.Datastores/sqlDatabases, Applications.Dapr/daprStateStores, Applications.Dapr/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 applications.core/containers orders
rad resource show applications.core/gateways orders_gateways

# show details of a specified resource in an application
rad resource show containers orders --application icecream-store
rad resource show applications.core/containers orders --application icecream-store

# show details of a specified resource in an application (shorthand flag)
rad resource show containers orders -a icecream-store
rad resource show applications.core/containers orders -a icecream-store

```

Expand Down
Loading