diff --git a/docs/content/guides/operations/groups/_index.md b/docs/content/guides/operations/groups/_index.md deleted file mode 100644 index 0d01fa5e0..000000000 --- a/docs/content/guides/operations/groups/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -type: docs -title: "Resource groups" -linkTitle: "Resource groups" -description: "Manage collections of resources with resource groups" -weight: 600 ---- diff --git a/docs/content/guides/operations/groups/howto-resourcegroups/index.md b/docs/content/guides/operations/groups/howto-resourcegroups/index.md deleted file mode 100644 index 08c1fa1dd..000000000 --- a/docs/content/guides/operations/groups/howto-resourcegroups/index.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -type: docs -title: "How-To: Manage resource groups" -linkTitle: "Manage groups" -description: "Learn how to manage resource groups in Radius" -weight: 200 ---- - -This guide will walk you through the process of managing resource groups in Radius. For more information on resource groups, see [Resource groups]({{< ref groups >}}). - -## Pre-requisites - -- [Supported Kubernetes cluster]({{< ref supported-clusters >}}) -- [Radius CLI]({{< ref howto-rad-cli >}}) - -## Step 1: Ensure Radius is installed - -Begin by making sure that Radius is installed on your Kubernetes cluster: - -```bash -rad install kubernetes -``` - -## Step 2: Create a resource group - -Run [`rad group create`]({{< ref rad_group_create >}}) to create a resource group: - -```bash -rad group create myGroup -``` - -You should see: - -``` -creating resource group "myGroup" in namespace "default"... - -resource group "myGroup" created -``` - -## Step 3: View your resource group - -Run [`rad group show`]({{< ref rad_group_show >}}) to view the your resource group: - -```bash -rad group show myGroup -``` - -You should see: - -``` -ID NAME -/planes/radius/local/resourcegroups/myGroup myGroup -``` - -You can use the `-o json` flag to view more information about the resource group: - -```bash -rad group show -o json -``` - -You should see: - -``` -{ - "id": "/planes/radius/local/resourcegroups/myGroup", - "location": "global", - "name": "myGroup", - "tags": {}, - "type": "System.Resources/resourceGroups", -} -``` - -## Step 4: Set your resource group as the default - -Setting a default resource group allows you to run commands like `rad deploy` without specifying the `-g/--group` flag explicitly every time. Run [`rad group switch`]({{< ref rad_group_switch >}}) to set your new resource group as the default: - -```bash -rad group switch myGroup -``` - -You can now run `rad deploy` or `rad recipe list` without needing to specify the group. - -## Step 5: Delete your resource group - -Run [`rad group delete`]({{< ref rad_group_delete >}}) to delete a resource group: - -```bash -rad group delete myGroup -``` diff --git a/docs/content/reference/cli/rad_env_init.md b/docs/content/reference/cli/rad_env_init.md deleted file mode 100644 index 969e14785..000000000 --- a/docs/content/reference/cli/rad_env_init.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -type: docs -date: 2022-09-29T14:48:16-07:00 -title: "rad env init CLI reference" -linkTitle: "rad env init" -slug: rad_env_init -url: /reference/cli/rad_env_init/ -description: "Details on the rad env init Radius CLI command" ---- -## rad env init - -Create a RAD environment - -### Synopsis - -Create a RAD environment - -### Options - -``` - --appcore-image string Specify Application.Core RP image to use - --appcore-tag string Specify Application.Core RP image tag to use - --chart string Specify a file path to a helm chart to install Radius from - -f, --force Overwrite existing workspace if present - -h, --help help for init - --image string Specify the radius controller image to use - -i, --interactive Collect values for required command arguments through command line interface prompts - -n, --namespace string Specify the namespace to use for the environment into which application resources are deployed (default "default") - --provider-aws Add AWS provider for cloud resources - --provider-aws-access-key-id string Specifies an AWS access key associated with an IAM user or role - --provider-aws-region string Specifies the region to be used for resources deployed by this provider - --provider-aws-secret-access-key string Specifies the secret key associated with the access key. This is essentially the "password" for the access key - --provider-azure Add Azure provider for cloud resources - --provider-azure-client-id string The client id for the service principal - --provider-azure-client-secret string The client secret for the service principal - --provider-azure-resource-group string Azure resource-group for cloud resources - --provider-azure-subscription string Azure subscription for cloud resources - --provider-azure-tenant-id string The tenant id for the service principal - --public-endpoint-override string Specify the public IP address or hostname of the Kubernetes cluster. It must be in the format: [:]. Ex: 'localhost:9000' - --reinstall Specify to force reinstallation of Radius - --tag string Specify the radius controller tag to use - --ucp-image string Specify the UCP image to use - --ucp-tag string Specify the UCP tag to use -``` - -### Options inherited from parent commands - -``` - --config string config file (default "$HOME/.rad/config.yaml") - -e, --environment string The environment name - -o, --output string output format (supported formats are json, table, list) (default "table") - -w, --workspace string The workspace name -``` - -### SEE ALSO - -* [rad env]({{< ref rad_env.md >}}) - Manage environments -* [rad env init kubernetes]({{< ref rad_env_init_kubernetes.md >}}) - Initializes a kubernetes environment - -###### Auto generated by spf13/cobra on 29-Sep-2022 diff --git a/docs/content/reference/cli/rad_env_init_kubernetes.md b/docs/content/reference/cli/rad_env_init_kubernetes.md deleted file mode 100644 index 25d856be3..000000000 --- a/docs/content/reference/cli/rad_env_init_kubernetes.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -type: docs -date: 2022-09-29T14:48:16-07:00 -title: "rad env init kubernetes CLI reference" -linkTitle: "rad env init kubernetes" -slug: rad_env_init_kubernetes -url: /reference/cli/rad_env_init_kubernetes/ -description: "Details on the rad env init kubernetes Radius CLI command" ---- -## rad env init kubernetes - -Initializes a kubernetes environment - -### Synopsis - -Initializes a kubernetes environment. - -``` -rad env init kubernetes [flags] -``` - -### Options - -``` - -h, --help help for kubernetes -``` - -### Options inherited from parent commands - -``` - --appcore-image string Specify Application.Core RP image to use - --appcore-tag string Specify Application.Core RP image tag to use - --chart string Specify a file path to a helm chart to install Radius from - --config string config file (default "$HOME/.rad/config.yaml") - -e, --environment string The environment name - -f, --force Overwrite existing workspace if present - --image string Specify the radius controller image to use - -i, --interactive Collect values for required command arguments through command line interface prompts - -n, --namespace string Specify the namespace to use for the environment into which application resources are deployed (default "default") - -o, --output string output format (supported formats are json, table, list) (default "table") - --provider-aws Add AWS provider for cloud resources - --provider-aws-access-key-id string Specifies an AWS access key associated with an IAM user or role - --provider-aws-region string Specifies the region to be used for resources deployed by this provider - --provider-aws-secret-access-key string Specifies the secret key associated with the access key. This is essentially the "password" for the access key - --provider-azure Add Azure provider for cloud resources - --provider-azure-client-id string The client id for the service principal - --provider-azure-client-secret string The client secret for the service principal - --provider-azure-resource-group string Azure resource-group for cloud resources - --provider-azure-subscription string Azure subscription for cloud resources - --provider-azure-tenant-id string The tenant id for the service principal - --public-endpoint-override string Specify the public IP address or hostname of the Kubernetes cluster. It must be in the format: [:]. Ex: 'localhost:9000' - --reinstall Specify to force reinstallation of Radius - --tag string Specify the radius controller tag to use - --ucp-image string Specify the UCP image to use - --ucp-tag string Specify the UCP tag to use - -w, --workspace string The workspace name -``` - -### SEE ALSO - -* [rad env init]({{< ref rad_env_init.md >}}) - Create a RAD environment - -###### Auto generated by spf13/cobra on 29-Sep-2022 diff --git a/docs/content/reference/cli/rad_env_start.md b/docs/content/reference/cli/rad_env_start.md deleted file mode 100644 index ec84a0278..000000000 --- a/docs/content/reference/cli/rad_env_start.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -type: docs -date: 2022-09-29T14:48:16-07:00 -title: "rad env start CLI reference" -linkTitle: "rad env start" -slug: rad_env_start -url: /reference/cli/rad_env_start/ -description: "Details on the rad env start Radius CLI command" ---- -## rad env start - -Start a local Radius environment. - -### Synopsis - -Start a local Radius environment. Uses the current user's default environment by default. - -``` -rad env start [flags] -``` - -### Options - -``` - -h, --help help for start -``` - -### Options inherited from parent commands - -``` - --config string config file (default "$HOME/.rad/config.yaml") - -e, --environment string The environment name - -o, --output string output format (supported formats are json, table, list) (default "table") - -w, --workspace string The workspace name -``` - -### SEE ALSO - -* [rad env]({{< ref rad_env.md >}}) - Manage environments - -###### Auto generated by spf13/cobra on 29-Sep-2022 diff --git a/docs/content/reference/cli/rad_env_status.md b/docs/content/reference/cli/rad_env_status.md deleted file mode 100644 index db40e2abc..000000000 --- a/docs/content/reference/cli/rad_env_status.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -type: docs -date: 2022-09-29T14:48:16-07:00 -title: "rad env status CLI reference" -linkTitle: "rad env status" -slug: rad_env_status -url: /reference/cli/rad_env_status/ -description: "Details on the rad env status Radius CLI command" ---- -## rad env status - -Show local Radius environment status - -### Synopsis - -Show local Radius environment status. Uses the current user's default environment by default. - -``` -rad env status [flags] -``` - -### Options - -``` - -h, --help help for status -``` - -### Options inherited from parent commands - -``` - --config string config file (default "$HOME/.rad/config.yaml") - -e, --environment string The environment name - -o, --output string output format (supported formats are json, table, list) (default "table") - -w, --workspace string The workspace name -``` - -### SEE ALSO - -* [rad env]({{< ref rad_env.md >}}) - Manage environments - -###### Auto generated by spf13/cobra on 29-Sep-2022 diff --git a/docs/content/reference/cli/rad_env_stop.md b/docs/content/reference/cli/rad_env_stop.md deleted file mode 100644 index 538373ba7..000000000 --- a/docs/content/reference/cli/rad_env_stop.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -type: docs -date: 2022-09-29T14:48:16-07:00 -title: "rad env stop CLI reference" -linkTitle: "rad env stop" -slug: rad_env_stop -url: /reference/cli/rad_env_stop/ -description: "Details on the rad env stop Radius CLI command" ---- -## rad env stop - -Stop a local Radius environment - -### Synopsis - -Stop a local Radius environment. Uses the current user's default environment by default. - -``` -rad env stop [flags] -``` - -### Options - -``` - -h, --help help for stop -``` - -### Options inherited from parent commands - -``` - --config string config file (default "$HOME/.rad/config.yaml") - -e, --environment string The environment name - -o, --output string output format (supported formats are json, table, list) (default "table") - -w, --workspace string The workspace name -``` - -### SEE ALSO - -* [rad env]({{< ref rad_env.md >}}) - Manage environments - -###### Auto generated by spf13/cobra on 29-Sep-2022 diff --git a/docs/content/reference/cli/rad_recipe_create.md b/docs/content/reference/cli/rad_recipe_create.md deleted file mode 100644 index 1916a35e2..000000000 --- a/docs/content/reference/cli/rad_recipe_create.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -type: docs -date: 2022-09-29T14:48:16-07:00 -title: "rad recipe create CLI reference" -linkTitle: "rad recipe create" -slug: rad_recipe_create -url: /reference/cli/rad_recipe_create/ -description: "Details on the rad recipe create Radius CLI command" ---- -## rad recipe create - -Add a connector recipe to the environment. - -### Synopsis - -Add a connector recipe to the environment. - -``` -rad recipe create [flags] -``` - -### Examples - -``` -rad recipe create --name cosmosdb -e env_name -w workspace --templatePath template_path --connectorType Applications.Connector/mongoDatabases -``` - -### Options - -``` - --connectorType string specify the type of the connector this recipe can be consumed by - -h, --help help for create - --name string specify the name of the recipe - --templatePath string specify the path to the template provided by the recipe. -``` - -### Options inherited from parent commands - -``` - --config string config file (default "$HOME/.rad/config.yaml") - -e, --environment string The environment name - -o, --output string output format (supported formats are json, table, list) (default "table") - -w, --workspace string The workspace name -``` - -### SEE ALSO - -* [rad recipe]({{< ref rad_recipe.md >}}) - Manage connector recipes - -###### Auto generated by spf13/cobra on 29-Sep-2022 diff --git a/docs/content/reference/cli/rad_workspace_init.md b/docs/content/reference/cli/rad_workspace_init.md deleted file mode 100644 index 0cd1ab3c9..000000000 --- a/docs/content/reference/cli/rad_workspace_init.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -type: docs -date: 2022-09-29T14:48:16-07:00 -title: "rad workspace init CLI reference" -linkTitle: "rad workspace init" -slug: rad_workspace_init -url: /reference/cli/rad_workspace_init/ -description: "Details on the rad workspace init Radius CLI command" ---- -## rad workspace init - -Initialize local workspace - -### Synopsis - -Initialize local workspace - -### Options - -``` - -h, --help help for init -``` - -### Options inherited from parent commands - -``` - --config string config file (default "$HOME/.rad/config.yaml") - -o, --output string output format (supported formats are json, table, list) (default "table") - -w, --workspace string The workspace name -``` - -### SEE ALSO - -* [rad workspace]({{< ref rad_workspace.md >}}) - Manage local workspaces -* [rad workspace init kubernetes]({{< ref rad_workspace_init_kubernetes.md >}}) - Initialize local workspace on kubernetes - -###### Auto generated by spf13/cobra on 29-Sep-2022 diff --git a/docs/content/reference/cli/rad_workspace_init_kubernetes.md b/docs/content/reference/cli/rad_workspace_init_kubernetes.md deleted file mode 100644 index 92f031224..000000000 --- a/docs/content/reference/cli/rad_workspace_init_kubernetes.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -type: docs -date: 2022-09-29T14:48:16-07:00 -title: "rad workspace init kubernetes CLI reference" -linkTitle: "rad workspace init kubernetes" -slug: rad_workspace_init_kubernetes -url: /reference/cli/rad_workspace_init_kubernetes/ -description: "Details on the rad workspace init kubernetes Radius CLI command" ---- -## rad workspace init kubernetes - -Initialize local workspace on kubernetes - -### Synopsis - -Initialize local workspace on kubernetes - -``` -rad workspace init kubernetes [flags] -``` - -### Options - -``` - -f, --force Overwrite existing workspace if present - -h, --help help for kubernetes - -i, --interactive Collect values for required command arguments through command line interface prompts - --kubecontext string the Kubernetes context to use, will use the default if unset - --provider-azure Add Azure provider for cloud resources - --provider-azure-client-id string The client id for the service principal - --provider-azure-client-secret string The client secret for the service principal - --provider-azure-resource-group string Azure resource-group for cloud resources - --provider-azure-subscription string Azure subscription for cloud resources - --provider-azure-tenant-id string The tenant id for the service principal -``` - -### Options inherited from parent commands - -``` - --config string config file (default "$HOME/.rad/config.yaml") - -o, --output string output format (supported formats are json, table, list) (default "table") - -w, --workspace string The workspace name -``` - -### SEE ALSO - -* [rad workspace init]({{< ref rad_workspace_init.md >}}) - Initialize local workspace - -###### Auto generated by spf13/cobra on 29-Sep-2022