Skip to content

Commit

Permalink
Merge branch 'edge' into superbeeny/secrets
Browse files Browse the repository at this point in the history
  • Loading branch information
superbeeny authored Sep 10, 2024
2 parents dcf439b + e4808b3 commit c485f14
Show file tree
Hide file tree
Showing 13 changed files with 188 additions and 18 deletions.
17 changes: 17 additions & 0 deletions .github/config/en-custom.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1270,3 +1270,20 @@ postgres
ReadOnly
DeployTimeConstant
postgres
DaprResourceAuth
DaprPubSubBrokerPropertiesMetadata
MetadataValue
MetadataValueFromSecret
secretKeyRef
DaprSecretStorePropertiesMetadata
awsIRSA
azureWorkloadIdentity
basicAuthentication
EnvironmentVariable
EnvironmentVariableReference
secretRef
DaprStateStorePropertiesMetadata
BicepConfigProperties
BicepConfigPropertiesAuthentication
RegistrySecretConfig

4 changes: 2 additions & 2 deletions docs/content/reference/cli/rad_install_kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ Installs Radius onto a kubernetes cluster
Install Radius in a Kubernetes cluster using the Radius Helm chart.
By default 'rad install kubernetes' will install Radius with the version matching the rad CLI version.

Radius will be installed in the 'radius-system' namespace. For more information visit https://docs.radapp.io/concepts/architecture/
Radius will be installed in the 'radius-system' namespace. For more information visit https://docs.radapp.io/concepts/technical/architecture/

Overrides can be set by specifying Helm chart values with the '--set' flag. For more information visit https://docs.radapp.io/operations/platforms/kubernetes/install/.
Overrides can be set by specifying Helm chart values with the '--set' flag. For more information visit https://docs.radapp.io/guides/operations/kubernetes/install/.


