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

Merge branch 'v1.5' of https://github.com/msfussell/docs into v1.5

This commit is contained in:
Mark Fussell 2021-11-16 00:25:19 -08:00
parent 5487aa9b54 4932699b73
commit 153a3c54e5
12 changed files with 44 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/workflows/website-root.yml vendored
View File

@ -3,11 +3,11 @@ name: Azure Static Web App Root
on: on:
push: push:
branches: branches:
- v1.4 - v1.5
pull_request: pull_request:
types: [opened, synchronize, reopened, closed] types: [opened, synchronize, reopened, closed]
branches: branches:
- v1.4 - v1.5
jobs: jobs:
build_and_deploy_job: build_and_deploy_job:

2
.github/workflows/website-v1-5.yml vendored
View File

@ -1,4 +1,4 @@
name: Azure Static Web App v1.4 name: Azure Static Web App v1.5
on: on:
push: push:

4
README.md
View File

@ -14,8 +14,8 @@ The following branches are currently maintained:
| Branch | Website | Description | | 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) (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.6](https://github.com/dapr/docs/tree/v1.6) (pre-release) | https://v1-6.docs.dapr.io/ | Pre-release documentation. Doc updates that are only applicable to v1.6+ go here. |
For more information visit the [Dapr branch structure](https://docs.dapr.io/contributing/contributing-docs/#branch-guidance) document. For more information visit the [Dapr branch structure](https://docs.dapr.io/contributing/contributing-docs/#branch-guidance) document.

13
daprdocs/config.toml
View File

@ -1,5 +1,5 @@
# Site Configuration # Site Configuration
baseURL = "https://v1-5.docs.dapr.io/" baseURL = "https://docs.dapr.io/"
title = "Dapr Docs" title = "Dapr Docs"
theme = "docsy" theme = "docsy"
disableFastRender = true disableFastRender = true
@ -160,17 +160,20 @@ github_subdir = "daprdocs"
github_branch = "v1.5" github_branch = "v1.5"
# Versioning # Versioning
version_menu = "v1.5 (preview)" version_menu = "v1.5 (latest)"
version = "v1.5" version = "v1.5"
archived_version = false archived_version = false
url_latest_version = "https://docs.dapr.io" url_latest_version = "https://docs.dapr.io"
[[params.versions]] [[params.versions]]
version = "v1.5 (preview)" version = "v1.6 (preview)"
url = "https://v1-6.docs.dapr.io"
[[params.versions]]
version = "v1.5 (latest)"
url = "#" url = "#"
[[params.versions]] [[params.versions]]
version = "v1.4 (latest)" version = "v1.4"
url = "https://docs.dapr.io" url = "https://v1-4.docs.dapr.io"
[[params.versions]] [[params.versions]]
version = "v1.3" version = "v1.3"
url = "https://v1-3.docs.dapr.io" url = "https://v1-3.docs.dapr.io"

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

@ -2,23 +2,6 @@
type: docs type: docs
no_list: true no_list: true
--- ---
<div class="card-deck">
<div class="card">
<div class="card-body">
<h5 class="card-title">
<img src="/images/daprcon.png" alt="DaprCon logo" width=40>
<b> Watch DaprCon sessions on-demand!</b>
</h5>
<p class="card-text">
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/21/thanks-for-a-great-first-daprcon/" class="stretched-link"></a>
</div>
</div>
</div>
<br></br>
# <img src="/images/home-title.png" alt="Dapr Docs" width=400> # <img src="/images/home-title.png" alt="Dapr Docs" width=400>
Welcome to the Dapr documentation site! Welcome to the Dapr documentation site!

2
daprdocs/content/en/developing-applications/building-blocks/configuration/howto-manage-configuration.md
View File

@ -46,7 +46,7 @@ metadata:
spec: spec:
type: configuration.redis type: configuration.redis
metadata: metadata:
- name: host - name: redisHost
value: localhost:6379 value: localhost:6379
- name: redisPassword - name: redisPassword
value: <PASSWORD> value: <PASSWORD>

13
daprdocs/content/en/getting-started/install-dapr-cli.md
View File

@ -48,6 +48,11 @@ This command installs the latest darwin Dapr CLI to `/usr/local/bin`:
```bash ```bash
curl -fsSL https://raw.githubusercontent.com/dapr/cli/master/install/install.sh | /bin/bash curl -fsSL https://raw.githubusercontent.com/dapr/cli/master/install/install.sh | /bin/bash
``` ```
#### Note for ARM64 Macs
Support for ARM64 Macs is available as a Preview feature. When installing from the terminal, native ARM64 binaries are downloaded when available. For older releases, AMD64 binaries are downloaded, which must be run with Rosetta2 emulation enabled. To install Rosetta emulation:
```bash
softwareupdate --install-rosetta
```
### Install from Homebrew ### Install from Homebrew
You can install via [Homebrew](https://brew.sh): You can install via [Homebrew](https://brew.sh):
@ -55,11 +60,11 @@ You can install via [Homebrew](https://brew.sh):
brew install dapr/tap/dapr-cli brew install dapr/tap/dapr-cli
``` ```
#### Note for M1 Macs #### Note for ARM64 Macs
For M1 Macs, homebrew is not supported. You will need to use the dapr install script and have the rosetta amd64 compatibility layer installed. If you do not have it installed already, you can run the following: For ARM64 Macs, only Homebrew 3.0 and higher versions are supported. Please update Homebrew to 3.0.0 or higher and then run the command below:
```bash ```bash
softwareupdate --install-rosetta arch -arm64 brew install dapr/tap/dapr-cli
``` ```
### Install without `sudo` ### Install without `sudo`
@ -132,4 +137,4 @@ Flags:
Use "dapr [command] --help" for more information about a command. Use "dapr [command] --help" for more information about a command.
``` ```
{{< button text="Next step: Initialize Dapr >>" page="install-dapr-selfhost" >}} {{< button text="Next step: Initialize Dapr >>" page="install-dapr-selfhost" >}}

1
daprdocs/content/en/operations/support/support-preview-features.md
View File

@ -16,3 +16,4 @@ Preview features in Dapr are considered experimental when they are first release
| **gRPC proxying** | Enables calling endpoints using service invocation on gRPC services through Dapr via gRPC proxying, without requiring the use of Dapr SDKs. | `proxy.grpc` | [How-To: Invoke services using gRPC]({{<ref howto-invoke-services-grpc>}}) | | **gRPC proxying** | Enables calling endpoints using service invocation on gRPC services through Dapr via gRPC proxying, without requiring the use of Dapr SDKs. | `proxy.grpc` | [How-To: Invoke services using gRPC]({{<ref howto-invoke-services-grpc>}}) |
| **State store encryption** | Enables automatic client side encryption for state stores | `State.Encryption` | [How-To: Encrypt application state]({{<ref howto-encrypt-state>}}) | | **State store encryption** | Enables automatic client side encryption for state stores | `State.Encryption` | [How-To: Encrypt application state]({{<ref howto-encrypt-state>}}) |
| **Pub/Sub routing** | Allow the use of expressions to route cloud events to different URIs/paths and event handlers in your application. | `PubSub.Routing` | [How-To: Publish a message and subscribe to a topic]({{<ref howto-route-messages>}}) | | **Pub/Sub routing** | Allow the use of expressions to route cloud events to different URIs/paths and event handlers in your application. | `PubSub.Routing` | [How-To: Publish a message and subscribe to a topic]({{<ref howto-route-messages>}}) |
| **ARM64 Mac Support** | Dapr CLI, sidecar, and Dashboard are now natively compiled for ARM64 Macs, along with Dapr CLI installation via Homebrew. | N/A | [Install the Dapr CLI]({{<ref install-dapr-cli>}}) |

22
daprdocs/content/en/operations/support/support-release-policy.md
View File

@ -39,13 +39,14 @@ The table below shows the versions of Dapr releases that have been tested togeth
| May 26th 2021 | 1.2.0</br> | 1.2.0 | Java 1.1.0 </br>Go 1.1.0 </br>PHP 1.1.0 </br>Python 1.1.0 </br>.NET 1.2.0 | 0.6.0 | Unsupported | | May 26th 2021 | 1.2.0</br> | 1.2.0 | Java 1.1.0 </br>Go 1.1.0 </br>PHP 1.1.0 </br>Python 1.1.0 </br>.NET 1.2.0 | 0.6.0 | Unsupported |
| Jun 16th 2021 | 1.2.1</br> | 1.2.0 | Java 1.1.0 </br>Go 1.1.0 </br>PHP 1.1.0 </br>Python 1.1.0 </br>.NET 1.2.0 | 0.6.0 | Unsupported | | Jun 16th 2021 | 1.2.1</br> | 1.2.0 | Java 1.1.0 </br>Go 1.1.0 </br>PHP 1.1.0 </br>Python 1.1.0 </br>.NET 1.2.0 | 0.6.0 | Unsupported |
| Jun 16th 2021 | 1.2.2</br> | 1.2.0 | Java 1.1.0 </br>Go 1.1.0 </br>PHP 1.1.0 </br>Python 1.1.0 </br>.NET 1.2.0 | 0.6.0 | Unsupported | | Jun 16th 2021 | 1.2.2</br> | 1.2.0 | Java 1.1.0 </br>Go 1.1.0 </br>PHP 1.1.0 </br>Python 1.1.0 </br>.NET 1.2.0 | 0.6.0 | Unsupported |
| Jul 26th 2021 | 1.3</br> | 1.3.0 | Java 1.2.0 </br>Go 1.2.0 </br>PHP 1.1.0 </br>Python 1.2.0 </br>.NET 1.3.0 | 0.7.0 | Supported | | Jul 26th 2021 | 1.3</br> | 1.3.0 | Java 1.2.0 </br>Go 1.2.0 </br>PHP 1.1.0 </br>Python 1.2.0 </br>.NET 1.3.0 | 0.7.0 | Unsupported |
| Sep 14th 2021 | 1.3.1</br> | 1.3.0 | Java 1.2.0 </br>Go 1.2.0 </br>PHP 1.1.0 </br>Python 1.2.0 </br>.NET 1.3.0 | 0.7.0 | Supported | | Sep 14th 2021 | 1.3.1</br> | 1.3.0 | Java 1.2.0 </br>Go 1.2.0 </br>PHP 1.1.0 </br>Python 1.2.0 </br>.NET 1.3.0 | 0.7.0 | Unsupported |
| Sep 15th 2021 | 1.4</br> | 1.4.0 | Java 1.3.0 </br>Go 1.3.0 </br>PHP 1.2.0 </br>Python 1.3.0 </br>.NET 1.4.0 | 0.8.0 | Supported | | Sep 15th 2021 | 1.4</br> | 1.4.0 | Java 1.3.0 </br>Go 1.2.0 </br>PHP 1.1.0 </br>Python 1.3.0 </br>.NET 1.4.0 | 0.8.0 | Supported |
| Sep 22nd 2021 | 1.4.1</br> | 1.4.0 | Java 1.3.0 </br>Go 1.3.0 </br>PHP 1.2.0 </br>Python 1.3.0 </br>.NET 1.4.0 | 0.8.0 | Supported | Sep 22nd 2021 | 1.4.1</br> | 1.4.0 | Java 1.3.0 </br>Go 1.2.0 </br>PHP 1.1.0 </br>Python 1.3.0 </br>.NET 1.4.0 | 0.8.0 | Supported
| Sep 24th 2021 | 1.4.2</br> | 1.4.0 | Java 1.3.0 </br>Go 1.3.0 </br>PHP 1.2.0 </br>Python 1.3.0 </br>.NET 1.4.0 | 0.8.0 | Supported | | Sep 24th 2021 | 1.4.2</br> | 1.4.0 | Java 1.3.0 </br>Go 1.2.0 </br>PHP 1.1.0 </br>Python 1.3.0 </br>.NET 1.4.0 | 0.8.0 | Supported |
| Oct 7th 2021 | 1.4.3</br> | 1.4.0 | Java 1.3.0 </br>Go 1.3.0 </br>PHP 1.2.0 </br>Python 1.3.0 </br>.NET 1.4.0 | 0.8.0 | Supported (current) | | Oct 7th 2021 | 1.4.3</br> | 1.4.0 | Java 1.3.0 </br>Go 1.2.0 </br>PHP 1.1.0 </br>Python 1.3.0 </br>.NET 1.4.0 | 0.8.0 | Supported |
| Nov 11th 2021 | 1.5.0</br> | 1.5.0 | Java 1.3.0 </br>Go 1.3.0 </br>PHP 1.1.0 </br>Python 1.4.0 </br>.NET 1.5.0 </br>JS 1.0.2 | 0.9.0 | Supported (current) |
## Upgrade paths ## 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 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
@ -59,15 +60,22 @@ General guidance on upgrading can be found for [self hosted mode]({{<ref self-ho
| | 1.1.2 | 1.2.2 | | | 1.1.2 | 1.2.2 |
| | 1.2.2 | 1.3.1 | | | 1.2.2 | 1.3.1 |
| | 1.3.1 | 1.4.3 | | | 1.3.1 | 1.4.3 |
| | 1.4.3 | 1.5.0 |
| 1.1.0 to 1.1.2 | N/A | 1.2.2 | | 1.1.0 to 1.1.2 | N/A | 1.2.2 |
| | 1.2.2 | 1.3.1 | | | 1.2.2 | 1.3.1 |
| | 1.3.1 | 1.4.3 | | | 1.3.1 | 1.4.3 |
| | 1.4.3 | 1.5.0 |
| 1.2.0 to 1.2.2 | N/A | 1.3.1 | | 1.2.0 to 1.2.2 | N/A | 1.3.1 |
| | 1.3.1 | 1.4.3 | | | 1.3.1 | 1.4.3 |
| | 1.4.3 | 1.5.0 |
| 1.3.0 | N/A | 1.3.1 | | 1.3.0 | N/A | 1.3.1 |
| | 1.3.1 | 1.4.3 | | | 1.3.1 | 1.4.3 |
| | 1.4.3 | 1.5.0 |
| 1.3.1 | N/A | 1.4.3 | | 1.3.1 | N/A | 1.4.3 |
| | 1.4.3 | 1.5.0 |
| 1.4.0 to 1.4.2 | N/A | 1.4.3 | | 1.4.0 to 1.4.2 | N/A | 1.4.3 |
| | 1.4.3 | 1.5.0 |
| 1.4.3 | N/A | 1.5.0 |
## Feature and deprecations ## Feature and deprecations
There is a process for announcing feature deprecations. Deprecations are applied two (2) releases after the release in which they were announced. For example Feature X is announced to be deprecated in the 1.0.0 release notes and will then be removed in 1.2.0. There is a process for announcing feature deprecations. Deprecations are applied two (2) releases after the release in which they were announced. For example Feature X is announced to be deprecated in the 1.0.0 release notes and will then be removed in 1.2.0.

6
daprdocs/content/en/reference/api/state_api.md
View File

@ -303,7 +303,7 @@ This API is in alpha stage.
### HTTP Request ### HTTP Request
``` ```
POST/PUT http://localhost:<daprPort>/v1.0-alpha/state/<storename>/query POST/PUT http://localhost:<daprPort>/v1.0-alpha1/state/<storename>/query
``` ```
#### URL Parameters #### URL Parameters
@ -330,7 +330,7 @@ An array of JSON-encoded values
### Example ### Example
```shell ```shell
curl http://localhost:3500/v1.0-alpha/state/myStore/query \ curl http://localhost:3500/v1.0-alpha1/state/myStore/query \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \
-d '{ -d '{
"query": { "query": {
@ -415,7 +415,7 @@ curl http://localhost:3500/v1.0-alpha/state/myStore/query \
To pass metadata as query parammeter: To pass metadata as query parammeter:
``` ```
POST http://localhost:3500/v1.0-alpha/state/myStore/query?metadata.partitionKey=mypartitionKey POST http://localhost:3500/v1.0-alpha1/state/myStore/query?metadata.partitionKey=mypartitionKey
``` ```
## State transactions ## State transactions

2
daprdocs/content/en/reference/components-reference/supported-bindings/_index.md
View File

@ -50,7 +50,7 @@ Table captions:
|------|:----------------:|:-----------------:|--------| ------ |----------| |------|:----------------:|:-----------------:|--------| ------ |----------|
| [Alibaba Cloud DingTalk]({{< ref alicloud-dingtalk.md >}}) | ✅ | ✅ | Alpha | v1 | 1.2 | | [Alibaba Cloud DingTalk]({{< ref alicloud-dingtalk.md >}}) | ✅ | ✅ | Alpha | v1 | 1.2 |
| [Alibaba Cloud OSS]({{< ref alicloudoss.md >}}) | | ✅ | Alpha | v1 | 1.0 | | [Alibaba Cloud OSS]({{< ref alicloudoss.md >}}) | | ✅ | Alpha | v1 | 1.0 |
| [Alibaba Cloud Tablestore]({{< ref alicloudtablestore.md >}}) | | ✅ | Alpha | v1 | 1.4 | | [Alibaba Cloud Tablestore]({{< ref alicloudtablestore.md >}}) | | ✅ | Alpha | v1 | 1.5 |
### Amazon Web Services (AWS) ### Amazon Web Services (AWS)

2
daprdocs/layouts/shortcodes/dapr-latest-version.html
View File

@ -1 +1 @@
{{- if .Get "short" }}1.4{{ else if .Get "long" }}1.4.3{{ else if .Get "cli" }}1.4.0{{ else }}1.4.3{{ end -}} {{- if .Get "short" }}1.5{{ else if .Get "long" }}1.5.0{{ else if .Get "cli" }}1.5.0{{ else }}1.5.0{{ end -}}