Skip to content
Open
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: 2 additions & 0 deletions docs/content/reference/cli/rad.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ Radius CLI
* [rad resource-type]({{< ref rad_resource-type.md >}}) - Manage resource types
* [rad rollback]({{< ref rad_rollback.md >}}) - Rolls back Radius for a given platform
* [rad run]({{< ref rad_run.md >}}) - Run an application
* [rad shutdown]({{< ref rad_shutdown.md >}}) - Back up Radius state and prepare for shutdown
* [rad startup]({{< ref rad_startup.md >}}) - Restore Radius state after startup
* [rad uninstall]({{< ref rad_uninstall.md >}}) - Uninstall Radius for a specific platform
* [rad upgrade]({{< ref rad_upgrade.md >}}) - Upgrades Radius for a given platform
* [rad version]({{< ref rad_version.md >}}) - Prints the versions of the rad CLI and the Radius Control Plane
Expand Down
4 changes: 4 additions & 0 deletions docs/content/reference/cli/rad_resource_expose.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ rad resource expose [type] [resource] [flags]
# expose port 80 on the 'orders' resource of the 'icecream-store' application
# on local port 5000
rad resource expose --application icecream-store Applications.Core/containers orders --port 5000 --remote-port 80

# expose port 80 using the preview resource type 'Radius.Compute/containers'
rad resource expose --application icecream-store Radius.Compute/containers orders --port 5000 --remote-port 80 --preview
```

### Options
Expand All @@ -35,6 +38,7 @@ rad resource expose --application icecream-store Applications.Core/containers or
-g, --group string The resource group name
-h, --help help for expose
-p, --port int specify the local port (default -1)
--preview Use the Radius.Core preview implementation (can also be set via RADIUS_PREVIEW=true)
--remote-port int specify the remote port (default -1)
--replica string specify the replica to expose
-r, --resource string The resource name
Expand Down
6 changes: 5 additions & 1 deletion docs/content/reference/cli/rad_resource_logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Read logs from a running containers resource

### Synopsis

Reads logs from a running resource. Currently only supports the resource type 'Applications.Core/containers'.
Reads logs from a running resource. Supports the resource type 'Applications.Core/containers', or 'Radius.Compute/containers' when the '--preview' flag is set.
This command allows you to access logs of a deployed application and output those logs to the local console.

'rad resource logs' will output all currently available logs for the resource and then exit.
Expand All @@ -39,6 +39,9 @@ rad resource logs Applications.Core/containers orders --application icecream-sto

# read logs from the 'daprd' sidecar container of the 'orders' resource of the 'icecream-store' application
rad resource logs Applications.Core/containers orders --application icecream-store --container daprd

# read logs from the 'orders' resource using the preview resource type 'Radius.Compute/containers'
rad resource logs Radius.Compute/containers orders --application icecream-store --preview
```

### Options
Expand All @@ -48,6 +51,7 @@ rad resource logs Applications.Core/containers orders --application icecream-sto
-f, --follow specify that logs should be stream until the command is canceled
-g, --group string The resource group name
-h, --help help for logs
--preview Use the Radius.Core preview implementation (can also be set via RADIUS_PREVIEW=true)
--replica string specify the replica to collect logs from
```

Expand Down
55 changes: 55 additions & 0 deletions docs/content/reference/cli/rad_shutdown.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
type: docs
title: "rad shutdown CLI reference"
linkTitle: "rad shutdown"
slug: rad_shutdown
url: /reference/cli/rad_shutdown/
description: "Details on the rad shutdown Radius CLI command"
---
## rad shutdown

Back up Radius state and prepare for shutdown

### Synopsis

Back up all durable Radius state for the current workspace.

Dumps the control-plane PostgreSQL databases and exports the Terraform recipe state Secrets,
commits them to the radius-state git orphan branch, and pushes to the remote when one is
configured. The state can be restored into a fresh control plane with 'rad startup'.

This command does not delete the cluster or uninstall Radius.

```
rad shutdown [flags]
```

### Examples

```

# Back up state for the current workspace
rad shutdown

# Back up state for a specific workspace
rad shutdown --workspace my-workspace
```

### Options

```
-h, --help help for shutdown
-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

