From 52e9eb0b50931d9baea8d4e86b86f178613fe51c Mon Sep 17 00:00:00 2001 From: Will Tsai <28876888+willtsai@users.noreply.github.com> Date: Mon, 23 Oct 2023 16:54:01 -0700 Subject: [PATCH] correct alignments Signed-off-by: Will Tsai <28876888+willtsai@users.noreply.github.com> --- docs/content/tutorials/helm/index.md | 802 +++++++++++++-------------- 1 file changed, 401 insertions(+), 401 deletions(-) diff --git a/docs/content/tutorials/helm/index.md b/docs/content/tutorials/helm/index.md index b294f1a01..c09089fdb 100644 --- a/docs/content/tutorials/helm/index.md +++ b/docs/content/tutorials/helm/index.md @@ -63,106 +63,106 @@ rad init 1. Navigate to the `./Chart` folder and browse its contents. This contains a Helm chart for the application that you will modify. - Here are the contents of `./demo/Chart/templates/app.yaml`. This file is part of the Helm chart, and describes the container used for this tutorial: - - ```yaml - apiVersion: apps/v1 - kind: Deployment - metadata: - name: webapp - namespace: {{ .Release.Namespace }} - spec: - selector: - matchLabels: - app: webapp - template: - metadata: - labels: + Here are the contents of `./demo/Chart/templates/app.yaml`. This file is part of the Helm chart, and describes the container used for this tutorial: + + ```yaml + apiVersion: apps/v1 + kind: Deployment + metadata: + name: webapp + namespace: {{ .Release.Namespace }} + spec: + selector: + matchLabels: app: webapp - spec: - containers: - - name: webapp - image: {{ .Values.image.repository }}:{{ .Values.image.tag }} - env: - - name: CONNECTION_REDIS_URL - valueFrom: - secretKeyRef: - name: redis-secret - key: url - ports: - - containerPort: 3000 - ``` - - The container that you will be working with is a ToDo application that uses Redis as a database. - - - The container is configured to listen on port 3000. - - The container will use the environment variable `CONNECTION_REDIS_URL` to connect to Redis. - - This `CONNECTION_REDIS_URL` environment variable is populated by a Kubernetes Secret. - -2. You can deploy this application for the first time by following these steps: - - - Create the Kubernetes namespace `demo` - - Create the Kubernetes Secret `redis-secret` containing the Redis URL. - - Install the Helm chart. - - {{< alert title="💡 Redis" color="info" >}} - 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: - - ```bash - kubectl create namespace demo - kubectl create secret generic --namespace demo --from-literal=url=redis://fake-server redis-secret - helm upgrade demo ./Chart -n demo --install - ``` - - The output should look similar to the following: - - ``` - > kubectl create namespace demo - namespace/demo created - - > 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 - Release "demo" does not exist. Installing it now. - NAME: demo - LAST DEPLOYED: Wed Sep 13 01:05:19 2023 - NAMESPACE: demo - STATUS: deployed - REVISION: 1 - TEST SUITE: None - ``` - - {{< alert title="⚠️ Chart Directory" color="warning" >}} - If you see an error message like **Error: path "./Chart" not found** then you are in the wrong directory. Make sure your terminal is in the `./demo` directory of the `samples` repository. - {{< /alert >}} + template: + metadata: + labels: + app: webapp + spec: + containers: + - name: webapp + image: {{ .Values.image.repository }}:{{ .Values.image.tag }} + env: + - name: CONNECTION_REDIS_URL + valueFrom: + secretKeyRef: + name: redis-secret + key: url + ports: + - containerPort: 3000 + ``` + + The container that you will be working with is a ToDo application that uses Redis as a database. + + - The container is configured to listen on port 3000. + - The container will use the environment variable `CONNECTION_REDIS_URL` to connect to Redis. + - This `CONNECTION_REDIS_URL` environment variable is populated by a Kubernetes Secret. + + You can deploy this application for the first time by following these steps: + + - Create the Kubernetes namespace `demo` + - Create the Kubernetes Secret `redis-secret` containing the Redis URL. + - Install the Helm chart. + + {{< alert title="💡 Redis" color="info" >}} + 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 >}} + +2. Complete these steps by running the following commands: + + ```bash + kubectl create namespace demo + kubectl create secret generic --namespace demo --from-literal=url=redis://fake-server redis-secret + helm upgrade demo ./Chart -n demo --install + ``` + + The output should look similar to the following: + + ``` + > kubectl create namespace demo + namespace/demo created + + > 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 + Release "demo" does not exist. Installing it now. + NAME: demo + LAST DEPLOYED: Wed Sep 13 01:05:19 2023 + NAMESPACE: demo + STATUS: deployed + REVISION: 1 + TEST SUITE: None + ``` + + {{< alert title="⚠️ Chart Directory" color="warning" >}} + If you see an error message like **Error: path "./Chart" not found** then you are in the wrong directory. Make sure your terminal is in the `./demo` directory of the `samples` repository. + {{< /alert >}} 3. Run the following command to check if everything is running: - ```bash - kubectl get all -n demo - ``` + ```bash + kubectl get all -n demo + ``` - The output should look similar to the following: + The output should look similar to the following: - ``` - > kubectl get all -n demo - NAME READY STATUS RESTARTS AGE - pod/webapp-79d5dfb99-vhj9g 1/1 Running 0 2m48s + ``` + > kubectl get all -n demo + NAME READY STATUS RESTARTS AGE + pod/webapp-79d5dfb99-vhj9g 1/1 Running 0 2m48s - NAME READY UP-TO-DATE AVAILABLE AGE - deployment.apps/webapp 1/1 1 1 2m49s + NAME READY UP-TO-DATE AVAILABLE AGE + deployment.apps/webapp 1/1 1 1 2m49s - NAME DESIRED CURRENT READY AGE - replicaset.apps/webapp-79d5dfb99 1 1 1 2m49s - ``` + NAME DESIRED CURRENT READY AGE + replicaset.apps/webapp-79d5dfb99 1 1 1 2m49s + ``` - > The generated names and ages of the objects will be different in your output. Make sure you see the status of `Running` for the `pod/webapp-...` entry. If the status is not `Running`, try repeating the `kubectl get all -n demo` after waiting. + > The generated names and ages of the objects will be different in your output. Make sure you see the status of `Running` for the `pod/webapp-...` entry. If the status is not `Running`, try repeating the `kubectl get all -n demo` after waiting. - At this point you've deployed the application but you have not actually used Radius yet. You will start doing that in the next step, as well as set up and use Redis. + At this point you've deployed the application but you have not actually used Radius yet. You will start doing that in the next step, as well as set up and use Redis. The steps so far are similar to how many applications are managed today: @@ -182,90 +182,90 @@ From here you will go through a series of steps to incrementally add more Radius 1. Make sure the `app.yaml` file from `./demo/Chart/templates/app.yaml` is open in your editor. You will make some edits to this file to enable Radius. - Add the `annotations` property to `metadata`, and then add the `radapp.io/enabled: 'true'` annotation. The `'true'` must be surrounded in quotes. + Add the `annotations` property to `metadata`, and then add the `radapp.io/enabled: 'true'` annotation. The `'true'` must be surrounded in quotes. - The example below shows the updated `metadata` section after making the changes. + The example below shows the updated `metadata` section after making the changes. - 

