Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Aaron Crawfis <[email protected]>
  • Loading branch information
willtsai and AaronCrawfis authored Oct 23, 2023
1 parent f03da4c commit c31e124
Showing 1 changed file with 17 additions and 19 deletions.
36 changes: 17 additions & 19 deletions docs/content/tutorials/helm/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ This tutorial will teach you the following about Radius:

* How to use update a Helm chart to include its resources in a Radius application
* How to use features like Recipes and Connections within Kubernetes YAML or Helm.


{{< image src="diagram.png" alt="Diagram of the application and its resources" width="500px" >}}

## Prerequisites
Expand Down Expand Up @@ -108,7 +106,7 @@ You can deploy this application for the first time by following these steps:
- Install the Helm chart.

{{< alert title="💡 Redis" color="info" >}}
For now you're not going to actually deploy Redis, the URL in this step is fake. You will deploy Redis using a Recipe later in the tutorial that will replace the fake URL contained within `redis-secret`.
For now you're not going to actually deploy Redis and the URL in this step is fake. You will deploy Redis using a Recipe later in the tutorial that will replace the fake URL contained within `redis-secret` with an actual container and URL.
{{< /alert >}}

Complete these steps by running the following commands:
Expand All @@ -121,11 +119,11 @@ helm upgrade demo ./Chart -n demo --install

The output should look similar to the following:

```txt
```
> kubectl create namespace demo
namespace/demo created
> kubectl create secret generic --namespace demo --from-literal=url=redis://redis-master:6379 redis-secret
> kubectl create secret generic --namespace demo --from-literal=url=redis://fake-server redis-secret
secret/redis-secret created
> helm upgrade demo ./Chart -n demo --install
Expand All @@ -150,7 +148,7 @@ kubectl get all -n demo

The output should look similar to the following:

```txt
```
> kubectl get all -n demo
NAME READY STATUS RESTARTS AGE
pod/webapp-79d5dfb99-vhj9g 1/1 Running 0 2m48s
Expand Down Expand Up @@ -210,7 +208,7 @@ helm upgrade demo ./Chart -n demo --install

The output should look like:

```txt
```
> helm upgrade demo ./Chart -n demo --install
Release "demo" has been upgraded. Happy Helming!
NAME: demo
Expand All @@ -231,7 +229,7 @@ kubectl get all -n demo

The output should look similar to the following:

```txt
```
> kubectl get all -n demo
NAME READY STATUS RESTARTS AGE
pod/webapp-79d5dfb99-mv6q9 1/1 Running 0 10m
Expand All @@ -253,7 +251,7 @@ rad app graph -a demo -g default-demo

The output should look like this:

```txt
```
> rad app graph -a demo -g default-demo
Displaying application: demo
Expand Down Expand Up @@ -302,9 +300,9 @@ default Applications.Datastores/redisCaches bicep
The recipe for `Applications.Datastores/redisCaches` is what you will use in this example.

{{< alert title="💡 Recipes" color="info" >}}
Radius includes Recipes for local development when you use `rad init`. These **local-dev** Recipes run popular OSS technologies as containerized infrastructure without requiring a cloud account.
Radius includes Recipes for local development when you use `rad init`. These [**local-dev**](https://github.com/radius-project/recipes/tree/main/local-dev) Recipes run popular OSS technologies as containerized infrastructure without requiring a cloud account.

In a production environment you can substitute recipes that will create cloud or on-premises dependencies instead.
In a production environment you can substitute recipes that will create cloud or on-premises dependencies instead.
{{< /alert >}}

Make sure the `app.yaml` file from `./demo/Chart/templates/app.yaml` is open in your editor. At the bottom of the file add the following text, including the `---`:
Expand Down Expand Up @@ -334,7 +332,7 @@ helm upgrade demo ./Chart -n demo --install

The output should look like:

```txt
```
> helm upgrade demo ./Chart -n demo --install
Release "demo" has been upgraded. Happy Helming!
NAME: demo
Expand All @@ -355,7 +353,7 @@ kubectl get all -n demo

The output should look similar to the following:

```txt
```
> kubectl get all -n demo
pod/redis-r5tcrra3d7uh6-7bcd8b8d8d-jmgn4 2/2 Running 0 51s
Expand Down Expand Up @@ -390,7 +388,7 @@ rad app graph -a demo -g default-demo

The output should look like this:

```txt
```
> rad app graph -a demo -g default-demo
Displaying application: demo
Expand Down Expand Up @@ -424,7 +422,7 @@ kubectl get secret -n demo redis-secret -o yaml

The output should look like the following:

```txt
```
>kubectl get secret -n demo redis-secret -o yaml
apiVersion: v1
data:
Expand Down Expand Up @@ -553,7 +551,7 @@ kubectl get all -n demo

The output should look like:

```txt
```
> kubectl get all -n demo
NAME READY STATUS RESTARTS AGE
pod/redis-r5tcrra3d7uh6-7bcd8b8d8d-jmgn4 2/2 Running 0 20m
Expand Down Expand Up @@ -586,7 +584,7 @@ rad app graph -a demo -g default-demo

The output should look like the example below:

```txt
```
> rad app graph -a demo -g default-demo
Displaying application: demo
Expand Down Expand Up @@ -627,7 +625,7 @@ Congrats! You're running your first Radius app.

You can use the homepage to view information about the container and its settings.

Navigate to the TODO List tab and test out the application. Using the TODO page will update the saved state in Redis.
Navigate to the ToDo List tab and test out the application. Using the ToDo page will update the saved state in Redis.

<img src="./demo-with-todolist.png" alt="Screenshot of the todolist" width=500>
<br /><br />
Expand All @@ -649,4 +647,4 @@ In summary, this tutorial walked through a hands-on example to show you how-to:
- Use Connections to automate the management of connection information.

<br>
{{< button text="Next step: Radius Tutorials" page="tutorials" >}}
{{< button text="Next step: Try another tutorial" page="tutorials" >}}

0 comments on commit c31e124

Please sign in to comment.