From 55a79b90645466c52e1594e8e66a942e78abf9fc Mon Sep 17 00:00:00 2001 From: Ori Zohar Date: Wed, 11 Aug 2021 10:39:55 -0700 Subject: [PATCH 01/10] Porting daprd ref from PR 1662 --- daprdocs/content/en/concepts/_index.md | 2 +- .../en/concepts/dapr-services/_index.md | 7 +++ .../en/concepts/dapr-services/sidecar.md | 52 +++++++++++++++++++ 3 files changed, 60 insertions(+), 1 deletion(-) create mode 100644 daprdocs/content/en/concepts/dapr-services/_index.md create mode 100644 daprdocs/content/en/concepts/dapr-services/sidecar.md diff --git a/daprdocs/content/en/concepts/_index.md b/daprdocs/content/en/concepts/_index.md index bcfdf00f6..e685e646b 100644 --- a/daprdocs/content/en/concepts/_index.md +++ b/daprdocs/content/en/concepts/_index.md @@ -1,6 +1,6 @@ --- type: docs -title: "Dapr Concepts" +title: "Dapr concepts" linkTitle: "Concepts" weight: 10 description: "Learn about Dapr including its main features and capabilities" diff --git a/daprdocs/content/en/concepts/dapr-services/_index.md b/daprdocs/content/en/concepts/dapr-services/_index.md new file mode 100644 index 000000000..be981e14a --- /dev/null +++ b/daprdocs/content/en/concepts/dapr-services/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "Dapr services" +linkTitle: "Dapr services" +weight: 800 +description: "Learn about the services that make up Dapr" +--- \ No newline at end of file diff --git a/daprdocs/content/en/concepts/dapr-services/sidecar.md b/daprdocs/content/en/concepts/dapr-services/sidecar.md new file mode 100644 index 000000000..11d1de7ba --- /dev/null +++ b/daprdocs/content/en/concepts/dapr-services/sidecar.md @@ -0,0 +1,52 @@ +--- +type: docs +title: "daprd sidecar process reference" +linkTitle: "daprd" +weight: 300 +description: "Detailed information on the daprd process and usage examples" +--- + +## Overview + +The daprd process is what you think of as "Dapr". It is the process that offers the various Dapr [building blocks]({{< ref building-blocks >}}) through HTTP and gRPC APIs to your application. + +The daprd process runs alongside your application as a [sidecar]({{< ref "overview.md#sidecar-architecture" >}}), either as a process in a self-hosted environment or as a container within the application pods in a Kubernetes environment. + +## Installation + +When initializing Dapr in self-hosted mode via `dapr init`, the daprd binary is installed to the`.dapr/bin` directory within your home directory. Running `dapr run` will launch a daprd process alongside your application. + +On Kubernetes, `dapr init -k` will install the [dapr-sidecar-injector service]({{< ref kubernetes-overview.md >}}), which will watch for new pods with the `dapr.io/enabled` annotation and inject a container with the daprd process within the pod. + +## Running 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. + +For a detailed list of all available arguments run `daprd --help` or see this [table]({{< ref arguments-annotations-overview.md >}}). + +### Examples + +1. Start a sidecar along an application by specifying its unique ID. Note `--app-id` is a required field: + +```bash +~/.dapr/bin/daprd --app-id myapp +``` + +2. Specify the port your application is listening to + +```bash +~/.dapr/bin/daprd --app-id --app-port 5000 +``` +3. If you are using several custom components and want to specify the location of the component definition files, use the `--components-path` argument: + +```bash +~/.dapr/bin/daprd --app-id myapp --components-path ~/.dapr/components +``` + +4. Enable collection of Prometheus metrics while running your app + +```bash +~/.dapr/bin/daprd --app-id myapp --enable-metrics +``` From bb323e3beabc3af9e84a9459f8fbf95eb686af8c Mon Sep 17 00:00:00 2001 From: Ori Zohar Date: Fri, 20 Aug 2021 13:13:11 -0700 Subject: [PATCH 02/10] Revising sidecar doc --- .../en/concepts/dapr-services/sidecar.md | 29 +++++++------------ 1 file changed, 11 insertions(+), 18 deletions(-) diff --git a/daprdocs/content/en/concepts/dapr-services/sidecar.md b/daprdocs/content/en/concepts/dapr-services/sidecar.md index 11d1de7ba..1002c28eb 100644 --- a/daprdocs/content/en/concepts/dapr-services/sidecar.md +++ b/daprdocs/content/en/concepts/dapr-services/sidecar.md @@ -1,30 +1,23 @@ --- type: docs -title: "daprd sidecar process reference" -linkTitle: "daprd" +title: "Dapr sidecar (daprd)" +linkTitle: "Sidecar" weight: 300 -description: "Detailed information on the daprd process and usage examples" +description: "Overview of the Dapr sidecar process" --- -## Overview +Dapr uses the [sidecar pattern]({{< ref "overview.md#sidecar-architecture" >}}), meaning that the Dapr APIs are 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 how the hosting environment. -The daprd process is what you think of as "Dapr". It is the process that offers the various Dapr [building blocks]({{< ref building-blocks >}}) through HTTP and gRPC APIs to your application. +## Self-hosted mode +When Dapr is installed in [self-hosted mode]({{}}), the `daprd` binary is downloaded and placed under the user home directory (`$HOME/.dapr/bin` for Linux/MacOS or `%USERPROFILE%\.dapr\bin\` for Windows). In self hosted mode, running the Dapr CLI run command launches the `daprd` executable together with the provided application executable. This is the recommended way of running the Dapr sidecar when working locally in scenarios such as development and testing. The various arguments that the CLI exposes to configure the sidecar can be found in the [Dapr run command reference]]({{}}). -The daprd process runs alongside your application as a [sidecar]({{< ref "overview.md#sidecar-architecture" >}}), either as a process in a self-hosted environment or as a container within the application pods in a Kubernetes environment. +## Kubernetes +On Kubernetes, the Dapr control plane includes the [dapr-sidecar-injector service]({{< ref kubernetes-overview.md >}}), which watches for new pods with the `dapr.io/enabled` annotation and injects a container with the `daprd` process within the pod. In this case, sidecar arguments can be passed through annotations as outlined in the **K8S annotations** column in [this table]({{}}). -## Installation +## 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. -When initializing Dapr in self-hosted mode via `dapr init`, the daprd binary is installed to the`.dapr/bin` directory within your home directory. Running `dapr run` will launch a daprd process alongside your application. - -On Kubernetes, `dapr init -k` will install the [dapr-sidecar-injector service]({{< ref kubernetes-overview.md >}}), which will watch for new pods with the `dapr.io/enabled` annotation and inject a container with the daprd process within the pod. - -## Running 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. - -For a detailed list of all available arguments run `daprd --help` or see this [table]({{< ref arguments-annotations-overview.md >}}). +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 From f7b9ea49cd927610b77a6b9514b12040265b0400 Mon Sep 17 00:00:00 2001 From: Ori Zohar Date: Fri, 20 Aug 2021 13:13:28 -0700 Subject: [PATCH 03/10] minor fixes --- daprdocs/content/en/concepts/terminology.md | 2 +- daprdocs/content/en/operations/hosting/self-hosted/_index.md | 2 +- daprdocs/content/en/reference/arguments-annotations-overview.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/daprdocs/content/en/concepts/terminology.md b/daprdocs/content/en/concepts/terminology.md index 5e97b8f7a..ce9273d12 100644 --- a/daprdocs/content/en/concepts/terminology.md +++ b/daprdocs/content/en/concepts/terminology.md @@ -2,7 +2,7 @@ type: docs title: "Dapr terminology and definitions" linkTitle: "Terminology" -weight: 800 +weight: 900 description: Definitions for common terms and acronyms in the Dapr documentation --- diff --git a/daprdocs/content/en/operations/hosting/self-hosted/_index.md b/daprdocs/content/en/operations/hosting/self-hosted/_index.md index 9c70df3ad..627f44f3b 100644 --- a/daprdocs/content/en/operations/hosting/self-hosted/_index.md +++ b/daprdocs/content/en/operations/hosting/self-hosted/_index.md @@ -1,6 +1,6 @@ --- type: docs -title: "Run Dapr in Self Hosted Mode" +title: "Run Dapr in self hosted mode" linkTitle: "Self-Hosted" weight: 1000 description: "How to get Dapr up and running in your local environment" diff --git a/daprdocs/content/en/reference/arguments-annotations-overview.md b/daprdocs/content/en/reference/arguments-annotations-overview.md index eec7f0c66..1ae47066a 100644 --- a/daprdocs/content/en/reference/arguments-annotations-overview.md +++ b/daprdocs/content/en/reference/arguments-annotations-overview.md @@ -10,7 +10,7 @@ aliases: This table is meant to help users understand the equivalent options for running Dapr sidecars in different contexts--via the [CLI]({{< ref cli-overview.md >}}) directly, via daprd, or on [Kubernetes]({{< ref kubernetes-overview.md >}}) via annotations. -| daprd | dapr CLI | CLI shorthand | K8s annotations | Description +| daprd | Dapr CLI | CLI shorthand | K8s annotations | Description |----- | ------- | -----------| ----------| ------------ | | `--allowed-origins` | not supported | | not supported | Allowed HTTP origins (default "*") | | `--app-id` | `--app-id` | `-i` | `dapr.io/app-id` | The unique ID of the application. Used for service discovery, state encapsulation and the pub/sub consumer ID | From 4addf47492d30cd097141afe49e627cbda3a1f96 Mon Sep 17 00:00:00 2001 From: Aaron Crawfis Date: Fri, 20 Aug 2021 13:38:33 -0700 Subject: [PATCH 04/10] Minor updates and linking --- .../en/concepts/dapr-services/_index.md | 4 +- .../en/concepts/dapr-services/sidecar.md | 42 +++++++++++-------- .../operations/hosting/self-hosted/_index.md | 2 +- .../performance-and-scalability/_index.md | 4 +- .../arguments-annotations-overview.md | 2 +- 5 files changed, 30 insertions(+), 24 deletions(-) diff --git a/daprdocs/content/en/concepts/dapr-services/_index.md b/daprdocs/content/en/concepts/dapr-services/_index.md index be981e14a..3ffe6c412 100644 --- a/daprdocs/content/en/concepts/dapr-services/_index.md +++ b/daprdocs/content/en/concepts/dapr-services/_index.md @@ -1,7 +1,7 @@ --- type: docs -title: "Dapr services" +title: "Overview of the Dapr services" linkTitle: "Dapr services" weight: 800 -description: "Learn about the services that make up Dapr" +description: "Learn about the services that make up the Dapr runtime" --- \ No newline at end of file diff --git a/daprdocs/content/en/concepts/dapr-services/sidecar.md b/daprdocs/content/en/concepts/dapr-services/sidecar.md index 1002c28eb..5012c0532 100644 --- a/daprdocs/content/en/concepts/dapr-services/sidecar.md +++ b/daprdocs/content/en/concepts/dapr-services/sidecar.md @@ -1,20 +1,25 @@ --- type: docs -title: "Dapr sidecar (daprd)" +title: "Dapr sidecar (daprd) overview" linkTitle: "Sidecar" weight: 300 description: "Overview of the Dapr sidecar process" --- -Dapr uses the [sidecar pattern]({{< ref "overview.md#sidecar-architecture" >}}), meaning that the Dapr APIs are 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 how the hosting environment. +Dapr uses a [sidecar pattern]({{< ref "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. -## Self-hosted mode -When Dapr is installed in [self-hosted mode]({{}}), the `daprd` binary is downloaded and placed under the user home directory (`$HOME/.dapr/bin` for Linux/MacOS or `%USERPROFILE%\.dapr\bin\` for Windows). In self hosted mode, running the Dapr CLI run command launches the `daprd` executable together with the provided application executable. This is the recommended way of running the Dapr sidecar when working locally in scenarios such as development and testing. The various arguments that the CLI exposes to configure the sidecar can be found in the [Dapr run command reference]]({{}}). + -## Kubernetes -On Kubernetes, the Dapr control plane includes the [dapr-sidecar-injector service]({{< ref kubernetes-overview.md >}}), which watches for new pods with the `dapr.io/enabled` annotation and injects a container with the `daprd` process within the pod. In this case, sidecar arguments can be passed through annotations as outlined in the **K8S annotations** column in [this table]({{}}). +## Self-hosted with `dapr run` + +When Dapr is installed in [self-hosted mode]({{}}), the `daprd` binary is downloaded and placed under the user home directory (`$HOME/.dapr/bin` for Linux/MacOS or `%USERPROFILE%\.dapr\bin\` for Windows). In self-hosted mode, running the Dapr CLI [`run` command]({{< ref dapr-run.md >}}) launches the `daprd` executable together with the provided application executable. This is the recommended way of running the Dapr sidecar when working locally in scenarios such as development and testing. The various arguments the CLI exposes to configure the sidecar can be found in the [Dapr run command reference]]({{}}). + +## Kubernetes with `dapr-sidecar-injector` + +On [Kubernetes]({{< ref kubernetes.md >}}), the Dapr control plane includes the [dapr-sidecar-injector service]({{< ref kubernetes-overview.md >}}), which watches for new pods with the `dapr.io/enabled` annotation and injects a container with the `daprd` process within the pod. In this case, sidecar arguments can be passed through annotations as outlined in the **Kubernetes annotations** column in [this table]({{}}). ## 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. 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. @@ -23,23 +28,24 @@ For a detailed list of all available arguments run `daprd --help` or see this [t 1. Start a sidecar along an application by specifying its unique ID. Note `--app-id` is a required field: -```bash -~/.dapr/bin/daprd --app-id myapp -``` + ```bash + ~/.dapr/bin/daprd --app-id myapp + ``` 2. Specify the port your application is listening to -```bash -~/.dapr/bin/daprd --app-id --app-port 5000 -``` + ```bash + ~/.dapr/bin/daprd --app-id --app-port 5000 + ``` + 3. If you are using several custom components and want to specify the location of the component definition files, use the `--components-path` argument: -```bash -~/.dapr/bin/daprd --app-id myapp --components-path ~/.dapr/components -``` + ```bash + ~/.dapr/bin/daprd --app-id myapp --components-path ~/.dapr/components + ``` 4. Enable collection of Prometheus metrics while running your app -```bash -~/.dapr/bin/daprd --app-id myapp --enable-metrics -``` + ```bash + ~/.dapr/bin/daprd --app-id myapp --enable-metrics + ``` diff --git a/daprdocs/content/en/operations/hosting/self-hosted/_index.md b/daprdocs/content/en/operations/hosting/self-hosted/_index.md index 627f44f3b..73aae4b5b 100644 --- a/daprdocs/content/en/operations/hosting/self-hosted/_index.md +++ b/daprdocs/content/en/operations/hosting/self-hosted/_index.md @@ -1,6 +1,6 @@ --- type: docs -title: "Run Dapr in self hosted mode" +title: "Run Dapr in self-hosted mode" linkTitle: "Self-Hosted" weight: 1000 description: "How to get Dapr up and running in your local environment" diff --git a/daprdocs/content/en/operations/performance-and-scalability/_index.md b/daprdocs/content/en/operations/performance-and-scalability/_index.md index a80ba5044..347865437 100644 --- a/daprdocs/content/en/operations/performance-and-scalability/_index.md +++ b/daprdocs/content/en/operations/performance-and-scalability/_index.md @@ -1,7 +1,7 @@ --- type: docs -title: "Performance and Scalability" -linkTitle: "Performance and Scalability" +title: "Performance and scalability statistics of Dapr" +linkTitle: "Performance and scalability" weight: 700 description: "Benchmarks and guidelines for Dapr building blocks" --- diff --git a/daprdocs/content/en/reference/arguments-annotations-overview.md b/daprdocs/content/en/reference/arguments-annotations-overview.md index cf69b2fc3..229b16a01 100644 --- a/daprdocs/content/en/reference/arguments-annotations-overview.md +++ b/daprdocs/content/en/reference/arguments-annotations-overview.md @@ -10,7 +10,7 @@ aliases: This table is meant to help users understand the equivalent options for running Dapr sidecars in different contexts--via the [CLI]({{< ref cli-overview.md >}}) directly, via daprd, or on [Kubernetes]({{< ref kubernetes-overview.md >}}) via annotations. -| daprd | Dapr CLI | CLI shorthand | K8s annotations | Description +| daprd | Dapr CLI | CLI shorthand | Kubernetes annotations | Description |----- | ------- | -----------| ----------| ------------ | | `--allowed-origins` | not supported | | not supported | Allowed HTTP origins (default "*") | | `--app-id` | `--app-id` | `-i` | `dapr.io/app-id` | The unique ID of the application. Used for service discovery, state encapsulation and the pub/sub consumer ID | From 8d0c1e2d98a4b2bf49be189b681f1bc8dcb66fc1 Mon Sep 17 00:00:00 2001 From: Ori Zohar Date: Fri, 20 Aug 2021 13:41:01 -0700 Subject: [PATCH 05/10] Fixing link --- daprdocs/content/en/concepts/dapr-services/sidecar.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/daprdocs/content/en/concepts/dapr-services/sidecar.md b/daprdocs/content/en/concepts/dapr-services/sidecar.md index 5012c0532..f009dda68 100644 --- a/daprdocs/content/en/concepts/dapr-services/sidecar.md +++ b/daprdocs/content/en/concepts/dapr-services/sidecar.md @@ -12,7 +12,7 @@ Dapr uses a [sidecar pattern]({{< ref "overview.md#sidecar-architecture" >}}), m ## Self-hosted with `dapr run` -When Dapr is installed in [self-hosted mode]({{}}), the `daprd` binary is downloaded and placed under the user home directory (`$HOME/.dapr/bin` for Linux/MacOS or `%USERPROFILE%\.dapr\bin\` for Windows). In self-hosted mode, running the Dapr CLI [`run` command]({{< ref dapr-run.md >}}) launches the `daprd` executable together with the provided application executable. This is the recommended way of running the Dapr sidecar when working locally in scenarios such as development and testing. The various arguments the CLI exposes to configure the sidecar can be found in the [Dapr run command reference]]({{}}). +When Dapr is installed in [self-hosted mode]({{}}), the `daprd` binary is downloaded and placed under the user home directory (`$HOME/.dapr/bin` for Linux/MacOS or `%USERPROFILE%\.dapr\bin\` for Windows). In self-hosted mode, running the Dapr CLI [`run` command]({{< ref dapr-run.md >}}) launches the `daprd` executable together with the provided application executable. This is the recommended way of running the Dapr sidecar when working locally in scenarios such as development and testing. The various arguments the CLI exposes to configure the sidecar can be found in the [Dapr run command reference]({{}}). ## Kubernetes with `dapr-sidecar-injector` From 6a5b5b47c6335347d6d5bb4e3590ae6bf85bf953 Mon Sep 17 00:00:00 2001 From: Ori Zohar Date: Fri, 20 Aug 2021 13:48:25 -0700 Subject: [PATCH 06/10] Removing Linux only paths in examples --- daprdocs/content/en/concepts/dapr-services/sidecar.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/daprdocs/content/en/concepts/dapr-services/sidecar.md b/daprdocs/content/en/concepts/dapr-services/sidecar.md index f009dda68..13513fe9f 100644 --- a/daprdocs/content/en/concepts/dapr-services/sidecar.md +++ b/daprdocs/content/en/concepts/dapr-services/sidecar.md @@ -29,23 +29,23 @@ For a detailed list of all available arguments run `daprd --help` or see this [t 1. Start a sidecar along an application by specifying its unique ID. Note `--app-id` is a required field: ```bash - ~/.dapr/bin/daprd --app-id myapp + daprd --app-id myapp ``` 2. Specify the port your application is listening to ```bash - ~/.dapr/bin/daprd --app-id --app-port 5000 + daprd --app-id --app-port 5000 ``` 3. If you are using several custom components and want to specify the location of the component definition files, use the `--components-path` argument: ```bash - ~/.dapr/bin/daprd --app-id myapp --components-path ~/.dapr/components + daprd --app-id myapp --components-path ``` 4. Enable collection of Prometheus metrics while running your app ```bash - ~/.dapr/bin/daprd --app-id myapp --enable-metrics + daprd --app-id myapp --enable-metrics ``` From d5bdc7a6fc7d4101bf24621d72904fbca2a400cc Mon Sep 17 00:00:00 2001 From: Aaron Crawfis Date: Fri, 20 Aug 2021 14:08:13 -0700 Subject: [PATCH 07/10] Add other services --- .../content/en/concepts/dapr-services/operator.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 daprdocs/content/en/concepts/dapr-services/operator.md diff --git a/daprdocs/content/en/concepts/dapr-services/operator.md b/daprdocs/content/en/concepts/dapr-services/operator.md new file mode 100644 index 000000000..627758d64 --- /dev/null +++ b/daprdocs/content/en/concepts/dapr-services/operator.md @@ -0,0 +1,12 @@ +--- +type: docs +title: "Dapr operator service overview" +linkTitle: "Operator" +description: "Overview of the Dapr operator process" +--- + +When running Dapr in [Kubernetes mode]({{< ref kubernetes >}}), a pod running the Dapr operator service manages [Dapr component]({{< ref components >}}) updates and provides Kubernetes services endpoints for Dapr. + +## Running the operator service + +The operator service is deployed as part of `dapr init -k`, or via the Dapr Helm charts. For more information on running Dapr on Kubernetes, visit the [Kubernetes hosting page]({{< ref kubernetes >}}). \ No newline at end of file From bd3e4252e5f1eb81434465432eb975e87df5f123 Mon Sep 17 00:00:00 2001 From: Aaron Crawfis Date: Fri, 20 Aug 2021 14:08:23 -0700 Subject: [PATCH 08/10] Add other services --- .../en/concepts/dapr-services/placement.md | 16 ++++++++++++ .../en/concepts/dapr-services/sentry.md | 26 +++++++++++++++++++ .../dapr-services/sidecar-injector.md | 12 +++++++++ .../en/concepts/dapr-services/sidecar.md | 2 +- 4 files changed, 55 insertions(+), 1 deletion(-) create mode 100644 daprdocs/content/en/concepts/dapr-services/placement.md create mode 100644 daprdocs/content/en/concepts/dapr-services/sentry.md create mode 100644 daprdocs/content/en/concepts/dapr-services/sidecar-injector.md diff --git a/daprdocs/content/en/concepts/dapr-services/placement.md b/daprdocs/content/en/concepts/dapr-services/placement.md new file mode 100644 index 000000000..8bed078ed --- /dev/null +++ b/daprdocs/content/en/concepts/dapr-services/placement.md @@ -0,0 +1,16 @@ +--- +type: docs +title: "Dapr placement service overview" +linkTitle: "Placement" +description: "Overview of the Dapr placement process" +--- + +The Dapr placement service is used to calculate and distribute distributed hash tables for the location of [Dapr actors]({{< ref actors >}} running in [self-hosted mode]({{< ref self-hosted >}}) or on [Kubernetes]({{< ref kubernetes >}}). This hash table maps actor IDs to pods or processes so a Dapr application can communicate with the actor.Anytime a Dapr application activates a Dapr actor, the placement updates the hash tables with the latest actor locations. + +## Self-hosted mode + +The placement service Docker container is started automatically as part of [`dapr init`]({{< ref self-hosted-with-docker.md >}}). It can also be run manually as a process if you are running in [slim-init mode]({{< ref self-hosted-no-docker.md >}}). + +## Kubernetes mode + +The placement service is deployed as part of `dapr init -k`, or via the Dapr Helm charts. For more information on running Dapr on Kubernetes, visit the [Kubernetes hosting page]({{< ref kubernetes >}}). diff --git a/daprdocs/content/en/concepts/dapr-services/sentry.md b/daprdocs/content/en/concepts/dapr-services/sentry.md new file mode 100644 index 000000000..0afe416be --- /dev/null +++ b/daprdocs/content/en/concepts/dapr-services/sentry.md @@ -0,0 +1,26 @@ +--- +type: docs +title: "Dapr sentry service overview" +linkTitle: "Sentry" +description: "Overview of the Dapr sentry process" +--- + +The Dapr sentry service manages mTLS between services and acts as a certificate authority. It generates mTLS certificates and distributes them to any running sidecars. This allows sidecars to communicate with encrypted, mTLS traffic. For more information read the [sidecar-to-sidecar communication overview]({{< ref "security-concept.md#sidecar-to-sidecar-communication" >}}). + +## Self-hosted mode + +The sentry service Docker container is started automatically as part of [`dapr init`]({{< ref self-hosted-with-docker.md >}}). It can also be run manually as a process if you are running in [slim-init mode]({{< ref self-hosted-no-docker.md >}}). + + + +## Kubernetes mode + +The sentry service is deployed as part of `dapr init -k`, or via the Dapr Helm charts. For more information on running Dapr on Kubernetes, visit the [Kubernetes hosting page]({{< ref kubernetes >}}). + + + +## Further reading + +- [Security overview]({{< ref security-concept.md >}}) +- [Self-hosted mode]({{< ref self-hosted-with-docker.md >}}) +- [Kubernetes mode]({{< ref kubernetes >}}) \ No newline at end of file diff --git a/daprdocs/content/en/concepts/dapr-services/sidecar-injector.md b/daprdocs/content/en/concepts/dapr-services/sidecar-injector.md new file mode 100644 index 000000000..f6338b382 --- /dev/null +++ b/daprdocs/content/en/concepts/dapr-services/sidecar-injector.md @@ -0,0 +1,12 @@ +--- +type: docs +title: "Dapr sidecar injector overview" +linkTitle: "Sidecar" +description: "Overview of the Dapr sidecar injector process" +--- + +When running Dapr in [Kubernetes mode]({{< ref kubernetes >}}), a pod is created running the dapr-sidecar-injector service, which looks for pods initialized with the [Dapr annotations]({{< ref arguments-annotations-overview.md >}}), and then creates another container in that pod for the [daprd service]({{< ref sidecar >}}) + +## Running the sidecar injector + +The sidecar injector service is deployed as part of `dapr init -k`, or via the Dapr Helm charts. For more information on running Dapr on Kubernetes, visit the [Kubernetes hosting page]({{< ref kubernetes >}}). diff --git a/daprdocs/content/en/concepts/dapr-services/sidecar.md b/daprdocs/content/en/concepts/dapr-services/sidecar.md index 13513fe9f..a00cb062d 100644 --- a/daprdocs/content/en/concepts/dapr-services/sidecar.md +++ b/daprdocs/content/en/concepts/dapr-services/sidecar.md @@ -2,7 +2,7 @@ type: docs title: "Dapr sidecar (daprd) overview" linkTitle: "Sidecar" -weight: 300 +weight: 100 description: "Overview of the Dapr sidecar process" --- From f361ede89886a7f571b841b51f16e74a715d517c Mon Sep 17 00:00:00 2001 From: Ori Zohar Date: Fri, 20 Aug 2021 14:19:14 -0700 Subject: [PATCH 09/10] adding space in injector doc title --- daprdocs/content/en/concepts/dapr-services/sidecar-injector.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/daprdocs/content/en/concepts/dapr-services/sidecar-injector.md b/daprdocs/content/en/concepts/dapr-services/sidecar-injector.md index f6338b382..36a87c384 100644 --- a/daprdocs/content/en/concepts/dapr-services/sidecar-injector.md +++ b/daprdocs/content/en/concepts/dapr-services/sidecar-injector.md @@ -1,7 +1,7 @@ --- type: docs title: "Dapr sidecar injector overview" -linkTitle: "Sidecar" +linkTitle: "Sidecar injector" description: "Overview of the Dapr sidecar injector process" --- From a1cc2a5b728c5cb97e481f4707c029c9a677ebdd Mon Sep 17 00:00:00 2001 From: Ori Zohar Date: Fri, 20 Aug 2021 14:27:53 -0700 Subject: [PATCH 10/10] Fixing link --- daprdocs/content/en/concepts/dapr-services/placement.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/daprdocs/content/en/concepts/dapr-services/placement.md b/daprdocs/content/en/concepts/dapr-services/placement.md index 8bed078ed..6d3e35010 100644 --- a/daprdocs/content/en/concepts/dapr-services/placement.md +++ b/daprdocs/content/en/concepts/dapr-services/placement.md @@ -5,7 +5,7 @@ linkTitle: "Placement" description: "Overview of the Dapr placement process" --- -The Dapr placement service is used to calculate and distribute distributed hash tables for the location of [Dapr actors]({{< ref actors >}} running in [self-hosted mode]({{< ref self-hosted >}}) or on [Kubernetes]({{< ref kubernetes >}}). This hash table maps actor IDs to pods or processes so a Dapr application can communicate with the actor.Anytime a Dapr application activates a Dapr actor, the placement updates the hash tables with the latest actor locations. +The Dapr placement service is used to calculate and distribute distributed hash tables for the location of [Dapr actors]({{< ref actors >}}) running in [self-hosted mode]({{< ref self-hosted >}}) or on [Kubernetes]({{< ref kubernetes >}}). This hash table maps actor IDs to pods or processes so a Dapr application can communicate with the actor.Anytime a Dapr application activates a Dapr actor, the placement updates the hash tables with the latest actor locations. ## Self-hosted mode