-  apiVersion: apps/v1
-  kind: Deployment
-  metadata:
-    name: webapp
-    namespace: {{ .Release.Namespace }}
-    annotations:
-      radapp.io/enabled: 'true'
-  spec:
-  ...
-
+ ```yaml + apiVersion: apps/v1 + kind: Deployment + metadata: + name: webapp + namespace: {{ .Release.Namespace }} + annotations: + radapp.io/enabled: 'true' + spec: + ... + ``` - Adding the `radapp.io/enabled: 'true'` annotation enables Radius for the deployment. + Adding the `radapp.io/enabled: 'true'` annotation enables Radius for the deployment. 2. Save the file after you have made the edits and deploy the application again using Helm. Since the namespace and secret have already been created, we only need to run the `helm` command. - ```bash - helm upgrade demo ./Chart -n demo --install - ``` + ```bash + helm upgrade demo ./Chart -n demo --install + ``` - The output should look like: + The output should look like: - ``` - > helm upgrade demo ./Chart -n demo --install - Release "demo" has been upgraded. Happy Helming! - NAME: demo - LAST DEPLOYED: Wed Sep 13 01:31:58 2023 - NAMESPACE: demo - STATUS: deployed - REVISION: 2 - TEST SUITE: None - ``` + ``` + > helm upgrade demo ./Chart -n demo --install + Release "demo" has been upgraded. Happy Helming! + NAME: demo + LAST DEPLOYED: Wed Sep 13 01:31:58 2023 + NAMESPACE: demo + STATUS: deployed + REVISION: 2 + TEST SUITE: None + ``` - You should confirm that your output contains `REVISION: 2`, that means that the changes were applied. + You should confirm that your output contains `REVISION: 2`, that means that the changes were applied. 3. Run the following command to confirm that everything is running: - ```bash - kubectl get all -n demo - ``` + ```bash + kubectl get all -n demo + ``` - The output should look similar to the following: + The output should look similar to the following: - ``` - > kubectl get all -n demo - NAME READY STATUS RESTARTS AGE - pod/webapp-79d5dfb99-mv6q9 1/1 Running 0 10m + ``` + > kubectl get all -n demo + NAME READY STATUS RESTARTS AGE + pod/webapp-79d5dfb99-mv6q9 1/1 Running 0 10m - NAME READY UP-TO-DATE AVAILABLE AGE - deployment.apps/webapp 1/1 1 1 10m + NAME READY UP-TO-DATE AVAILABLE AGE + deployment.apps/webapp 1/1 1 1 10m - NAME DESIRED CURRENT READY AGE - replicaset.apps/webapp-79d5dfb99 1 1 1 10m - ``` + NAME DESIRED CURRENT READY AGE + replicaset.apps/webapp-79d5dfb99 1 1 1 10m + ``` - Notice that the `AGE` of `pod/webapp-...` reflects the time of your **first** deployment. Enabling Radius for an application does not change any of its behaviors, so Kubernetes did not need to restart the container. + Notice that the `AGE` of `pod/webapp-...` reflects the time of your **first** deployment. Enabling Radius for an application does not change any of its behaviors, so Kubernetes did not need to restart the container. 4. Now that Radius has been enabled, run this command to display the state of the Radius application: - ```bash - rad app graph -a demo -g default-demo - ``` + ```bash + rad app graph -a demo -g default-demo + ``` - The output should look like this: + The output should look like this: - ``` - > rad app graph -a demo -g default-demo - Displaying application: demo + ``` + > rad app graph -a demo -g default-demo + Displaying application: demo - Name: webapp (Applications.Core/containers) - Connections: (none) - Resources: - webapp (kubernetes: apps/Deployment) - ``` + Name: webapp (Applications.Core/containers) + Connections: (none) + Resources: + webapp (kubernetes: apps/Deployment) + ``` - This means that Radius has found the Kubernetes `Deployment` running your container and cataloged it as part of the application. + This means that Radius has found the Kubernetes `Deployment` running your container and cataloged it as part of the application. - {{< alert title="💡 Application Name" color="info" >}} - Radius will use the Kubernetes namespace as the application name by default. - {{< /alert >}} + {{< alert title="💡 Application Name" color="info" >}} + Radius will use the Kubernetes namespace as the application name by default. + {{< /alert >}} ## Step 5. Add Recipe @@ -280,175 +280,175 @@ In this step you will: 1. First, check recipes installed in your environment by running: - ```bash - rad recipe list - ``` + ```bash + rad recipe list + ``` - You will see output like this: + You will see output like this: - ``` - NAME TYPE TEMPLATE KIND TEMPLATE VERSION TEMPLATE - default Applications.Datastores/sqlDatabases bicep radius.ghcr.io/recipes/local-dev/sqldatabases:latest - default Applications.Messaging/rabbitMQQueues bicep radius.ghcr.io/recipes/local-dev/rabbitmqqueues:latest - default Applications.Dapr/pubSubBrokers bicep radius.ghcr.io/recipes/local-dev/pubsubbrokers:latest - default Applications.Dapr/secretStores bicep radius.ghcr.io/recipes/local-dev/secretstores:latest - default Applications.Dapr/stateStores bicep radius.ghcr.io/recipes/local-dev/statestores:latest - default Applications.Datastores/mongoDatabases bicep radius.ghcr.io/recipes/local-dev/mongodatabases:latest - default Applications.Datastores/redisCaches bicep radius.ghcr.io/recipes/local-dev/rediscaches:latest - ``` + ``` + NAME TYPE TEMPLATE KIND TEMPLATE VERSION TEMPLATE + default Applications.Datastores/sqlDatabases bicep radius.ghcr.io/recipes/local-dev/sqldatabases:latest + default Applications.Messaging/rabbitMQQueues bicep radius.ghcr.io/recipes/local-dev/rabbitmqqueues:latest + default Applications.Dapr/pubSubBrokers bicep radius.ghcr.io/recipes/local-dev/pubsubbrokers:latest + default Applications.Dapr/secretStores bicep radius.ghcr.io/recipes/local-dev/secretstores:latest + default Applications.Dapr/stateStores bicep radius.ghcr.io/recipes/local-dev/statestores:latest + default Applications.Datastores/mongoDatabases bicep radius.ghcr.io/recipes/local-dev/mongodatabases:latest + default Applications.Datastores/redisCaches bicep radius.ghcr.io/recipes/local-dev/rediscaches:latest + ``` - The recipe for `Applications.Datastores/redisCaches` is what you will use in this example. + 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**](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. - {{< /alert >}} + {{< alert title="💡 Recipes" color="info" >}} + 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. + {{< /alert >}} 2. 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 `---`: - ```yaml - --- - apiVersion: radapp.io/v1alpha3 - kind: Recipe - metadata: - name: db - namespace: {{ .Release.Namespace }} - spec: - type: Applications.Datastores/redisCaches - secretName: redis-secret - ``` + ```yaml + --- + apiVersion: radapp.io/v1alpha3 + kind: Recipe + metadata: + name: db + namespace: {{ .Release.Namespace }} + spec: + type: Applications.Datastores/redisCaches + secretName: redis-secret + ``` - Defining a `Recipe` object in Kubernetes will use a Radius Recipe to create dependencies for your application: + Defining a `Recipe` object in Kubernetes will use a Radius Recipe to create dependencies for your application: - - The `.spec.type` field defines the type of resource to create. `Applications.Datastores/redisCaches` is the type for a Redis Cache. - - The `.spec.secretName` field tells Radius where to store connection information. This is optional, and should be used to interoperate with other Kubernetes technologies that read from secrets. This tutorial example uses the secret to populate an environment variable. + - The `.spec.type` field defines the type of resource to create. `Applications.Datastores/redisCaches` is the type for a Redis Cache. + - The `.spec.secretName` field tells Radius where to store connection information. This is optional, and should be used to interoperate with other Kubernetes technologies that read from secrets. This tutorial example uses the secret to populate an environment variable. 3. Save the file after you have made the edits and deploy the application again using Helm. Since the namespace and secret have already been created, you only need to run the `helm` command. - ```bash - helm upgrade demo ./Chart -n demo --install - ``` + ```bash + helm upgrade demo ./Chart -n demo --install + ``` - The output should look like: + The output should look like: - ``` - > helm upgrade demo ./Chart -n demo --install - Release "demo" has been upgraded. Happy Helming! - NAME: demo - LAST DEPLOYED: Wed Sep 13 01:44:04 2023 - NAMESPACE: demo - STATUS: deployed - REVISION: 3 - TEST SUITE: None - ``` + ``` + > helm upgrade demo ./Chart -n demo --install + Release "demo" has been upgraded. Happy Helming! + NAME: demo + LAST DEPLOYED: Wed Sep 13 01:44:04 2023 + NAMESPACE: demo + STATUS: deployed + REVISION: 3 + TEST SUITE: None + ``` - This time you should see `REVISION: 3`. + This time you should see `REVISION: 3`. 4. Now that you are using a Recipe, you should see more resources running in Kubernetes. Run the following command: - ```bash - kubectl get all -n demo - ``` + ```bash + kubectl get all -n demo + ``` - The output should look similar to the following: + The output should look similar to the following: - ``` - > kubectl get all -n demo + ``` + > kubectl get all -n demo - pod/redis-r5tcrra3d7uh6-7bcd8b8d8d-jmgn4 2/2 Running 0 51s - pod/webapp-79d5dfb99-f6xgj 1/1 Running 0 52s + pod/redis-r5tcrra3d7uh6-7bcd8b8d8d-jmgn4 2/2 Running 0 51s + pod/webapp-79d5dfb99-f6xgj 1/1 Running 0 52s - NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE - service/redis-r5tcrra3d7uh6 ClusterIP 10.43.104.63 6379/TCP 51s + NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE + service/redis-r5tcrra3d7uh6 ClusterIP 10.43.104.63 6379/TCP 51s - NAME READY UP-TO-DATE AVAILABLE AGE - deployment.apps/redis-r5tcrra3d7uh6 1/1 1 1 51s - deployment.apps/webapp 1/1 1 1 52s + NAME READY UP-TO-DATE AVAILABLE AGE + deployment.apps/redis-r5tcrra3d7uh6 1/1 1 1 51s + deployment.apps/webapp 1/1 1 1 52s - NAME DESIRED CURRENT READY AGE - replicaset.apps/redis-r5tcrra3d7uh6-7bcd8b8d8d 1 1 1 51s - replicaset.apps/webapp-79d5dfb99 1 1 1 52s + NAME DESIRED CURRENT READY AGE + replicaset.apps/redis-r5tcrra3d7uh6-7bcd8b8d8d 1 1 1 51s + replicaset.apps/webapp-79d5dfb99 1 1 1 52s - NAME TYPE SECRET STATUS - recipe.radapp.io/db Applications.Datastores/redisCaches redis-secret Ready - ``` + NAME TYPE SECRET STATUS + recipe.radapp.io/db Applications.Datastores/redisCaches redis-secret Ready + ``` - Look at the status of the `recipe.radapp.io/db` resource. If the status is not `Ready`, then try running the command again after a delay. The status should show as `Ready` when the Recipe has fully-deployed. You can also see additional resources starting with `redis-`. These were created by the Recipe. + Look at the status of the `recipe.radapp.io/db` resource. If the status is not `Ready`, then try running the command again after a delay. The status should show as `Ready` when the Recipe has fully-deployed. You can also see additional resources starting with `redis-`. These were created by the Recipe. - {{< alert title="⚠️ Missing resources" color="warning" >}} - If you do not see the additional resources starting with `redis-` then it's likely they are in a different Kubernetes namespace. Run `kubectl get all -A` to see everything. - {{< /alert >}} + {{< alert title="⚠️ Missing resources" color="warning" >}} + If you do not see the additional resources starting with `redis-` then it's likely they are in a different Kubernetes namespace. Run `kubectl get all -A` to see everything. + {{< /alert >}} 5. Now that you have added a Recipe, run this command to display the state of the Radius application: - ```bash - rad app graph -a demo -g default-demo - ``` + ```bash + rad app graph -a demo -g default-demo + ``` - The output should look like this: + The output should look like this: - ``` - > rad app graph -a demo -g default-demo - Displaying application: demo + ``` + > rad app graph -a demo -g default-demo + Displaying application: demo - Name: webapp (Applications.Core/containers) - Connections: (none) - Resources: - webapp (kubernetes: apps/Deployment) + Name: webapp (Applications.Core/containers) + Connections: (none) + Resources: + webapp (kubernetes: apps/Deployment) - Name: db (Applications.Datastores/redisCaches) - Connections: (none) - Resources: - redis-r5tcrra3d7uh6 (kubernetes: apps/Deployment) - redis-r5tcrra3d7uh6 (kubernetes: core/Service) - ``` + Name: db (Applications.Datastores/redisCaches) + Connections: (none) + Resources: + redis-r5tcrra3d7uh6 (kubernetes: apps/Deployment) + redis-r5tcrra3d7uh6 (kubernetes: core/Service) + ``` - `rad app graph` shows the **Application Graph** of the application. This includes: + `rad app graph` shows the **Application Graph** of the application. This includes: - - Entries for each major resource: `webapp` is an `Applications.Core/containers` and `db` is an `Applications.Datastores/redisCaches`. - - Connections between resources: (none yet, you will add this next). - - Resources that were created: see the Kubernetes `Deployment` listed for `webapp` and the Kubernetes `Deployment` and `Service` listed for `db`. + - Entries for each major resource: `webapp` is an `Applications.Core/containers` and `db` is an `Applications.Datastores/redisCaches`. + - Connections between resources: (none yet, you will add this next). + - Resources that were created: see the Kubernetes `Deployment` listed for `webapp` and the Kubernetes `Deployment` and `Service` listed for `db`. - The Redis Cache created by the recipe is visible as part of the application. You can also see the `Resources` created in Kubernetes that make up the Redis Cache. In a previous step you saw these listed by `kubectl`. Since Radius deployed the Recipe, it knows that these resources *logically* are part of the Redis Cache in the application. + The Redis Cache created by the recipe is visible as part of the application. You can also see the `Resources` created in Kubernetes that make up the Redis Cache. In a previous step you saw these listed by `kubectl`. Since Radius deployed the Recipe, it knows that these resources *logically* are part of the Redis Cache in the application. 6. You can also see the contents of `redis-secret` as created by Radius. Run the following command: - ```bash - kubectl get secret -n demo redis-secret -o yaml - ``` - - The output should look like the following: - - ``` - >kubectl get secret -n demo redis-secret -o yaml - apiVersion: v1 - data: - connectionString: cmVkaXMtcjV0Y3JyYTNkN3VoNi5kZW1vLnN2Yy5jbHVzdGVyLmxvY2FsOjYzNzksYWJvcnRDb25uZWN0PUZhbHNl - host: cmVkaXMtcjV0Y3JyYTNkN3VoNi5kZW1vLnN2Yy5jbHVzdGVyLmxvY2Fs - password: "" - port: NjM3OQ== - tls: ZmFsc2U= - url: cmVkaXM6Ly9yZWRpcy1yNXRjcnJhM2Q3dWg2LmRlbW8uc3ZjLmNsdXN0ZXIubG9jYWw6NjM3OS8wPw== - username: "" - kind: Secret - metadata: - creationTimestamp: "2023-09-13T01:49:36Z" - name: redis-secret - namespace: demo - ownerReferences: - - apiVersion: radapp.io/v1alpha3 - blockOwnerDeletion: true - controller: true - kind: Recipe - name: db - uid: d40567a1-cd52-4984-8321-6cb8bea5f798 - resourceVersion: "3672" - uid: b1613fb0-09e6-4f76-8685-02f458e173b9 - type: Opaque - ``` - - The actual values like `connectionString` are Base64 encoded in this display. The `url` value in this secret is being used by the container to connect to the Redis Cache. For each type of Recipe, Radius stores the most-commonly used connection information for the convenience of application developers. + ```bash + kubectl get secret -n demo redis-secret -o yaml + ``` + + The output should look like the following: + + ``` + >kubectl get secret -n demo redis-secret -o yaml + apiVersion: v1 + data: + connectionString: cmVkaXMtcjV0Y3JyYTNkN3VoNi5kZW1vLnN2Yy5jbHVzdGVyLmxvY2FsOjYzNzksYWJvcnRDb25uZWN0PUZhbHNl + host: cmVkaXMtcjV0Y3JyYTNkN3VoNi5kZW1vLnN2Yy5jbHVzdGVyLmxvY2Fs + password: "" + port: NjM3OQ== + tls: ZmFsc2U= + url: cmVkaXM6Ly9yZWRpcy1yNXRjcnJhM2Q3dWg2LmRlbW8uc3ZjLmNsdXN0ZXIubG9jYWw6NjM3OS8wPw== + username: "" + kind: Secret + metadata: + creationTimestamp: "2023-09-13T01:49:36Z" + name: redis-secret + namespace: demo + ownerReferences: + - apiVersion: radapp.io/v1alpha3 + blockOwnerDeletion: true + controller: true + kind: Recipe + name: db + uid: d40567a1-cd52-4984-8321-6cb8bea5f798 + resourceVersion: "3672" + uid: b1613fb0-09e6-4f76-8685-02f458e173b9 + type: Opaque + ``` + + The actual values like `connectionString` are Base64 encoded in this display. The `url` value in this secret is being used by the container to connect to the Redis Cache. For each type of Recipe, Radius stores the most-commonly used connection information for the convenience of application developers. ## Step 6. Add Connection @@ -458,146 +458,146 @@ Make sure the `app.yaml` file from `./demo/Chart/templates/app.yaml` is open in 1. First, add another annotation. This time add the `radapp.io/connection-redis: 'db'` annotation, to `.metadata.annotations`. Order does not matter but indentation does. - Here's the updated content of `metadata`: + Here's the updated content of `metadata`: - ```yaml - apiVersion: apps/v1 - kind: Deployment - metadata: - name: webapp - namespace: {{ .Release.Namespace }} - annotations: - radapp.io/enabled: 'true' - radapp.io/connection-redis: 'db' - spec: - ... - ``` + ```yaml + apiVersion: apps/v1 + kind: Deployment + metadata: + name: webapp + namespace: {{ .Release.Namespace }} + annotations: + radapp.io/enabled: 'true' + radapp.io/connection-redis: 'db' + spec: + ... + ``` - The `radapp.io/connection-` annotation defines a connection from the container to some other dependency. Each connection has: + The `radapp.io/connection-` annotation defines a connection from the container to some other dependency. Each connection has: - - A name: `redis` is the connection name this case. - - A source: `db` is the name of the Recipe you created earlier. + - A name: `redis` is the connection name this case. + - A source: `db` is the name of the Recipe you created earlier. - Connections are named because you can define many of them. The connection name is used to generate environment variables that are unique to the connection. + Connections are named because you can define many of them. The connection name is used to generate environment variables that are unique to the connection. - Since you're using a connection called `redis`, Radius will automatically define the `CONNECTION_REDIS_URL` environment variable. The prefix of `CONNECTION_REDIS_` will be combined with each of the settings that you could see in the `redis-secret` secret in the previous step. + Since you're using a connection called `redis`, Radius will automatically define the `CONNECTION_REDIS_URL` environment variable. The prefix of `CONNECTION_REDIS_` will be combined with each of the settings that you could see in the `redis-secret` secret in the previous step. 2. You can remove the manual definition of `CONNECTION_REDIS_URL` from `app.yaml` since Radius will provide it automatically. Find the `env` property and delete all of its contents. You can also remove `.spec.secretName` from the `Recipe`. - The final contents of `app.yaml` should look like: - - ```yaml - apiVersion: apps/v1 - kind: Deployment - metadata: - name: webapp - namespace: {{ .Release.Namespace }} - annotations: - radapp.io/enabled: 'true' - radapp.io/connection-redis: 'db' - spec: - selector: - matchLabels: - app: webapp - template: - metadata: - labels: + The final contents of `app.yaml` should look like: + + ```yaml + apiVersion: apps/v1 + kind: Deployment + metadata: + name: webapp + namespace: {{ .Release.Namespace }} + annotations: + radapp.io/enabled: 'true' + radapp.io/connection-redis: 'db' + spec: + selector: + matchLabels: app: webapp - spec: - containers: - - name: webapp - image: {{ .Values.image.repository }}:{{ .Values.image.tag }} - ports: - - containerPort: 3000 - --- - apiVersion: radapp.io/v1alpha3 - kind: Recipe - metadata: - name: db - namespace: {{ .Release.Namespace }} - spec: - type: Applications.Datastores/redisCaches - ``` + template: + metadata: + labels: + app: webapp + spec: + containers: + - name: webapp + image: {{ .Values.image.repository }}:{{ .Values.image.tag }} + ports: + - containerPort: 3000 + --- + apiVersion: radapp.io/v1alpha3 + kind: Recipe + metadata: + name: db + namespace: {{ .Release.Namespace }} + spec: + type: Applications.Datastores/redisCaches + ``` 3. Save the file after you have made the edits and deploy the application again using Helm. - ```bash - helm upgrade demo ./Chart -n demo --install - ``` + ```bash + helm upgrade demo ./Chart -n demo --install + ``` - The output should look like: + The output should look like: - ``` - > helm upgrade demo ./Chart -n demo --install - Release "demo" has been upgraded. Happy Helming! - NAME: demo - LAST DEPLOYED: Wed Sep 13 02:09:41 2023 - NAMESPACE: demo - STATUS: deployed - REVISION: 4 - TEST SUITE: None - ``` + ``` + > helm upgrade demo ./Chart -n demo --install + Release "demo" has been upgraded. Happy Helming! + NAME: demo + LAST DEPLOYED: Wed Sep 13 02:09:41 2023 + NAMESPACE: demo + STATUS: deployed + REVISION: 4 + TEST SUITE: None + ``` - This time you should see `REVISION: 4`. + This time you should see `REVISION: 4`. - Check the status in Kubernetes again by running: + Check the status in Kubernetes again by running: - ```bash - kubectl get all -n demo - ``` + ```bash + kubectl get all -n demo + ``` - The output should look like: + The output should look like: - ``` - > kubectl get all -n demo - NAME READY STATUS RESTARTS AGE - pod/redis-r5tcrra3d7uh6-7bcd8b8d8d-jmgn4 2/2 Running 0 20m - pod/webapp-76db7964d8-plc2s 1/1 Running 0 37s + ``` + > kubectl get all -n demo + NAME READY STATUS RESTARTS AGE + pod/redis-r5tcrra3d7uh6-7bcd8b8d8d-jmgn4 2/2 Running 0 20m + pod/webapp-76db7964d8-plc2s 1/1 Running 0 37s - NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE - service/redis-r5tcrra3d7uh6 ClusterIP 10.43.104.63 6379/TCP 20m + NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE + service/redis-r5tcrra3d7uh6 ClusterIP 10.43.104.63 6379/TCP 20m - NAME READY UP-TO-DATE AVAILABLE AGE - deployment.apps/redis-r5tcrra3d7uh6 1/1 1 1 20m - deployment.apps/webapp 1/1 1 1 20m + NAME READY UP-TO-DATE AVAILABLE AGE + deployment.apps/redis-r5tcrra3d7uh6 1/1 1 1 20m + deployment.apps/webapp 1/1 1 1 20m - NAME DESIRED CURRENT READY AGE - replicaset.apps/redis-r5tcrra3d7uh6-7bcd8b8d8d 1 1 1 20m - replicaset.apps/webapp-79d5dfb99 0 0 0 20m - replicaset.apps/webapp-76db7964d8 1 1 1 37s - replicaset.apps/webapp-687dcf5cdf 0 0 0 38s + NAME DESIRED CURRENT READY AGE + replicaset.apps/redis-r5tcrra3d7uh6-7bcd8b8d8d 1 1 1 20m + replicaset.apps/webapp-79d5dfb99 0 0 0 20m + replicaset.apps/webapp-76db7964d8 1 1 1 37s + replicaset.apps/webapp-687dcf5cdf 0 0 0 38s - NAME TYPE SECRET STATUS - recipe.radapp.io/db Applications.Datastores/redisCaches Ready - ``` + NAME TYPE SECRET STATUS + recipe.radapp.io/db Applications.Datastores/redisCaches Ready + ``` - Depending on the timing you may see pods in the `Terminating` state. This is normal as old replicas take some time to shut down. + Depending on the timing you may see pods in the `Terminating` state. This is normal as old replicas take some time to shut down. 4. Check the Radius status again. Now Radius is aware of the connection from `webapp->db`: - ```bash - rad app graph -a demo -g default-demo - ``` + ```bash + rad app graph -a demo -g default-demo + ``` - The output should look like the example below: + The output should look like the example below: - ``` - > rad app graph -a demo -g default-demo - Displaying application: demo + ``` + > rad app graph -a demo -g default-demo + Displaying application: demo - Name: webapp (Applications.Core/containers) - Connections: - webapp -> db (Applications.Datastores/redisCaches) - Resources: - webapp (kubernetes: apps/Deployment) + Name: webapp (Applications.Core/containers) + Connections: + webapp -> db (Applications.Datastores/redisCaches) + Resources: + webapp (kubernetes: apps/Deployment) - Name: db (Applications.Datastores/redisCaches) - Connections: - webapp (Applications.Core/containers) -> db - Resources: - redis-r5tcrra3d7uh6 (kubernetes: apps/Deployment) - redis-r5tcrra3d7uh6 (kubernetes: core/Service) - ``` + Name: db (Applications.Datastores/redisCaches) + Connections: + webapp (Applications.Core/containers) -> db + Resources: + redis-r5tcrra3d7uh6 (kubernetes: apps/Deployment) + redis-r5tcrra3d7uh6 (kubernetes: core/Service) + ``` ## Step 7. Try it out @@ -605,38 +605,38 @@ In this step you can access the application and explore its features. Since the 1. Run the following command to start the port-forward: - ```bash - kubectl port-forward -n demo deployment/webapp 3000 - ``` + ```bash + kubectl port-forward -n demo deployment/webapp 3000 + ``` - If you are inside Codespaces this will open a new browser tab that you can use to access the webapp. + If you are inside Codespaces this will open a new browser tab that you can use to access the webapp. - If you are not using Codespaces then open your browser and navigate to `http://localhost:3000` + If you are not using Codespaces then open your browser and navigate to `http://localhost:3000` - Screenshot of the demo container -

+ Screenshot of the demo container +

- Congrats! You're running your first Radius app. + Congrats! You're running your first Radius app. - You can use the homepage to view information about the container and its settings. + You can use the homepage to view information about the container and its settings. 2. Navigate to the ToDo List tab and test out the application. Using the ToDo page will update the saved state in Redis. - Screenshot of the todolist -

+ Screenshot of the todolist +

- When you're ready to move on to the next step, use `CTRL+C` to exit the command. + When you're ready to move on to the next step, use `CTRL+C` to exit the command. ## Cleanup and next steps To delete your app, run the following command: +> This command also cleans up all the resources created by the Radius Recipe you deployed earlier. + ```bash helm uninstall demo -n demo ``` -> This command also cleans up all the resources created by the Radius Recipe you deployed earlier. - In summary, this tutorial walked through a hands-on example to show you how-to: - Enable Radius for a Helm or Kubernetes-based application to catalog your assets.