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

Documenting manual Radius Environment setup #619

Merged
merged 37 commits into from
Aug 11, 2023
Merged
Changes from 11 commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
5e8f8b0
Manual rad setup doc
jasonviviano Jun 14, 2023
cb2dcfd
Merge branch 'edge' into jasonviviano/rad-setup
jasonviviano Jun 23, 2023
296afaf
Updated environment page with environment creation steps
jasonviviano Jun 23, 2023
c56ef8b
Fixed bash output snippets
jasonviviano Jun 23, 2023
cdad539
Merge remote-tracking branch 'origin/edge' into jasonviviano/rad-setup
jasonviviano Jun 23, 2023
2ec0295
Fixed merge conflcit
jasonviviano Jun 23, 2023
a1d2341
Fixed PR
jasonviviano Jun 23, 2023
43d13f7
Fixed pages changed
jasonviviano Jun 23, 2023
d467bdd
Added back aws provider
jasonviviano Jun 23, 2023
02418e8
Fixed list view
jasonviviano Jun 23, 2023
e2662ff
Fixed list view again
jasonviviano Jun 23, 2023
e98035f
Merge branch 'edge' into jasonviviano/rad-setup
jasonviviano Jun 27, 2023
91abaff
Apply suggestions from code review
jasonviviano Jun 27, 2023
8eda33e
How-to:Radius environments
jasonviviano Jun 27, 2023
3412693
Fixed render
jasonviviano Jun 27, 2023
f36185e
Merge branch 'edge' into jasonviviano/rad-setup
jasonviviano Jun 27, 2023
57ffd8c
Update docs/content/operations/environments/howto-environment/index.md
jasonviviano Jun 28, 2023
8aefd30
Update docs/content/operations/environments/howto-environment/index.md
jasonviviano Jun 28, 2023
69333be
Added new info to the cloud provider sections
jasonviviano Jun 28, 2023
36776ca
Merge branch 'edge' into jasonviviano/rad-setup
jasonviviano Jun 28, 2023
77bd4b2
Changes to environment
jasonviviano Jul 21, 2023
c7467fa
Merge branch 'edge' into jasonviviano/rad-setup
jasonviviano Jul 21, 2023
aebb719
Changed structure of page
jasonviviano Jul 24, 2023
e6dd585
Merge branch 'edge' into jasonviviano/rad-setup
jasonviviano Jul 24, 2023
8a4d7a4
Apply suggestions from code review
jasonviviano Jul 25, 2023
4d1a617
Update index.md
jasonviviano Jul 25, 2023
66a41c9
Messed up the previous commit
jasonviviano Jul 25, 2023
8c6b337
Update docs/content/operations/environments/howto-environment/index.md
jasonviviano Jul 26, 2023
43975d0
Update docs/content/operations/environments/howto-environment/index.md
jasonviviano Jul 26, 2023
1c531b3
Merge branch 'edge' into jasonviviano/rad-setup
jasonviviano Aug 7, 2023
53e2e85
Reformatted howto-environment.md to have outputs demonstrated for adv…
jasonviviano Aug 7, 2023
08b4eff
Fixed spelling check issue
jasonviviano Aug 7, 2023
d60bd01
Apply suggestions from code review
jasonviviano Aug 7, 2023
042510a
Updated AWS prerequisites and steps
jasonviviano Aug 7, 2023
f9a16b7
Update docs/content/operations/environments/howto-environment/index.md
jasonviviano Aug 7, 2023
88d74e7
Update docs/content/operations/environments/howto-environment/index.md
jasonviviano Aug 7, 2023
1ab5e7d
Small formatting updates
AaronCrawfis Aug 7, 2023
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
97 changes: 81 additions & 16 deletions docs/content/operations/environments/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,18 +105,19 @@ The following example shows an environment configured with Kubernetes as the tar

## How-to: Initialize a new environment
jasonviviano marked this conversation as resolved.
Show resolved Hide resolved

1. Begin by deploying a compatible [Kubernetes cluster]({{< ref "/operations/platforms/kubernetes" >}})
Begin by ensuring you are using a compatible [Kubernetes cluster]({{< ref "/operations/platforms/kubernetes" >}})

*Visit the [Kubernetes platform docs]({{< ref "/operations/platforms/kubernetes" >}}) for a list of supported clusters and specific cluster requirements.*

1. Ensure your target kubectl context is set as the default:
```bash
kubectl config current-context
```
{{< tabs "Customized environment" "Manual" >}}
jasonviviano marked this conversation as resolved.
Show resolved Hide resolved

{{% codetab %}}

1. Initialize a new environment with `rad init` command:
```bash
rad init
```

