Skip to content

Commit

Permalink
Upmerge 1.7 into 1.8 [2022-06-20] (#2546)
Browse files Browse the repository at this point in the history
* fix code snippet typo and grammar pass

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* fix parameter typo and grammar pass

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* Fix CLI command typo

Fix CLI certificate renewal command typo

Signed-off-by: Bernd Verst <4535280+berndverst@users.noreply.github.com>

* Fixes state-store-ttl Python example (#2352)

* Update state-store-ttl.md

Add comma so the metadata value is a tuple of tuple, otherwise Python collapses it to just being an ordinary tuple.

Signed-off-by: Bernd Verst <4535280+berndverst@users.noreply.github.com>

* Update pubsub-raw.md

Signed-off-by: Bernd Verst <4535280+berndverst@users.noreply.github.com>

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* Fix go quickstart port (#2360)

* fix go quickstart port

Signed-off-by: yaron2 <schneider.yaron@live.com>

* fix pub/sub port also

Signed-off-by: yaron2 <schneider.yaron@live.com>

* Fixes wrong working directory for dotnet state management sample (#2359)

* Wrong working directory for .Net state management sample

The working directory for .NET is pointing to `pub_sub` but it should be `state_management`.

Signed-off-by: Stephane Lapointe <stephane.lap@outlook.com>

* Removing the word "publisher" which was also unneed

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* add new dapr init flags and examples to docs

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* quick save

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* [state management] Update docs around transactional operations (#2372)

* clarify transactional operations in docs

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* Added some more details for clarity

* updates per Mark

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* remove en from link

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* ignore links attempt

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* Fixed typo in security concept doc (#2374)

Signed-off-by: moreyhat <moreyhat@gmail.com>

Co-authored-by: Yaron Schneider <schneider.yaron@live.com>

* Fix curl example

`\` is missing for some curl examples.

Signed-off-by: zhangchao <zchao9100@gmail.com>

* Update metrics-overview.md

* replace zip file; update url (#2386)

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* Update to version to 1.7.1 (#2388)

Signed-off-by: Nick Greenfield <nigreenf@microsoft.com>

* typo fix (#2384)

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* update building_blocks.png (#2387)

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* Update dapr runtime version to 1.7.2

Signed-off-by: Nick Greenfield <nigreenf@microsoft.com>

* Remove "quickstart" references from tutorial (#2383)

* remove quickstart references

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* Update daprdocs/content/en/getting-started/tutorials/get-started-component.md

* Update daprdocs/content/en/getting-started/tutorials/get-started-component.md

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* sentry isn't installed by default in self-hosted mode (#2366)

* sentry isn't installed by default in self-hosted mode

Fixes: #2365

Signed-off-by: Doug Davis <dug@microsoft.com>

* Update daprdocs/content/en/concepts/dapr-services/sentry.md

Co-authored-by: greenie-msft <56556602+greenie-msft@users.noreply.github.com>
Co-authored-by: Mark Fussell <markfussell@gmail.com>

* Bump nanoid from 3.1.23 to 3.3.2 in /daprdocs (#2348)

Bumps [nanoid](https://github.com/ai/nanoid) from 3.1.23 to 3.3.2.
- [Release notes](https://github.com/ai/nanoid/releases)
- [Changelog](https://github.com/ai/nanoid/blob/main/CHANGELOG.md)
- [Commits](ai/nanoid@3.1.23...3.3.2)

---
updated-dependencies:
- dependency-name: nanoid
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: greenie-msft <56556602+greenie-msft@users.noreply.github.com>
Co-authored-by: Mark Fussell <markfussell@gmail.com>

* update JS submodule

Signed-off-by: Nick Greenfield <nigreenf@microsoft.com>

* [Dapr API] Extend example to include delete state (#2377)

* extend dapr api example

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* remove extra #

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* quote urls

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* ignore links

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* remove transactional and bulk get

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* update intro to only one object

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* Update daprdocs/content/en/getting-started/get-started-api.md

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* Update daprdocs/content/en/getting-started/get-started-api.md

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* Update daprdocs/content/en/getting-started/get-started-api.md

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* Update daprdocs/content/en/getting-started/get-started-api.md

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* Update daprdocs/content/en/getting-started/get-started-api.md

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* Update daprdocs/content/en/getting-started/get-started-api.md

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

Co-authored-by: Mark Fussell <markfussell@gmail.com>

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* Fix TTL example for Python (#2394)

Signed-off-by: Bernd Verst <4535280+berndverst@users.noreply.github.com>

* Fix config yaml w.r.t. name and namespace (#2397)

The config sample yaml used the wrong namespace and while in there I decided to
mention the name of the config instead of just its namespace since the two
are so similar, I didn't want people to think one was a typo.

And the monitoring sample had a typo.

Signed-off-by: Doug Davis <dug@microsoft.com>

* [quickstarts] fix port typo in pubsub and service invo (#2369)

* fix typo in js command

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* check commands in other quickstarts

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* update kubernetes overview to explain where annotations should actually go to (#2400)

Signed-off-by: Thorsten Hans <thorsten.hans@gmail.com>

Co-authored-by: Yaron Schneider <schneider.yaron@live.com>

* Add profile-port to env variables table (#2402)

* add profile-port to env variables table

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* fix link

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* [secrets and actors api reference docs] error code fixes (#2356)

* error code fixes

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* reverting changes to secrets api

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* update presentation

Signed-off-by: msfussell <markfussell@gmail.com>

* add note to table

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* add missing upgrade step for 1.7 (#2423)

Signed-off-by: yaron2 <schneider.yaron@live.com>

* update presentation (#2415)

Signed-off-by: msfussell <markfussell@gmail.com>

Co-authored-by: greenie-msft <56556602+greenie-msft@users.noreply.github.com>

* new deck

Signed-off-by: msfussell <markfussell@gmail.com>

* Fixes in howto-bindings: (#2416)

- JS and curl samples were sending data as objects but sample apps expected ints
- Improved JS sample to correctly handle async code and make it more readable
- Fixed indentation in .NET code
- JavaScript has uppercased S

Signed-off-by: Alessandro Segala (ItalyPaleAle) <43508+ItalyPaleAle@users.noreply.github.com>

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* API tokens do not need to be JWT's (#2332)

* API tokens do not need to be JWT's

Signed-off-by: Alessandro (Ale) Segala <43508+ItalyPaleAle@users.noreply.github.com>

* Updated app-api-token

Signed-off-by: GitHub <noreply@github.com>

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* message for restarting the dapr-enabled pods (#2399)

* message for restarting the dapr-enabled pods

Signed-off-by: Pravin Pushkar <ppushkar@microsoft.com>

* Addressed review comments

Signed-off-by: Pravin Pushkar <ppushkar@microsoft.com>

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* fix kafka pubsub example config (#2429)

Signed-off-by: zhangchao <zchao9100@gmail.com>

* update otel collector version to 0.50.0 (#2434)

Signed-off-by: fabistb <fabian0401@online.de>

* Fixing URL bug in AWS name (#2439)

Signed-off-by: msfussell <markfussell@gmail.com>

* Update runtime version to 1.7.3

Signed-off-by: Nick Greenfield <nigreenf@microsoft.com>

* Update vscode-how-to-debug-multiple-dapr-apps.md

Signed-off-by: Jack Liu shurui <jackliusr@gmail.com>

* correct configuration.program in launch.json

Signed-off-by: Jack Liu shurui <jackliusr@gmail.com>

* Update daprdocs/content/en/reference/arguments-annotations-overview.md

* Mention that the DAPR_INSTALL_DIR directory must already exist (#2410)

Signed-off-by: Jakub Kuczys <6032823+jack1142@users.noreply.github.com>

Co-authored-by: greenie-msft <56556602+greenie-msft@users.noreply.github.com>
Co-authored-by: Mark Fussell <markfussell@gmail.com>

* Added missing metadata option for Service Bus in 1.7 (#2448)

* Added missing metadata option for Service Bus

Signed-off-by: ItalyPaleAle <43508+ItalyPaleAle@users.noreply.github.com>

* Update daprdocs/content/en/reference/components-reference/supported-pubsub/setup-azure-servicebus.md

Signed-off-by: Alessandro (Ale) Segala <43508+ItalyPaleAle@users.noreply.github.com>

Co-authored-by: Mark Fussell <markfussell@gmail.com>

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* [Pub/sub] Overview & how-tos (#2414)

* overview; parse out howto-publish-subscribe

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* updates after talk w Mark

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* break up cloudevents into two articles

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* update to overview

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* how to and overview updates

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* grammar pass before opening for review

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* updates from Mark

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* updated diagram

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* typo fix and freshness pass (#2460)

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* add example of non-default ports (#2458)

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* [AWS components] Add note for AWS K8s components (#2459)

* add aws note

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* small fix

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* fix typo (#2468)

fix typo on Components page: #2466

Signed-off-by: owen <zhi_gang_sun@163.com>

* Update latest version of dapr runtime to 1.7.4 (#2478)

Signed-off-by: Nick Greenfield <nigreenf@microsoft.com>

* Update service-invocation-overview.md (#2419)

* Update service-invocation-overview.md

This is a work in progress. Opening an early draft-PR to start getting feedback before I complete the doc refresh for service invocation API.

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

Added table for doc consistency between refresh docs

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update daprdocs/content/en/developing-applications/building-blocks/service-invocation/service-invocation-overview.md

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* Update daprdocs/content/en/developing-applications/building-blocks/service-invocation/service-invocation-overview.md

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* Update daprdocs/content/en/developing-applications/building-blocks/service-invocation/service-invocation-overview.md

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* Update daprdocs/content/en/developing-applications/building-blocks/service-invocation/service-invocation-overview.md

Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>

* Update daprdocs/content/en/developing-applications/building-blocks/service-invocation/service-invocation-overview.md

Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>

* Update daprdocs/content/en/developing-applications/building-blocks/service-invocation/service-invocation-overview.md

Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>

* Update daprdocs/content/en/developing-applications/building-blocks/service-invocation/service-invocation-overview.md

Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>

* Update daprdocs/content/en/developing-applications/building-blocks/service-invocation/service-invocation-overview.md

Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>

* Update daprdocs/content/en/developing-applications/building-blocks/service-invocation/service-invocation-overview.md

Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>

* Update daprdocs/content/en/developing-applications/building-blocks/service-invocation/service-invocation-overview.md

Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>

* Update daprdocs/content/en/developing-applications/building-blocks/service-invocation/service-invocation-overview.md

Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>

* Update daprdocs/content/en/developing-applications/building-blocks/service-invocation/service-invocation-overview.md

Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>

* Update daprdocs/content/en/developing-applications/building-blocks/service-invocation/service-invocation-overview.md

Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>

* Update daprdocs/content/en/developing-applications/building-blocks/service-invocation/service-invocation-overview.md

Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>

* Update service-invocation-overview.md

* Update service-invocation-overview.md

* Update service-invocation-overview.md

Co-authored-by: greenie-msft <56556602+greenie-msft@users.noreply.github.com>
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>

* [Quickstart] Secrets Mgmt (#2470)

* initial draft

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* link to quickstart from overview and howto

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* add go example

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* forgot go tab

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* small change

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* attempt at java example (#2486)

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* fix link (#2489)

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* update orderprocessor port (#2491)

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* [State store component] Add clarification to Redis state store setup (#2492)

* add suggested text

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* peer level

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* Match linkTitle case for HTTP (#2480)

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* fix and move links (#2505)

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* fix formatting and add response output (#2504)

Signed-off-by: Sarthak Sharma <t-sartsharma@microsoft.com>

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* Add note to documentation to reference the podName attribute (#2523)

Signed-off-by: CacheCoww <hmsmith2510@gmail.com>

* Added spec.metadata to example and note (#2527)

Signed-off-by: Tyson Lawrie <tlawrie@users.noreply.github.com>

* Clarify how Component configuration works (#2507)

* Add section on Component configuration.

* Clarify component configuration details.

* Update daprdocs/content/en/concepts/components-concept.md

Co-authored-by: Mark Fussell <markfussell@gmail.com>

Signed-off-by: Simon Waight <simon.waight@gmail.com>

* Update daprdocs/content/en/concepts/components-concept.md

Co-authored-by: Mark Fussell <markfussell@gmail.com>

Signed-off-by: Simon Waight <simon.waight@gmail.com>

* Update daprdocs/content/en/concepts/components-concept.md

Signed-off-by: Mark Fussell <markfussell@gmail.com>

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* [secrets mgmt] typo in go section (#2530)

* typo in go section

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* clean up link

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* change opencensus link

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* Fixed Go sample code (#2531)

Signed-off-by: Alessandro (Ale) Segala <43508+ItalyPaleAle@users.noreply.github.com>

Co-authored-by: Mark Fussell <markfussell@gmail.com>

* Update issue and typos (#2533)

* diagram updates (#2536)

Signed-off-by: msfussell <markfussell@gmail.com>

* [How-tos] Remove step numbers in how-to docs (#2542)

* changes per Nick

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* updates per Mark

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

* fix error

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

Co-authored-by: Mark Fussell <markfussell@gmail.com>

Co-authored-by: Hannah Hunter <hannahhunter@microsoft.com>
Co-authored-by: Bernd Verst <4535280+berndverst@users.noreply.github.com>
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Co-authored-by: Yaron Schneider <schneider.yaron@live.com>
Co-authored-by: Stephane Lapointe <slapointe@users.noreply.github.com>
Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>
Co-authored-by: moreyhat <moreyhat@gmail.com>
Co-authored-by: Taction <zchao9100@gmail.com>
Co-authored-by: Doug Davis <duglin@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Thorsten Hans <thorsten.hans@outlook.com>
Co-authored-by: Alessandro (Ale) Segala <43508+ItalyPaleAle@users.noreply.github.com>
Co-authored-by: Pravin Pushkar <ppushkar@microsoft.com>
Co-authored-by: Fabian Steinbach <63794579+fabistb@users.noreply.github.com>
Co-authored-by: Jack Liu Shurui <jackliusr@gmail.com>
Co-authored-by: Jakub Kuczys <6032823+jack1142@users.noreply.github.com>
Co-authored-by: zhi-gang-sun <zgsun@cn.ibm.com>
Co-authored-by: nyemade-uversky <55847877+nyemade-uversky@users.noreply.github.com>
Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>
Co-authored-by: Sarthak Sharma <48413781+sarsharma@users.noreply.github.com>
Co-authored-by: CacheCoww <hmsmith2510@gmail.com>
Co-authored-by: Tyson Lawrie <tlawrie@users.noreply.github.com>
Co-authored-by: Simon Waight <simon.waight@gmail.com>
  • Loading branch information
1 parent 3d575e4 commit e540ceb
Show file tree
Hide file tree
Showing 58 changed files with 1,857 additions and 822 deletions.
24 changes: 16 additions & 8 deletions daprdocs/content/en/concepts/components-concept.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,53 +12,61 @@ Dapr uses a modular design where functionality is delivered as a component. Each

You can get a list of current components available in the hosting environment using the `dapr components` CLI command.

## Component specification

Each component has a specification (or spec) that it conforms to. Components are configured at design-time with a YAML file which is stored in either a `components/local` folder within your solution, or globally in the `.dapr` folder created when invoking `dapr init`. These YAML files adhere to the generic [Dapr component schema]({{<ref "component-schema.md">}}), but each is specific to the component specification.

It is important to understand that the component spec values, particularly the spec `metadata`, can change between components of the same component type, for example between different state stores, and that some design-time spec values can be overridden at runtime when making requests to a component's API. As a result, it is strongly recommended to review a [component's specs]({{<ref "components-reference">}}), paying particular attention to the sample payloads for requests to set the metadata used to interact with the component.

## Available component types

The following are the component types provided by Dapr:

## State stores
### State stores

State store components are data stores (databases, files, memory) that store key-value pairs as part of the [state management]({{< ref "state-management-overview.md" >}}) building block.

- [List of state stores]({{< ref supported-state-stores >}})
- [State store implementations](https://github.com/dapr/components-contrib/tree/master/state)

## Name resolution
### Name resolution

Name resolution components are used with the [service invocation]({{<ref "service-invocation-overview.md">}}) building block to integrate with the hosting environment and provide service-to-service discovery. For example, the Kubernetes name resolution component integrates with the Kubernetes DNS service, self-hosted uses mDNS and clusters of VMs can use the Consul name resolution component.

- [List of name resolution components]({{< ref supported-name-resolution >}})
- [Name resolution implementations](https://github.com/dapr/components-contrib/tree/master/nameresolution)

## Pub/sub brokers
### Pub/sub brokers

Pub/sub broker components are message brokers that can pass messages to/from services as part of the [publish & subscribe]({{< ref pubsub-overview.md >}}) building block.

- [List of pub/sub brokers]({{< ref supported-pubsub >}})
- [Pub/sub broker implementations](https://github.com/dapr/components-contrib/tree/master/pubsub)

## Bindings
### Bindings

External resources can connect to Dapr in order to trigger a method on an application or be called from an application as part of the [bindings]({{< ref bindings-overview.md >}}) building block.

- [List of supported bindings]({{< ref supported-bindings >}})
- [Binding implementations](https://github.com/dapr/components-contrib/tree/master/bindings)

## Secret stores
### Secret stores

A [secret]({{<ref "secrets-overview.md">}}) is any piece of private information that you want to guard against unwanted access. Secrets stores are used to store secrets that can be retrieved and used in applications.

- [List of supported secret stores]({{< ref supported-secret-stores >}})
- [Secret store implementations](https://github.com/dapr/components-contrib/tree/master/secretstores)

## Configuration stores
### Configuration stores

Configuration stores are used to save application data, which can then be read by application instances on startup or notified of when changes occur. This allows for dynamic configuration.

- [List of supported configuration stores]({{< ref supported-configuration-stores >}})
- [Configuration store implementations](https://github.com/dapr/components-contrib/tree/master/configuration)

## Middleware
### Middleware

Dapr allows custom [middleware]({{<ref "middleware.md">}}) to be plugged into the HTTP request processing pipeline. Middleware can perform additional actions on an HTTP request, such as authentication, encryption and message transformation before the request is routed to the user code, or before the request is returned to the client. The middleware components are used with the [service invocation]({{<ref "service-invocation-overview.md">}}) building block.
Dapr allows custom [middleware]({{<ref "middleware.md">}}) to be plugged into the HTTP request processing pipeline. Middleware can perform additional actions on an HTTP request, such as authentication, encryption and message transformation before the request is routed to the user code, or before the response is returned to the client. The middleware components are used with the [service invocation]({{<ref "service-invocation-overview.md">}}) building block.

- [List of supported middleware components]({{< ref supported-middleware >}})
- [Middleware implementations](https://github.com/dapr/components-contrib/tree/master/middleware)
11 changes: 8 additions & 3 deletions daprdocs/content/en/concepts/dapr-services/sidecar.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,13 @@ weight: 100
description: "Overview of the Dapr sidecar process"
---

Dapr uses a [sidecar pattern]({{< ref "concepts/overview.md#sidecar-architecture" >}}), meaning the Dapr APIs are run and exposed on a separate process (i.e. the Dapr sidecar) running alongside your application. The Dapr sidecar process is named `daprd` and is launched in different ways depending on the hosting environment.
Dapr uses a [sidecar pattern]({{< ref "concepts/overview.md#sidecar-architecture" >}}), meaning the Dapr APIs are run and exposed on a separate process, the Dapr sidecar, running alongside your application. The Dapr sidecar process is named `daprd` and is launched in different ways depending on the hosting environment.

The Dapr sidecar exposes [building block APIs]({{<ref building-blocks-concept>}}) used by your application business logic, a [metadata API]({{<ref metadata_api>}}) for discoverability of capabiliites and to set attributes and a [health API]({{<ref sidecar-health>}}) to determine health status.

<img src="/images/overview-sidecar-apis.png" width=700>

The sidecar APIs are called from your application over local http or gRPC endpoints.
<img src="/images/overview-sidecar-model.png" width=700>

## Self-hosted with `dapr run`
Expand All @@ -20,13 +25,13 @@ On [Kubernetes]({{< ref kubernetes.md >}}), the Dapr control plane includes the

## Running the sidecar directly

In most cases you do not need to run `daprd` explicitly, as the sidecar is either launched by the CLI (self-hosted mode) or by the dapr-sidecar-injector service (Kubernetes). For advanced use cases (debugging, scripted deployments, etc.) the `daprd` process can be launched directly.
In most cases you do not need to run `daprd` explicitly, as the sidecar is either launched by the [CLI]({{<ref cli-overview>}}) (self-hosted mode) or by the dapr-sidecar-injector service (Kubernetes). For advanced use cases (debugging, scripted deployments, etc.) the `daprd` process can be launched directly.

For a detailed list of all available arguments run `daprd --help` or see this [table]({{< ref arguments-annotations-overview.md >}}) which outlines how the `daprd` arguments relate to the CLI arguments and Kubernetes annotations.

### Examples

1. Start a sidecar along an application by specifying its unique ID. Note `--app-id` is a required field:
1. Start a sidecar along with an application by specifying its unique ID. Note `--app-id` is a required field:

```bash
daprd --app-id myapp
Expand Down
Loading

0 comments on commit e540ceb

Please sign in to comment.