Skip to content

Commit f2a25fc

Browse files
pravinpushkarmsfussellyaron2mukundansundar
authored
Adding pluggable secret store doc (#3792)
Signed-off-by: Pravin Pushkar <ppushkar@microsoft.com> Co-authored-by: Mark Fussell <markfussell@gmail.com> Co-authored-by: Yaron Schneider <schneider.yaron@live.com> Co-authored-by: Mukundan Sundararajan <65565396+mukundansundar@users.noreply.github.com>
1 parent 6d1e6c4 commit f2a25fc

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

daprdocs/content/en/developing-applications/develop-components/pluggable-components/develop-pluggable.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,21 @@ In order to implement a pluggable component, you need to implement a gRPC servic
1414

1515
### Find the proto definition file
1616

17-
Proto definitions are provided for each supported service interface (state store, pub/sub, bindings).
17+
Proto definitions are provided for each supported service interface (state store, pub/sub, bindings, secret stores).
1818

1919
Currently, the following component APIs are supported:
2020

2121
- State stores
2222
- Pub/sub
2323
- Bindings
24+
- Secret stores
2425

2526
| Component | Type | gRPC definition | Built-in Reference Implementation | Docs |
2627
| :---------: | :--------: | :--------------: | :----------------------------------------------------------------------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
27-
| State Store | `state` | [state.proto] | [Redis](https://github.com/dapr/components-contrib/tree/master/state/redis) | [concept]({{< ref "state-management-overview" >}}), [howto]({{< ref "howto-get-save-state" >}}), [api spec]({{< ref "state_api" >}}) |
28-
| Pub/sub | `pubsub` | [pubsub.proto] | [Redis](https://github.com/dapr/components-contrib/tree/master/pubsub/redis) | [concept]({{< ref "pubsub-overview" >}}), [howto]({{< ref "howto-publish-subscribe" >}}), [api spec]({{< ref "pubsub_api" >}}) |
29-
| Bindings | `bindings` | [bindings.proto] | [Kafka](https://github.com/dapr/components-contrib/tree/master/bindings/kafka) | [concept]({{< ref "bindings-overview" >}}), [input howto]({{< ref "howto-triggers" >}}), [output howto]({{< ref "howto-bindings" >}}), [api spec]({{< ref "bindings_api" >}}) |
28+
| State Store | `state` | [state.proto](https://github.com/dapr/dapr/blob/master/dapr/proto/components/v1/state.proto) | [Redis](https://github.com/dapr/components-contrib/tree/master/state/redis) | [concept]({{< ref "state-management-overview" >}}), [howto]({{< ref "howto-get-save-state" >}}), [api spec]({{< ref "state_api" >}}) |
29+
| Pub/sub | `pubsub` | [pubsub.proto](https://github.com/dapr/dapr/blob/master/dapr/proto/components/v1/pubsub.proto) | [Redis](https://github.com/dapr/components-contrib/tree/master/pubsub/redis) | [concept]({{< ref "pubsub-overview" >}}), [howto]({{< ref "howto-publish-subscribe" >}}), [api spec]({{< ref "pubsub_api" >}}) |
30+
| Bindings | `bindings` | [bindings.proto](https://github.com/dapr/dapr/blob/master/dapr/proto/components/v1/bindings.proto) | [Kafka](https://github.com/dapr/components-contrib/tree/master/bindings/kafka) | [concept]({{< ref "bindings-overview" >}}), [input howto]({{< ref "howto-triggers" >}}), [output howto]({{< ref "howto-bindings" >}}), [api spec]({{< ref "bindings_api" >}}) |
31+
| Secret Store | `secretstores` | [secretstore.proto](https://github.com/dapr/dapr/blob/master/dapr/proto/components/v1/secretstore.proto) | [Hashicorp/Vault](https://github.com/dapr/components-contrib/blob/master/secretstores/hashicorp/vault/vault.go) | [concept]({{< ref "secrets-overview" >}}), [howto-secrets]({{< ref "howto-secrets" >}}), [api spec]({{< ref "secrets_api" >}}) |
3032

3133
Below is a snippet of the gRPC service definition for pluggable component state stores ([state.proto]):
3234

@@ -95,11 +97,15 @@ Provide a concrete implementation of the desired service. Each component has a g
9597

9698
- **Pub/sub**
9799

98-
Pluggable pub/sub components only have a single core service interface defined ([pubsub.proto]). They have no optional service interfaces.
100+
Pluggable pub/sub components only have a single core service interface defined [pubsub.proto](https://github.com/dapr/dapr/blob/master/dapr/proto/components/v1/pubsub.proto). They have no optional service interfaces.
99101

100102
- **Bindings**
101103

102-
Pluggable input and output bindings have a single core service definition on [bindings.proto]. They have no optional service interfaces.
104+
Pluggable input and output bindings have a single core service definition on [bindings.proto](https://github.com/dapr/dapr/blob/master/dapr/proto/components/v1/bindings.proto). They have no optional service interfaces.
105+
106+
- **Secret Store**
107+
108+
Pluggable Secret store have a single core service definition on [secretstore.proto](https://github.com/dapr/dapr/blob/master/dapr/proto/components/v1/secretstore.proto). They have no optional service interfaces.
103109

104110
After generating the above state store example's service scaffolding code using gRPC and protocol buffers tools, you can define concrete implementations for the 9 methods defined under `service StateStore`, along with code to initialize and communicate with your dependencies.
105111

daprdocs/content/en/developing-applications/develop-components/pluggable-components/pluggable-components-overview.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,3 @@ In contrast, pluggable components require additional steps before they can commu
6363

6464
- [Implement a pluggable component]({{< ref develop-pluggable.md >}})
6565
- [Pluggable component registration]({{< ref "pluggable-components-registration" >}})
66-
67-
[state.proto]: https://github.com/dapr/dapr/blob/master/dapr/proto/components/v1/state.proto
68-
[pubsub.proto]: https://github.com/dapr/dapr/blob/master/dapr/proto/components/v1/pubsub.proto
69-
[bindings.proto]: https://github.com/dapr/dapr/blob/master/dapr/proto/components/v1/bindings.proto

0 commit comments

Comments
 (0)