dapr
/
docs
mirror of https://github.com/dapr/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'v1.4' into azure-blob-storage-add-access-level

This commit is contained in:
greenie-msft 2021-10-28 14:44:15 -07:00 committed by GitHub
parent 5edac2577f 1e175c902d
commit e7d22bf1b1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
28 changed files with 343 additions and 323 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -13,9 +13,9 @@ 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.
| ------------------------------------------------------------ | -------------------------- | ------------------------------------------------------------------------------------------------ |
| [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).

6
daprdocs/content/en/_index.md
View File

@ -8,12 +8,12 @@ no_list: true
<div class="card-body">
<h5 class="card-title">
<img src="/images/daprcon.png" alt="DaprCon logo" width=40>
<b> Join us for DaprCon on October 19th-20th, 2021!</b>
<b> Watch DaprCon sessions on-demand!</b>
</h5>
<p class="card-text">
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! <br></br><i><b>Learn more >></b></i>
The first ever DaprCon took place October 19th-20th, 2021. Read this recap and find links to all on-demand content <br></br><i><b>Learn more >></b></i>
</p>
<a href="https://blog.dapr.io/posts/2021/10/05/join-us-for-daprcon-october-19th-20th-2021/" class="stretched-link"></a>
<a href="https://blog.dapr.io/posts/2021/10/21/thanks-for-a-great-first-daprcon/" class="stretched-link"></a>
</div>
</div>
</div>

2
daprdocs/content/en/developing-applications/integrations/workflows.md
View File

@ -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:

1
daprdocs/content/en/getting-started/_index.md
View File

@ -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]({{<ref concepts>}}).
{{< 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.

16
daprdocs/content/en/operations/hosting/kubernetes/kubernetes-upgrade.md
View File

@ -49,14 +49,26 @@ Then proceed with the `dapr upgrade --runtime-version {{% dapr-latest-version lo
From version 1.0.0 onwards, upgrading Dapr using Helm is no longer a disruptive action since existing certificate values will automatically be re-used.
1. Upgrade Dapr from 1.0.0 (or newer) to any [NEW VERSION] > v1.0.0:
1. Upgrade Dapr from 1.0.0 (or newer) to any [NEW VERSION] > 1.0.0:
*Helm does not handle upgrading CRDs, so you need to perform that manually. CRDs are backward-compatible and should only be installed forward.*
>Note: The Dapr version is included in the commands below.
For version {{% dapr-latest-version long="true" %}}:
```bash
kubectl replace -f https://raw.githubusercontent.com/dapr/dapr/v{{% dapr-latest-version long="true" %}}/charts/dapr/crds/components.yaml
kubectl replace -f https://raw.githubusercontent.com/dapr/dapr/v{{% dapr-latest-version long="true" %}}/charts/dapr/crds/configuration.yaml
kubectl replace -f https://raw.githubusercontent.com/dapr/dapr/v{{% dapr-latest-version long="true" %}}/charts/dapr/crds/subscription.yaml
```
```bash
helm repo update
```
```bash
helm upgrade dapr dapr/dapr --version [NEW VERSION] --namespace dapr-system --wait
helm upgrade dapr dapr/dapr --version {{% dapr-latest-version long="true" %}} --namespace dapr-system --wait
```
*If you're using a values file, remember to add the `--values` option when running the upgrade command.*

4
daprdocs/content/en/reference/cli/cli-overview.md
View File

@ -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.

9
daprdocs/content/en/reference/cli/dapr-build-info.md
View File

@ -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.

34
daprdocs/content/en/reference/cli/dapr-completion.md
View File

@ -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 |
## 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

16
daprdocs/content/en/reference/cli/dapr-components.md
View File

@ -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
| --- | --- | --- | --- |
| 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
```

22
daprdocs/content/en/reference/cli/dapr-configurations.md
View File

@ -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)
| 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
```

31
daprdocs/content/en/reference/cli/dapr-dashboard.md
View File

@ -5,24 +5,25 @@ 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 |
@ -30,29 +31,21 @@ dapr dashboard [flags]
| `--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
```

10
daprdocs/content/en/reference/cli/dapr-help.md
View File

@ -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
| --- | --- | --- | --- |
| Name | Environment Variable | Default | Description |
| -------------- | -------------------- | ------- | ------------------------ |
| `--help`, `-h` | | | Prints this help message |

53
daprdocs/content/en/reference/cli/dapr-init.md
View File

@ -5,24 +5,25 @@ 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
| --- | --- | --- | --- |
| 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 |
@ -30,42 +31,44 @@ dapr init [flags]
| `--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 |
## 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
```

25
daprdocs/content/en/reference/cli/dapr-invoke.md
View File

@ -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 |
| 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)
| `--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
```

27
daprdocs/content/en/reference/cli/dapr-list.md
View File

@ -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
| --- | --- | --- | --- |
| 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`
| `--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
```

28
daprdocs/content/en/reference/cli/dapr-logs.md
View File

@ -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
```

24
daprdocs/content/en/reference/cli/dapr-mtls/_index.md
View File

@ -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
| --- | --- | --- | --- |
| 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
```

17
daprdocs/content/en/reference/cli/dapr-mtls/dapr-mtls-expiry.md
View File

@ -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
| --- | --- | --- | --- |
| 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
```

17
daprdocs/content/en/reference/cli/dapr-mtls/dapr-mtls-export.md
View File

@ -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
| --- | --- | --- | --- |
| 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
```

20
daprdocs/content/en/reference/cli/dapr-publish.md
View File

@ -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
| 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"}'
```

58
daprdocs/content/en/reference/cli/dapr-run.md
View File

@ -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 |
| 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` | | | The port your application is listening on
| `--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
| `--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
| `--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` |
| `--placement-host-address` | `DAPR_PLACEMENT_HOST` | `localhost` | The address of the placement service. Format is either `<hostname>` for default port (`6050` on Windows, `50005` on Linux/MacOS) or `<hostname>:<port>` for custom port |
| `--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.|
| `--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
```

16
daprdocs/content/en/reference/cli/dapr-status.md
View File

@ -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
| --- | --- | --- | --- |
| 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
```

18
daprdocs/content/en/reference/cli/dapr-stop.md
View File

@ -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 |
| 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 <ID>
```

24
daprdocs/content/en/reference/cli/dapr-uninstall.md
View File

@ -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
| --- | --- | --- | --- |
| 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 |
## 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
```

27
daprdocs/content/en/reference/cli/dapr-upgrade.md
View File

@ -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
| --- | --- | --- | --- |
| 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 >}})

2
daprdocs/content/en/reference/components-reference/supported-state-stores/setup-firestore.md
View File

@ -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" >}}

17
daprdocs/content/en/reference/environment/_index.md
View File

@ -9,11 +9,12 @@ 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 >}})
| -------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| 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 >}}) |

3
daprdocs/layouts/docs/list.html
View File

@ -1,7 +1,6 @@
{{ define "main" }}
<div class="td-content">
<h1>{{ .Title }}</h1>
{{ with .Params.description }}<div class="lead">{{ . | markdownify }}</div>{{ end }}
<h1>{{ .LinkTitle }}</h1>
{{ if (and (not .Params.hide_readingtime) (.Site.Params.ui.readingtime.enable)) }}
{{ partial "reading-time.html" . }}
{{ end }}