```
Expand Down
1 change: 1 addition & 0 deletions docs/content/reference/cli/rad_uninstall_kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ rad uninstall kubernetes --kubecontext my-kubecontext
```
-h, --help help for kubernetes
--kubecontext string The Kubernetes context to use, will use the default if unset
--purge Delete all data stored by Radius.
```

### Options inherited from parent commands
Expand Down
7 changes: 3 additions & 4 deletions docs/content/reference/resource-schema/cache/redis/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,9 @@ The `redislabs.com/Redis` is a [resource]({{< ref portable-resources >}}) which

The following methods are available on the Redis cache:

| Method | Description |
|--------|-------------|
| connectionString() | Get the connection string for the Redis cache. |
| password() | Get the password for the Redis cache. |
| Method | Description | Example |
|--------|-------------|---------|
| listSecrets() | Get the [secrets](#secrets) for the Redis cache. | `listSecrets().connectionString` |

## Resource provisioning

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ The following methods are available on the Extender resource:

| Method | Description |
|--------|-------------|
| secrets('SECRET_NAME') | Get the value of a secret. |
| .listSecrets('SECRET_NAME') | Get the value of a secret. |

## Resource provisioning

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,11 +74,9 @@ The `mongodb.com/MongoDatabase` [resource]({{< ref portable-resources >}}) repre

The following methods are available on the Mongo database resource:

| Method | Description |
|--------|-------------|
| connectionString() | Get the connection string for the MongoDb. |
| username() | Get the username for the MongoDB. |
| password() | Get the password for the MongoDB. |
| Method | Description | Example |
|--------|-------------|---------|
| listSecrets() | Get the [secrets](#secrets) for the MongoDb. | `listSecrets().connectionString` |

## Resource provisioning

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Secrets are used when defining a RabbitMQ resource with a container or external

| Property | Description | Example |
|----------|-------------|---------|
| `uri()` | Returns the RabbitMQ uri used to connect to the resource. | `amqp://guest:***@rabbitmq.svc.local.cluster:5672` |
| listSecrets() | Get the [secrets](#secrets) for the RabbitMQ. | `listSecrets().uri` |

## Resource provisioning

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,33 @@ description: "Detailed reference documentation for applications.core/containers@

#### Additional Properties

* **Additional Properties Type**: string
* **Additional Properties Type**: [EnvironmentVariable](#environmentvariable)

### EnvironmentVariable

#### Properties

| Property | Type | Description |
|----------|------|-------------|
| **value** | string | The value of the environment variable |
| **valueFrom** | [EnvironmentVariableReference](#environmentvariablereference) | The reference to the variable |

### EnvironmentVariableReference

#### Properties

| Property | Type | Description |
|----------|------|-------------|
| **secretRef** | [SecretReference](#secretreference) | This secret is used within a recipe. Secrets are encrypted, often have fine-grained access control, auditing and are recommended to be used to hold sensitive data. <br />_(Required)_ |

### SecretReference

#### Properties

| Property | Type | Description |
|----------|------|-------------|
| **key** | string | The key for the secret in the secret store. <br />_(Required)_ |
| **source** | string | The ID of an Applications.Core/SecretStore resource containing sensitive data required for recipe execution. <br />_(Required)_ |

### HealthProbeProperties

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -170,10 +170,37 @@ description: "Detailed reference documentation for applications.core/environment

| Property | Type | Description |
|----------|------|-------------|
| **bicep** | [BicepConfigProperties](#bicepconfigproperties) | Configuration for Bicep Recipes. Controls how Bicep plans and applies templates as part of Recipe deployment. |
| **env** | [EnvironmentVariables](#environmentvariables) | The environment variables injected during Terraform Recipe execution for the recipes in the environment. |
| **envSecrets** | [RecipeConfigPropertiesEnvSecrets](#recipeconfigpropertiesenvsecrets) | Environment variables containing sensitive information can be stored as secrets. The secrets are stored in Applications.Core/SecretStores resource. |
| **terraform** | [TerraformConfigProperties](#terraformconfigproperties) | Configuration for Terraform Recipes. Controls how Terraform plans and applies templates as part of Recipe deployment. |

### BicepConfigProperties

#### Properties

| Property | Type | Description |
|----------|------|-------------|
| **authentication** | [BicepConfigPropertiesAuthentication](#bicepconfigpropertiesauthentication) | Authentication information used to access private bicep registries, which is a map of registry hostname to secret config that contains credential information. |

### BicepConfigPropertiesAuthentication

#### Properties

* **none**

#### Additional Properties

* **Additional Properties Type**: [RegistrySecretConfig](#registrysecretconfig)

### RegistrySecretConfig

#### Properties

| Property | Type | Description |
|----------|------|-------------|
| **secret** | string | The ID of an Applications.Core/SecretStore resource containing credential information used to authenticate private container registry.The keys in the secretstore depends on the type. |

### EnvironmentVariables

#### Properties
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ description: "Detailed reference documentation for applications.core/secretstore
| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called <br />_(ReadOnly)_ |
| **resource** | string | The resource id of external secret store. |
| **status** | [ResourceStatus](#resourcestatus) | Status of a resource. <br />_(ReadOnly)_ |
| **type** | 'certificate' | 'generic' | The type of SecretStore data |
| **type** | 'awsIRSA' | 'azureWorkloadIdentity' | 'basicAuthentication' | 'certificate' | 'generic' | The type of SecretStore data |

### SecretStorePropertiesData

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,10 @@ description: "Detailed reference documentation for applications.dapr/pubsubbroke
| Property | Type | Description |
|----------|------|-------------|
| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) |
| **auth** | [DaprResourceAuth](#daprresourceauth) | Authentication properties for a Dapr component object |
| **componentName** | string | The name of the Dapr component object. Use this value in your code when interacting with the Dapr client to use the Dapr component. <br />_(ReadOnly)_ |
| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to <br />_(Required)_ |
| **metadata** | any | Any object |
| **metadata** | [DaprPubSubBrokerPropertiesMetadata](#daprpubsubbrokerpropertiesmetadata) | The metadata for Dapr resource which must match the values specified in Dapr component spec |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called <br />_(ReadOnly)_ |
| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for a portable resource |
| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. Available values are 'recipe', where Radius manages the lifecycle of the resource through a Recipe, and 'manual', where a user manages the resource and provides the values. |
Expand All @@ -42,6 +43,42 @@ description: "Detailed reference documentation for applications.dapr/pubsubbroke
| **type** | string | Dapr component type which must matches the format used by Dapr Kubernetes configuration format |
| **version** | string | Dapr component version |

### DaprResourceAuth

#### Properties

| Property | Type | Description |
|----------|------|-------------|
| **secretStore** | string | Secret store to fetch secrets from |

### DaprPubSubBrokerPropertiesMetadata

#### Properties

* **none**

#### Additional Properties

* **Additional Properties Type**: [MetadataValue](#metadatavalue)

### MetadataValue

#### Properties

| Property | Type | Description |
|----------|------|-------------|
| **secretKeyRef** | [MetadataValueFromSecret](#metadatavaluefromsecret) | A reference of a value in a secret store component. |
| **value** | string | The plain text value of the metadata |

### MetadataValueFromSecret

#### Properties

| Property | Type | Description |
|----------|------|-------------|
| **key** | string | The field to select in the secret value. If the secret value is a string, it should be equal to the secret name <br />_(Required)_ |
| **name** | string | Secret name in the secret store component <br />_(Required)_ |

### Recipe

#### Properties
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,42 @@ description: "Detailed reference documentation for applications.dapr/secretstore
| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) |
| **componentName** | string | The name of the Dapr component object. Use this value in your code when interacting with the Dapr client to use the Dapr component. <br />_(ReadOnly)_ |
| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to <br />_(Required)_ |
| **metadata** | any | Any object |
| **metadata** | [DaprSecretStorePropertiesMetadata](#daprsecretstorepropertiesmetadata) | The metadata for Dapr resource which must match the values specified in Dapr component spec |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called <br />_(ReadOnly)_ |
| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for a portable resource |
| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. Available values are 'recipe', where Radius manages the lifecycle of the resource through a Recipe, and 'manual', where a user manages the resource and provides the values. |
| **status** | [ResourceStatus](#resourcestatus) | Status of a resource. <br />_(ReadOnly)_ |
| **type** | string | Dapr component type which must matches the format used by Dapr Kubernetes configuration format |
| **version** | string | Dapr component version |

### DaprSecretStorePropertiesMetadata

#### Properties

* **none**

#### Additional Properties

* **Additional Properties Type**: [MetadataValue](#metadatavalue)

### MetadataValue

#### Properties

| Property | Type | Description |
|----------|------|-------------|
| **secretKeyRef** | [MetadataValueFromSecret](#metadatavaluefromsecret) | A reference of a value in a secret store component. |
| **value** | string | The plain text value of the metadata |

### MetadataValueFromSecret

#### Properties

| Property | Type | Description |
|----------|------|-------------|
| **key** | string | The field to select in the secret value. If the secret value is a string, it should be equal to the secret name <br />_(Required)_ |
| **name** | string | Secret name in the secret store component <br />_(Required)_ |

### Recipe

#### Properties
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,10 @@ description: "Detailed reference documentation for applications.dapr/statestores
| Property | Type | Description |
|----------|------|-------------|
| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) |
| **auth** | [DaprResourceAuth](#daprresourceauth) | Authentication properties for a Dapr component object |
| **componentName** | string | The name of the Dapr component object. Use this value in your code when interacting with the Dapr client to use the Dapr component. <br />_(ReadOnly)_ |
| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to <br />_(Required)_ |
| **metadata** | any | Any object |
| **metadata** | [DaprStateStorePropertiesMetadata](#daprstatestorepropertiesmetadata) | The metadata for Dapr resource which must match the values specified in Dapr component spec |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called <br />_(ReadOnly)_ |
| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for a portable resource |
| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. Available values are 'recipe', where Radius manages the lifecycle of the resource through a Recipe, and 'manual', where a user manages the resource and provides the values. |
Expand All @@ -42,6 +43,42 @@ description: "Detailed reference documentation for applications.dapr/statestores
| **type** | string | Dapr component type which must matches the format used by Dapr Kubernetes configuration format |
| **version** | string | Dapr component version |

### DaprResourceAuth

#### Properties

| Property | Type | Description |
|----------|------|-------------|
| **secretStore** | string | Secret store to fetch secrets from |

### DaprStateStorePropertiesMetadata

#### Properties

* **none**

#### Additional Properties

* **Additional Properties Type**: [MetadataValue](#metadatavalue)

### MetadataValue

#### Properties

| Property | Type | Description |
|----------|------|-------------|
| **secretKeyRef** | [MetadataValueFromSecret](#metadatavaluefromsecret) | A reference of a value in a secret store component. |
| **value** | string | The plain text value of the metadata |

### MetadataValueFromSecret

#### Properties

| Property | Type | Description |
|----------|------|-------------|
| **key** | string | The field to select in the secret value. If the secret value is a string, it should be equal to the secret name <br />_(Required)_ |
| **name** | string | Secret name in the secret store component <br />_(Required)_ |

### Recipe

#### Properties
Expand Down

0 comments on commit c485f14

Please sign in to comment.