1. Follow the prompts, specifying:
- **Namespace** - The Kubernetes namespace where your application containers and networking resources will be deployed (different than the Radius control-plane namespace, `radius-system`)
- **Azure provider** (optional) - Allows you to [deploy and manage Azure resources]({{< ref "providers#azure-provider" >}})
Expand All @@ -127,7 +128,23 @@ The following example shows an environment configured with Kubernetes as the tar
2. **Create the environment** - An environment resource is created in the Radius control plane. It maps to a Kubernetes namespace.
3. **Add the Azure Cloud Provider** - The Azure cloud provider configuration is saved in the Radius control plane
4. **Add the AWS Cloud Provider** - The AWS cloud provider configuration is saved in the Radius control plane
5. **Create a workspace** - [Workspaces]({{< ref workspaces >}}) are local pointers to a cluster running Radius, and an environment. Workspaces are saved to the Radius config file (`~/.rad/config.yaml` on Linux and macOS, `%USERPROFILE%\.rad\config.yaml` on Windows)

You should see the following output:

```bash
Initializing Radius...

✅ Install Radius v0.21
- Kubernetes cluster: k3d-k3s-default
- Kubernetes namespace: radius-system
✅ Create new environment default
- Kubernetes namespace: default
✅ Scaffold application samples
✅ Update local configuration

Initialization complete! Have a RAD time 😎
```

2. Verify the initialization by running:
```bash
kubectl get deployments -n radius-system
Expand All @@ -136,20 +153,68 @@ The following example shows an environment configured with Kubernetes as the tar
You should see:

```
NAME READY UP-TO-DATE AVAILABLE AGE
ucp 1/1 1 1 53s
appcore-rp 1/1 1 1 53s
bicep-de 1/1 1 1 53s
contour-contour 1/1 1 1 46s
dapr-dashboard 1/1 1 1 35s
dapr-sidecar-injector 1/1 1 1 35s
dapr-sentry 1/1 1 1 35s
dapr-operator 1/1 1 1 35s
NAME READY UP-TO-DATE AVAILABLE AGE
ucp 1/1 1 1 2m56s
appcore-rp 1/1 1 1 2m56s
bicep-de 1/1 1 1 2m56s
contour-contour 1/1 1 1 2m33s
```

You can also use [`rad env list`]({{< ref rad_env_list.md >}}) to see if the created environment gets listed:

```bash
rad env list
```

{{% /codetab %}}

{{% codetab %}}

1. Install Radius onto a Kubernetes cluster:

Use the following command to target your desired Kubernetes cluster.

For a list of all the supported command options visit [rad install kubernetes]({{< ref rad_install_kubernetes >}})

```bash
rad install kubernetes --chart <user-chart> --tag <user-tag> --set <user-set>
jasonviviano marked this conversation as resolved.
Show resolved Hide resolved
```
2. Create a new Radius resource group:
Radius resource groups are used to organize Radius resources, such as applications, environments, links, and routes. For more information visit [Radius resource groups]({{< ref groups >}}).
For a dive into the command visit [`rad group create`]({{< ref rad_group_create >}})
jasonviviano marked this conversation as resolved.
Show resolved Hide resolved
```bash
rad group create <user-radius-resource-group>
jasonviviano marked this conversation as resolved.
Show resolved Hide resolved
```
4. Create your Radius Environment and pass it your Kubernetes namespace:
```bash
rad env create <user-radius-environment> --namespace <kubernetes-namespace>
jasonviviano marked this conversation as resolved.
Show resolved Hide resolved
```
For a dive into the command visit [`rad env create`]({{< ref rad_env_create >}})
jasonviviano marked this conversation as resolved.
Show resolved Hide resolved
5. Set your Radius Environment:
```bash
rad env switch kind-radius
```
For a dive into the command visit [`rad env switch`]({{< ref rad_env_switch >}}).

6. Verify the initialization by running:
jasonviviano marked this conversation as resolved.
Show resolved Hide resolved
```bash
kubectl get deployments -n radius-system
```

jasonviviano marked this conversation as resolved.
Show resolved Hide resolved
You should see:

```
NAME READY UP-TO-DATE AVAILABLE AGE
ucp 1/1 1 1 2m56s
appcore-rp 1/1 1 1 2m56s
bicep-de 1/1 1 1 2m56s
contour-contour 1/1 1 1 2m33s
```

You can also use [`rad env list`]({{< ref rad_env_list.md >}}) to see if the created environment gets listed:

```bash
rad env list
jasonviviano marked this conversation as resolved.
Show resolved Hide resolved
```
{{% /codetab %}}
{{< /tabs >}}