Skip to content

Commit

Permalink
Added small blurb on storing env variables as secrets for connections. (
Browse files Browse the repository at this point in the history
#1042)

* Added small blurb on storing env variables as secrets for connections.

Signed-off-by: jasonviviano <[email protected]>

* 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 <[email protected]>

* Update docs/content/guides/author-apps/containers/overview/index.md

Signed-off-by: jasonviviano <[email protected]>

* Added addiontal `connections` details to the `container` table section.

Signed-off-by: jasonviviano <[email protected]>

* Rephrased sentence.

Signed-off-by: jasonviviano <[email protected]>

* Fixed table with a more simplified style for the added configuration

Signed-off-by: jasonviviano <[email protected]>

* Apply suggestions from code review

Co-authored-by: Aaron Crawfis <[email protected]>
Signed-off-by: jasonviviano <[email protected]>

---------

Signed-off-by: jasonviviano <[email protected]>
Co-authored-by: Aaron Crawfis <[email protected]>
  • Loading branch information
jasonviviano and AaronCrawfis authored Mar 4, 2024
1 parent f4f713c commit 25d84c2
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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 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.

Expand Down
5 changes: 3 additions & 2 deletions docs/content/guides/operations/kubernetes/overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 resource/configuration | Kubernetes object |
|----------------------------------|-------------------|
| [`Applications.Core/containers`]({{< ref container-schema >}}) | `apps/Deployment@v1`<br />`core/Service@v1` _(if ports defined)_ |
| [`Applications.Core/containers`]({{< ref container-schema >}}) | `apps/Deployment@v1`<br /> <br /> `core/Service@v1` _(if ports defined)_ |
| `Applications.Core/containers` connections | `core/Secret@v1` <br /> 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` |
Expand Down

0 comments on commit 25d84c2

Please sign in to comment.