Move component specs into reference section

This commit is contained in:
Aaron Crawfis 2021-04-09 12:56:14 -07:00
parent 1802c9de3f
commit bbd2d18b3a
91 changed files with 336 additions and 109 deletions

View File

@ -42,7 +42,7 @@ spec:
Make sure to replace `<PATH TO SECRETS FILE>` with the path to the JSON file you just created.
To configure a different kind of secret store see the guidance on [how to configure a secret store]({{<ref secret-stores-overview>}}) and review [supported secret stores]({{<ref supported-secret-stores >}}) to see specific details required for different secret store solutions.
To configure a different kind of secret store see the guidance on [how to configure a secret store]({{<ref setup-secret-store>}}) and review [supported secret stores]({{<ref supported-secret-stores >}}) to see specific details required for different secret store solutions.
## Get a secret
Now run the Dapr sidecar (with no application)
@ -173,7 +173,7 @@ $app->run(function(\Dapr\SecretManager $secretManager, \Psr\Log\LoggerInterface
- [Dapr secrets overview]({{<ref secrets-overview>}})
- [Secrets API reference]({{<ref secrets_api>}})
- [Configure a secret store]({{<ref secret-stores-overview>}})
- [Supported secrets]({{<ref secret-stores-overview>}})
- [Configure a secret store]({{<ref setup-secret-store>}})
- [Supported secrets]({{<ref supported-secret-stores>}})
- [Using secrets in components]({{<ref component-secrets>}})
- [Secret stores quickstart](https://github.com/dapr/quickstarts/tree/master/secretstore)

View File

@ -11,7 +11,7 @@ You can read [guidance on setting up secret store components]({{< ref setup-secr
To limit the secrets to which the Dapr application has access to, you can can define secret scopes by adding a secret scope policy to the application configuration with restrictive permissions. Follow [these instructions]({{< ref configuration-concept.md >}}) to define an application configuration.
The secret scoping policy applies to any [secret store]({{< ref supported-secret-stores.md >}}), whether that is a local secret store, a Kubernetes secret store or a public cloud secret store. For details on how to set up a [secret stores]({{< ref secret-stores-overview.md >}}) read [How To: Retrieve a secret]({{< ref howto-secrets.md >}})
The secret scoping policy applies to any [secret store]({{< ref supported-secret-stores.md >}}), whether that is a local secret store, a Kubernetes secret store or a public cloud secret store. For details on how to set up a [secret stores]({{< ref setup-secret-store.md >}}) read [How To: Retrieve a secret]({{< ref howto-secrets.md >}})
Watch this [video](https://youtu.be/j99RN_nxExA?start=2272) for a demo on how to use secret scoping with your application.
<iframe width="688" height="430" src="https://www.youtube.com/embed/j99RN_nxExA?start=2272" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
@ -95,6 +95,6 @@ Scenarios | defaultAccess | allowedSecrets | deniedSecrets | permission
## Related links
* List of [secret stores]({{< ref supported-secret-stores.md >}})
* Overview of [secret stores]({{< ref secret-stores-overview.md >}})
* Overview of [secret stores]({{< ref setup-secret-store.md >}})
howto-secrets/

View File

@ -24,7 +24,7 @@ To change the state store being used, replace the YAML under `/components` with
### Kubernetes
See the instructions [here]({{<ref setup-state-store-overview>}}) on how to setup different state stores on Kubernetes.
See the instructions [here]({{<ref setup-state-store>}}) on how to setup different state stores on Kubernetes.
## Strong and Eventual consistency

View File

@ -6,4 +6,4 @@ weight: 500
description: "Guides for working with specific backend states stores"
---
Explore the **Operations** section to see a list of [supported state stores]({{<ref supported-state-stores.md>}}) and how to setup [state store components]({{<ref setup-state-store-overview.md>}}).
Explore the **Operations** section to see a list of [supported state stores]({{<ref supported-state-stores.md>}}) and how to setup [state store components]({{<ref setup-state-store.md>}}).

View File

@ -1,7 +1,7 @@
---
type: docs
title: "How-To: Scope components to one or more applications"
linkTitle: "How-To: Set component scopes"
linkTitle: "Scope access to components"
weight: 300
description: "Limit component access to particular Dapr instances"
---

View File

@ -1,7 +1,7 @@
---
type: docs
title: "How-To: Reference secrets in components"
linkTitle: "How-To: Reference secrets"
linkTitle: "Reference secrets in components"
weight: 400
description: "How to securly reference secrets from a component definition"
---

View File

@ -0,0 +1,85 @@
---
type: docs
title: "Bindings components"
linkTitle: "Bindings"
description: "Guidance on setting up Dapr bindings components"
weight: 4000
---
Dapr integrates with external resources to allow apps to both be triggered by external events and interact with the resources. Each binding component has a name and this name is used when interacting with the resource.
As with other building block components, binding components are extensible and can be found in the [components-contrib repo](https://github.com/dapr/components-contrib).
A binding in Dapr is described using a `Component` file with the following fields:
```yaml
apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
name: <NAME>
namespace: <NAMESPACE>
spec:
type: bindings.<NAME>
version: v1
metadata:
- name: <KEY>
value: <VALUE>
- name: <KEY>
value: <VALUE>
...
```
The type of binding is determined by the `type` field, and things like connection strings and other metadata are put in the `.metadata` section.
Different [supported bindings]({{< ref supported-bindings >}}) will have different specific fields that would need to be configured. For example, when configuring a binding for [Azure Blob Storage]({{< ref blobstorage>}}), the file would look like this:
```yaml
apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
name: <NAME>
namespace: <NAMESPACE>
spec:
type: bindings.azure.blobstorage
version: v1
metadata:
- name: storageAccount
value: myStorageAccountName
- name: storageAccessKey
value: ***********
- name: container
value: container1
- name: decodeBase64
value: <bool>
- name: getBlobRetryCount
value: <integer>
```
## Apply the configuration
Once you have created the component's YAML file, follow these instructions to apply it based on your hosting environment:
{{< tabs "Self-Hosted" "Kubernetes" >}}
{{% codetab %}}
To run locally, create a `components` dir containing the YAML file and provide the path to the `dapr run` command with the flag `--components-path`.
{{% /codetab %}}
{{% codetab %}}
To deploy in Kubernetes, assuming your component file is named `mybinding.yaml`, run:
```bash
kubectl apply -f mybinding.yaml
```
{{% /codetab %}}
{{< /tabs >}}
## Supported bindings
Visit the [bindings reference]({{< ref supported-bindings >}}) for a full list of supported resources.
## Related links
- [Bindings building block]({{< ref bindings >}})
- [Supported bindings]({{<ref supported-bindings >}})

View File

@ -1,7 +0,0 @@
---
type: docs
title: "Bindings components"
linkTitle: "Bindings"
description: "Guidance on setting up Dapr bindings components"
weight: 4000
---

View File

@ -4,4 +4,53 @@ title: "Pub/Sub brokers"
linkTitle: "Pub/sub brokers"
description: "Guidance on setting up different message brokers for Dapr Pub/Sub"
weight: 2000
aliases:
- "/operations/components/setup-pubsub/setup-pubsub-overview/"
---
Dapr integrates with pub/sub message buses to provide applications with the ability to create event-driven, loosely coupled architectures where producers send events to consumers via topics.
Dapr supports the configuration of multiple, named, pub/sub components *per application*. Each pub/sub component has a name and this name is used when publishing a message topic. Read the [API reference]({{< ref pubsub_api.md >}}) for details on how to publish and subscribe to topics.
Pub/sub components are extensible. A list of support pub/sub components is [here]({{< ref supported-pubsub >}}) and the implementations can be found in the [components-contrib repo](https://github.com/dapr/components-contrib).
## Component files
A pub/sub is described using a `Component` file:
```yaml
apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
name: pubsub
namespace: default
spec:
type: pubsub.<NAME>
version: v1
metadata:
- name: <KEY>
value: <VALUE>
- name: <KEY>
value: <VALUE>
...
```
The type of pub/sub is determined by the `type` field, and properties such as connection strings and other metadata are put in the `.metadata` section.
Even though metadata values can contain secrets in plain text, it is recommended you use a [secret store]({{< ref component-secrets.md >}}) using a `secretKeyRef`.
{{% alert title="Topic creation" color="primary" %}}
Depending on the pub/sub message bus you are using and how it is configured, topics may be created automatically. Even if the message bus supports automatic topic creation, it is a common governance practice to disable it in production environments. You may still need to use a CLI, admin console, or request form to manually create the topics required by your application.
{{% /alert %}}
Visit [this guide]({{< ref "howto-publish-subscribe.md#step-3-publish-a-topic" >}}) for instructions on configuring and using pub/sub components.
## Related links
- Overview of the Dapr [Pub/Sub building block]({{< ref pubsub-overview.md >}})
- Try the [Pub/Sub quickstart sample](https://github.com/dapr/quickstarts/tree/master/pub-sub)
- Read the [guide on publishing and subscribing]({{< ref howto-publish-subscribe.md >}})
- Learn about [topic scoping]({{< ref pubsub-scopes.md >}})
- Learn about [message time-to-live]({{< ref pubsub-message-ttl.md >}})
- Learn [how to configure Pub/Sub components with multiple namespaces]({{< ref pubsub-namespaces.md >}})
- List of [pub/sub components]({{< ref supported-pubsub >}})
- Read the [API reference]({{< ref pubsub_api.md >}})

View File

@ -1,55 +0,0 @@
---
type: docs
title: "Overview"
linkTitle: "Overview"
description: "Overview on setting up of pub/sub components for Dapr"
weight: 10000
type: docs
---
Dapr integrates with pub/sub message buses to provide applications with the ability to create event-driven, loosely coupled architectures where producers send events to consumers via topics.
Dapr supports the configuration of multiple, named, pub/sub components *per application*. Each pub/sub component has a name and this name is used when publishing a message topic. Read the [API reference]({{< ref pubsub_api.md >}}) for details on how to publish and subscribe to topics.
Pub/sub components are extensible. A list of support pub/sub components is [here]({{< ref supported-pubsub >}}) and the implementations can be found in the [components-contrib repo](https://github.com/dapr/components-contrib).
## Component files
A pub/sub is described using a `Component` file:
```yaml
apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
name: pubsub
namespace: default
spec:
type: pubsub.<NAME>
version: v1
metadata:
- name: <KEY>
value: <VALUE>
- name: <KEY>
value: <VALUE>
...
```
The type of pub/sub is determined by the `type` field, and properties such as connection strings and other metadata are put in the `.metadata` section.
Even though metadata values can contain secrets in plain text, it is recommended you use a [secret store]({{< ref component-secrets.md >}}) using a `secretKeyRef`.
{{% alert title="Topic creation" color="primary" %}}
Depending on the pub/sub message bus you are using and how it is configured, topics may be created automatically. Even if the message bus supports automatic topic creation, it is a common governance practice to disable it in production environments. You may still need to use a CLI, admin console, or request form to manually create the topics required by your application.
{{% /alert %}}
Visit [this guide]({{< ref "howto-publish-subscribe.md#step-3-publish-a-topic" >}}) for instructions on configuring and using pub/sub components.
## Related links
- Overview of the Dapr [Pub/Sub building block]({{< ref pubsub-overview.md >}})
- Try the [Pub/Sub quickstart sample](https://github.com/dapr/quickstarts/tree/master/pub-sub)
- Read the [guide on publishing and subscribing]({{< ref howto-publish-subscribe.md >}})
- Learn about [topic scoping]({{< ref pubsub-scopes.md >}})
- Learn about [message time-to-live]({{< ref pubsub-message-ttl.md >}})
- Learn [how to configure Pub/Sub components with multiple namespaces]({{< ref pubsub-namespaces.md >}})
- List of [pub/sub components]({{< ref supported-pubsub >}})
- Read the [API reference]({{< ref pubsub_api.md >}})

View File

@ -1,10 +1,11 @@
---
type: docs
title: "Overview"
linkTitle: "Overview"
description: "General overview on set up of secret stores for Dapr"
weight: 10000
type: docs
title: "Secret store components"
linkTitle: "Secret stores"
description: "Guidance on setting up different secret store components"
weight: 3000
aliases:
- "/operations/components/setup-state-store/secret-stores-overview/"
---
Dapr integrates with secret stores to provide apps and other components with secure storage and access to secrets such as access keys and passwords. Each secret store component has a name and this name is used when accessing a secret.
@ -75,6 +76,10 @@ kubectl apply -f secret-store.yaml
{{< /tabs >}}
## Supported secret stores
Visit the [secret stores reference]({{< ref supported-secret-stores >}}) for a full list of supported secret stores.
## Related links

View File

@ -1,8 +0,0 @@
---
type: docs
title: "Secret store components"
linkTitle: "Secret stores"
description: "Guidance on setting up different secret store components"
weight: 3000
type: docs
---

View File

@ -1,9 +1,11 @@
---
type: docs
title: "Overview"
linkTitle: "Overview"
description: "Guidance on set up for state management components"
weight: 10000
title: "State stores components"
linkTitle: "State stores"
description: "Guidance on setting up different state stores for Dapr state management"
weight: 1000
aliases:
- "/operations/components/setup-state-store/setup-state-store-overview/"
---
Dapr integrates with existing databases to provide apps with state management capabilities for CRUD operations, transactions and more. It also supports the configuration of multiple, named, state store components *per application*.
@ -34,7 +36,12 @@ Even though metadata values can contain secrets in plain text, it is recommended
Visit [this guide]({{< ref "howto-get-save-state.md#step-1-setup-a-state-store" >}}) on how to configure a state store component.
## Supported state stores
Visit [this reference]({{< ref supported-state-stores >}}) to see all of the supported state stores in Dapr.
## Related topics
- [Component concept]({{< ref components-concept.md >}})
- [State management overview]({{< ref state-management >}})
- [State management API specification]({{< ref state_api.md >}})
- [Supported state stores]({{< ref supported-state-stores >}})

View File

@ -1,7 +0,0 @@
---
type: docs
title: "State stores components"
linkTitle: "State stores"
description: "Guidance on setting up different state stores for Dapr state management"
weight: 1000
---

View File

@ -0,0 +1,7 @@
---
type: docs
title: "Dapr components reference"
linkTitle: "Component specs"
description: "Detailed information and specifications on Dapr components"
weight: 400
---

View File

@ -1,9 +1,11 @@
---
type: docs
title: "Supported external bindings"
linkTitle: "Supported bindings"
weight: 200
linkTitle: "Bindings"
weight: 3000
description: The supported external bindings that interface with Dapr
aliases:
- "/operations/components/setup-bindings/supported-bindings/"
no_list: true
---

View File

@ -3,6 +3,8 @@ type: docs
title: "Alibaba Cloud Object Storage Service binding spec"
linkTitle: "Alibaba Cloud Object Storage"
description: "Detailed documentation on the Alibaba Cloud Object Storage binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/alicloudoss/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "Apple Push Notification Service binding spec"
linkTitle: "Apple Push Notification Service"
description: "Detailed documentation on the Apple Push Notification Service binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/apns/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "Azure Blob Storage binding spec"
linkTitle: "Azure Blob Storage"
description: "Detailed documentation on the Azure Blob Storage binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/blobstorage/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "Azure CosmosDB binding spec"
linkTitle: "Azure CosmosDB"
description: "Detailed documentation on the Azure CosmosDB binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/cosmosdb/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "Cron binding spec"
linkTitle: "Cron"
description: "Detailed documentation on the cron binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/cron/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "AWS DynamoDB binding spec"
linkTitle: "AWS DynamoDB"
description: "Detailed documentation on the AWS DynamoDB binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/dynamodb/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "Azure Event Grid binding spec"
linkTitle: "Azure Event Grid"
description: "Detailed documentation on the Azure Event Grid binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/eventgrid/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "Azure Event Hubs binding spec"
linkTitle: "Azure Event Hubs"
description: "Detailed documentation on the Azure Event Hubs binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/eventhubs/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "GCP Storage Bucket binding spec"
linkTitle: "GCP Storage Bucket"
description: "Detailed documentation on the GCP Storage Bucket binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/gcpbucket/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "GCP Pub/Sub binding spec"
linkTitle: "GCP Pub/Sub"
description: "Detailed documentation on the GCP Pub/Sub binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/gcppubsub/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "HTTP binding spec"
linkTitle: "HTTP"
description: "Detailed documentation on the HTTP binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/http/"
---
## Setup Dapr component

View File

@ -3,6 +3,8 @@ type: docs
title: "InfluxDB binding spec"
linkTitle: "InfluxDB"
description: "Detailed documentation on the InfluxDB binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/influxdb/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "Kafka binding spec"
linkTitle: "Kafka"
description: "Detailed documentation on the Kafka binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/kafka/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "AWS Kinesis binding spec"
linkTitle: "AWS Kinesis"
description: "Detailed documentation on the AWS Kinesis binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/kinesis/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "Kubernetes Events binding spec"
linkTitle: "Kubernetes Events"
description: "Detailed documentation on the Kubernetes Events binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/kubernetes-binding/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "Local Storage binding spec"
linkTitle: "Local Storage"
description: "Detailed documentation on the Local Storage binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/localstorage/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "MQTT binding spec"
linkTitle: "MQTT"
description: "Detailed documentation on the MQTT binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/mqtt/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "MySQL binding spec"
linkTitle: "MySQL"
description: "Detailed documentation on the MySQL binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/mysql/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "PostgreSQL binding spec"
linkTitle: "PostgreSQL"
description: "Detailed documentation on the PostgreSQL binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/postgres/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "Postmark binding spec"
linkTitle: "Postmark"
description: "Detailed documentation on the Postmark binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/postmark/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "RabbitMQ binding spec"
linkTitle: "RabbitMQ"
description: "Detailed documentation on the RabbitMQ binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/rabbitmq/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "Redis binding spec"
linkTitle: "Redis"
description: "Detailed documentation on the Redis binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/redis/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "RethinkDB binding spec"
linkTitle: "RethinkDB"
description: "Detailed documentation on the RethinkDB binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/rethinkdb/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "AWS S3 binding spec"
linkTitle: "AWS S3"
description: "Detailed documentation on the AWS S3 binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/s3/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "Twilio SendGrid binding spec"
linkTitle: "Twilio SendGrid"
description: "Detailed documentation on the Twilio SendGrid binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/sendgrid/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "Azure Service Bus Queues binding spec"
linkTitle: "Azure Service Bus Queues"
description: "Detailed documentation on the Azure Service Bus Queues binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/servicebusqueues/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "Azure SignalR binding spec"
linkTitle: "Azure SignalR"
description: "Detailed documentation on the Azure SignalR binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/signalr/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "SMTP binding spec"
linkTitle: "SMTP"
description: "Detailed documentation on the SMTP binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/smtp/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "AWS SNS binding spec"
linkTitle: "AWS SNS"
description: "Detailed documentation on the AWS SNS binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/sns/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "AWS SQS binding spec"
linkTitle: "AWS SQS"
description: "Detailed documentation on the AWS SQS binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/sqs/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "Azure Storage Queues binding spec"
linkTitle: "Azure Storage Queues"
description: "Detailed documentation on the Azure Storage Queues binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/storagequeues/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "Twilio SMS binding spec"
linkTitle: "Twilio SMS"
description: "Detailed documentation on the Twilio SMS binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/twilio/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "Twitter binding spec"
linkTitle: "Twitter"
description: "Detailed documentation on the Twitter binding component"
aliases:
- "/operations/components/setup-bindings/supported-bindings/twitter/"
---
## Component format

View File

@ -1,9 +1,11 @@
---
type: docs
title: "Supported pub/sub brokers"
linkTitle: "Supported pub/sub brokers"
weight: 30000
linkTitle: "Pub/sub brokers"
weight: 2000
description: The supported pub/sub brokers that interface with Dapr
aliases:
- "/operations/components/setup-pubsub/supported-pubsub/"
no_list: true
---

View File

@ -3,6 +3,8 @@ type: docs
title: "Apache Kafka"
linkTitle: "Apache Kafka"
description: "Detailed documentation on the Apache Kafka pubsub component"
aliases:
- "/operations/components/setup-pubsub/supported-pubsub/setup-apache-kafka/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "AWS SNS/SQS"
linkTitle: "AWS SNS/SQS"
description: "Detailed documentation on the AWS SNS/SQS pubsub component"
aliases:
- "/operations/components/setup-pubsub/supported-pubsub/setup-aws-snssqs/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "Azure Events Hub"
linkTitle: "Azure Events Hub"
description: "Detailed documentation on the Azure Event Hubs pubsub component"
aliases:
- "/operations/components/setup-pubsub/supported-pubsub/setup-azure-eventhubs/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "Azure Service Bus"
linkTitle: "Azure Service Bus"
description: "Detailed documentation on the Azure Service Bus pubsub component"
aliases:
- "/operations/components/setup-pubsub/supported-pubsub/setup-azure-servicebus/"
---
## Component format

View File

@ -5,6 +5,7 @@ linkTitle: "GCP Pub/Sub"
description: "Detailed documentation on the GCP Pub/Sub component"
aliases:
- "/operations/components/setup-pubsub/supported-pubsub/setup-gcp/"
- "/operations/components/setup-pubsub/supported-pubsub/setup-gcp-pubsub/"
---
## Create a Dapr component

View File

@ -3,6 +3,8 @@ type: docs
title: "Hazelcast"
linkTitle: "Hazelcast"
description: "Detailed documentation on the Hazelcast pubsub component"
aliases:
- "/operations/components/setup-pubsub/supported-pubsub/setup-hazelcast/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "MQTT"
linkTitle: "MQTT"
description: "Detailed documentation on the MQTT pubsub component"
aliases:
- "/operations/components/setup-pubsub/supported-pubsub/setup-mqtt/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "NATS Streaming"
linkTitle: "NATS Streaming"
description: "Detailed documentation on the NATS Streaming pubsub component"
aliases:
- "/operations/components/setup-pubsub/supported-pubsub/setup-nats-streaming/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "Pulsar"
linkTitle: "Pulsar"
description: "Detailed documentation on the Pulsar pubsub component"
aliases:
- "/operations/components/setup-pubsub/supported-pubsub/setup-pulsar/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "RabbitMQ"
linkTitle: "RabbitMQ"
description: "Detailed documentation on the RabbitMQ pubsub component"
aliases:
- "/operations/components/setup-pubsub/supported-pubsub/setup-rabbitmq/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "Redis Streams"
linkTitle: "Redis Streams"
description: "Detailed documentation on the Redis Streams pubsub component"
aliases:
- "/operations/components/setup-pubsub/supported-pubsub/setup-redis-pubsub/"
---
## Component format

View File

@ -1,9 +1,11 @@
---
type: docs
title: "Supported secret stores"
linkTitle: "Supported secret stores"
weight: 30000
linkTitle: "Secret stores"
weight: 4000
description: The supported secret stores that interface with Dapr
aliases:
- "/operations/components/setup-secret-store/supported-secret-stores/"
no_list: true
---

View File

@ -3,11 +3,13 @@ type: docs
title: "AWS SSM Parameter Store"
linkTitle: "AWS SSM Parameter Store"
description: Detailed information on the AWS SSM Parameter Store - secret store component
aliases:
- "/operations/components/setup-secret-store/supported-secret-stores/aws-parameter-store/"
---
## Component format
To setup AWS SSM Parameter Store secret store create a component of type `secretstores.aws.parameterstore`. See [this guide]({{< ref "secret-stores-overview.md#apply-the-configuration" >}}) on how to create and apply a secretstore configuration. See this guide on [referencing secrets]({{< ref component-secrets.md >}}) to retrieve and use the secret with Dapr components.
To setup AWS SSM Parameter Store secret store create a component of type `secretstores.aws.parameterstore`. See [this guide]({{< ref "setup-secret-store.md#apply-the-configuration" >}}) on how to create and apply a secretstore configuration. See this guide on [referencing secrets]({{< ref component-secrets.md >}}) to retrieve and use the secret with Dapr components.
See [Authenticating to AWS]({{< ref authenticating-aws.md >}}) for information about authentication-related attributes.

View File

@ -3,11 +3,13 @@ type: docs
title: "AWS Secrets Manager"
linkTitle: "AWS Secrets Manager"
description: Detailed information on the decret store component
aliases:
- "/operations/components/setup-secret-store/supported-secret-stores/aws-secret-manager/"
---
## Component format
To setup AWS Secrets Manager secret store create a component of type `secretstores.aws.secretmanager`. See [this guide]({{< ref "secret-stores-overview.md#apply-the-configuration" >}}) on how to create and apply a secretstore configuration. See this guide on [referencing secrets]({{< ref component-secrets.md >}}) to retrieve and use the secret with Dapr components.
To setup AWS Secrets Manager secret store create a component of type `secretstores.aws.secretmanager`. See [this guide]({{< ref "setup-secret-store.md#apply-the-configuration" >}}) on how to create and apply a secretstore configuration. See this guide on [referencing secrets]({{< ref component-secrets.md >}}) to retrieve and use the secret with Dapr components.
See [Authenticating to AWS]({{< ref authenticating-aws.md >}}) for information about authentication-related attributes.

View File

@ -3,11 +3,13 @@ type: docs
title: "Azure Key Vault with Managed Identities on Kubernetes"
linkTitle: "Azure Key Vault w/ Managed Identity"
description: How to configure Azure Key Vault and Kubernetes to use Azure Managed Identities to access secrets
aliases:
- "/operations/components/setup-secret-store/supported-secret-stores/azure-keyvault-managed-identity/"
---
## Component format
To setup Azure Key Vault secret store with Managed Identies create a component of type `secretstores.azure.keyvault`. See [this guide]({{< ref "secret-stores-overview.md#apply-the-configuration" >}}) on how to create and apply a secretstore configuration. See this guide on [referencing secrets]({{< ref component-secrets.md >}}) to retrieve and use the secret with Dapr components.
To setup Azure Key Vault secret store with Managed Identies create a component of type `secretstores.azure.keyvault`. See [this guide]({{< ref "setup-secret-store.md#apply-the-configuration" >}}) on how to create and apply a secretstore configuration. See this guide on [referencing secrets]({{< ref component-secrets.md >}}) to retrieve and use the secret with Dapr components.
In Kubernetes mode, you store the certificate for the service principal into the Kubernetes Secret Store and then enable Azure Key Vault secret store with this certificate in Kubernetes secretstore.

View File

@ -3,6 +3,8 @@ type: docs
title: "Azure Key Vault secret store"
linkTitle: "Azure Key Vault"
description: Detailed information on the Azure Key Vault secret store component
aliases:
- "/operations/components/setup-secret-store/supported-secret-stores/azure-keyvault/"
---
{{% alert title="Note" color="primary" %}}
@ -11,7 +13,7 @@ Azure Managed Identity can be used for Azure Key Vault access on Kubernetes. Ins
## Component format
To setup Azure Key Vault secret store create a component of type `secretstores.azure.keyvault`. See [this guide]({{< ref "secret-stores-overview.md#apply-the-configuration" >}}) on how to create and apply a secretstore configuration. See this guide on [referencing secrets]({{< ref component-secrets.md >}}) to retrieve and use the secret with Dapr components.
To setup Azure Key Vault secret store create a component of type `secretstores.azure.keyvault`. See [this guide]({{< ref "setup-secret-store.md#apply-the-configuration" >}}) on how to create and apply a secretstore configuration. See this guide on [referencing secrets]({{< ref component-secrets.md >}}) to retrieve and use the secret with Dapr components.
See also [configure the component](#configure-the-component) guide in this page.

View File

@ -3,6 +3,8 @@ type: docs
title: "Local environment variables (for Development)"
linkTitle: "Local environment variables"
description: Detailed information on the local environment secret store component
aliases:
- "/operations/components/setup-secret-store/supported-secret-stores/envvar-secret-store/"
---
This Dapr secret store component uses locally defined environment variable and does not use authentication.

View File

@ -3,6 +3,8 @@ type: docs
title: "Local file (for Development)"
linkTitle: "Local file"
description: Detailed information on the local file secret store component
aliases:
- "/operations/components/setup-secret-store/supported-secret-stores/file-secret-store/"
---
This Dapr secret store component reads plain text JSON from a given file and does not use authentication.

View File

@ -3,11 +3,13 @@ type: docs
title: "GCP Secret Manager"
linkTitle: "GCP Secret Manager"
description: Detailed information on the GCP Secret Manager secret store component
aliases:
- "/operations/components/setup-secret-store/supported-secret-stores/gcp-secret-manager/"
---
## Component format
To setup GCP Secret Manager secret store create a component of type `secretstores.gcp.secretmanager`. See [this guide]({{< ref "secret-stores-overview.md#apply-the-configuration" >}}) on how to create and apply a secretstore configuration. See this guide on [referencing secrets]({{< ref component-secrets.md >}}) to retrieve and use the secret with Dapr components.
To setup GCP Secret Manager secret store create a component of type `secretstores.gcp.secretmanager`. See [this guide]({{< ref "setup-secret-store#apply-the-configuration" >}}) on how to create and apply a secretstore configuration. See this guide on [referencing secrets]({{< ref component-secrets.md >}}) to retrieve and use the secret with Dapr components.
```yaml
apiVersion: dapr.io/v1alpha1

View File

@ -3,11 +3,13 @@ type: docs
title: "HashiCorp Vault"
linkTitle: "HashiCorp Vault"
description: Detailed information on the HashiCorp Vault secret store component
aliases:
- "/operations/components/setup-secret-store/supported-secret-stores/hashicorp-vault/"
---
## Create the Vault component
To setup HashiCorp Vault secret store create a component of type `secretstores.hashicorp.vault`. See [this guide]({{< ref "secret-stores-overview.md#apply-the-configuration" >}}) on how to create and apply a secretstore configuration. See this guide on [referencing secrets]({{< ref component-secrets.md >}}) to retrieve and use the secret with Dapr components.
To setup HashiCorp Vault secret store create a component of type `secretstores.hashicorp.vault`. See [this guide]({{< ref "setup-secret-store.md#apply-the-configuration" >}}) on how to create and apply a secretstore configuration. See this guide on [referencing secrets]({{< ref component-secrets.md >}}) to retrieve and use the secret with Dapr components.
```yaml
apiVersion: dapr.io/v1alpha1

View File

@ -3,6 +3,8 @@ type: docs
title: "Kubernetes secrets"
linkTitle: "Kubernetes secrets"
description: Detailed information on the Kubernetes secret store component
aliases:
- "/operations/components/setup-secret-store/supported-secret-stores/kubernetes-secret-store/"
---
## Summary

View File

@ -1,9 +1,11 @@
---
type: docs
title: "Supported state stores"
linkTitle: "Supported state stores"
linkTitle: "State stores"
description: "The supported state stores that interface with Dapr"
weight: 20000
weight: 1000
aliases:
- "/operations/components/setup-state-store/supported-state-stores/"
no_list: true
---

View File

@ -3,6 +3,8 @@ type: docs
title: "Aerospike"
linkTitle: "Aerospike"
description: Detailed information on the Aerospike state store component
aliases:
- "/operations/components/setup-state-store/supported-state-stores/setup-aerospike/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "Azure Blob Storage"
linkTitle: "Azure Blob Storage"
description: Detailed information on the Azure Blob Store state store component
aliases:
- "/operations/components/setup-state-store/supported-state-stores/setup-azure-blobstorage/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "Azure Cosmos DB"
linkTitle: "Azure Cosmos DB"
description: Detailed information on the Azure CosmosDB state store component
aliases:
- "/operations/components/setup-state-store/supported-state-stores/setup-azure-cosmosdb/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "Azure Table Storage "
linkTitle: "Azure Table Storage "
description: Detailed information on the Azure Table Storage state store component
aliases:
- "/operations/components/setup-state-store/supported-state-stores/setup-azure-tablestorage/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "Cassandra"
linkTitle: "Cassandra"
description: Detailed information on the Cassandra state store component
aliases:
- "/operations/components/setup-state-store/supported-state-stores/setup-cassandra/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "Cloudstate"
linkTitle: "Cloudstate"
description: Detailed information on the Cloudstate state store component
aliases:
- "/operations/components/setup-state-store/supported-state-stores/setup-cloudstate/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "HashiCorp Consul"
linkTitle: "HashiCorp Consul"
description: Detailed information on the HashiCorp Consul state store component
aliases:
- "/operations/components/setup-state-store/supported-state-stores/setup-consul/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "Couchbase"
linkTitle: "Couchbase"
description: Detailed information on the Couchbase state store component
aliases:
- "/operations/components/setup-state-store/supported-state-stores/setup-couchbase/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "AWS DynamoDB"
linkTitle: "AWS DynamoDB"
description: Detailed information on the AWS DynamoDB state store component
aliases:
- "/operations/components/setup-state-store/supported-state-stores/setup-dynamodb/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "GCP Firestore (Datastore mode)"
linkTitle: "GCP Firestore"
description: Detailed information on the GCP Firestore state store component
aliases:
- "/operations/components/setup-state-store/supported-state-stores/setup-firestore/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "Hazelcast"
linkTitle: "Hazelcast"
description: Detailed information on the Hazelcast state store component
aliases:
- "/operations/components/setup-state-store/supported-state-stores/setup-hazelcast/"
---
## Create a Dapr component

View File

@ -3,6 +3,8 @@ type: docs
title: "Memcached"
linkTitle: "Memcached"
description: Detailed information on the Memcached state store component
aliases:
- "/operations/components/setup-state-store/supported-state-stores/setup-memcached/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "MongoDB"
linkTitle: "MongoDB"
description: Detailed information on the MongoDB state store component
aliases:
- "/operations/components/setup-state-store/supported-state-stores/setup-mongodb/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "MySQL"
linkTitle: "MySQL"
description: Detailed information on the MySQL state store component
aliases:
- "/operations/components/setup-state-store/supported-state-stores/setup-mysql/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "PostgreSQL"
linkTitle: "PostgreSQL"
description: Detailed information on the PostgreSQL state store component
aliases:
- "/operations/components/setup-state-store/supported-state-stores/setup-postgresql/"
---
## Create a Dapr component

View File

@ -3,6 +3,8 @@ type: docs
title: "Redis"
linkTitle: "Redis"
description: Detailed information on the Redis state store component
aliases:
- "/operations/components/setup-state-store/supported-state-stores/setup-redis/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "RethinkDB"
linkTitle: "RethinkDB"
description: Detailed information on the RethinkDB state store component
aliases:
- "/operations/components/setup-state-store/supported-state-stores/setup-rethinkdb/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "SQL Server"
linkTitle: "SQL Server"
description: Detailed information on the SQL Server state store component
aliases:
- "/operations/components/setup-state-store/supported-state-stores/setup-sqlserver/"
---
## Component format

View File

@ -3,6 +3,8 @@ type: docs
title: "Zookeeper"
linkTitle: "Zookeeper"
description: Detailed information on the Zookeeper state store component
aliases:
- "/operations/components/setup-state-store/supported-state-stores/setup-zookeeper/"
---
## Component format