mirror of https://github.com/dapr/docs.git
Merge branch 'v1.12' into otel_override_service_name
This commit is contained in:
Whit Waldo
GitHub
commit
836906d12c
|
|
@ -1,109 +0,0 @@
|
|||
name: Azure Static Web App Root
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
push:
|
||||
branches:
|
||||
- v1.12
|
||||
pull_request:
|
||||
types: [opened, synchronize, reopened, closed]
|
||||
branches:
|
||||
- v1.12
|
||||
|
||||
concurrency:
|
||||
# Cancel the previously triggered build for only PR build.
|
||||
group: website-${{ github.event.pull_request.number || github.sha }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
build_and_deploy_job:
|
||||
name: Build Hugo Website
|
||||
if: github.event.action != 'closed'
|
||||
runs-on: ubuntu-latest
|
||||
env:
|
||||
SWA_BASE: 'proud-bay-0e9e0e81e'
|
||||
HUGO_ENV: production
|
||||
steps:
|
||||
- name: Checkout docs repo
|
||||
uses: actions/checkout@v3
|
||||
with:
|
||||
submodules: true
|
||||
- name: Setup Node
|
||||
uses: actions/setup-node@v2
|
||||
with:
|
||||
node-version: '14'
|
||||
- name: Setup Hugo
|
||||
uses: peaceiris/actions-hugo@v2.5.0
|
||||
with:
|
||||
hugo-version: 0.102.3
|
||||
extended: true
|
||||
- name: Setup Docsy
|
||||
run: |
|
||||
cd daprdocs
|
||||
git submodule update --init --recursive
|
||||
sudo npm install -D --save autoprefixer
|
||||
sudo npm install -D --save postcss-cli
|
||||
- name: Build Hugo Website
|
||||
run: |
|
||||
cd daprdocs
|
||||
git config --global --add safe.directory /github/workspace
|
||||
if [ $GITHUB_EVENT_NAME == 'pull_request' ]; then
|
||||
STAGING_URL="https://${SWA_BASE}-${{github.event.number}}.westus2.azurestaticapps.net/"
|
||||
fi
|
||||
hugo ${STAGING_URL+-b "$STAGING_URL"}
|
||||
- name: Deploy docs site
|
||||
uses: Azure/static-web-apps-deploy@v1
|
||||
with:
|
||||
azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN_PROUD_BAY_0E9E0E81E }}
|
||||
repo_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
action: "upload"
|
||||
app_location: "daprdocs/public/"
|
||||
api_location: "daprdocs/public/"
|
||||
output_location: ""
|
||||
skip_app_build: true
|
||||
skip_deploy_on_missing_secrets: true
|
||||
- name: Upload Hugo artifacts
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: hugo_build
|
||||
path: ./daprdocs/public/
|
||||
if-no-files-found: error
|
||||
|
||||
close_staging_site:
|
||||
if: github.event_name == 'pull_request' && github.event.action == 'closed'
|
||||
runs-on: ubuntu-latest
|
||||
name: Close Pull Request Job
|
||||
steps:
|
||||
- name: Close Pull Request
|
||||
id: closepullrequest
|
||||
uses: Azure/static-web-apps-deploy@v1
|
||||
with:
|
||||
azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN_PROUD_BAY_0E9E0E81E }}
|
||||
action: "close"
|
||||
skip_deploy_on_missing_secrets: true
|
||||
|
||||
algolia_index:
|
||||
name: Index site for Algolia
|
||||
if: github.event_name == 'push'
|
||||
needs: ['build_and_deploy_job']
|
||||
runs-on: ubuntu-latest
|
||||
env:
|
||||
ALGOLIA_APP_ID: ${{ secrets.ALGOLIA_APP_ID }}
|
||||
ALGOLIA_API_WRITE_KEY: ${{ secrets.ALGOLIA_API_WRITE_KEY }}
|
||||
ALGOLIA_INDEX_NAME: daprdocs
|
||||
steps:
|
||||
- name: Checkout docs repo
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
submodules: false
|
||||
- name: Download Hugo artifacts
|
||||
uses: actions/download-artifact@v3
|
||||
with:
|
||||
name: hugo_build
|
||||
path: site/
|
||||
- name: Install Python packages
|
||||
run: |
|
||||
pip install --upgrade bs4
|
||||
pip install --upgrade 'algoliasearch>=2.0,<3.0'
|
||||
- name: Index site
|
||||
run: python ./.github/scripts/algolia.py ./site
|
||||
|
|
@ -14,8 +14,8 @@ The following branches are currently maintained:
|
|||
|
||||
| Branch | Website | Description |
|
||||
| ------------------------------------------------------------ | -------------------------- | ------------------------------------------------------------------------------------------------ |
|
||||
| [v1.12](https://github.com/dapr/docs) (primary) | https://docs.dapr.io | Latest Dapr release documentation. Typo fixes, clarifications, and most documentation goes here. |
|
||||
| [v1.13](https://github.com/dapr/docs/tree/v1.13) (pre-release) | https://v1-13.docs.dapr.io/ | Pre-release documentation. Doc updates that are only applicable to v1.13+ go here. |
|
||||
| [v1.13](https://github.com/dapr/docs) (primary) | https://docs.dapr.io | Latest Dapr release documentation. Typo fixes, clarifications, and most documentation goes here. |
|
||||
| [v1.14](https://github.com/dapr/docs/tree/v1.14) (pre-release) | https://v1-14.docs.dapr.io/ | Pre-release documentation. Doc updates that are only applicable to v1.14+ go here. |
|
||||
|
||||
For more information visit the [Dapr branch structure](https://docs.dapr.io/contributing/docs-contrib/contributing-docs/#branch-guidance) document.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
# Site Configuration
|
||||
baseURL = "https://docs.dapr.io"
|
||||
baseURL = "https://v1-12.docs.dapr.io"
|
||||
title = "Dapr Docs"
|
||||
theme = "docsy"
|
||||
disableFastRender = true
|
||||
|
|
@ -183,17 +183,20 @@ github_subdir = "daprdocs"
|
|||
github_branch = "v1.12"
|
||||
|
||||
# Versioning
|
||||
version_menu = "v1.12 (latest)"
|
||||
version_menu = "v1.12"
|
||||
version = "v1.12"
|
||||
archived_version = false
|
||||
archived_version = true
|
||||
url_latest_version = "https://docs.dapr.io"
|
||||
|
||||
[[params.versions]]
|
||||
version = "v1.13 (preview)"
|
||||
url = "https://v1-13.docs.dapr.io"
|
||||
version = "v1.14 (preview)"
|
||||
url = "https://v1-14.docs.dapr.io"
|
||||
[[params.versions]]
|
||||
version = "v1.12 (latest)"
|
||||
version = "v1.13 (latest)"
|
||||
url = "#"
|
||||
[[params.versions]]
|
||||
version = "v1.12"
|
||||
url = "https://v1-12.docs.dapr.io"
|
||||
[[params.versions]]
|
||||
version = "v1.11"
|
||||
url = "https://v1-11.docs.dapr.io"
|
||||
|
|
|
|||
|
|
@ -3,10 +3,11 @@ type: docs
|
|||
title: "Use the Dapr API"
|
||||
linkTitle: "Use the Dapr API"
|
||||
weight: 30
|
||||
description: "Run a Dapr sidecar and try out the state API"
|
||||
description: "Run a Dapr sidecar and try out the state management API"
|
||||
---
|
||||
|
||||
In this guide, you'll simulate an application by running the sidecar and calling the API directly. After running Dapr using the Dapr CLI, you'll:
|
||||
In this guide, you'll simulate an application by running the sidecar and calling the state management API directly.
|
||||
After running Dapr using the Dapr CLI, you'll:
|
||||
|
||||
- Save a state object.
|
||||
- Read/get the state object.
|
||||
|
|
@ -21,7 +22,8 @@ In this guide, you'll simulate an application by running the sidecar and calling
|
|||
|
||||
### Step 1: Run the Dapr sidecar
|
||||
|
||||
The [`dapr run`]({{< ref dapr-run.md >}}) command launches an application, together with a sidecar.
|
||||
The [`dapr run`]({{< ref dapr-run.md >}}) command normally runs your application and a Dapr sidecar. In this case,
|
||||
it only runs the sidecar since you are interacting with the state management API directly.
|
||||
|
||||
Launch a Dapr sidecar that will listen on port 3500 for a blank application named `myapp`:
|
||||
|
||||
|
|
|
|||
|
|
@ -15,6 +15,11 @@ You'll use the Dapr CLI as the main tool for various Dapr-related tasks. You can
|
|||
|
||||
The Dapr CLI works with both [self-hosted]({{< ref self-hosted >}}) and [Kubernetes]({{< ref Kubernetes >}}) environments.
|
||||
|
||||
{{% alert title="Before you begin" color="primary" %}}
|
||||
In Docker Desktop's advanced options, verify you've allowed the default Docker socket to be used.
|
||||
<img src="/images/docker-desktop-setting.png" width=800 style="padding-bottom:15px;">
|
||||
{{% /alert %}}
|
||||
|
||||
### Step 1: Install the Dapr CLI
|
||||
|
||||
{{< tabs Linux Windows MacOS Binaries>}}
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ To initialize Dapr in your local or remote **Kubernetes** cluster for developmen
|
|||
{{% /alert %}}
|
||||
|
||||
{{% alert title="Docker" color="primary" %}}
|
||||
The recommended development environment requires [Docker](https://docs.docker.com/install/). While you can [initialize Dapr without a dependency on Docker]({{< ref self-hosted-no-docker.md >}})), the next steps in this guide assume the recommended Docker development environment.
|
||||
The recommended development environment requires [Docker](https://docs.docker.com/install/). While you can [initialize Dapr without a dependency on Docker]({{< ref self-hosted-no-docker.md >}}), the next steps in this guide assume the recommended Docker development environment.
|
||||
|
||||
You can also install [Podman](https://podman.io/) in place of Docker. Read more about [initializing Dapr using Podman]({{< ref dapr-init.md >}}).
|
||||
{{% /alert %}}
|
||||
|
|
@ -70,7 +70,7 @@ dapr init
|
|||
|
||||
**If you are installing on Mac OS Silicon with Docker,** you may need to perform the following workaround to enable `dapr init` to talk to Docker without using Kubernetes.
|
||||
1. Navigate to **Docker Desktop** > **Settings** > **Advanced**.
|
||||
1. Select the **Enable default Docker socket** checkbox.
|
||||
1. Select the **Allow the default Docker socket to be used (requires password)** checkbox.
|
||||
|
||||
{{% /codetab %}}
|
||||
|
||||
|
|
@ -86,6 +86,7 @@ dapr init
|
|||
|
||||
{{< /tabs >}}
|
||||
|
||||
[See the troubleshooting guide if you encounter any error messages regarding Docker not being installed or running.]({{< ref "common_issues.md#dapr-cant-connect-to-docker-when-installing-the-dapr-cli" >}})
|
||||
|
||||
### Step 3: Verify Dapr version
|
||||
|
||||
|
|
|
|||
|
|
@ -88,7 +88,11 @@ kubectl rollout restart deployment/<deployment-name> --namespace <namespace-name
|
|||
|
||||
## Adding API token to client API invocations
|
||||
|
||||
Once token authentication is configured in Dapr, all clients invoking Dapr API will have to append the API token token to every request:
|
||||
Once token authentication is configured in Dapr, all clients invoking Dapr API need to append the `dapr-api-token` token to every request.
|
||||
|
||||
> **Note:** The Dapr SDKs read the [DAPR_API_TOKEN]({{< ref environment >}}) environment variable and set it for you by default.
|
||||
|
||||
<img src="/images/tokens-auth.png" width=800 style="padding-bottom:15px;">
|
||||
|
||||
### HTTP
|
||||
|
||||
|
|
|
|||
|
|
@ -89,11 +89,13 @@ kubectl rollout restart deployment/<deployment-name> --namespace <namespace-name
|
|||
|
||||
## Authenticating requests from Dapr
|
||||
|
||||
Once app token authentication is configured in Dapr, all requests *coming from Dapr* include the token.
|
||||
Once app token authentication is configured using the environment variable or Kubernetes secret `app-api-token`, the Dapr sidecar always includes the HTTP header/gRPC metadata `dapr-api-token: <token>` in the calls to the app. From the app side, ensure you are authenticating using the `dapr-api-token` value which uses the `app-api-token` you set to authenticate requests from Dapr.
|
||||
|
||||
<img src="/images/tokens-auth.png" width=800 style="padding-bottom:15px;">
|
||||
|
||||
### HTTP
|
||||
|
||||
In case of HTTP, in your code look for the HTTP header `dapr-api-token` in incoming requests:
|
||||
In your code, look for the HTTP header `dapr-api-token` in incoming requests:
|
||||
|
||||
```text
|
||||
dapr-api-token: <token>
|
||||
|
|
|
|||
|
|
@ -6,6 +6,24 @@ weight: 1000
|
|||
description: "Common issues and problems faced when running Dapr applications"
|
||||
---
|
||||
|
||||
This guide covers common issues you may encounter while installing and running Dapr.
|
||||
|
||||
## Dapr can't connect to Docker when installing the Dapr CLI
|
||||
|
||||
When installing and initializing the Dapr CLI, if you see the following error message after running `dapr init`:
|
||||
|
||||
```bash
|
||||
⌛ Making the jump to hyperspace...
|
||||
❌ could not connect to docker. docker may not be installed or running
|
||||
```
|
||||
|
||||
Troubleshoot the error by ensuring:
|
||||
|
||||
1. [The correct containers are running.]({{< ref "install-dapr-selfhost.md#step-4-verify-containers-are-running" >}})
|
||||
1. In Docker Desktop, verify the **Allow the default Docker socket to be used (requires password)** option is selected.
|
||||
|
||||
<img src="/images/docker-desktop-setting.png" width=800 style="padding-bottom:15px;">
|
||||
|
||||
## I don't see the Dapr sidecar injected to my pod
|
||||
|
||||
There could be several reasons to why a sidecar will not be injected into a pod.
|
||||
|
|
|
|||
|
|
@ -43,8 +43,8 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
| 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"`
|
||||
| processingTimeout | N | The amount time a message must be pending before attempting to redeliver it. Defaults to `"15s"`. `"0"` disables redelivery. | `"30s"`
|
||||
| redeliverInterval | N | The interval between checking for pending messages to redeliver. Can use either be Go duration string (for example "ms", "s", "m") or milliseconds number. Defaults to `"60s"`. `"0"` disables redelivery. | `"30s"`, `"5000"`
|
||||
| processingTimeout | N | The amount time that a message must be pending before attempting to redeliver it. Can use either be Go duration string ( for example "ms", "s", "m") or milliseconds number. Defaults to `"15s"`. `"0"` disables redelivery. | `"60s"`, `"600000"`
|
||||
| queueDepth | N | The size of the message queue for processing. Defaults to `"100"`. | `"1000"`
|
||||
| concurrency | N | The number of concurrent workers that are processing messages. Defaults to `"10"`. | `"15"`
|
||||
| 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"`
|
||||
|
|
|
|||
Binary file not shown.
|
After Width: | Height: | Size: 255 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 24 KiB |
Binary file not shown.
Loading…
Reference in New Issue