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/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]({{}}) - [`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 47e478692..09b6a77f6 100644 --- a/daprdocs/content/en/reference/cli/dapr-run.md +++ b/daprdocs/content/en/reference/cli/dapr-run.md @@ -5,72 +5,62 @@ 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 | -| `--unix-domain-socket`, `-u` | | `/tmp/dapr-APPID-[http|grpc].socket` | The socket path 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 | +| `--unix-domain-socket`, `-u` | | | Path to a unix domain socket dir mount. If specified, Dapr API servers will use Unix Domain Sockets | +| `--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 ``` ### Run a .Net application with socket 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/gcpbucket.md b/daprdocs/content/en/reference/components-reference/supported-bindings/gcpbucket.md index 19b7ba19b..e314b1849 100644 --- a/daprdocs/content/en/reference/components-reference/supported-bindings/gcpbucket.md +++ b/daprdocs/content/en/reference/components-reference/supported-bindings/gcpbucket.md @@ -44,6 +44,10 @@ spec: value: https://www.googleapis.com/robot/v1/metadata/x509/.iam.gserviceaccount.com - name: private_key value: PRIVATE KEY + - name: decodeBase64 + value: + - name: encodeBase64 + value: ``` {{% alert title="Warning" color="warning" %}} @@ -65,12 +69,17 @@ The above example uses secrets as plain strings. It is recommended to use a secr | token_uri | Y | Output | Google account token uri | `https://oauth2.googleapis.com/token` | auth_provider_x509_cert_url | Y | Output | GCP credentials cert url | `https://www.googleapis.com/oauth2/v1/certs` | client_x509_cert_url | Y | Output | GCP credentials project x509 cert url | `https://www.googleapis.com/robot/v1/metadata/x509/.iam.gserviceaccount.com` +| decodeBase64 | N | Output | Configuration to decode base64 file content before saving to bucket storage. (In case of saving a file with binary content). `true` is the only allowed positive value. Other positive variations like `"True", "1"` are not acceptable. Defaults to `false` | `true`, `false` | +| encodeBase64 | N | Output | Configuration to encode base64 file content before return the content. (In case of opening a file with binary content). `true` is the only allowed positive value. Other positive variations like `"True", "1"` are not acceptable. Defaults to `false` | `true`, `false` | ## Binding support This component supports **output binding** with the following operations: -- `create` +- `create` : [Create file](#create-file) +- `get` : [Get file](#get-file) +- `delete` : [Delete file](#delete-file) +- `list`: [List file](#list-files) ### Create file @@ -84,10 +93,11 @@ To perform a create operation, invoke the GCP Storage Bucket binding with a `POS "data": "YOUR_CONTENT" } ``` +The metadata parameters are: +- `key` - (optional) the name of the object +- `decodeBase64` - (optional) configuration to decode base64 file content before saving to storage #### Examples - - ##### Save text to a random generated UUID file {{< tabs Windows Linux >}} @@ -113,14 +123,14 @@ To perform a create operation, invoke the GCP Storage Bucket binding with a `POS {{% codetab %}} ```bash - curl -d "{ \"operation\": \"create\", \"data\": \"Hello World\", \"metadata\": { \"name\": \"my-test-file.txt\" } }" \ + curl -d "{ \"operation\": \"create\", \"data\": \"Hello World\", \"metadata\": { \"key\": \"my-test-file.txt\" } }" \ http://localhost:/v1.0/bindings/ ``` {{% /codetab %}} {{% codetab %}} ```bash - curl -d '{ "operation": "create", "data": "Hello World", "metadata": { "name": "my-test-file.txt" } }' \ + curl -d '{ "operation": "create", "data": "Hello World", "metadata": { "key": "my-test-file.txt" } }' \ http://localhost:/v1.0/bindings/ ``` {{% /codetab %}} @@ -138,19 +148,175 @@ Then you can upload it as you would normally: {{% codetab %}} ```bash - curl -d "{ \"operation\": \"create\", \"data\": \"(YOUR_FILE_CONTENTS)\", \"metadata\": { \"name\": \"my-test-file.jpg\" } }" http://localhost:/v1.0/bindings/ + curl -d "{ \"operation\": \"create\", \"data\": \"(YOUR_FILE_CONTENTS)\", \"metadata\": { \"key\": \"my-test-file.jpg\" } }" http://localhost:/v1.0/bindings/ ``` {{% /codetab %}} {{% codetab %}} ```bash - curl -d '{ "operation": "create", "data": "$(cat my-test-file.jpg)", "metadata": { "name": "my-test-file.jpg" } }' \ + curl -d '{ "operation": "create", "data": "$(cat my-test-file.jpg)", "metadata": { "key": "my-test-file.jpg" } }' \ + http://localhost:/v1.0/bindings/ + ``` + {{% /codetab %}} + +{{< /tabs >}} +#### Response + +The response body will contain the following JSON: + +```json +{ + "objectURL":"https://storage.googleapis.com//", +} +``` + +### Get object + +To perform a get file operation, invoke the GCP bucket binding with a `POST` method and the following JSON body: + +```json +{ + "operation": "get", + "metadata": { + "key": "my-test-file.txt" + } +} +``` + +The metadata parameters are: + +- `key` - the name of the object +- `encodeBase64` - (optional) configuration to encode base64 file content before return the content. + + +#### Example + +{{< tabs Windows Linux >}} + + {{% codetab %}} + ```bash + curl -d '{ \"operation\": \"get\", \"metadata\": { \"key\": \"my-test-file.txt\" }}' http://localhost:/v1.0/bindings/ + ``` + {{% /codetab %}} + + {{% codetab %}} + ```bash + curl -d '{ "operation": "get", "metadata": { "key": "my-test-file.txt" }}' \ http://localhost:/v1.0/bindings/ ``` {{% /codetab %}} {{< /tabs >}} +#### Response + +The response body contains the value stored in the object. + + +### Delete object + +To perform a delete object operation, invoke the GCP bucket binding with a `POST` method and the following JSON body: + +```json +{ + "operation": "delete", + "metadata": { + "key": "my-test-file.txt" + } +} +``` + +The metadata parameters are: + +- `key` - the name of the object + + +#### Examples + +##### Delete object + +{{< tabs Windows Linux >}} + + {{% codetab %}} + ```bash + curl -d '{ \"operation\": \"delete\", \"metadata\": { \"key\": \"my-test-file.txt\" }}' http://localhost:/v1.0/bindings/ + ``` + {{% /codetab %}} + + {{% codetab %}} + ```bash + curl -d '{ "operation": "delete", "metadata": { "key": "my-test-file.txt" }}' \ + http://localhost:/v1.0/bindings/ + ``` + {{% /codetab %}} + +{{< /tabs >}} + +#### Response +An HTTP 204 (No Content) and empty body will be retuned if successful. + + +### List objects + +To perform a list object operation, invoke the S3 binding with a `POST` method and the following JSON body: + +```json +{ + "operation": "list", + "data": { + "maxResults": 10, + "prefix": "file", + "delimiter": "i0FvxAn2EOEL6" + } +} +``` + +The data parameters are: + +- `maxResults` - (optional) sets the maximum number of keys returned in the response. By default the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more. +- `prefix` - (optional) it can be used to filter objects starting with prefix. +- `delimiter` - (optional) it can be used to restrict the results to only the kobjects in the given "directory". Without the delimiter, the entire tree under the prefix is returned + +#### Response + +The response body contains the list of found objects. + +The list of objects will be returned as JSON array in the following form: + +```json +[ + { + "Bucket": "", + "Name": "02WGzEdsUWNlQ", + "ContentType": "image/png", + "ContentLanguage": "", + "CacheControl": "", + "EventBasedHold": false, + "TemporaryHold": false, + "RetentionExpirationTime": "0001-01-01T00:00:00Z", + "ACL": null, + "PredefinedACL": "", + "Owner": "", + "Size": 5187, + "ContentEncoding": "", + "ContentDisposition": "", + "MD5": "aQdLBCYV0BxA51jUaxc3pQ==", + "CRC32C": 1058633505, + "MediaLink": "https://storage.googleapis.com/download/storage/v1/b//o/02WGzEdsUWNlQ?generation=1631553155678071&alt=media", + "Metadata": null, + "Generation": 1631553155678071, + "Metageneration": 1, + "StorageClass": "STANDARD", + "Created": "2021-09-13T17:12:35.679Z", + "Deleted": "0001-01-01T00:00:00Z", + "Updated": "2021-09-13T17:12:35.679Z", + "CustomerKeySHA256": "", + "KMSKeyName": "", + "Prefix": "", + "Etag": "CPf+mpK5/PICEAE=" + } +] +``` ## Related links - [Basic schema for a Dapr component]({{< ref component-schema >}}) diff --git a/daprdocs/content/en/reference/components-reference/supported-bindings/rabbitmq.md b/daprdocs/content/en/reference/components-reference/supported-bindings/rabbitmq.md index 2671e0766..b548d9872 100644 --- a/daprdocs/content/en/reference/components-reference/supported-bindings/rabbitmq.md +++ b/daprdocs/content/en/reference/components-reference/supported-bindings/rabbitmq.md @@ -38,6 +38,8 @@ spec: value: false - name: maxPriority value: 5 +- name: contentType + value: "text/plain" ``` {{% alert title="Warning" color="warning" %}} @@ -56,6 +58,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr | prefetchCount | N | Input | Set the [Channel Prefetch Setting (QoS)](https://www.rabbitmq.com/confirms.html#channel-qos-prefetch). If this parameter is omiited, QoS would set value to 0 as no limit | `0` | | exclusive | N | Input/Output | Determines whether the topic will be an exclusive topic or not. Defaults to `"false"` | `"true"`, `"false"` | | maxPriority| N | Input/Output | Parameter to set the [priority queue](https://www.rabbitmq.com/priority.html). If this parameter is omitted, queue will be created as a general queue instead of a priority queue. Value between 1 and 255. See [also](#specifying-a-priority-per-message) | `"1"`, `"10"` | +| contentType | N | Input/Output | The content type of the message. Defaults to "text/plain". | `"text/plain"`, `"application/cloudevent+json"` and so on | ## Binding support This component supports both **input and output** binding interfaces. diff --git a/daprdocs/content/en/reference/components-reference/supported-bindings/redis.md b/daprdocs/content/en/reference/components-reference/supported-bindings/redis.md index ce35caf27..e07ec5d5e 100644 --- a/daprdocs/content/en/reference/components-reference/supported-bindings/redis.md +++ b/daprdocs/content/en/reference/components-reference/supported-bindings/redis.md @@ -40,25 +40,26 @@ The above example uses secrets as plain strings. It is recommended to use a secr |--------------------|:--------:|------------|-----|---------| | redisHost | Y | Output | The Redis host address | `"localhost:6379"` | | redisPassword | Y | Output | The Redis password | `"password"` | +| redisUsername | N | Output | Username for Redis host. Defaults to empty. Make sure your redis server version is 6 or above, and have created acl rule correctly. | `"username"` | | enableTLS | N | Output | If the Redis instance supports TLS with public certificates it can be configured to enable or disable TLS. Defaults to `"false"` | `"true"`, `"false"` | -| failover | N | Property to enabled failover configuration. Needs sentinalMasterName to be set. Defaults to `"false"` | `"true"`, `"false"` -| sentinelMasterName | N | The sentinel master name. See [Redis Sentinel Documentation](https://redis.io/topics/sentinel) | `""`, `"127.0.0.1:6379"` -| redeliverInterval | N | The interval between checking for pending messages to redelivery. Defaults to `"60s"`. `"0"` disables redelivery. | `"30s"` -| processingTimeout | N | The amount time a message must be pending before attempting to redeliver it. Defaults to `"15s"`. `"0"` disables redelivery. | `"30s"` -| redisType | N | The type of redis. There are two valid values, one is `"node"` for single node mode, the other is `"cluster"` for redis cluster mode. Defaults to `"node"`. | `"cluster"` -| redisDB | N | Database selected after connecting to redis. If `"redisType"` is `"cluster"` this option is ignored. Defaults to `"0"`. | `"0"` -| redisMaxRetries | N | Maximum number of times to retry commands before giving up. Default is to not retry failed commands. | `"5"` -| redisMinRetryInterval | N | Minimum backoff for redis commands between each retry. Default is `"8ms"`; `"-1"` disables backoff. | `"8ms"` -| redisMaxRetryInterval | N | Maximum backoff for redis commands between each retry. Default is `"512ms"`;`"-1"` disables backoff. | `"5s"` -| dialTimeout | N | Dial timeout for establishing new connections. Defaults to `"5s"`. | `"5s"` -| readTimeout | N | Timeout for socket reads. If reached, redis commands will fail with a timeout instead of blocking. Defaults to `"3s"`, `"-1"` for no timeout. | `"3s"` -| writeTimeout | N | Timeout for socket writes. If reached, redis commands will fail with a timeout instead of blocking. Defaults is readTimeout. | `"3s"` -| poolSize | N | Maximum number of socket connections. Default is 10 connections per every CPU as reported by runtime.NumCPU. | `"20"` -| poolTimeout | N | Amount of time client waits for a connection if all connections are busy before returning an error. Default is readTimeout + 1 second. | `"5s"` -| maxConnAge | N | Connection age at which the client retires (closes) the connection. Default is to not close aged connections. | `"30m"` -| minIdleConns | N | Minimum number of idle connections to keep open in order to avoid the performance degradation associated with creating new connections. Defaults to `"0"`. | `"2"` -| idleCheckFrequency | N | Frequency of idle checks made by idle connections reaper. Default is `"1m"`. `"-1"` disables idle connections reaper. | `"-1"` -| idleTimeout | N | Amount of time after which the client closes idle connections. Should be less than server's timeout. Default is `"5m"`. `"-1"` disables idle timeout check. | `"10m"` +| failover | N | Output | Property to enabled failover configuration. Needs sentinalMasterName to be set. Defaults to `"false"` | `"true"`, `"false"` +| sentinelMasterName | N | Output | The sentinel master name. See [Redis Sentinel Documentation](https://redis.io/topics/sentinel) | `""`, `"127.0.0.1:6379"` +| redeliverInterval | N | Output | The interval between checking for pending messages to redelivery. Defaults to `"60s"`. `"0"` disables redelivery. | `"30s"` +| processingTimeout | N | Output | The amount time a message must be pending before attempting to redeliver it. Defaults to `"15s"`. `"0"` disables redelivery. | `"30s"` +| redisType | N | Output | The type of redis. There are two valid values, one is `"node"` for single node mode, the other is `"cluster"` for redis cluster mode. Defaults to `"node"`. | `"cluster"` +| redisDB | N | Output | Database selected after connecting to redis. If `"redisType"` is `"cluster"` this option is ignored. Defaults to `"0"`. | `"0"` +| redisMaxRetries | N | Output | Maximum number of times to retry commands before giving up. Default is to not retry failed commands. | `"5"` +| redisMinRetryInterval | N | Output | Minimum backoff for redis commands between each retry. Default is `"8ms"`; `"-1"` disables backoff. | `"8ms"` +| redisMaxRetryInterval | N | Output | Maximum backoff for redis commands between each retry. Default is `"512ms"`;`"-1"` disables backoff. | `"5s"` +| dialTimeout | N | Output | Dial timeout for establishing new connections. Defaults to `"5s"`. | `"5s"` +| readTimeout | N | Output | Timeout for socket reads. If reached, redis commands will fail with a timeout instead of blocking. Defaults to `"3s"`, `"-1"` for no timeout. | `"3s"` +| writeTimeout | N | Output | Timeout for socket writes. If reached, redis commands will fail with a timeout instead of blocking. Defaults is readTimeout. | `"3s"` +| poolSize | N | Output | Maximum number of socket connections. Default is 10 connections per every CPU as reported by runtime.NumCPU. | `"20"` +| poolTimeout | N | Output | Amount of time client waits for a connection if all connections are busy before returning an error. Default is readTimeout + 1 second. | `"5s"` +| maxConnAge | N | Output | Connection age at which the client retires (closes) the connection. Default is to not close aged connections. | `"30m"` +| minIdleConns | N | Output | Minimum number of idle connections to keep open in order to avoid the performance degradation associated with creating new connections. Defaults to `"0"`. | `"2"` +| idleCheckFrequency | N | Output | Frequency of idle checks made by idle connections reaper. Default is `"1m"`. `"-1"` disables idle connections reaper. | `"-1"` +| idleTimeout | N | Output | Amount of time after which the client closes idle connections. Should be less than server's timeout. Default is `"5m"`. `"-1"` disables idle timeout check. | `"10m"` ## Binding support 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-pubsub/setup-redis-pubsub.md b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-redis-pubsub.md index 394beeaea..9b5787a98 100644 --- a/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-redis-pubsub.md +++ b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-redis-pubsub.md @@ -41,6 +41,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr |--------------------|:--------:|---------|---------| | redisHost | Y | Connection-string for the redis host. If `"redisType"` is `"cluster"` it can be multiple hosts separated by commas or just a single host | `localhost:6379`, `redis-master.default.svc.cluster.local:6379` | redisPassword | Y | Password for Redis host. No Default. Can be `secretKeyRef` to use a secret reference | `""`, `"KeFg23!"` +| redisUsername | N | Username for Redis host. Defaults to empty. Make sure your redis server version is 6 or above, and have created acl rule correctly. | `""`, `"default"` | consumerID | N | The consumer group ID | `"myGroup"` | enableTLS | N | If the Redis instance supports TLS with public certificates, can be configured to be enabled or disabled. Defaults to `"false"` | `"true"`, `"false"` | redeliverInterval | N | The interval between checking for pending messages to redelivery. Defaults to `"60s"`. `"0"` disables redelivery. | `"30s"` 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-redis.md b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-redis.md index 36c01fb57..c0234cdf7 100644 --- a/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-redis.md +++ b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-redis.md @@ -60,6 +60,7 @@ If you wish to use Redis as an actor store, append the following to the yaml. |--------------------|:--------:|---------|---------| | redisHost | Y | Connection-string for the redis host | `localhost:6379`, `redis-master.default.svc.cluster.local:6379` | redisPassword | Y | Password for Redis host. No Default. Can be `secretKeyRef` to use a secret reference | `""`, `"KeFg23!"` +| redisUsername | N | Username for Redis host. Defaults to empty. Make sure your redis server version is 6 or above, and have created acl rule correctly. | `""`, `"default"` | consumerID | N | The consumer group ID | `"myGroup"` | enableTLS | N | If the Redis instance supports TLS with public certificates, can be configured to be enabled or disabled. Defaults to `"false"` | `"true"`, `"false"` | maxRetries | N | Maximum number of retries before giving up. Defaults to `3` | `5`, `10` 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