56 changes: 56 additions & 0 deletions docs/content/reference/cli/rad_startup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
type: docs
title: "rad startup CLI reference"
linkTitle: "rad startup"
slug: rad_startup
url: /reference/cli/rad_startup/
description: "Details on the rad startup Radius CLI command"
---
## rad startup

Restore Radius state after startup

### Synopsis

Restore durable Radius state for the current workspace.

Opens the radius-state git orphan branch, waits for the control-plane PostgreSQL instance to be
ready, restores the control-plane databases, and re-creates the Terraform recipe state Secrets.
Run this after Radius is installed on a fresh cluster to resume from the state saved by
'rad shutdown'.

This command does not create the cluster or install Radius.

```
rad startup [flags]
```

### Examples

```

# Restore state for the current workspace
rad startup

# Restore state for a specific workspace
rad startup --workspace my-workspace
```

### Options

```
-h, --help help for startup
-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

Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ description: "Detailed reference documentation for applications.core/application
| **id** | string | The resource id <br />_(ReadOnly, DeployTimeConstant)_ |
| **location** | string | The geo-location where the resource lives |
| **name** | string | The resource name <br />_(Required, DeployTimeConstant, Identifier)_ |
| **properties** | [ApplicationProperties](#applicationproperties) | Application properties <br />_(Required)_ |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called <br />_(ReadOnly)_ |
| **properties** | [ApplicationProperties](#applicationproperties) | The resource-specific properties for this resource. <br />_(Required)_ |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation. <br />_(ReadOnly)_ |
| **status** | [ResourceStatus](#resourcestatus) | Status of a resource. <br />_(ReadOnly)_ |
| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource. <br />_(ReadOnly)_ |
| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. |
| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information. <br />_(ReadOnly)_ |
| **tags** | [Record](#record) | Resource tags. |
| **type** | 'Applications.Core/applications' | The resource type <br />_(ReadOnly, DeployTimeConstant)_ |

### Extension
Expand All @@ -43,7 +43,7 @@ description: "Detailed reference documentation for applications.core/application

| Property | Type | Description |
|----------|------|-------------|
| **kind** | 'aci' | Discriminator property for Extension. <br />_(Required)_ |
| **kind** | 'aci' | The kind of the resource. <br />_(Required)_ |
| **resourceGroup** | string | The resource group of the application environment. <br />_(Required)_ |

#### DaprSidecarExtension
Expand All @@ -53,28 +53,28 @@ description: "Detailed reference documentation for applications.core/application
| Property | Type | Description |
|----------|------|-------------|
| **appId** | string | The Dapr appId. Specifies the identifier used by Dapr for service invocation. <br />_(Required)_ |
| **appPort** | int | The Dapr appPort. Specifies the internal listening port for the application to handle requests from the Dapr sidecar. |
| **appPort** | int | The Dapr appPort. Specifies the internal listening port for the application to handle requests from the Dapr sidecar. |
| **config** | string | Specifies the Dapr configuration to use for the resource. |
| **kind** | 'daprSidecar' | Discriminator property for Extension. <br />_(Required)_ |
| **protocol** | 'grpc' | 'http' | The Dapr sidecar extension protocol |
| **kind** | 'daprSidecar' | Specifies the extension of the resource <br />_(Required)_ |
| **protocol** | 'grpc' | 'http' | Specifies the Dapr app-protocol to use for the resource. |

#### KubernetesMetadataExtension

##### Properties

| Property | Type | Description |
|----------|------|-------------|
| **annotations** | [KubernetesMetadataExtensionAnnotations](#kubernetesmetadataextensionannotations) | Annotations to be applied to the Kubernetes resources output by the resource |
| **kind** | 'kubernetesMetadata' | Discriminator property for Extension. <br />_(Required)_ |
| **labels** | [KubernetesMetadataExtensionLabels](#kubernetesmetadataextensionlabels) | Labels to be applied to the Kubernetes resources output by the resource |
| **annotations** | [Record](#record) | Annotations to be applied to the Kubernetes resources output by the resource |
| **kind** | 'kubernetesMetadata' | The kind of the resource. <br />_(Required)_ |
| **labels** | [Record](#record) | Labels to be applied to the Kubernetes resources output by the resource |

#### KubernetesNamespaceExtension

##### Properties

| Property | Type | Description |
|----------|------|-------------|
| **kind** | 'kubernetesNamespace' | Discriminator property for Extension. <br />_(Required)_ |
| **kind** | 'kubernetesNamespace' | The kind of the resource. <br />_(Required)_ |
| **namespace** | string | The namespace of the application environment. <br />_(Required)_ |

#### ManualScalingExtension
Expand All @@ -83,11 +83,11 @@ description: "Detailed reference documentation for applications.core/application

| Property | Type | Description |
|----------|------|-------------|
| **kind** | 'manualScaling' | Discriminator property for Extension. <br />_(Required)_ |
| **kind** | 'manualScaling' | Specifies the extension of the resource <br />_(Required)_ |
| **replicas** | int | Replica count. <br />_(Required)_ |


### KubernetesMetadataExtensionAnnotations
### Record

#### Properties

Expand All @@ -97,7 +97,7 @@ description: "Detailed reference documentation for applications.core/application

* **Additional Properties Type**: string

### KubernetesMetadataExtensionLabels
### Record

#### Properties

Expand All @@ -115,7 +115,7 @@ description: "Detailed reference documentation for applications.core/application
|----------|------|-------------|
| **environment** | string | Fully qualified resource ID for the environment that the application is linked to <br />_(Required)_ |
| **extensions** | [Extension](#extension)[] | The application extension. |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called <br />_(ReadOnly)_ |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation. <br />_(ReadOnly)_ |
| **status** | [ResourceStatus](#resourcestatus) | Status of a resource. <br />_(ReadOnly)_ |

### ResourceStatus
Expand All @@ -124,9 +124,9 @@ description: "Detailed reference documentation for applications.core/application

| Property | Type | Description |
|----------|------|-------------|
| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource |
| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. |
| **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource |
| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource. <br />_(ReadOnly)_ |
| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment <br />_(ReadOnly)_ |

### EnvironmentCompute

Expand All @@ -136,7 +136,7 @@ description: "Detailed reference documentation for applications.core/application

| Property | Type | Description |
|----------|------|-------------|
| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. |
| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers |
| **resourceId** | string | The resource id of the compute resource for application environment. |

#### AzureContainerInstanceCompute
Expand All @@ -145,7 +145,7 @@ description: "Detailed reference documentation for applications.core/application

| Property | Type | Description |
|----------|------|-------------|
| **kind** | 'aci' | Discriminator property for EnvironmentCompute. <br />_(Required)_ |
| **kind** | 'aci' | The Azure container instance compute kind <br />_(Required)_ |
| **resourceGroup** | string | The resource group to use for the environment. |

#### KubernetesCompute
Expand All @@ -154,7 +154,7 @@ description: "Detailed reference documentation for applications.core/application

| Property | Type | Description |
|----------|------|-------------|
| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute. <br />_(Required)_ |
| **kind** | 'kubernetes' | The Kubernetes compute kind <br />_(Required)_ |
| **namespace** | string | The namespace to use for the environment. <br />_(Required)_ |


Expand All @@ -164,7 +164,7 @@ description: "Detailed reference documentation for applications.core/application

| Property | Type | Description |
|----------|------|-------------|
| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | IdentitySettingKind is the kind of supported external identity setting <br />_(Required)_ |
| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting <br />_(Required)_ |
| **managedIdentity** | string[] | The list of user assigned managed identities |
| **oidcIssuer** | string | The URI for your compute platform's OIDC issuer |
| **resource** | string | The resource ID of the provisioned identity |
Expand Down Expand Up @@ -200,9 +200,9 @@ description: "Detailed reference documentation for applications.core/application
| **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. |
| **lastModifiedAt** | string | The timestamp of resource last modification (UTC) |
| **lastModifiedBy** | string | The identity that last modified the resource. |
| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. |
| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. |

### TrackedResourceTags
### Record

#### Properties

Expand Down
Loading
Loading