From 611f611619ef06e75b6a8744614dd39d688b1394 Mon Sep 17 00:00:00 2001 From: rad-ci-bot <103787451+rad-ci-bot@users.noreply.github.com> Date: Thu, 5 Sep 2024 13:33:15 -0700 Subject: [PATCH 1/3] Update auto-generated documentation (#1223) * Autogenerate reference docs Signed-off-by: rad-ci-bot * Update en-custom.txt Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> * Update en-custom.txt Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> --------- Signed-off-by: rad-ci-bot Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> Co-authored-by: rad-ci-bot Co-authored-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> --- .github/config/en-custom.txt | 13 +++++++ .../reference/cli/rad_install_kubernetes.md | 4 +- .../reference/cli/rad_uninstall_kubernetes.md | 1 + .../2023-10-01-preview/containers/index.md | 28 ++++++++++++- .../2023-10-01-preview/secretstores/index.md | 2 +- .../2023-10-01-preview/pubsubbrokers/index.md | 39 ++++++++++++++++++- .../2023-10-01-preview/secretstores/index.md | 30 +++++++++++++- .../2023-10-01-preview/statestores/index.md | 39 ++++++++++++++++++- 8 files changed, 149 insertions(+), 7 deletions(-) diff --git a/.github/config/en-custom.txt b/.github/config/en-custom.txt index b80d0cdbe..df1278baf 100644 --- a/.github/config/en-custom.txt +++ b/.github/config/en-custom.txt @@ -1270,3 +1270,16 @@ postgres ReadOnly DeployTimeConstant postgres +DaprResourceAuth +DaprPubSubBrokerPropertiesMetadata +MetadataValue +MetadataValueFromSecret +secretKeyRef +DaprSecretStorePropertiesMetadata +awsIRSA +azureWorkloadIdentity +basicAuthentication +EnvironmentVariable +EnvironmentVariableReference +secretRef +DaprStateStorePropertiesMetadata diff --git a/docs/content/reference/cli/rad_install_kubernetes.md b/docs/content/reference/cli/rad_install_kubernetes.md index 1df499317..472ee21cf 100644 --- a/docs/content/reference/cli/rad_install_kubernetes.md +++ b/docs/content/reference/cli/rad_install_kubernetes.md @@ -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/. ``` diff --git a/docs/content/reference/cli/rad_uninstall_kubernetes.md b/docs/content/reference/cli/rad_uninstall_kubernetes.md index 84ee002d1..1e58e00d1 100644 --- a/docs/content/reference/cli/rad_uninstall_kubernetes.md +++ b/docs/content/reference/cli/rad_uninstall_kubernetes.md @@ -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 diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/containers/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/containers/index.md index 763f4befa..ba34d6d01 100644 --- a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/containers/index.md +++ b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/containers/index.md @@ -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.
_(Required)_ | + +### SecretReference + +#### Properties + +| Property | Type | Description | +|----------|------|-------------| +| **key** | string | The key for the secret in the secret store.
_(Required)_ | +| **source** | string | The ID of an Applications.Core/SecretStore resource containing sensitive data required for recipe execution.
_(Required)_ | ### HealthProbeProperties diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/secretstores/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/secretstores/index.md index dfa045b42..1883ac9fe 100644 --- a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/secretstores/index.md +++ b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/secretstores/index.md @@ -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
_(ReadOnly)_ | | **resource** | string | The resource id of external secret store. | | **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **type** | 'certificate' | 'generic' | The type of SecretStore data | +| **type** | 'awsIRSA' | 'azureWorkloadIdentity' | 'basicAuthentication' | 'certificate' | 'generic' | The type of SecretStore data | ### SecretStorePropertiesData diff --git a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/pubsubbrokers/index.md b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/pubsubbrokers/index.md index a9838e939..3c2a88b40 100644 --- a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/pubsubbrokers/index.md +++ b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/pubsubbrokers/index.md @@ -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.
_(ReadOnly)_ | | **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(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
_(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. | @@ -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
_(Required)_ | +| **name** | string | Secret name in the secret store component
_(Required)_ | + ### Recipe #### Properties diff --git a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/secretstores/index.md b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/secretstores/index.md index 0f47923b2..4c21726d9 100644 --- a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/secretstores/index.md +++ b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/secretstores/index.md @@ -33,7 +33,7 @@ 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.
_(ReadOnly)_ | | **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(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
_(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. | @@ -41,6 +41,34 @@ description: "Detailed reference documentation for applications.dapr/secretstore | **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
_(Required)_ | +| **name** | string | Secret name in the secret store component
_(Required)_ | + ### Recipe #### Properties diff --git a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/statestores/index.md b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/statestores/index.md index cab18c1b2..94c5621c8 100644 --- a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/statestores/index.md +++ b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/statestores/index.md @@ -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.
_(ReadOnly)_ | | **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(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
_(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. | @@ -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
_(Required)_ | +| **name** | string | Secret name in the secret store component
_(Required)_ | + ### Recipe #### Properties From b652f1f3c5b2e951e64f6f14239974d98f6f3de9 Mon Sep 17 00:00:00 2001 From: Shruthi Kumar Date: Tue, 10 Sep 2024 07:41:31 -0700 Subject: [PATCH 2/3] update resource methods (#1218) Signed-off-by: sk593 --- .../reference/resource-schema/cache/redis/index.md | 7 +++---- .../resource-schema/core-schema/extender/index.md | 2 +- .../reference/resource-schema/databases/mongodb/index.md | 8 +++----- .../reference/resource-schema/messaging/rabbitmq/index.md | 2 +- 4 files changed, 8 insertions(+), 11 deletions(-) diff --git a/docs/content/reference/resource-schema/cache/redis/index.md b/docs/content/reference/resource-schema/cache/redis/index.md index ac8860096..ecf1d7d29 100644 --- a/docs/content/reference/resource-schema/cache/redis/index.md +++ b/docs/content/reference/resource-schema/cache/redis/index.md @@ -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 diff --git a/docs/content/reference/resource-schema/core-schema/extender/index.md b/docs/content/reference/resource-schema/core-schema/extender/index.md index 996b9a61c..0f57667f2 100644 --- a/docs/content/reference/resource-schema/core-schema/extender/index.md +++ b/docs/content/reference/resource-schema/core-schema/extender/index.md @@ -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 diff --git a/docs/content/reference/resource-schema/databases/mongodb/index.md b/docs/content/reference/resource-schema/databases/mongodb/index.md index 76a44e7bc..6485544fe 100644 --- a/docs/content/reference/resource-schema/databases/mongodb/index.md +++ b/docs/content/reference/resource-schema/databases/mongodb/index.md @@ -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 diff --git a/docs/content/reference/resource-schema/messaging/rabbitmq/index.md b/docs/content/reference/resource-schema/messaging/rabbitmq/index.md index fb2516153..6001a6c83 100644 --- a/docs/content/reference/resource-schema/messaging/rabbitmq/index.md +++ b/docs/content/reference/resource-schema/messaging/rabbitmq/index.md @@ -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 From e4808b39a563dadc53b4ec703a9f95d883a5dcba Mon Sep 17 00:00:00 2001 From: rad-ci-bot <103787451+rad-ci-bot@users.noreply.github.com> Date: Tue, 10 Sep 2024 09:17:25 -0700 Subject: [PATCH 3/3] Update auto-generated documentation (#1225) * Autogenerate reference docs Signed-off-by: rad-ci-bot * Update en-custom.txt Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> --------- Signed-off-by: rad-ci-bot Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> Co-authored-by: rad-ci-bot Co-authored-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> --- .github/config/en-custom.txt | 4 +++ .../2023-10-01-preview/environments/index.md | 27 +++++++++++++++++++ 2 files changed, 31 insertions(+) diff --git a/.github/config/en-custom.txt b/.github/config/en-custom.txt index df1278baf..6a3f1c370 100644 --- a/.github/config/en-custom.txt +++ b/.github/config/en-custom.txt @@ -1283,3 +1283,7 @@ EnvironmentVariable EnvironmentVariableReference secretRef DaprStateStorePropertiesMetadata +BicepConfigProperties +BicepConfigPropertiesAuthentication +RegistrySecretConfig + diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/environments/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/environments/index.md index 7a7361947..fa7fb968f 100644 --- a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/environments/index.md +++ b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/environments/index.md @@ -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