From e939a6f6020645f892e16d2dbcdf2c5dc8f7490f Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Mon, 12 Feb 2024 19:03:22 +0000 Subject: [PATCH 1/7] Added small blurb on storing env variables as secrets for connections. Signed-off-by: jasonviviano <83607984+jasonviviano@users.noreply.github.com> --- docs/content/guides/author-apps/containers/overview/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/guides/author-apps/containers/overview/index.md b/docs/content/guides/author-apps/containers/overview/index.md index 2a7285725..6675103bb 100644 --- a/docs/content/guides/author-apps/containers/overview/index.md +++ b/docs/content/guides/author-apps/containers/overview/index.md @@ -90,7 +90,7 @@ Refer to the probes section of the [container resource schema]({{< ref "containe ## Connections -When a connection between two resources is declared, Radius injects resource related information into environment variables that are then used to access the respective resource without having to hard code URIs, connection strings, access keys, or anything that application code needs to successfully communicate. +When a connection between two resources is declared, Radius injects resource related information into environment variables that are then used to access the respective resource without having to hard code URIs, connection strings, access keys, or anything that application code needs to successfully and securely communicate, which is done by storing these environment variables as secrets inside of the Radius Environment. These environment variables follow a naming convention that makes their use predictable. The naming pattern is derived from the connection name and resource type, which determines what values are required. This way the code that needs to read the values gets to define how they are named. Refer to the [reference documentation]({{< ref resource-schema >}}) of each resource for more information. From c1bc9fb44a0e91964438c8c4473007905219a302 Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Thu, 15 Feb 2024 19:00:15 +0000 Subject: [PATCH 2/7] Blurb on environment variables being stored as secrets in Kubernetes env with a generic blurb on secure storing for the container overview. Signed-off-by: jasonviviano <83607984+jasonviviano@users.noreply.github.com> --- docs/content/guides/author-apps/containers/overview/index.md | 2 +- docs/content/guides/operations/kubernetes/overview/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/content/guides/author-apps/containers/overview/index.md b/docs/content/guides/author-apps/containers/overview/index.md index 6675103bb..55afb2a46 100644 --- a/docs/content/guides/author-apps/containers/overview/index.md +++ b/docs/content/guides/author-apps/containers/overview/index.md @@ -90,7 +90,7 @@ Refer to the probes section of the [container resource schema]({{< ref "containe ## Connections -When a connection between two resources is declared, Radius injects resource related information into environment variables that are then used to access the respective resource without having to hard code URIs, connection strings, access keys, or anything that application code needs to successfully and securely communicate, which is done by storing these environment variables as secrets inside of the Radius Environment. +When a connection between two resources is declared, Radius injects resource related information into environment variables that are then used to access the respective resource without having to hard code URIs, connection strings, access keys, or anything that application code needs to successfully and securely communicate, which is done by storing these environment variables as securely inside of the Radius Environment. These environment variables follow a naming convention that makes their use predictable. The naming pattern is derived from the connection name and resource type, which determines what values are required. This way the code that needs to read the values gets to define how they are named. Refer to the [reference documentation]({{< ref resource-schema >}}) of each resource for more information. diff --git a/docs/content/guides/operations/kubernetes/overview/index.md b/docs/content/guides/operations/kubernetes/overview/index.md index 42f51d26e..852d54b07 100644 --- a/docs/content/guides/operations/kubernetes/overview/index.md +++ b/docs/content/guides/operations/kubernetes/overview/index.md @@ -18,7 +18,7 @@ Kubernetes version `1.23.8` or higher is recommended to run Radius. ## Resource mapping -Radius resources, when deployed to a Kubernetes environment, are mapped to one or more Kubernetes objects. The following table describes the mapping between Radius resources and Kubernetes objects: +Radius resources, when deployed to a Kubernetes environment, are mapped to one or more Kubernetes objects.If a connection is established between Radius resources they are stored as Secret objects if they are Radius automatically-configured values and regular Kubernetes objects if they are manually configured by a user. The following table describes the mapping between Radius resources and Kubernetes objects: | Radius resource | Kubernetes object | |----------------------------------|-------------------| From d497a818bf6ff6c997bb23b2dba6d3242f34c953 Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Thu, 15 Feb 2024 14:01:38 -0500 Subject: [PATCH 3/7] Update docs/content/guides/author-apps/containers/overview/index.md Signed-off-by: jasonviviano <83607984+jasonviviano@users.noreply.github.com> --- docs/content/guides/author-apps/containers/overview/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/guides/author-apps/containers/overview/index.md b/docs/content/guides/author-apps/containers/overview/index.md index 55afb2a46..37bc9be8c 100644 --- a/docs/content/guides/author-apps/containers/overview/index.md +++ b/docs/content/guides/author-apps/containers/overview/index.md @@ -90,7 +90,7 @@ Refer to the probes section of the [container resource schema]({{< ref "containe ## Connections -When a connection between two resources is declared, Radius injects resource related information into environment variables that are then used to access the respective resource without having to hard code URIs, connection strings, access keys, or anything that application code needs to successfully and securely communicate, which is done by storing these environment variables as securely inside of the Radius Environment. +When a connection between two resources is declared, Radius injects resource related information into environment variables that are then used to access the respective resource without having to hard code URIs, connection strings, access keys, or anything that application code needs to successfully and securely communicate, which is done by storing these environment variables safely inside of the Radius Environment. These environment variables follow a naming convention that makes their use predictable. The naming pattern is derived from the connection name and resource type, which determines what values are required. This way the code that needs to read the values gets to define how they are named. Refer to the [reference documentation]({{< ref resource-schema >}}) of each resource for more information. From 2a0b93a18fd021ccbbfbf407483e64fc76c5ce47 Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Mon, 19 Feb 2024 15:24:10 +0000 Subject: [PATCH 4/7] Added addiontal `connections` details to the `container` table section. Signed-off-by: jasonviviano <83607984+jasonviviano@users.noreply.github.com> --- docs/content/guides/operations/kubernetes/overview/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/content/guides/operations/kubernetes/overview/index.md b/docs/content/guides/operations/kubernetes/overview/index.md index 852d54b07..e5ebf6876 100644 --- a/docs/content/guides/operations/kubernetes/overview/index.md +++ b/docs/content/guides/operations/kubernetes/overview/index.md @@ -18,11 +18,11 @@ Kubernetes version `1.23.8` or higher is recommended to run Radius. ## Resource mapping -Radius resources, when deployed to a Kubernetes environment, are mapped to one or more Kubernetes objects.If a connection is established between Radius resources they are stored as Secret objects if they are Radius automatically-configured values and regular Kubernetes objects if they are manually configured by a user. The following table describes the mapping between Radius resources and Kubernetes objects: +Radius resources, when deployed to a Kubernetes environment, are mapped to one or more Kubernetes objects. The following table describes the mapping between Radius resources and Kubernetes objects: | Radius resource | Kubernetes object | |----------------------------------|-------------------| -| [`Applications.Core/containers`]({{< ref container-schema >}}) | `apps/Deployment@v1`
`core/Service@v1` _(if ports defined)_ | +| [`Applications.Core/containers`]({{< ref container-schema >}}) | `apps/Deployment@v1`

`core/Service@v1` _(if ports defined)_

The `connections` property allows users to declare a connection between two resources, which Radius uses to inject resource related information into environment variables. This information is stored in a Kubernetes secret object if it is automatically-configured data and a non-secret Kubernetes object if its manually configured data. They are then used to access the respective resource information without having to hard code URIs, connection strings, access keys, or anything that an application code needs to successfully communicate. | | [`Applications.Core/gateways`]({{< ref gateway >}}) | `projectcontour.io/HTTPProxy@v1` | | [`Applications.Dapr/pubSubBrokers`]({{< ref dapr-pubsub >}}) | `dapr.io/Component@v1alpha1` | | [`Applications.Dapr/secretStores`]({{< ref dapr-secretstore >}}) | `dapr.io/Component@v1alpha1` | From 7817c59457bbd8bfbb1832c6a2ec37e8c7e9b68d Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Mon, 26 Feb 2024 15:50:53 +0000 Subject: [PATCH 5/7] Rephrased sentence. Signed-off-by: jasonviviano <83607984+jasonviviano@users.noreply.github.com> --- docs/content/guides/author-apps/containers/overview/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/guides/author-apps/containers/overview/index.md b/docs/content/guides/author-apps/containers/overview/index.md index 37bc9be8c..3e850ab53 100644 --- a/docs/content/guides/author-apps/containers/overview/index.md +++ b/docs/content/guides/author-apps/containers/overview/index.md @@ -90,7 +90,7 @@ Refer to the probes section of the [container resource schema]({{< ref "containe ## Connections -When a connection between two resources is declared, Radius injects resource related information into environment variables that are then used to access the respective resource without having to hard code URIs, connection strings, access keys, or anything that application code needs to successfully and securely communicate, which is done by storing these environment variables safely inside of the Radius Environment. +When a connection between two resources is declared, Radius injects resource-related information into environment variables. These variables are used to access the respective resource without hard coding URIs, connection strings, access keys, or any other details needed for secure communication, which is securely managed within the Radius Environment. These environment variables follow a naming convention that makes their use predictable. The naming pattern is derived from the connection name and resource type, which determines what values are required. This way the code that needs to read the values gets to define how they are named. Refer to the [reference documentation]({{< ref resource-schema >}}) of each resource for more information. From 0ace8740d3b904db5d08c9124950d773e099f210 Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Wed, 28 Feb 2024 15:27:00 +0000 Subject: [PATCH 6/7] Fixed table with a more simplified style for the added configuration Signed-off-by: jasonviviano <83607984+jasonviviano@users.noreply.github.com> --- docs/content/guides/operations/kubernetes/overview/index.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/content/guides/operations/kubernetes/overview/index.md b/docs/content/guides/operations/kubernetes/overview/index.md index e5ebf6876..82f85b809 100644 --- a/docs/content/guides/operations/kubernetes/overview/index.md +++ b/docs/content/guides/operations/kubernetes/overview/index.md @@ -20,9 +20,10 @@ Kubernetes version `1.23.8` or higher is recommended to run Radius. Radius resources, when deployed to a Kubernetes environment, are mapped to one or more Kubernetes objects. The following table describes the mapping between Radius resources and Kubernetes objects: -| Radius resource | Kubernetes object | +| Radius resources/configurations | Kubernetes object | |----------------------------------|-------------------| -| [`Applications.Core/containers`]({{< ref container-schema >}}) | `apps/Deployment@v1`

`core/Service@v1` _(if ports defined)_

The `connections` property allows users to declare a connection between two resources, which Radius uses to inject resource related information into environment variables. This information is stored in a Kubernetes secret object if it is automatically-configured data and a non-secret Kubernetes object if its manually configured data. They are then used to access the respective resource information without having to hard code URIs, connection strings, access keys, or anything that an application code needs to successfully communicate. | +| [`Applications.Core/containers`]({{< ref container-schema >}}) | `apps/Deployment@v1`

`core/Service@v1` _(if ports defined)_ | +| [`Applications.Core/containers.connections`]({{< ref "container-schema#properties" >}}) | `core/Secret@v1`
Mounted to the container as an environment variable, visit the [connections guide]({{< ref howto-connect-dependencies >}}) to learn more| | [`Applications.Core/gateways`]({{< ref gateway >}}) | `projectcontour.io/HTTPProxy@v1` | | [`Applications.Dapr/pubSubBrokers`]({{< ref dapr-pubsub >}}) | `dapr.io/Component@v1alpha1` | | [`Applications.Dapr/secretStores`]({{< ref dapr-secretstore >}}) | `dapr.io/Component@v1alpha1` | From e0320753c504a5fad62920823467c2f836c2566f Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Fri, 1 Mar 2024 15:52:32 -0500 Subject: [PATCH 7/7] Apply suggestions from code review Co-authored-by: Aaron Crawfis Signed-off-by: jasonviviano <83607984+jasonviviano@users.noreply.github.com> --- docs/content/guides/author-apps/containers/overview/index.md | 2 +- docs/content/guides/operations/kubernetes/overview/index.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/content/guides/author-apps/containers/overview/index.md b/docs/content/guides/author-apps/containers/overview/index.md index 3e850ab53..a1d10f08a 100644 --- a/docs/content/guides/author-apps/containers/overview/index.md +++ b/docs/content/guides/author-apps/containers/overview/index.md @@ -90,7 +90,7 @@ Refer to the probes section of the [container resource schema]({{< ref "containe ## Connections -When a connection between two resources is declared, Radius injects resource-related information into environment variables. These variables are used to access the respective resource without hard coding URIs, connection strings, access keys, or any other details needed for secure communication, which is securely managed within the Radius Environment. +When a connection is declared from a container to another Radius resource, Radius injects environment variables with connection information to make it easy to access the target resource. These variables can be used by your code to access the resource without manually hard-coding or mounting URIs, connection strings, access keys, or other values. Connection information is securely managed by the Radius Environment, ensuring it is stored and mounted correctly. These environment variables follow a naming convention that makes their use predictable. The naming pattern is derived from the connection name and resource type, which determines what values are required. This way the code that needs to read the values gets to define how they are named. Refer to the [reference documentation]({{< ref resource-schema >}}) of each resource for more information. diff --git a/docs/content/guides/operations/kubernetes/overview/index.md b/docs/content/guides/operations/kubernetes/overview/index.md index 82f85b809..0fc231210 100644 --- a/docs/content/guides/operations/kubernetes/overview/index.md +++ b/docs/content/guides/operations/kubernetes/overview/index.md @@ -20,10 +20,10 @@ Kubernetes version `1.23.8` or higher is recommended to run Radius. Radius resources, when deployed to a Kubernetes environment, are mapped to one or more Kubernetes objects. The following table describes the mapping between Radius resources and Kubernetes objects: -| Radius resources/configurations | Kubernetes object | +| Radius resource/configuration | Kubernetes object | |----------------------------------|-------------------| | [`Applications.Core/containers`]({{< ref container-schema >}}) | `apps/Deployment@v1`

`core/Service@v1` _(if ports defined)_ | -| [`Applications.Core/containers.connections`]({{< ref "container-schema#properties" >}}) | `core/Secret@v1`
Mounted to the container as an environment variable, visit the [connections guide]({{< ref howto-connect-dependencies >}}) to learn more| +| `Applications.Core/containers` connections | `core/Secret@v1`
Mounted to the container as environment variables. Refer to the [connections guide]({{< ref howto-connect-dependencies >}}) to learn more. | | [`Applications.Core/gateways`]({{< ref gateway >}}) | `projectcontour.io/HTTPProxy@v1` | | [`Applications.Dapr/pubSubBrokers`]({{< ref dapr-pubsub >}}) | `dapr.io/Component@v1alpha1` | | [`Applications.Dapr/secretStores`]({{< ref dapr-secretstore >}}) | `dapr.io/Component@v1alpha1` |