Skip to content

Commit

Permalink
Add HowTo guide on managing resource groups (#743)
Browse files Browse the repository at this point in the history
* Restructure groups page and add how-to guide

* Shorten linkTitle

* Reorder guide

* Update docs/content/guides/operations/groups/howto-resourcegroups/index.md

Co-authored-by: Will <[email protected]>

---------

Co-authored-by: Will <[email protected]>
  • Loading branch information
AaronCrawfis and willtsai authored Sep 18, 2023
1 parent e487c44 commit febd0fc
Show file tree
Hide file tree
Showing 5 changed files with 99 additions and 3 deletions.
7 changes: 7 additions & 0 deletions docs/content/guides/operations/groups/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
type: docs
title: "Resource groups"
linkTitle: "Resource groups"
description: "Manage collections of resources with resource groups"
weight: 600
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
---
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
```
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
type: docs
title: "Resource groups"
linkTitle: "Resource groups"
description: "Manage collections of resources with resource groups"
title: "Overview: Resource groups"
linkTitle: "Overview"
description: "Learn how to manage collections of resources with resource groups"
weight: 100
---

Expand Down

0 comments on commit febd0fc

Please sign in to comment.