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
6 changes: 3 additions & 3 deletions docs/content/reference/cli/rad_application_graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ the command compiles the template and writes the resulting modeled graph to
./app-graph.json without contacting the control plane.

If the command runs inside a GitHub Actions runner (GITHUB_ACTIONS=true), the
modeled graph is committed to <source-branch>/app-graph.json on the radius-graph
orphan branch instead of the local filesystem. This is auto-detected; no flag
modeled graph is saved to <source-branch>/app-graph.json in the radius-graph
archive instead of the local filesystem. This is auto-detected; no flag
is required.

```
Expand All @@ -46,7 +46,7 @@ rad app graph ./app.bicep
-a, --application string The application name
-g, --group string The resource group name
-h, --help help for graph
--include-icons When set with --preview, embeds each referenced resource type icon's SVG bytes in the response.
--include-icons When set with --preview (deployed) or with a bicep-file argument (modeled), embeds each referenced resource type icon's SVG bytes in the response's icons map.
-o, --output string output format (supported formats are json, table) (default "table")
--preview Use the Radius.Core preview implementation (can also be set via RADIUS_PREVIEW=true)
-w, --workspace string The workspace name
Expand Down
1 change: 1 addition & 0 deletions docs/content/reference/cli/rad_deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ rad deploy myapp.bicep --parameters @myfile.json --parameters version=latest
-g, --group string The resource group name
-h, --help help for deploy
-p, --parameters stringArray Specify parameters for the deployment
--preview Deploy the application using the Radius.Core/applications resource type instead of Applications.Core/applications (can also be set via RADIUS_PREVIEW=true)
-w, --workspace string The workspace name
```

Expand Down
14 changes: 9 additions & 5 deletions docs/content/reference/cli/rad_environment_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,21 @@ rad environment create [envName] [flags]

```

## Create environment with default namespace
## Create environment
rad env create myenv

## Create environment with a specific namespace
rad env create myenv --kubernetes-namespace mynamespace

## Create environment with Azure cloud provider
rad env create myenv --azure-subscription-id <subscription-id> --azure-resource-group <resource-group>

## Create environment with AWS cloud provider
rad env create myenv --aws-region <region> --aws-account-id <account-id>

## Create environment with a specific Kubernetes namespace
rad env create myenv --kubernetes-namespace mynamespace

## Create environment with recipe packs (--preview)
rad env create myenv --preview --recipe-packs pack1,pack2

```

### Options
Expand All @@ -49,7 +52,8 @@ rad env create myenv --aws-region <region> --aws-account-id <account-id>
-g, --group string The resource group name
-h, --help help for create
--kubernetes-namespace string The namespace where Kubernetes resources will be deployed
--preview Use the Radius.Core preview implementation (can also be set via RADIUS_PREVIEW=true)
--preview Use the Radius.Core preview implementation for environment create (can also be set via RADIUS_PREVIEW=true)
--recipe-packs strings Specify recipe packs to assign to the environment (--preview). Accepts comma-separated values.
-w, --workspace string The workspace name
```

Expand Down
2 changes: 1 addition & 1 deletion docs/content/reference/cli/rad_environment_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ rad env update myenv --recipe-packs pack1,pack2
-g, --group string The resource group name
-h, --help help for update
--kubernetes-namespace string The namespace where Kubernetes resources will be deployed
--preview Use the Radius.Core preview implementation for environment update.
--preview Use the Radius.Core preview implementation for environment update (can also be set via RADIUS_PREVIEW=true)
--recipe-packs strings Specify recipe packs to replace the environment's recipe pack list (--preview). Accepts comma-separated values.
-w, --workspace string The workspace name
```
Expand Down
16 changes: 12 additions & 4 deletions docs/content/reference/cli/rad_install_kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,14 @@ By default 'rad install kubernetes' will install Radius with the version matchin

Radius will be installed in the 'radius-system' namespace. For more information visit https://docs.radapp.io/concepts#technical-architecture

This command also ensures that a default resource group named 'default' and a default environment
named 'default' (using the 'default' Kubernetes namespace) exist so the cluster is immediately
ready to deploy applications. If either resource already exists, it is left unchanged; user
customizations are never overwritten, even with '--reinstall'.
On install or reinstall, this command also ensures that a default resource group named 'default'
and a default environment named 'default' (using the 'default' Kubernetes namespace) exist so the
cluster is immediately ready to deploy applications. If either resource already exists, it is left
unchanged (GET-first); user customizations are never overwritten, even with '--reinstall'.

By default the environment is created using the 'Applications.Core/environments' resource type.
Pass '--preview' (or set RADIUS_PREVIEW=true) to create it using the new 'Radius.Core/environments'
resource type with the default recipe pack instead.

Overrides can be set by specifying Helm chart values with the '--set' flag. For more information visit https://docs.radapp.io/guides/operations/kubernetes/install/.

Expand All @@ -35,6 +39,9 @@ rad install kubernetes [flags]
# Install Radius with default settings in current Kubernetes context
rad install kubernetes

# Install Radius and create the default environment using the Radius.Core/environments type
rad install kubernetes --preview

# Install Radius with default settings in specified Kubernetes context
rad install kubernetes --kubecontext mycluster

Expand Down Expand Up @@ -92,6 +99,7 @@ rad install kubernetes --set global.terraform.loglevel=DEBUG
--contour-set-file stringArray Set values from files on the command line (can specify multiple or separate files with commas: key1=filename1,key2=filename2)
-h, --help help for kubernetes
--kubecontext string The Kubernetes context to use, will use the default if unset
--preview Create the default environment using the Radius.Core/environments resource type instead of Applications.Core/environments (can also be set via RADIUS_PREVIEW=true)
--reinstall Specify to force reinstallation of Radius
--set stringArray Set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
--set-file stringArray Set values from files on the command line (can specify multiple or separate files with commas: key1=filename1,key2=filename2)
Expand Down
15 changes: 14 additions & 1 deletion docs/content/reference/cli/rad_resource_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Lists resources

### Synopsis

List all resources of specified type
List all resources of a specified type. If no resource type is given, lists all resources of any type in an environment or application.

```
rad resource list [resourceType] [flags]
Expand All @@ -35,12 +35,25 @@ rad resource list Applications.Core/containers --application icecream-store
# list all resources of a specified type in an application (shorthand flag)
rad resource list Applications.Core/containers -a icecream-store

# list all resources of a specified type in a specified environment
rad resource list Applications.Core/containers -e not-default-env

# list all resources of any type in the default environment
rad resource list

# list all resources of any type in a specified environment
rad resource list -e not-default-env

# list all resources of any type in an application
rad resource list -a icecream-store

```

### Options

```
-a, --application string The application name
-e, --environment string The environment name
-g, --group string The resource group name
-h, --help help for list
-o, --output string output format (supported formats are json, table) (default "table")
Expand Down
4 changes: 2 additions & 2 deletions docs/content/reference/cli/rad_shutdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ Back up Radius state and prepare for shutdown
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'.
commits them to the radius-state archive. The state can be restored into a fresh control plane
with 'rad startup'.

This command does not delete the cluster or uninstall Radius.

Expand Down
2 changes: 1 addition & 1 deletion docs/content/reference/cli/rad_startup.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Restore Radius state after startup

Restore durable Radius state for the current workspace.

Opens the radius-state git orphan branch, waits for the control-plane PostgreSQL instance to be
Opens the radius-state archive, 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'.
Expand Down
Loading
Loading