diff --git a/README.md b/README.md index 768ba03c4..4997d48e5 100644 --- a/README.md +++ b/README.md @@ -12,10 +12,10 @@ The Dapr docs handles branching differently than most code repositories. Instead The following branches are currently maintained: -| Branch | Website | Description | -|--------|---------|-------------| -| [v1.4](https://github.com/dapr/docs) (primary) | https://docs.dapr.io | Latest Dapr release documentation. Typo fixes, clarifications, and most documentation goes here. -| [v1.5](https://github.com/dapr/docs/tree/v1.5) (pre-release) | https://v1-5.docs.dapr.io/ | Pre-release documentation. Doc updates that are only applicable to v1.5+ go here. +| Branch | Website | Description | +| ------------------------------------------------------------ | -------------------------- | ------------------------------------------------------------------------------------------------ | +| [v1.4](https://github.com/dapr/docs) (primary) | https://docs.dapr.io | Latest Dapr release documentation. Typo fixes, clarifications, and most documentation goes here. | +| [v1.5](https://github.com/dapr/docs/tree/v1.5) (pre-release) | https://v1-5.docs.dapr.io/ | Pre-release documentation. Doc updates that are only applicable to v1.5+ go here. | For more information visit the [Dapr branch structure](https://docs.dapr.io/contributing/contributing-docs/#branch-guidance) document. @@ -38,31 +38,43 @@ The [daprdocs](./daprdocs) directory contains the hugo project, markdown files, 1. Ensure pre-requisites are installed 2. Clone this repository + ```sh git clone https://github.com/dapr/docs.git ``` + 3. Change to daprdocs directory: + ```sh -cd ./docs/daprdocs +cd ./daprdocs ``` + 4. Update submodules: + ```sh git submodule update --init --recursive ``` + 5. Install npm packages: + ```sh npm install ``` ## Run local server + 1. Make sure you're still in the `daprdocs` directory 2. Run + ```sh hugo server ``` + 3. Navigate to `http://localhost:1313/` + ## Update docs + 1. Fork repo into your account 1. Create new branch 1. Commit and push changes to forked branch @@ -70,4 +82,5 @@ hugo server 1. Staging site will automatically get created and linked to PR to review and test ## Code of Conduct + Please refer to our [Dapr community code of conduct](https://github.com/dapr/community/blob/master/CODE-OF-CONDUCT.md). diff --git a/daprdocs/content/en/_index.md b/daprdocs/content/en/_index.md index 5243416f2..6ca2cff4c 100644 --- a/daprdocs/content/en/_index.md +++ b/daprdocs/content/en/_index.md @@ -3,6 +3,22 @@ type: docs no_list: true --- +
+
+
+
+ DaprCon logo + Join us for DaprCon on October 19th-20th, 2021! +
+

+ The first ever DaprCon will take place October 19th-20th, 2021 virtually! Tune in for free and attend technical sessions, panels and real world examples from the community on building applications with Dapr!

Learn more >> +

+ +
+
+
+ +

# Dapr Docs Welcome to the Dapr documentation site! diff --git a/daprdocs/content/en/developing-applications/integrations/workflows.md b/daprdocs/content/en/developing-applications/integrations/workflows.md index ec30a0e1e..7261e5ddf 100644 --- a/daprdocs/content/en/developing-applications/integrations/workflows.md +++ b/daprdocs/content/en/developing-applications/integrations/workflows.md @@ -128,7 +128,7 @@ Prerequisites: 1. Create a Config Map for the workflow: ```bash - kubectl create configmap workflows --from-file ./samples/workflow1. json + kubectl create configmap workflows --from-file ./samples/workflow1.json ``` 1. Create a secret containing the Azure Storage Account credentials. Replace the account name and key values below with the actual credentials: @@ -228,4 +228,4 @@ Watch an example from the Dapr community call: ## Additional resources - [Blog announcement](https://cloudblogs.microsoft.com/opensource/2020/05/26/announcing-cloud-native-workflows-dapr-logic-apps/) -- [Repo](https://github.com/dapr/workflows) \ No newline at end of file +- [Repo](https://github.com/dapr/workflows) diff --git a/daprdocs/content/en/getting-started/_index.md b/daprdocs/content/en/getting-started/_index.md index 238fed7b3..6339d4a5e 100644 --- a/daprdocs/content/en/getting-started/_index.md +++ b/daprdocs/content/en/getting-started/_index.md @@ -11,7 +11,6 @@ Welcome to the Dapr getting started guide! {{% alert title="Dapr Concepts" color="primary" %}} If you are looking for an introductory overview of Dapr and learn more about basic Dapr terminology, it is recommended to visit the [concepts section]({{}}). -{{< button text="Learn more" page="concepts" >}} {{% /alert %}} This guide will walk you through a series of steps to install, initialize and start using Dapr. The recommended way to get started with Dapr is to setup a local development environment (also referred to as [_self-hosted_ mode]({{< ref self-hosted >}})) which includes the Dapr CLI, Dapr sidecar binaries, and some default components that can help you start using Dapr quickly. diff --git a/daprdocs/content/en/operations/components/certification-lifecycle.md b/daprdocs/content/en/operations/components/certification-lifecycle.md index a1f18b264..8dca1bdc5 100644 --- a/daprdocs/content/en/operations/components/certification-lifecycle.md +++ b/daprdocs/content/en/operations/components/certification-lifecycle.md @@ -22,7 +22,7 @@ To make sure a component conforms to the standards set by Dapr, there are a set The levels are as follows: - [Alpha](#alpha) - [Beta](#beta) -- [General availability (GA)](#general-availability-ga) +- [Stable](#stable) ### Alpha @@ -42,11 +42,16 @@ All components start at the Alpha stage. - The component contains a record of the conformance test result reviewed and approved by Dapr maintainers with specific components-contrib version - Recommended for only non-business-critical uses because of potential for incompatible changes in subsequent releases -### General Availability (GA) +### Stable -- Has at least two different users using the component in production -- A GA component has a maintainer in the Dapr community or the Dapr maintainers -- The component is well documented, tested and maintained across multiple versions of components-contrib repo +- The component must have component [certification tests](#certification-tests) validating functionality and resiliency +- The component is maintained by Dapr maintainers and supported by the community +- The component is well documented and tested +- A maintainer will address component security, core functionality and test issues according to the Dapr support policy and issue a patch release that includes the patched stable component + +### Previous Generally Available (GA) components + +Any component that was previously certified as GA is allowed into Stable even if the new requirements are not met. ## Conformance tests @@ -66,24 +71,45 @@ To understand more about them see the readme [here](https://github.com/dapr/comp - The tests should validate the functional behavior and robustness of component based on the component specification - All the details needed to reproduce the tests are added as part of the component conformance test documentation +## Certification tests + +Each stable component in the [components-contrib](https://github.com/dapr/components-contrib) repository must have a certification test plan and automated certification tests validating all features supported by the component via Dapr. + +Test plan for stable components should include the following scenarios: + +- Client reconnection: in case the client library cannot connect to the service for a moment, Dapr sidecar should not require a restart once the service is back online. +- Authentication options: validate the component can authenticate with all the supported options. +- Validate resource provisioning: validate if the component automatically provisions resources on initialization, if applicable. +- All scenarios relevant to the corresponding building block and component. + +The test plan must be approved by a Dapr maintainer and be published in a `README.md` file along with the component code. + +### Test requirements + +- The tests should validate the functional behavior and robustness of the component based on the component specification, reflecting the scenarios from the test plan +- The tests must run successfully as part of the continuous integration of the [components-contrib](https://github.com/dapr/components-contrib) repository + + ## Component certification process -For a component to be certified tests are run in an environment maintained by the Dapr team. +In order for a component to be certified, tests are run in an environment maintained by the Dapr project. -### New component certification: Alpha->Beta or Beta->GA +### New component certification: Alpha->Beta -For a new component requiring a certification change from Alpha to Beta or Beta to GA, a request for component certification follows these steps: -- An issue is created with a request for certification of the component with the current and the new certification levels -- A user of a component submits a PR for integrating the component to run with the defined conformance test suite -- The user details the environment setup in the issue created, so that a Dapr maintainer can setup the service in a managed environment -- After the environment setup is complete, Dapr maintainers review the PR and if approved merges that PR -- Dapr maintainers review functional correctness with the test being run in an environment maintained by the Dapr team -- Dapr maintainers update the component status document categorized by Dapr Runtime version. This is done as part of the release process in the next release of Dapr runtime - -### Existing GA certified component - -For an existing GA certified component, conformance test should be run against any changes made to component code or the backing service version or the client version. - -In the scenarios where a component version is updated, the component again starts from Alpha stage and then the new component certification is followed for that. +For a new component requiring a certification change from Alpha to Beta, a request for component certification follows these steps: +- Requestor creates an issue in the [components-contrib](https://github.com/dapr/components-contrib) repository for certification of the component with the current and the new certification levels +- Requestor submits a PR to integrate the component with the defined conformance test suite, if not already included + - The user details the environment setup in the issue created, so a Dapr maintainer can setup the service in a managed environment + - After the environment setup is complete, Dapr maintainers review the PR and if approved merges that PR +- Requestor submits a PR in the [docs](https://github.com/dapr/docs) repository, updating the component's certification level +### New component certification: Beta->Stable +For a new component requiring a certification change from Beta to Stable, a request for component certification follows these steps: +- Requestor creates an issue in the [components-contrib](https://github.com/dapr/components-contrib) repository for certification of the component with the current and the new certification levels +- Requestor submits a PR for the test plan as a `README.md` file in the component's source code directory + - The requestor details the test environment requirements in the created PR, including any manual steps or credentials needed + - A Dapr maintainer reviews the test plan, provides feedback or approves it, and eventually merges the PR +- Requestor submits a PR for the automated certification tests, including scripts to provision resources when applicable +- After the test environment setup is completed and credentials provisioned, Dapr maintainers review the PR and, if approved, merges the PR +- Requestor submits a PR in the [docs](https://github.com/dapr/docs) repository, updating the component's certification level diff --git a/daprdocs/content/en/operations/hosting/kubernetes/cluster/setup-aks.md b/daprdocs/content/en/operations/hosting/kubernetes/cluster/setup-aks.md index 905ef73b7..0323ba208 100644 --- a/daprdocs/content/en/operations/hosting/kubernetes/cluster/setup-aks.md +++ b/daprdocs/content/en/operations/hosting/kubernetes/cluster/setup-aks.md @@ -12,7 +12,7 @@ description: > ## Prerequisites - [Docker](https://docs.docker.com/install/) -- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) +- [kubectl](https://kubernetes.io/docs/tasks/tools/) - [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest) ## Deploy an Azure Kubernetes Service cluster diff --git a/daprdocs/content/en/operations/hosting/kubernetes/cluster/setup-gke.md b/daprdocs/content/en/operations/hosting/kubernetes/cluster/setup-gke.md index 5a7b7607c..53d278669 100644 --- a/daprdocs/content/en/operations/hosting/kubernetes/cluster/setup-gke.md +++ b/daprdocs/content/en/operations/hosting/kubernetes/cluster/setup-gke.md @@ -8,7 +8,7 @@ description: "Setup a Google Kubernetes Engine cluster" ### Prerequisites -- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) +- [kubectl](https://kubernetes.io/docs/tasks/tools/) - [Google Cloud SDK](https://cloud.google.com/sdk) ## Create a new cluster diff --git a/daprdocs/content/en/operations/hosting/kubernetes/cluster/setup-minikube.md b/daprdocs/content/en/operations/hosting/kubernetes/cluster/setup-minikube.md index ef1d0110d..09762c9fd 100644 --- a/daprdocs/content/en/operations/hosting/kubernetes/cluster/setup-minikube.md +++ b/daprdocs/content/en/operations/hosting/kubernetes/cluster/setup-minikube.md @@ -12,7 +12,7 @@ description: > ## Prerequisites - [Docker](https://docs.docker.com/install/) -- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) +- [kubectl](https://kubernetes.io/docs/tasks/tools/) - [Minikube](https://minikube.sigs.k8s.io/docs/start/) > Note: For Windows, enable Virtualization in BIOS and [install Hyper-V](https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v) diff --git a/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-deploy.md b/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-deploy.md index afa7a238a..81b62d716 100644 --- a/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-deploy.md +++ b/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-deploy.md @@ -15,7 +15,7 @@ For more information on what is deployed to your Kubernetes cluster read the [Ku ## Prerequisites - Install [Dapr CLI]({{< ref install-dapr-cli.md >}}) -- Install [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) +- Install [kubectl](https://kubernetes.io/docs/tasks/tools/) - Kubernetes cluster (see below if needed) ### Create cluster diff --git a/daprdocs/content/en/operations/monitoring/logging/fluentd.md b/daprdocs/content/en/operations/monitoring/logging/fluentd.md index 0c15c1584..fd0758418 100644 --- a/daprdocs/content/en/operations/monitoring/logging/fluentd.md +++ b/daprdocs/content/en/operations/monitoring/logging/fluentd.md @@ -9,7 +9,7 @@ description: "How to install Fluentd, Elastic Search, and Kibana to search logs ## Prerequisites - Kubernetes (> 1.14) -- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) +- [kubectl](https://kubernetes.io/docs/tasks/tools/) - [Helm 3](https://helm.sh/) ## Install Elastic search and Kibana diff --git a/daprdocs/content/en/operations/monitoring/metrics/azure-monitor.md b/daprdocs/content/en/operations/monitoring/metrics/azure-monitor.md index 852716e76..c253d4f42 100644 --- a/daprdocs/content/en/operations/monitoring/metrics/azure-monitor.md +++ b/daprdocs/content/en/operations/monitoring/metrics/azure-monitor.md @@ -10,7 +10,7 @@ description: "Enable Dapr metrics and logs with Azure Monitor for Azure Kubernet - [Azure Kubernetes Service](https://docs.microsoft.com/en-us/azure/aks/) - [Enable Azure Monitor For containers in AKS](https://docs.microsoft.com/en-us/azure/azure-monitor/insights/container-insights-overview) -- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) +- [kubectl](https://kubernetes.io/docs/tasks/tools/) - [Helm 3](https://helm.sh/) ## Enable Prometheus metric scrape using config map diff --git a/daprdocs/content/en/operations/monitoring/metrics/prometheus.md b/daprdocs/content/en/operations/monitoring/metrics/prometheus.md index b81f1f539..b179b75a0 100644 --- a/daprdocs/content/en/operations/monitoring/metrics/prometheus.md +++ b/daprdocs/content/en/operations/monitoring/metrics/prometheus.md @@ -67,7 +67,7 @@ Once Prometheus is running, you'll be able to visit its dashboard by visiting `h ### Prerequisites - Kubernetes (> 1.14) -- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) +- [kubectl](https://kubernetes.io/docs/tasks/tools/) - [Helm 3](https://helm.sh/) ### Install Prometheus diff --git a/daprdocs/content/en/operations/support/support-release-policy.md b/daprdocs/content/en/operations/support/support-release-policy.md index 5ec7285f2..a07e40e4e 100644 --- a/daprdocs/content/en/operations/support/support-release-policy.md +++ b/daprdocs/content/en/operations/support/support-release-policy.md @@ -42,7 +42,9 @@ The table below shows the versions of Dapr releases that have been tested togeth | Jul 26th 2021 | 1.3
| 1.3.0 | Java 1.2.0
Go 1.2.0
PHP 1.1.0
Python 1.2.0
.NET 1.3.0 | 0.7.0 | Supported | | Sep 14th 2021 | 1.3.1
| 1.3.0 | Java 1.2.0
Go 1.2.0
PHP 1.1.0
Python 1.2.0
.NET 1.3.0 | 0.7.0 | Supported | | Sep 15th 2021 | 1.4
| 1.4.0 | Java 1.3.0
Go 1.3.0
PHP 1.2.0
Python 1.3.0
.NET 1.4.0 | 0.8.0 | Supported | -| Sep 22nd 2021 | 1.4.1
| 1.4.0 | Java 1.3.0
Go 1.3.0
PHP 1.2.0
Python 1.3.0
.NET 1.4.0 | 0.8.0 | Supported (current) | +| Sep 22nd 2021 | 1.4.1
| 1.4.0 | Java 1.3.0
Go 1.3.0
PHP 1.2.0
Python 1.3.0
.NET 1.4.0 | 0.8.0 | Supported +| Sep 24th 2021 | 1.4.2
| 1.4.0 | Java 1.3.0
Go 1.3.0
PHP 1.2.0
Python 1.3.0
.NET 1.4.0 | 0.8.0 | Supported | +| Oct 7th 2021 | 1.4.3
| 1.4.0 | Java 1.3.0
Go 1.3.0
PHP 1.2.0
Python 1.3.0
.NET 1.4.0 | 0.8.0 | Supported (current) | ## Upgrade paths After the 1.0 release of the runtime there may be situations where it is necessary to explicitly upgrade through an additional release to reach the desired target. For example an upgrade from v1.0 to v1.2 may need go pass through v1.1 @@ -56,16 +58,16 @@ General guidance on upgrading can be found for [self hosted mode]({{}}) * List of [pub/sub components]({{< ref supported-pubsub.md >}}) * List of [secret store components]({{< ref supported-secret-stores.md >}}) diff --git a/daprdocs/content/en/operations/troubleshooting/common_issues.md b/daprdocs/content/en/operations/troubleshooting/common_issues.md index 77d963c80..f63e0d54d 100644 --- a/daprdocs/content/en/operations/troubleshooting/common_issues.md +++ b/daprdocs/content/en/operations/troubleshooting/common_issues.md @@ -226,3 +226,26 @@ In order for mDNS to function properly, ensure `Micorosft Content Filter` is ina Microsoft Content Filter is disabled when the output is "Success". > Some organizations will re-enable the filter from time to time. If you repeatedly encounter app-id values missing, first check to see if the filter has been re-enabled before doing more extensive troubleshooting. + +## Admission webhook denied the request + +You may encounter an error similar to the one below due to admission webhook having an allowlist for service accounts to create or modify resources. + +``` +root:[dapr]$ kubectl run -i --tty --rm debug --image=busybox --restart=Never -- sh +Error from server: admission webhook "sidecar-injector.dapr.io" denied the request: service account 'user-xdd5l' not on the list of allowed controller accounts +``` + +To resolve this error, you should create a `clusterrolebind` for the current user: + +```bash +kubectl create clusterrolebinding dapr- --clusterrole=dapr-operator-admin --user +``` + +You can run the below command to get all users in your cluster: + +```bash +kubectl config get-users +``` + +You may learn more about webhooks [here](https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/). diff --git a/daprdocs/content/en/reference/arguments-annotations-overview.md b/daprdocs/content/en/reference/arguments-annotations-overview.md index 257a5b9ac..03c38a42d 100644 --- a/daprdocs/content/en/reference/arguments-annotations-overview.md +++ b/daprdocs/content/en/reference/arguments-annotations-overview.md @@ -22,7 +22,7 @@ This table is meant to help users understand the equivalent options for running | `--dapr-grpc-port` | `--dapr-grpc-port` | | not supported | gRPC port for the Dapr API to listen on (default "50001") | | `--dapr-http-port` | `--dapr-http-port` | | not supported | The HTTP port for the Dapr API | |` --dapr-http-max-request-size` | --dapr-http-max-request-size | | `dapr.io/http-max-request-size` | Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is `4` MB | -| not supported | `--image` | | not supported +| not supported | `--image` | | `dapr.io/sidecar-image` | Dapr sidecar image. Default is `daprio/daprd:latest` | | `--internal-grpc-port` | not supported | | not supported | gRPC port for the Dapr Internal API to listen on | | `--enable-metrics` | not supported | | configuration spec | Enable prometheus metric (default true) | | `--enable-mtls` | not supported | | configuration spec | Enables automatic mTLS for daprd to daprd communication channels | diff --git a/daprdocs/content/en/reference/cli/cli-overview.md b/daprdocs/content/en/reference/cli/cli-overview.md index 8e19ef8d6..745fc2f12 100644 --- a/daprdocs/content/en/reference/cli/cli-overview.md +++ b/daprdocs/content/en/reference/cli/cli-overview.md @@ -50,7 +50,7 @@ Flags: Use "dapr [command] --help" for more information about a command. ``` -## Command Reference +### Command Reference You can learn more about each Dapr command from the links below. @@ -72,6 +72,6 @@ You can learn more about each Dapr command from the links below. - [`dapr uninstall`]({{< ref dapr-uninstall.md >}}) - [`dapr upgrade`]({{< ref dapr-upgrade.md >}}) -## Environment Variables +### Environment Variables Some Dapr flags can be set via environment variables (e.g. `DAPR_NETWORK` for the `--network` flag of the `dapr init` command). Note that specifying the flag on the command line overrides any set environment variable. \ No newline at end of file diff --git a/daprdocs/content/en/reference/cli/dapr-build-info.md b/daprdocs/content/en/reference/cli/dapr-build-info.md index 764847810..54c827e33 100644 --- a/daprdocs/content/en/reference/cli/dapr-build-info.md +++ b/daprdocs/content/en/reference/cli/dapr-build-info.md @@ -5,19 +5,20 @@ linkTitle: "build-info" description: "Detailed build information on dapr-cli and daprd executables" --- -## Description +### Description Get the version and git commit data for `dapr-cli` and `daprd` executables. -## Supported platforms +### Supported platforms - [Self-Hosted]({{< ref self-hosted >}}) -## Usage +### Usage + ```bash dapr build-info ``` -## Related facts +### Related facts You can get `daprd` build information directly by invoking `daprd --build-info` command. diff --git a/daprdocs/content/en/reference/cli/dapr-completion.md b/daprdocs/content/en/reference/cli/dapr-completion.md index 5e6e80f7c..f0f37c2c4 100644 --- a/daprdocs/content/en/reference/cli/dapr-completion.md +++ b/daprdocs/content/en/reference/cli/dapr-completion.md @@ -5,60 +5,68 @@ linkTitle: "completion" description: "Detailed information on the completion CLI command" --- -## Description +### Description Generates shell completion scripts -## Usage +### Usage ```bash dapr completion [flags] dapr completion [command] ``` -## Flags +### Flags -| Name | Environment Variable | Default | Description | -|------|----------------------|---------|-------------| -| `--help`, `-h` | | | Prints this help message | +| Name | Environment Variable | Default | Description | +| -------------- | -------------------- | ------- | ------------------------ | +| `--help`, `-h` | | | Prints this help message | -## Examples +### Examples -### Installing bash completion on macOS using Homebrew +#### Installing bash completion on macOS using Homebrew If running Bash 3.2 included with macOS: + ```bash brew install bash-completion ``` + Or, if running Bash 4.1+: + ```bash brew install bash-completion@2 ``` + Add the completion to your completion directory: + ```bash dapr completion bash > $(brew --prefix)/etc/bash_completion.d/dapr source ~/.bash_profile ``` -### Installing bash completion on Linux +#### Installing bash completion on Linux If bash-completion is not installed on Linux, please install the bash-completion' package via your distribution's package manager. Load the dapr completion code for bash into the current shell: + ```bash source <(dapr completion bash) ``` Write bash completion code to a file and source if from .bash_profile: + ```bash dapr completion bash > ~/.dapr/completion.bash.inc printf "source '$HOME/.dapr/completion.bash.inc'" >> $HOME/.bash_profile source $HOME/.bash_profile ``` -### Installing zsh completion on macOS using homebrew +#### Installing zsh completion on macOS using homebrew If zsh-completion is not installed on macOS, please install the 'zsh-completion' package: + ```bash brew install zsh-completions ``` @@ -69,33 +77,37 @@ dapr completion zsh > "${fpath[1]}/_dapr" source ~/.zshrc ``` -### Installing zsh completion on Linux +#### Installing zsh completion on Linux If zsh-completion is not installed on Linux, please install the 'zsh-completion' package via your distribution's package manager. Load the dapr completion code for zsh into the current shell: + ```bash source <(dapr completion zsh) ``` Set the dapr completion code for zsh[1] to autoload on startup: + ```bash dapr completion zsh > "${fpath[1]}/_dapr" ``` -### Installing Powershell completion on Windows +#### Installing Powershell completion on Windows Create $PROFILE if it not exists: + ```bash if (!(Test-Path -Path $PROFILE )){ New-Item -Type File -Path $PROFILE -Force } ``` Add the completion to your profile: + ```bash dapr completion powershell >> $PROFILE ``` -## Available Commands +### Available Commands ```txt bash Generates bash completion scripts diff --git a/daprdocs/content/en/reference/cli/dapr-components.md b/daprdocs/content/en/reference/cli/dapr-components.md index 693ae4e10..3d61c531b 100644 --- a/daprdocs/content/en/reference/cli/dapr-components.md +++ b/daprdocs/content/en/reference/cli/dapr-components.md @@ -5,30 +5,30 @@ linkTitle: "components" description: "Detailed information on the components CLI command" --- -## Description +### Description List all Dapr components. -## Supported platforms +### Supported platforms - [Kubernetes]({{< ref kubernetes >}}) -## Usage +### Usage ```bash dapr components [flags] ``` -## Flags +### Flags -| Name | Environment Variable | Default | Description -| --- | --- | --- | --- | -| `--help`, `-h` | | | Print this help message | -| `--kubernetes`, `-k` | | `false` | List all Dapr components in a Kubernetes cluster | +| Name | Environment Variable | Default | Description | +| -------------------- | -------------------- | ------- | ------------------------------------------------ | +| `--help`, `-h` | | | Print this help message | +| `--kubernetes`, `-k` | | `false` | List all Dapr components in a Kubernetes cluster | -## Examples +### Examples -### List Kubernetes components ```bash +# List Kubernetes components dapr components -k ``` diff --git a/daprdocs/content/en/reference/cli/dapr-configurations.md b/daprdocs/content/en/reference/cli/dapr-configurations.md index 6cb0c7809..82348aa99 100644 --- a/daprdocs/content/en/reference/cli/dapr-configurations.md +++ b/daprdocs/content/en/reference/cli/dapr-configurations.md @@ -5,32 +5,32 @@ linkTitle: "configurations" description: "Detailed information on the configurations CLI command" --- -## Description +### Description List all Dapr configurations. -## Supported platforms +### Supported platforms - [Kubernetes]({{< ref kubernetes >}}) -## Usage +### Usage ```bash dapr configurations [flags] ``` -## Flags +### Flags -| Name | Environment Variable | Default | Description -| --- | --- | --- | --- | -| `--kubernetes`, `-k` | | `false` | List all Dapr configurations in a Kubernetes cluster -| `--name`, `-n` | | | The configuration name to be printed (optional) -| `--output`, `-o` | | `list`| Output format (options: json or yaml or list) -| `--help`, `-h` | | | Print this help message | +| Name | Environment Variable | Default | Description | +| -------------------- | -------------------- | ------- | ---------------------------------------------------- | +| `--kubernetes`, `-k` | | `false` | List all Dapr configurations in a Kubernetes cluster | +| `--name`, `-n` | | | The configuration name to be printed (optional) | +| `--output`, `-o` | | `list` | Output format (options: json or yaml or list) | +| `--help`, `-h` | | | Print this help message | -## Examples +### Examples -### List Kubernetes Dapr configurations ```bash +# List Kubernetes Dapr configurations dapr configurations -k ``` diff --git a/daprdocs/content/en/reference/cli/dapr-dashboard.md b/daprdocs/content/en/reference/cli/dapr-dashboard.md index ef4922650..906a5da91 100644 --- a/daprdocs/content/en/reference/cli/dapr-dashboard.md +++ b/daprdocs/content/en/reference/cli/dapr-dashboard.md @@ -5,54 +5,47 @@ linkTitle: "dashboard" description: "Detailed information on the dashboard CLI command" --- -## Description +### Description Start [Dapr dashboard](https://github.com/dapr/dashboard). -## Supported platforms +### Supported platforms - [Self-Hosted]({{< ref self-hosted >}}) - [Kubernetes]({{< ref kubernetes >}}) -## Usage +### Usage + ```bash dapr dashboard [flags] ``` -## Flags +### Flags -| Name | Environment Variable | Default | Description | -|------|----------------------|---------|-------------| -| `--address`, `-a` | | `localhost` | Address to listen on. Only accepts IP address or localhost as a value | -| `--help`, `-h` | | | Prints this help message | -| `--kubernetes`, `-k` | | `false` | Opens Dapr dashboard in local browser via local proxy to Kubernetes cluster | -| `--namespace`, `-n` | | `dapr-system` | The namespace where Dapr dashboard is running | -| `--port`, `-p` | | `8080` | The local port on which to serve Dapr dashboard | -| `--version`, `-v` | | `false` | Print the version for Dapr dashboard | +| Name | Environment Variable | Default | Description | +| -------------------- | -------------------- | ------------- | --------------------------------------------------------------------------- | +| `--address`, `-a` | | `localhost` | Address to listen on. Only accepts IP address or localhost as a value | +| `--help`, `-h` | | | Prints this help message | +| `--kubernetes`, `-k` | | `false` | Opens Dapr dashboard in local browser via local proxy to Kubernetes cluster | +| `--namespace`, `-n` | | `dapr-system` | The namespace where Dapr dashboard is running | +| `--port`, `-p` | | `8080` | The local port on which to serve Dapr dashboard | +| `--version`, `-v` | | `false` | Print the version for Dapr dashboard | -## Examples +### Examples -### Start dashboard locally ```bash +# Start dashboard locally dapr dashboard -``` -### Start dashboard service locally on a specified port -```bash +# Start dashboard service locally on a specified port dapr dashboard -p 9999 -``` -### Port forward to dashboard service running in Kubernetes -```bash +# Port forward to dashboard service running in Kubernetes dapr dashboard -k -``` -### Port forward to dashboard service running in Kubernetes on all addresses on a specified port -```bash +# Port forward to dashboard service running in Kubernetes on all addresses on a specified port dapr dashboard -k -p 9999 --address 0.0.0.0 -``` -### Port forward to dashboard service running in Kubernetes on a specified port -```bash +# Port forward to dashboard service running in Kubernetes on a specified port dapr dashboard -k -p 9999 ``` diff --git a/daprdocs/content/en/reference/cli/dapr-help.md b/daprdocs/content/en/reference/cli/dapr-help.md index a645a2a35..b34a71474 100644 --- a/daprdocs/content/en/reference/cli/dapr-help.md +++ b/daprdocs/content/en/reference/cli/dapr-help.md @@ -5,18 +5,18 @@ linkTitle: "help" description: "Detailed information on the help CLI command" --- -## Description +### Description Help provides help for any command in the application. -## Usage +### Usage ```bash dapr help [command] [flags] ``` -## Flags +### Flags -| Name | Environment Variable | Default | Description -| --- | --- | --- | --- | -| `--help`, `-h` | | | Prints this help message | +| Name | Environment Variable | Default | Description | +| -------------- | -------------------- | ------- | ------------------------ | +| `--help`, `-h` | | | Prints this help message | diff --git a/daprdocs/content/en/reference/cli/dapr-init.md b/daprdocs/content/en/reference/cli/dapr-init.md index 8477c7514..0b383949c 100644 --- a/daprdocs/content/en/reference/cli/dapr-init.md +++ b/daprdocs/content/en/reference/cli/dapr-init.md @@ -5,67 +5,70 @@ linkTitle: "init" description: "Detailed information on the init CLI command" --- -## Description +### Description Install Dapr on supported hosting platforms. -## Supported platforms +### Supported platforms - [Self-Hosted]({{< ref self-hosted >}}) - [Kubernetes]({{< ref kubernetes >}}) -## Usage +### Usage + ```bash dapr init [flags] ``` -## Flags +### Flags -| Name | Environment Variable | Default | Description -| --- | --- | --- | --- | -| `--enable-ha` | | `false` | Enable high availability (HA) mode | -| `--enable-mtls` | | `true` | Enable mTLS in your cluster | -| `--help`, `-h` | | | Print this help message | -| `--kubernetes`, `-k` | | `false` | Deploy Dapr to a Kubernetes cluster | -| `--wait` | | `false` | Wait for Kubernetes initialization to complete | -| `--timeout` | | `300` | The wait timeout for the Kubernetes installation | -| `--namespace`, `-n` | | `dapr-system` | The Kubernetes namespace to install Dapr in | -| `--network` | `DAPR_NETWORK` | | The Docker network on which to deploy the Dapr runtime | -| `--runtime-version` | | `latest` | The version of the Dapr runtime to install, for example: `1.0.0` | -| `--slim`, `-s` | | `false` | Exclude placement service, Redis and Zipkin containers from self-hosted installation | +| Name | Environment Variable | Default | Description | +| -------------------- | -------------------- | ------------- | ------------------------------------------------------------------------------------ | +| `--enable-ha` | | `false` | Enable high availability (HA) mode | +| `--enable-mtls` | | `true` | Enable mTLS in your cluster | +| `--help`, `-h` | | | Print this help message | +| `--kubernetes`, `-k` | | `false` | Deploy Dapr to a Kubernetes cluster | +| `--wait` | | `false` | Wait for Kubernetes initialization to complete | +| `--timeout` | | `300` | The wait timeout for the Kubernetes installation | +| `--namespace`, `-n` | | `dapr-system` | The Kubernetes namespace to install Dapr in | +| `--runtime-version` | | `latest` | The version of the Dapr runtime to install, for example: `1.0.0` | +| `--slim`, `-s` | | `false` | Exclude placement service, Redis and Zipkin containers from self-hosted installation | -## Examples +### Examples + +#### Self-hosted environment -### Initialize Dapr in self-hosted mode ```bash dapr init ``` -### Initialize Dapr in Kubernetes +You can also specify a specific runtime version. Be default, the latest version is used. + +```bash +dapr init --runtime-version 1.4.0 +``` + +Dapr can also run [Slim self-hosted mode]({{< ref self-hosted-no-docker.md >}}) without Docker. + +```bash +dapr init -s +``` + +#### Kubernetes environment + ```bash dapr init -k ``` -### Initialize Dapr in Kubernetes and wait for the installation to complete +You can wait for the installation to complete its deployment with the `--wait` flag. +The default timeout is 300s (5 min), but can be customized with the `--timeout` flag. - You can wait for the installation to complete its deployment with the `--wait` flag. - - The default timeout is 300s (5 min), but can be customized with the `--timeout` flag. ```bash dapr init -k --wait --timeout 600 ``` -### Initialize specified version of Dapr runtime in self-hosted mode -```bash -dapr init --runtime-version 0.10.0 -``` +You can also specify a specific runtime version. -### Initialize specified version of Dapr runtime in Kubernetes ```bash -dapr init -k --runtime-version 0.10.0 -``` - -### Initialize Dapr in [slim self-hosted mode]({{< ref self-hosted-no-docker.md >}}) -```bash -dapr init -s +dapr init -k --runtime-version 1.4.0 ``` diff --git a/daprdocs/content/en/reference/cli/dapr-invoke.md b/daprdocs/content/en/reference/cli/dapr-invoke.md index 9a471f769..60bbb5509 100644 --- a/daprdocs/content/en/reference/cli/dapr-invoke.md +++ b/daprdocs/content/en/reference/cli/dapr-invoke.md @@ -5,38 +5,37 @@ linkTitle: "invoke" description: "Detailed information on the invoke CLI command" --- -## Description +### Description Invoke a method on a given Dapr application. -## Supported platforms +### Supported platforms - [Self-Hosted]({{< ref self-hosted >}}) -## Usage +### Usage + ```bash dapr invoke [flags] ``` -## Flags +### Flags -| Name | Environment Variable | Default | Description -| --- | --- | --- | --- | -| `--app-id`, `-a` | | | The application id to invoke | -| `--help`, `-h` | | | Print this help message | -| `--method`, `-m` | | | The method to invoke | -| `--data`, `-d` | | | The JSON serialized data string (optional) | -| `--data-file`, `-f` | | | A file containing the JSON serialized data (optional) -| `--verb`, `-v` | | `POST` | The HTTP verb to use | +| Name | Environment Variable | Default | Description | +| ------------------- | -------------------- | ------- | ----------------------------------------------------- | +| `--app-id`, `-a` | `APP_ID` | | The application id to invoke | +| `--help`, `-h` | | | Print this help message | +| `--method`, `-m` | | | The method to invoke | +| `--data`, `-d` | | | The JSON serialized data string (optional) | +| `--data-file`, `-f` | | | A file containing the JSON serialized data (optional) | +| `--verb`, `-v` | | `POST` | The HTTP verb to use | -## Examples +### Examples -### Invoke a sample method on target app with POST Verb ```bash +# Invoke a sample method on target app with POST Verb dapr invoke --app-id target --method sample --data '{"key":"value"}' -``` -### Invoke a sample method on target app with GET Verb -```bash +# Invoke a sample method on target app with GET Verb dapr invoke --app-id target --method sample --verb GET -``` +``` \ No newline at end of file diff --git a/daprdocs/content/en/reference/cli/dapr-list.md b/daprdocs/content/en/reference/cli/dapr-list.md index c8d3358c8..73b46dd56 100644 --- a/daprdocs/content/en/reference/cli/dapr-list.md +++ b/daprdocs/content/en/reference/cli/dapr-list.md @@ -5,41 +5,38 @@ linkTitle: "list" description: "Detailed information on the list CLI command" --- -## Description +### Description List all Dapr instances. -## Supported platforms +### Supported platforms - [Self-Hosted]({{< ref self-hosted >}}) - [Kubernetes]({{< ref kubernetes >}}) -## Usage +### Usage + ```bash dapr list [flags] ``` -## Flags +### Flags -| Name | Environment Variable | Default | Description -| --- | --- | --- | --- | -| `--help`, `-h` | | | Print this help message | -| `--kubernetes`, `-k` | | `false` | List all Dapr pods in a Kubernetes cluster | -| `--output`, `-o` | | `table` | The output format of the list. Valid values are: `json`, `yaml`, or `table` +| Name | Environment Variable | Default | Description | +| -------------------- | -------------------- | ------- | --------------------------------------------------------------------------- | +| `--help`, `-h` | | | Print this help message | +| `--kubernetes`, `-k` | | `false` | List all Dapr pods in a Kubernetes cluster | +| `--output`, `-o` | | `table` | The output format of the list. Valid values are: `json`, `yaml`, or `table` | -## Examples +### Examples -### List Dapr instances in self-hosted mode ```bash +# List Dapr instances in self-hosted mode dapr list -``` -### List Dapr instances in Kubernetes mode -```bash +# List Dapr instances in Kubernetes mode dapr list -k -``` -### List Dapr instances in JSON format -```bash +# List Dapr instances in JSON format dapr list -o json ``` diff --git a/daprdocs/content/en/reference/cli/dapr-logs.md b/daprdocs/content/en/reference/cli/dapr-logs.md index 45e6bb5c5..e9c6e44b0 100644 --- a/daprdocs/content/en/reference/cli/dapr-logs.md +++ b/daprdocs/content/en/reference/cli/dapr-logs.md @@ -5,33 +5,33 @@ linkTitle: "logs" description: "Detailed information on the logs CLI command" --- -## Description +### Description Get Dapr sidecar logs for an application. -## Supported platforms +### Supported platforms - [Kubernetes]({{< ref kubernetes >}}) -## Usage +### Usage + ```bash dapr logs [flags] ``` -## Flags +### Flags -| Name | Environment Variable | Default | Description -| --- | --- | --- | --- | -| `--app-id`, `-a` | | | The application id for which logs are needed | -| `--help`, `-h` | | | Print this help message | -| `--kubernetes`, `-k` | | `true` | Get logs from a Kubernetes cluster | -| `--namespace`, `-n` | | `default` | The Kubernetes namespace in which your application is deployed | -| `--pod-name`, `-p` | | | The name of the pod in Kubernetes, in case your application has multiple pods (optional) | + | Name | Environment Variable | Default | Description | + | -------------------- | -------------------- | --------- | ---------------------------------------------------------------------------------------- | + | `--app-id`, `-a` | `APP_ID` | | The application id for which logs are needed | + | `--help`, `-h` | | | Print this help message | + | `--kubernetes`, `-k` | | `true` | Get logs from a Kubernetes cluster | + | `--namespace`, `-n` | | `default` | The Kubernetes namespace in which your application is deployed | + | `--pod-name`, `-p` | | | The name of the pod in Kubernetes, in case your application has multiple pods (optional) | +### Examples -## Examples - -### Get logs of sample app from target pod in custom namespace ```bash +# Get logs of sample app from target pod in custom namespace dapr logs -k --app-id sample --pod-name target --namespace custom ``` diff --git a/daprdocs/content/en/reference/cli/dapr-mtls/_index.md b/daprdocs/content/en/reference/cli/dapr-mtls/_index.md index 4fa7eadea..abc49c875 100644 --- a/daprdocs/content/en/reference/cli/dapr-mtls/_index.md +++ b/daprdocs/content/en/reference/cli/dapr-mtls/_index.md @@ -5,45 +5,45 @@ linkTitle: "mtls" description: "Detailed information on the mtls CLI command" --- -## Description +### Description Check if mTLS is enabled. -## Supported platforms +### Supported platforms - [Kubernetes]({{< ref kubernetes >}}) -## Usage +### Usage ```bash dapr mtls [flags] dapr mtls [command] ``` -## Flags +### Flags -| Name | Environment Variable | Default | Description -| --- | --- | --- | --- | -| `--help`, `-h` | | | Print this help message | -| `--kubernetes`, `-k` | | `false` | Check if mTLS is enabled in a Kubernetes cluster | +| Name | Environment Variable | Default | Description | +| -------------------- | -------------------- | ------- | ------------------------------------------------ | +| `--help`, `-h` | | | Print this help message | +| `--kubernetes`, `-k` | | `false` | Check if mTLS is enabled in a Kubernetes cluster | -## Available Commands +### Available Commands ```txt expiry Checks the expiry of the root certificate export Export the root CA, issuer cert and key from Kubernetes to local files ``` -## Command Reference +### Command Reference You can learn more about each sub command from the links below. - - [`dapr mtls expiry`]({{< ref dapr-mtls-expiry.md >}}) - - [`dapr mtls export`]({{< ref dapr-mtls-export.md >}}) +- [`dapr mtls expiry`]({{< ref dapr-mtls-expiry.md >}}) +- [`dapr mtls export`]({{< ref dapr-mtls-export.md >}}) -## Examples +### Examples -### Check if mTLS is enabled ```bash +# Check if mTLS is enabled dapr mtls -k ``` \ No newline at end of file diff --git a/daprdocs/content/en/reference/cli/dapr-mtls/dapr-mtls-expiry.md b/daprdocs/content/en/reference/cli/dapr-mtls/dapr-mtls-expiry.md index 2f32af1c3..7fdf5b614 100644 --- a/daprdocs/content/en/reference/cli/dapr-mtls/dapr-mtls-expiry.md +++ b/daprdocs/content/en/reference/cli/dapr-mtls/dapr-mtls-expiry.md @@ -6,28 +6,29 @@ description: "Detailed information on the mtls expiry CLI command" weight: 2000 --- -## Description +### Description Checks the expiry of the root certificate -## Supported platforms +### Supported platforms - [Kubernetes]({{< ref kubernetes >}}) -## Usage +### Usage + ```bash dapr mtls expiry [flags] ``` -## Flags +### Flags -| Name | Environment Variable | Default | Description -| --- | --- | --- | --- | -| `--help`, `-h` | | | help for expiry | +| Name | Environment Variable | Default | Description | +| -------------- | -------------------- | ------- | --------------- | +| `--help`, `-h` | | | help for expiry | -## Examples +### Examples -### Check expiry of Kubernetes certs ```bash +# Check expiry of Kubernetes certs dapr mtls expiry ``` diff --git a/daprdocs/content/en/reference/cli/dapr-mtls/dapr-mtls-export.md b/daprdocs/content/en/reference/cli/dapr-mtls/dapr-mtls-export.md index 2236601f3..2a6047f9b 100644 --- a/daprdocs/content/en/reference/cli/dapr-mtls/dapr-mtls-export.md +++ b/daprdocs/content/en/reference/cli/dapr-mtls/dapr-mtls-export.md @@ -6,29 +6,30 @@ description: "Detailed information on the mtls export CLI command" weight: 1000 --- -## Description +### Description Export the root CA, issuer cert and key from Kubernetes to local files -## Supported platforms +### Supported platforms - [Kubernetes]({{< ref kubernetes >}}) -## Usage +### Usage + ```bash dapr mtls export [flags] ``` -## Flags +### Flags -| Name | Environment Variable | Default | Description -| --- | --- | --- | --- | -| `--help`, `-h` | | | help for export | -| `--out`, `-o` | | current directory | The output directory path to save the certs | +| Name | Environment Variable | Default | Description | +| -------------- | -------------------- | ----------------- | ------------------------------------------- | +| `--help`, `-h` | | | help for export | +| `--out`, `-o` | | current directory | The output directory path to save the certs | -## Examples +### Examples -### Check expiry of Kubernetes certs ```bash +# Check expiry of Kubernetes certs dapr mtls export -o ./certs ``` diff --git a/daprdocs/content/en/reference/cli/dapr-publish.md b/daprdocs/content/en/reference/cli/dapr-publish.md index 749a2071f..e70d853f9 100644 --- a/daprdocs/content/en/reference/cli/dapr-publish.md +++ b/daprdocs/content/en/reference/cli/dapr-publish.md @@ -5,35 +5,35 @@ linkTitle: "publish" description: "Detailed information on the publish CLI command" --- -## Description +### Description Publish a pub-sub event. -## Supported platforms +### Supported platforms - [Self-Hosted]({{< ref self-hosted >}}) -## Usage +### Usage ```bash dapr publish [flags] ``` -## Flags +### Flags -| Name | Environment Variable | Default | Description -| --- | --- | --- | --- | -| `--publish-app-id`, `-i`| | The ID that represents the app from which you are publishing -| `--pubsub`, `-p` | | The name of the pub/sub component -| `--topic`, `-t` | | | The topic to be published to | -| `--data`, `-d` | | | The JSON serialized string (optional) | -| `--data-file`, `-f` | | | A file containing the JSON serialized data (optional) | -| `--help`, `-h` | | | Print this help message | +| Name | Environment Variable | Default | Description | +| ------------------------ | -------------------- | ------------------------------------------------------------ | ----------------------------------------------------- | +| `--publish-app-id`, `-i` | | The ID that represents the app from which you are publishing | +| `--pubsub`, `-p` | | The name of the pub/sub component | +| `--topic`, `-t` | | | The topic to be published to | +| `--data`, `-d` | | | The JSON serialized string (optional) | +| `--data-file`, `-f` | | | A file containing the JSON serialized data (optional) | +| `--help`, `-h` | | | Print this help message | -## Examples +### Examples -### Publish to sample topic in target pubsub ```bash +# Publish to sample topic in target pubsub dapr publish --publish-app-id appId --topic sample --pubsub target --data '{"key":"value"}' ``` diff --git a/daprdocs/content/en/reference/cli/dapr-run.md b/daprdocs/content/en/reference/cli/dapr-run.md index 49d6713c6..2b45908e9 100644 --- a/daprdocs/content/en/reference/cli/dapr-run.md +++ b/daprdocs/content/en/reference/cli/dapr-run.md @@ -5,69 +5,59 @@ linkTitle: "run" description: "Detailed information on the run CLI command" --- -## Description +### Description Run Dapr and (optionally) your application side by side. A full list comparing daprd arguments, CLI arguments, and Kubernetes annotations can be found [here]({{< ref arguments-annotations-overview.md >}}). -## Supported platforms +### Supported platforms - [Self-Hosted]({{< ref self-hosted >}}) -## Usage +### Usage ```bash dapr run [flags] [command] ``` -## Flags +### Flags -| Name | Environment Variable | Default | Description -| --- | --- | --- | --- | -| `--app-id`, `-a` | | | The id for your application, used for service discovery | -| `--app-max-concurrency` | | `unlimited` | The concurrency level of the application, otherwise is unlimited | -| `--app-port`, `-p` | | | The port your application is listening on -| `--app-protocol`, `-P` | | `http` | The protocol (gRPC or HTTP) Dapr uses to talk to the application. Valid values are: `http` or `grpc` | -| `--app-ssl` | | `false` | Enable https when Dapr invokes the application -| `--components-path`, `-d` | | `Linux & Mac: $HOME/.dapr/components`, `Windows: %USERPROFILE%\.dapr\components` | The path for components directory -| `--config`, `-c` | | `Linux & Mac: $HOME/.dapr/config.yaml`, `Windows: %USERPROFILE%\.dapr\config.yaml` | Dapr configuration file | -| `--dapr-grpc-port` | | `50001` | The gRPC port for Dapr to listen on | -| `--dapr-http-port` | | `3500` | The HTTP port for Dapr to listen on | -| `--enable-profiling` | | `false` | Enable `pprof` profiling via an HTTP endpoint -| `--help`, `-h` | | | Print this help message | -| `--image` | | | The image to build the code in. Input is: `repository/image` | -| `--log-level` | | `info` | The log verbosity. Valid values are: `debug`, `info`, `warn`, `error`, `fatal`, or `panic` | -| `--placement-host-address` | `DAPR_PLACEMENT_HOST` | `localhost` | The address of the placement service. Format is either `` for default port (`6050` on Windows, `50005` on Linux/MacOS) or `:` for custom port | -| `--profile-port` | | `7777` | The port for the profile server to listen on | -| `--dapr-http-max-request-size` | | `4` | Max size of request body in MB.| +| Name | Environment Variable | Default | Description | +| ------------------------------ | -------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `--app-id`, `-a` | `APP_ID` | | The id for your application, used for service discovery | +| `--app-max-concurrency` | | `unlimited` | The concurrency level of the application, otherwise is unlimited | +| `--app-port`, `-p` | `APP_PORT` | | The port your application is listening on | +| `--app-protocol`, `-P` | | `http` | The protocol (gRPC or HTTP) Dapr uses to talk to the application. Valid values are: `http` or `grpc` | +| `--app-ssl` | | `false` | Enable https when Dapr invokes the application | +| `--components-path`, `-d` | | `Linux & Mac: $HOME/.dapr/components`, `Windows: %USERPROFILE%\.dapr\components` | The path for components directory | +| `--config`, `-c` | | `Linux & Mac: $HOME/.dapr/config.yaml`, `Windows: %USERPROFILE%\.dapr\config.yaml` | Dapr configuration file | +| `--dapr-grpc-port` | `DAPR_GRPC_PORT` | `50001` | The gRPC port for Dapr to listen on | +| `--dapr-http-port` | `DAPR_HTTP_PORT` | `3500` | The HTTP port for Dapr to listen on | +| `--enable-profiling` | | `false` | Enable `pprof` profiling via an HTTP endpoint | +| `--help`, `-h` | | | Print this help message | +| `--image` | | | The image to build the code in. Input is: `repository/image` | +| `--log-level` | | `info` | The log verbosity. Valid values are: `debug`, `info`, `warn`, `error`, `fatal`, or `panic` | +| `--metrics-port` | `DAPR_METRICS_PORT` | `9090` | The port that Dapr sends its metrics information to | +| `--profile-port` | | `7777` | The port for the profile server to listen on | +| `--dapr-http-max-request-size` | | `4` | Max size of request body in MB. | -## Examples - -### Run a .NET application +### Examples ```bash +# Run a .NET application dapr run --app-id myapp --app-port 5000 -- dotnet run -``` -### Run a Java application - -```bash +# Run a Java application dapr run --app-id myapp -- java -jar myapp.jar -``` -### Run a NodeJs application that listens to port 3000 - -```bash +# Run a NodeJs application that listens to port 3000 dapr run --app-id myapp --app-port 3000 -- node myapp.js -``` -### Run a Python application - -```bash +# Run a Python application dapr run --app-id myapp -- python myapp.py -``` -### Run sidecar only - -```bash +# Run sidecar only dapr run --app-id myapp + +# Run a gRPC application written in Go (listening on port 3000) +dapr run --app-id myapp --app-port 5000 --app-protocol grpc -- go run main.go ``` diff --git a/daprdocs/content/en/reference/cli/dapr-status.md b/daprdocs/content/en/reference/cli/dapr-status.md index dc0087e07..7aec87c5d 100644 --- a/daprdocs/content/en/reference/cli/dapr-status.md +++ b/daprdocs/content/en/reference/cli/dapr-status.md @@ -5,30 +5,30 @@ linkTitle: "status" description: "Detailed information on the status CLI command" --- -## Description +### Description Show the health status of Dapr services. -## Supported platforms +### Supported platforms - [Kubernetes]({{< ref kubernetes >}}) -## Usage +### Usage ```bash dapr status -k ``` -## Flags +### Flags -| Name | Environment Variable | Default | Description -| --- | --- | --- | --- | -| `--help`, `-h` | | | Print this help message | -| `--kubernetes`, `-k` | | `false` | Show the health status of Dapr services on Kubernetes cluster | +| Name | Environment Variable | Default | Description | +| -------------------- | -------------------- | ------- | ------------------------------------------------------------- | +| `--help`, `-h` | | | Print this help message | +| `--kubernetes`, `-k` | | `false` | Show the health status of Dapr services on Kubernetes cluster | -## Examples +### Examples -### Get status of Dapr services from Kubernetes ```bash +# Get status of Dapr services from Kubernetes dapr status -k ``` diff --git a/daprdocs/content/en/reference/cli/dapr-stop.md b/daprdocs/content/en/reference/cli/dapr-stop.md index c4f44581d..2f9a47d00 100644 --- a/daprdocs/content/en/reference/cli/dapr-stop.md +++ b/daprdocs/content/en/reference/cli/dapr-stop.md @@ -5,30 +5,30 @@ linkTitle: "stop" description: "Detailed information on the stop CLI command" --- -## Description +### Description Stop Dapr instances and their associated apps. -## Supported platforms +### Supported platforms - [Self-Hosted]({{< ref self-hosted >}}) -## Usage +### Usage ```bash dapr stop [flags] ``` -## Flags +### Flags -| Name | Environment Variable | Default | Description -| --- | --- | --- | --- | -| `--app-id`, `-a` | | | The application id to be stopped | -| `--help`, `-h` | | | Print this help message | +| Name | Environment Variable | Default | Description | +| ---------------- | -------------------- | ------- | -------------------------------- | +| `--app-id`, `-a` | `APP_ID` | | The application id to be stopped | +| `--help`, `-h` | | | Print this help message | -## Examples +### Examples -### Stop Dapr application ```bash +# Stop Dapr application dapr stop --app-id ``` diff --git a/daprdocs/content/en/reference/cli/dapr-uninstall.md b/daprdocs/content/en/reference/cli/dapr-uninstall.md index 28130221d..4abd62eaa 100644 --- a/daprdocs/content/en/reference/cli/dapr-uninstall.md +++ b/daprdocs/content/en/reference/cli/dapr-uninstall.md @@ -5,44 +5,46 @@ linkTitle: "uninstall" description: "Detailed information on the uninstall CLI command" --- -## Description +### Description Uninstall Dapr runtime. -## Supported platforms +### Supported platforms - [Self-Hosted]({{< ref self-hosted >}}) - [Kubernetes]({{< ref kubernetes >}}) -## Usage +### Usage ```bash dapr uninstall [flags] ``` -## Flags +### Flags -| Name | Environment Variable | Default | Description -| --- | --- | --- | --- | -| `--all` | | `false` | Remove Redis, Zipkin containers in addition to actor placement container. Remove default dapr dir located at `$HOME/.dapr or %USERPROFILE%\.dapr\`. | -| `--help`, `-h` | | | Print this help message | -| `--kubernetes`, `-k` | | `false` | Uninstall Dapr from a Kubernetes cluster | -| `--namespace`, `-n` | | `dapr-system` | The Kubernetes namespace to uninstall Dapr from | -| `--network` | `DAPR_NETWORK` | | The Docker network from which to remove the Dapr runtime | +| Name | Environment Variable | Default | Description | +| -------------------- | -------------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | +| `--all` | | `false` | Remove Redis, Zipkin containers in addition to actor placement container. Remove default dapr dir located at `$HOME/.dapr or %USERPROFILE%\.dapr\`. | +| `--help`, `-h` | | | Print this help message | +| `--kubernetes`, `-k` | | `false` | Uninstall Dapr from a Kubernetes cluster | +| `--namespace`, `-n` | | `dapr-system` | The Kubernetes namespace to uninstall Dapr from | -## Examples +### Examples + +#### Uninstall from self-hosted mode -### Uninstall from self-hosted mode ```bash dapr uninstall ``` -### Uninstall from self-hosted mode and remove .dapr directory, Redis, Placement and Zipkin containers +You can also use option `--all` to remove .dapr directory, Redis, Placement and Zipkin containers + ```bash dapr uninstall --all ``` -### Uninstall from Kubernetes +#### Uninstall from Kubernetes + ```bash dapr uninstall -k ``` diff --git a/daprdocs/content/en/reference/cli/dapr-upgrade.md b/daprdocs/content/en/reference/cli/dapr-upgrade.md index 6cc434569..9e2a9a3b6 100644 --- a/daprdocs/content/en/reference/cli/dapr-upgrade.md +++ b/daprdocs/content/en/reference/cli/dapr-upgrade.md @@ -5,7 +5,7 @@ linkTitle: "upgrade" description: "Detailed information on the upgrade CLI command" --- -## Description +### Description Upgrade or downgrade Dapr on supported hosting platforms. @@ -15,41 +15,38 @@ Version steps should be done incrementally, including minor versions as you upgr Prior to downgrading, confirm components are backwards compatible and application code does ultilize APIs that are not supported in previous versions of Dapr. {{% /alert %}} -## Supported platforms +### Supported platforms - [Kubernetes]({{< ref kubernetes >}}) -## Usage +### Usage + ```bash dapr upgrade [flags] ``` -## Flags +### Flags -| Name | Environment Variable | Default | Description -| --- | --- | --- | --- | -| `--help`, `-h` | | | Print this help message | -| `--kubernetes`, `-k` | | `false` | Upgrade/Downgrade Dapr in a Kubernetes cluster | -| `--runtime-version` | | `latest` | The version of the Dapr runtime to upgrade/downgrade to, for example: `1.0.0` | -| `--set` | | | Set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) | +| Name | Environment Variable | Default | Description | +| -------------------- | -------------------- | -------- | --------------------------------------------------------------------------------------------------------- | +| `--help`, `-h` | | | Print this help message | +| `--kubernetes`, `-k` | | `false` | Upgrade/Downgrade Dapr in a Kubernetes cluster | +| `--runtime-version` | | `latest` | The version of the Dapr runtime to upgrade/downgrade to, for example: `1.0.0` | +| `--set` | | | Set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) | -## Examples +### Examples -### Upgrade Dapr in Kubernetes to latest version ```bash +# Upgrade Dapr in Kubernetes to latest version dapr upgrade -k -``` -### Upgrade or downgrade to a specified version of Dapr runtime in Kubernetes -```bash +# Upgrade or downgrade to a specified version of Dapr runtime in Kubernetes dapr upgrade -k --runtime-version 1.2 -``` -### Upgrade or downgrade to a specified version of Dapr runtime in Kubernetes with value set -```bash +# Upgrade or downgrade to a specified version of Dapr runtime in Kubernetes with value set dapr upgrade -k --runtime-version 1.2 --set global.logAsJson=true ``` -# Related links +### Related links - [Upgrade Dapr on a Kubernetes cluster]({{< ref kubernetes-upgrade.md >}}) \ No newline at end of file diff --git a/daprdocs/content/en/reference/components-reference/supported-bindings/_index.md b/daprdocs/content/en/reference/components-reference/supported-bindings/_index.md index 50b314a16..167fe5a22 100644 --- a/daprdocs/content/en/reference/components-reference/supported-bindings/_index.md +++ b/daprdocs/content/en/reference/components-reference/supported-bindings/_index.md @@ -28,7 +28,7 @@ Table captions: | [Apple Push Notifications (APN)]({{< ref apns.md >}}) | | ✅ | Alpha | v1 | 1.0 | | [Cron (Scheduler)]({{< ref cron.md >}}) | ✅ | ✅ | Alpha | v1 | 1.0 | | [GraphQL]({{< ref graghql.md >}}) | | ✅ | Alpha | v1 | 1.0 | -| [HTTP]({{< ref http.md >}}) | | ✅ | GA | v1 | 1.0 | +| [HTTP]({{< ref http.md >}}) | | ✅ | Stable| v1 | 1.0 | | [InfluxDB]({{< ref influxdb.md >}}) | | ✅ | Alpha | v1 | 1.0 | | [Kafka]({{< ref kafka.md >}}) | ✅ | ✅ | Alpha | v1 | 1.0 | | [Kubernetes Events]({{< ref "kubernetes-binding.md" >}}) | ✅ | | Alpha | v1 | 1.0 | @@ -80,7 +80,7 @@ Table captions: | [Azure Event Hubs]({{< ref eventhubs.md >}}) | ✅ | ✅ | Alpha | v1 | 1.0 | | [Azure Service Bus Queues]({{< ref servicebusqueues.md >}}) | ✅ | ✅ | Alpha | v1 | 1.0 | | [Azure SignalR]({{< ref signalr.md >}}) | | ✅ | Alpha | v1 | 1.0 | -| [Azure Storage Queues]({{< ref storagequeues.md >}}) | ✅ | ✅ | GA | v1 | 1.0 | +| [Azure Storage Queues]({{< ref storagequeues.md >}}) | ✅ | ✅ | Stable| v1 | 1.0 | ### Zeebe (Camunda Cloud) diff --git a/daprdocs/content/en/reference/components-reference/supported-bindings/eventhubs.md b/daprdocs/content/en/reference/components-reference/supported-bindings/eventhubs.md index 813b67644..637939fef 100644 --- a/daprdocs/content/en/reference/components-reference/supported-bindings/eventhubs.md +++ b/daprdocs/content/en/reference/components-reference/supported-bindings/eventhubs.md @@ -64,13 +64,14 @@ Azure IoT Hub provides an [endpoint that is compatible with Event Hubs](https:// The device-to-cloud events created by Azure IoT Hub devices will contain additional [IoT Hub System Properties](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-messages-construct#system-properties-of-d2c-iot-hub-messages), and the Azure Event Hubs binding for Dapr will return the following as part of the response metadata: -| System Property Name | Description | -|--------------------|:--------| +| System Property Name | Description & Routing Query Keyword | +|----------------------|:------------------------------------| | `iothub-connection-auth-generation-id` | The **connectionDeviceGenerationId** of the device that sent the message. See [IoT Hub device identity properties](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#device-identity-properties). | -| `iothub-connection-auth-method` | The authentication method used to authenticate the device that sent the message. | +| `iothub-connection-auth-method` | The **connectionAuthMethod** used to authenticate the device that sent the message. | | `iothub-connection-device-id` | The **deviceId** of the device that sent the message. See [IoT Hub device identity properties](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#device-identity-properties). | | `iothub-connection-module-id` | The **moduleId** of the device that sent the message. See [IoT Hub device identity properties](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#device-identity-properties). | -| `iothub-enqueuedtime` | The date and time in RFC3339 format that the device-to-cloud message was received by IoT Hub. | +| `iothub-enqueuedtime` | The **enqueuedTime** in RFC3339 format that the device-to-cloud message was received by IoT Hub. | +| `message-id` | The user-settable AMQP **messageId**. | For example, the headers of a HTTP `Read()` response would contain: @@ -85,6 +86,7 @@ For example, the headers of a HTTP `Read()` response would contain: 'iothub-connection-auth-method': '{"scope":"module","type":"sas","issuer":"iothub","acceptingIpFilterRule":null}', 'iothub-connection-module-id': 'my-test-module-a', 'iothub-enqueuedtime': '2021-07-13T22:08:09Z', + 'message-id': 'my-custom-message-id', 'x-opt-sequence-number': '35', 'x-opt-enqueued-time': '2021-07-13T22:08:09Z', 'x-opt-offset': '21560', diff --git a/daprdocs/content/en/reference/components-reference/supported-bindings/servicebusqueues.md b/daprdocs/content/en/reference/components-reference/supported-bindings/servicebusqueues.md index e8116cd02..1e4398049 100644 --- a/daprdocs/content/en/reference/components-reference/supported-bindings/servicebusqueues.md +++ b/daprdocs/content/en/reference/components-reference/supported-bindings/servicebusqueues.md @@ -40,7 +40,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr | Field | Required | Binding support | Details | Example | |--------------------|:--------:|------------|-----|---------| | connectionString | Y | Input/Output | The Service Bus connection string | `"Endpoint=sb://************"` | -| queueName | Y | Input/Output | The Service Bus queue name | `"queuename"` | +| queueName | Y | Input/Output | The Service Bus queue name. Queue names are case-insensitive and will always be forced to lowercase. | `"queuename"` | | ttlInSeconds | N | Output | Parameter to set the default message [time to live](https://docs.microsoft.com/azure/service-bus-messaging/message-expiration). If this parameter is omitted, messages will expire after 14 days. See [also](#specifying-a-ttl-per-message) | `"60"` | ## Binding support diff --git a/daprdocs/content/en/reference/components-reference/supported-middleware/_index.md b/daprdocs/content/en/reference/components-reference/supported-middleware/_index.md index 039ec971e..eb92c4470 100644 --- a/daprdocs/content/en/reference/components-reference/supported-middleware/_index.md +++ b/daprdocs/content/en/reference/components-reference/supported-middleware/_index.md @@ -18,4 +18,4 @@ aliases: | [OAuth2 client credentials]({{< ref middleware-oauth2clientcredentials.md >}}) | Enables the [OAuth2 Client Credentials Grant flow](https://tools.ietf.org/html/rfc6749#section-4.4) on a Web API | Alpha | v1| | [Bearer]({{< ref middleware-bearer.md >}}) | Verifies a [Bearer Token](https://tools.ietf.org/html/rfc6750) using [OpenID Connect](https://openid.net/connect/) on a Web API | Alpha | v1| | [Open Policy Agent]({{< ref middleware-opa.md >}}) | Applies [Rego/OPA Policies](https://www.openpolicyagent.org/) to incoming Dapr HTTP requests | Alpha | v1| -| [Uppercase]({{< ref middleware-uppercase.md >}}) | Converts the body of the request to uppercase letters | GA (For local development) | v1| +| [Uppercase]({{< ref middleware-uppercase.md >}}) | Converts the body of the request to uppercase letters | Stable(For local development) | v1| diff --git a/daprdocs/content/en/reference/components-reference/supported-name-resolution/_index.md b/daprdocs/content/en/reference/components-reference/supported-name-resolution/_index.md index c0c66b074..453aa54f6 100644 --- a/daprdocs/content/en/reference/components-reference/supported-name-resolution/_index.md +++ b/daprdocs/content/en/reference/components-reference/supported-name-resolution/_index.md @@ -21,13 +21,13 @@ The following components provide name resolution for the service invocation buil | Name | Status | Component version | Since | |------|:------:|:-----------------:|:-----:| -| [mDNS]({{< ref nr-mdns.md >}}) | GA | v1 | 1.0 | +| [mDNS]({{< ref nr-mdns.md >}}) | Stable| v1 | 1.0 | ### Kubernetes | Name | Status | Component version | Since | |------------|:------:|:-----------------:|:-----:| -| [Kubernetes]({{< ref nr-kubernetes.md >}}) | GA | v1 | 1.0 | +| [Kubernetes]({{< ref nr-kubernetes.md >}}) | Stable| v1 | 1.0 | ## Definitions diff --git a/daprdocs/content/en/reference/components-reference/supported-pubsub/_index.md b/daprdocs/content/en/reference/components-reference/supported-pubsub/_index.md index c45c1599d..de99a9088 100644 --- a/daprdocs/content/en/reference/components-reference/supported-pubsub/_index.md +++ b/daprdocs/content/en/reference/components-reference/supported-pubsub/_index.md @@ -30,7 +30,7 @@ Table captions: | [JetStream]({{< ref setup-jetstream.md >}}) | Alpha | v1 | 1.4 | | [Pulsar]({{< ref setup-pulsar.md >}}) | Alpha | v1 | 1.0 | | [RabbitMQ]({{< ref setup-rabbitmq.md >}}) | Alpha | v1 | 1.0 | -| [Redis Streams]({{< ref setup-redis-pubsub.md >}}) | GA | v1 | 1.0 | +| [Redis Streams]({{< ref setup-redis-pubsub.md >}}) | Stable | v1 | 1.0 | ### Amazon Web Services (AWS) @@ -49,4 +49,4 @@ Table captions: | Name | Status | Component version | Since | |-----------------------------------------------------------|--------| ----------------| -- | | [Azure Event Hubs]({{< ref setup-azure-eventhubs.md >}}) | Alpha | v1 | 1.0 | -| [Azure Service Bus]({{< ref setup-azure-servicebus.md >}})| GA | v1 | 1.0 | +| [Azure Service Bus]({{< ref setup-azure-servicebus.md >}})| Stable | v1 | 1.0 | diff --git a/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-apache-kafka.md b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-apache-kafka.md index 91a86b1cd..277b738bf 100644 --- a/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-apache-kafka.md +++ b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-apache-kafka.md @@ -37,6 +37,8 @@ spec: key: saslPasswordSecret - name: maxMessageBytes # Optional. value: 1024 + - name: consumeRetryInterval # Optional. + value: 200ms ``` ## Spec metadata fields @@ -51,6 +53,7 @@ spec: | saslPassword | N | The SASL password used for authentication. Can be `secretKeyRef` to use a [secret reference]({{< ref component-secrets.md >}}). Only required if `authRequired` is set to `"true"`. | `""`, `"KeFg23!"` | initialOffset | N | The initial offset to use if no offset was previously committed. Should be "newest" or "oldest". Defaults to "newest". | `"oldest"` | maxMessageBytes | N | The maximum size in bytes allowed for a single Kafka message. Defaults to 1024. | `2048` +| consumeRetryInterval | N | The interval between retries when attempting to consume topics. Treats numbers without suffix as milliseconds. Defaults to 100ms. | `200ms` ## Per-call metadata fields diff --git a/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-azure-eventhubs.md b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-azure-eventhubs.md index ab1aed4db..4fa681081 100644 --- a/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-azure-eventhubs.md +++ b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-azure-eventhubs.md @@ -64,13 +64,14 @@ Azure IoT Hub provides an [endpoint that is compatible with Event Hubs](https:// The device-to-cloud events created by Azure IoT Hub devices will contain additional [IoT Hub System Properties](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-messages-construct#system-properties-of-d2c-iot-hub-messages), and the Azure Event Hubs pubsub component for Dapr will return the following as part of the response metadata: -| System Property Name | Description | -|--------------------|:--------| +| System Property Name | Description & Routing Query Keyword | +|----------------------|:------------------------------------| | `iothub-connection-auth-generation-id` | The **connectionDeviceGenerationId** of the device that sent the message. See [IoT Hub device identity properties](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#device-identity-properties). | -| `iothub-connection-auth-method` | The authentication method used to authenticate the device that sent the message. | +| `iothub-connection-auth-method` | The **connectionAuthMethod** used to authenticate the device that sent the message. | | `iothub-connection-device-id` | The **deviceId** of the device that sent the message. See [IoT Hub device identity properties](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#device-identity-properties). | | `iothub-connection-module-id` | The **moduleId** of the device that sent the message. See [IoT Hub device identity properties](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry#device-identity-properties). | -| `iothub-enqueuedtime` | The date and time in RFC3339 format that the device-to-cloud message was received by IoT Hub. | +| `iothub-enqueuedtime` | The **enqueuedTime** in RFC3339 format that the device-to-cloud message was received by IoT Hub. | +| `message-id` | The user-settable AMQP **messageId**. | For example, the headers of a delivered HTTP subscription message would contain: @@ -85,6 +86,7 @@ For example, the headers of a delivered HTTP subscription message would contain: 'iothub-connection-auth-method': '{"scope":"module","type":"sas","issuer":"iothub","acceptingIpFilterRule":null}', 'iothub-connection-module-id': 'my-test-module-a', 'iothub-enqueuedtime': '2021-07-13T22:08:09Z', + 'message-id': 'my-custom-message-id', 'x-opt-sequence-number': '35', 'x-opt-enqueued-time': '2021-07-13T22:08:09Z', 'x-opt-offset': '21560', diff --git a/daprdocs/content/en/reference/components-reference/supported-secret-stores/_index.md b/daprdocs/content/en/reference/components-reference/supported-secret-stores/_index.md index 1636dcd3f..a1ee0e89d 100644 --- a/daprdocs/content/en/reference/components-reference/supported-secret-stores/_index.md +++ b/daprdocs/content/en/reference/components-reference/supported-secret-stores/_index.md @@ -26,7 +26,7 @@ Table captions: | [Local environment variables]({{< ref envvar-secret-store.md >}}) | Beta | v1 | 1.0 | | [Local file]({{< ref file-secret-store.md >}}) | Beta | v1 | 1.0 | | [HashiCorp Vault]({{< ref hashicorp-vault.md >}}) | Alpha | v1 | 1.0 | -| [Kubernetes secrets]({{< ref kubernetes-secret-store.md >}}) | GA | v1 | 1.0 | +| [Kubernetes secrets]({{< ref kubernetes-secret-store.md >}}) | Stable | v1 | 1.0 | ### Amazon Web Services (AWS) @@ -45,4 +45,4 @@ Table captions: | Name | Status | Component version | Since | |---------------------------------------------------------------------------------------|--------| ---- |--------------| -| [Azure Key Vault]({{< ref azure-keyvault.md >}}) | GA | v1 | 1.0 | +| [Azure Key Vault]({{< ref azure-keyvault.md >}}) | Stable | v1 | 1.0 | diff --git a/daprdocs/content/en/reference/components-reference/supported-state-stores/_index.md b/daprdocs/content/en/reference/components-reference/supported-state-stores/_index.md index 60547031b..d1c03f82d 100644 --- a/daprdocs/content/en/reference/components-reference/supported-state-stores/_index.md +++ b/daprdocs/content/en/reference/components-reference/supported-state-stores/_index.md @@ -35,10 +35,10 @@ The following stores are supported, at various levels, by the Dapr state managem | [Hashicorp Consul]({{< ref setup-consul.md >}}) | ✅ | ❌ | ❌ | ❌ | ❌ | Alpha | v1 | 1.0 | | [Hazelcast]({{< ref setup-hazelcast.md >}}) | ✅ | ❌ | ❌ | ❌ | ❌ | Alpha | v1 | 1.0 | | [Memcached]({{< ref setup-memcached.md >}}) | ✅ | ❌ | ❌ | ✅ | ❌ | Alpha | v1 | 1.0 | -| [MongoDB]({{< ref setup-mongodb.md >}}) | ✅ | ✅ | ✅ | ❌ | ✅ | GA | v1 | 1.0 | +| [MongoDB]({{< ref setup-mongodb.md >}}) | ✅ | ✅ | ✅ | ❌ | ✅ | Stable | v1 | 1.0 | | [MySQL]({{< ref setup-mysql.md >}}) | ✅ | ✅ | ✅ | ❌ | ✅ | Alpha | v1 | 1.0 | | [PostgreSQL]({{< ref setup-postgresql.md >}}) | ✅ | ✅ | ✅ | ❌ | ✅ | Alpha | v1 | 1.0 | -| [Redis]({{< ref setup-redis.md >}}) | ✅ | ✅ | ✅ | ✅ | ✅ | GA | v1 | 1.0 | +| [Redis]({{< ref setup-redis.md >}}) | ✅ | ✅ | ✅ | ✅ | ✅ | Stable | v1 | 1.0 | | [RethinkDB]({{< ref setup-rethinkdb.md >}}) | ✅ | ✅ | ✅ | ❌ | ✅ | Alpha | v1 | 1.0 | | [Zookeeper]({{< ref setup-zookeeper.md >}}) | ✅ | ❌ | ✅ | ❌ | ❌ | Alpha | v1 | 1.0 | @@ -57,7 +57,7 @@ The following stores are supported, at various levels, by the Dapr state managem | Name | CRUD | Transactional | ETag | [TTL]({{< ref state-store-ttl.md >}}) | [Actors]({{< ref howto-actors.md >}}) | Status | Component version | Since | |------------------------------------------------------------------|------|---------------------|------|-----|--------|-----|-----|-------| -| [Azure Blob Storage]({{< ref setup-azure-blobstorage.md >}}) | ✅ | ❌ | ✅ | ❌ | ❌ | GA | v1 | 1.0 | -| [Azure CosmosDB]({{< ref setup-azure-cosmosdb.md >}}) | ✅ | ✅ | ✅ | ✅ | ✅ | GA | v1 | 1.0 | +| [Azure Blob Storage]({{< ref setup-azure-blobstorage.md >}}) | ✅ | ❌ | ✅ | ❌ | ❌ | Stable | v1 | 1.0 | +| [Azure CosmosDB]({{< ref setup-azure-cosmosdb.md >}}) | ✅ | ✅ | ✅ | ✅ | ✅ | Stable | v1 | 1.0 | | [Azure SQL Server]({{< ref setup-sqlserver.md >}}) | ✅ | ✅ | ✅ | ❌ | ✅ | Alpha | v1 | 1.0 | | [Azure Table Storage]({{< ref setup-azure-tablestorage.md >}}) | ✅ | ❌ | ✅ | ❌ | ❌ | Alpha | v1 | 1.0 | diff --git a/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-firestore.md b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-firestore.md index 10a964aa6..2ea52382e 100644 --- a/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-firestore.md +++ b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-firestore.md @@ -65,7 +65,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr | client_x509_cert_url | Y | The client certificate URL | `"https://www.googleapis.com/robot/v1/metadata/x509/x"` | entity_kind | N | The entity name in Filestore. Defaults to `"DaprState"` | `"DaprState"` -## Setup GCP Firestone +## Setup GCP Firestore {{< tabs "Self-Hosted" "Google Cloud" >}} diff --git a/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-sqlserver.md b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-sqlserver.md index b2e0bd148..76dec26e9 100644 --- a/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-sqlserver.md +++ b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-sqlserver.md @@ -25,7 +25,7 @@ spec: - name: connectionString value: # Required. - name: tableName - value: # Required. + value: # Optional. defaults to "state" - name: keyType value: # Optional. defaults to "string" - name: keyLength @@ -52,8 +52,8 @@ If you wish to use SQL server as an [actor state store]({{< ref "state_api.md#co | Field | Required | Details | Example | |--------------------|:--------:|---------|---------| -| connectionString | Y | The connection string used to connect | `"Server=myServerName\myInstanceName;Database=myDataBase;User Id=myUsername;Password=myPassword;"` -| tableName | Y | The name of the table to use. Alpha-numeric with underscores | `"table_name"` +| connectionString | Y | The connection string used to connect. If the connection string contains the database it must already exist. If the database is omitted a default database named `"Dapr"` is created. | `"Server=myServerName\myInstanceName;Database=myDataBase;User Id=myUsername;Password=myPassword;"` +| tableName | N | The name of the table to use. Alpha-numeric with underscores. Defaults to `"state"` | `"table_name"` | keyType | N | The type of key used. Defaults to `"string"` | `"string"` | keyLength | N | The max length of key. Used along with `"string"` keytype. Defaults to `"200"` | `"200"` | schema | N | The schema to use. Defaults to `"dbo"` | `"dapr"`,`"dbo"` @@ -69,7 +69,7 @@ If you wish to use SQL server as an [actor state store]({{< ref "state_api.md#co In order to setup SQL Server as a state store, you need the following properties: -- **Connection String**: the SQL Server connection string. For example: server=localhost;user id=sa;password=your-password;port=1433;database=mydatabase; +- **Connection String**: The SQL Server connection string. For example: server=localhost;user id=sa;password=your-password;port=1433;database=mydatabase; - **Schema**: The database schema to use (default=dbo). Will be created if does not exist - **Table Name**: The database table name. Will be created if does not exist - **Indexed Properties**: Optional properties from json data which will be indexed and persisted as individual column diff --git a/daprdocs/content/en/reference/environment/_index.md b/daprdocs/content/en/reference/environment/_index.md index 16b21455a..7eb1bf339 100644 --- a/daprdocs/content/en/reference/environment/_index.md +++ b/daprdocs/content/en/reference/environment/_index.md @@ -8,12 +8,13 @@ weight: 300 The following table lists the environment variables used by the Dapr runtime, CLI, or from within your application: -| Environment Variable | Used By | Description | -|----------------------------------|------------------|-------------| -| DAPR_HTTP_PORT | Your application | The HTTP port that Dapr is listening on. Your application should use this variable to connect to Dapr instead of hardcoding the port value. Injected by the `dapr-sidecar-injector` into all the containers in the pod. -| DAPR_GRPC_PORT | Your application | The gRPC port that Dapr is listening on. Your application should use this variable to connect to Dapr instead of hardcoding the port value. Injected by the `dapr-sidecar-injector` into all the containers in the pod. -| DAPR_TOKEN_API | Your application | The token used for Dapr API authentication for requests from the application. Read [enable API token authentication in Dapr]({{< ref api-token >}}) for more information. -| APP_TOKEN_API | Your application | The token used by the app to authenticate requests from Dapr. Read [authenticate requests from Dapr using token authentication]({{< ref app-api-token >}}) for more information. -| DAPR_PLACEMENT_HOST |Your application | The address for the Dapr Placement service. Only needed in self-hosted mode if you run your app (which creates actors) and you want to tell the app the location of the Placement service. This is never needed outside of local machine development. -| DAPR_NETWORK | Dapr CLI | Optionally used by the Dapr CLI to specify the Docker network on which to deploy the Dapr runtime. -| NAMESPACE | Dapr runtime | Used to specify a component's [namespace in self-hosted mode]({{< ref component-scopes >}}) +| Environment Variable | Used By | Description | +| -------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| APP_ID | Your application | The id for your application, used for service discovery | +| APP_PORT | Your application | The port your application is listening on | +| APP_API_TOKEN | Your application | The token used by the application to authenticate requests from Dapr API. Read [authenticate requests from Dapr using token authentication]({{< ref app-api-token >}}) for more information. | +| DAPR_HTTP_PORT | Your application | The HTTP port that the Dapr sidecar is listening on. Your application should use this variable to connect to Dapr sidecar instead of hardcoding the port value. Set by the Dapr CLI run command for self hosted or injected by the dapr-sidecar-injector into all the containers in the pod. | +| DAPR_GRPC_PORT | Your application | The gRPC port that the Dapr sidecar is listening on. Your application should use this variable to connect to Dapr sidecar instead of hardcoding the port value. Set by the Dapr CLI run command for self hosted or injected by the dapr-sidecar-injector into all the containers in the pod. | +| DAPR_METRICS_PORT | Your application | The HTTP [Prometheus]({{< ref prometheus >}}) port that Dapr sends its metrics information to. Your application can use this variable to send its application specific metrics to have both Dapr metrics and application metrics together. See [metrics-port] ({{< ref arguments-annotations-overview>}}) for more information | +| DAPR_API_TOKEN | Dapr sidecar | The token used for Dapr API authentication for requests from the application. Read [enable API token authentication in Dapr]({{< ref api-token >}}) for more information. | +| NAMESPACE | Dapr sidecar | Used to specify a component's [namespace in self-hosted mode]({{< ref component-scopes >}}) | diff --git a/daprdocs/layouts/docs/list.html b/daprdocs/layouts/docs/list.html index 8886ba5b6..cfcff916f 100644 --- a/daprdocs/layouts/docs/list.html +++ b/daprdocs/layouts/docs/list.html @@ -1,7 +1,6 @@ {{ define "main" }}
-

{{ .Title }}

- {{ with .Params.description }}
{{ . | markdownify }}
{{ end }} +

{{ .LinkTitle }}

{{ if (and (not .Params.hide_readingtime) (.Site.Params.ui.readingtime.enable)) }} {{ partial "reading-time.html" . }} {{ end }} diff --git a/daprdocs/layouts/shortcodes/dapr-latest-version.html b/daprdocs/layouts/shortcodes/dapr-latest-version.html index 6f1027f0a..9a456a8b3 100644 --- a/daprdocs/layouts/shortcodes/dapr-latest-version.html +++ b/daprdocs/layouts/shortcodes/dapr-latest-version.html @@ -1 +1 @@ -{{- if .Get "short" }}1.4{{ else if .Get "long" }}1.4.1{{ else if .Get "cli" }}1.4.0{{ else }}1.4.1{{ end -}} +{{- if .Get "short" }}1.4{{ else if .Get "long" }}1.4.3{{ else if .Get "cli" }}1.4.0{{ else }}1.4.3{{ end -}} diff --git a/daprdocs/static/images/daprcon.png b/daprdocs/static/images/daprcon.png new file mode 100644 index 000000000..ed0d3882c Binary files /dev/null and b/daprdocs/static/images/daprcon.png differ