From 3e0f702fa2d2af8918cce4c265561abbdf73e26c Mon Sep 17 00:00:00 2001 From: Bernd Verst Date: Wed, 26 May 2021 18:59:40 -0700 Subject: [PATCH 1/8] Supported Release Info and Upgrade Path for v1.2 (#1494) * Supported Release Info and Upgrade Path for v1.2 * Update support-release-policy.md * Update daprdocs/content/en/operations/support/support-release-policy.md Co-authored-by: Aaron Crawfis --- .../operations/support/support-release-policy.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/daprdocs/content/en/operations/support/support-release-policy.md b/daprdocs/content/en/operations/support/support-release-policy.md index 9c3e689ecfa..20594c89dd3 100644 --- a/daprdocs/content/en/operations/support/support-release-policy.md +++ b/daprdocs/content/en/operations/support/support-release-policy.md @@ -31,11 +31,12 @@ The table below shows the versions of Dapr releases that have been tested togeth | Release date | Runtime | CLI | SDKs | Dashboard | Status | |--------------------|:--------:|:--------|---------|---------|---------| -| Feb 17th 2021 | 1.0.0
| 1.0.0 | Java 1.0.0
Go 1.0.0
PHP 1.0.0
Python 1.0.0
.NET 1.0.0 | 0.6.0 | Supported | -| Mar 4th 2021 | 1.0.1
| 1.0.1 | Java 1.0.2
Go 1.0.0
PHP 1.0.0
Python 1.0.0
.NET 1.0.0 | 0.6.0 | Supported | +| Feb 17th 2021 | 1.0.0
| 1.0.0 | Java 1.0.0
Go 1.0.0
PHP 1.0.0
Python 1.0.0
.NET 1.0.0 | 0.6.0 | Unsupported | +| Mar 4th 2021 | 1.0.1
| 1.0.1 | Java 1.0.2
Go 1.0.0
PHP 1.0.0
Python 1.0.0
.NET 1.0.0 | 0.6.0 | Unsupported | | Apr 1st 2021 | 1.1.0
| 1.1.0 | Java 1.0.2
Go 1.1.0
PHP 1.0.0
Python 1.1.0
.NET 1.1.0 | 0.6.0 | Supported | -| Apr 6th 2021 | 1.1.1
| 1.1.0 | Java 1.0.2
Go 1.1.0
PHP 1.0.0
Python 1.1.0
.NET 1.1.0 | 0.6.0 | Supported (current) | -| Apr 16th 2021 | 1.1.2
| 1.1.0 | Java 1.0.2
Go 1.1.0
PHP 1.0.0
Python 1.1.0
.NET 1.1.0 | 0.6.0 | Supported (current) | +| Apr 6th 2021 | 1.1.1
| 1.1.0 | Java 1.0.2
Go 1.1.0
PHP 1.0.0
Python 1.1.0
.NET 1.1.0 | 0.6.0 | Supported | +| Apr 16th 2021 | 1.1.2
| 1.1.0 | Java 1.0.2
Go 1.1.0
PHP 1.0.0
Python 1.1.0
.NET 1.1.0 | 0.6.0 | Supported | +| May 26th 2021 | 1.2.0
| 1.2.0 | Java 1.1.0
Go 1.1.0
PHP 1.1.0
Python 1.1.0
.NET 1.2.0 | 0.6.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 @@ -48,9 +49,11 @@ General guidance on upgrading can be found for [self hosted mode]({{ Date: Fri, 28 May 2021 10:12:24 -0700 Subject: [PATCH 2/8] Adding K8s versions table (#1521) * Adding table of kubernetes versions * Updating intro --- .../hosting/kubernetes/kubernetes-overview.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-overview.md b/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-overview.md index 781050e2625..d6e9cde72c9 100644 --- a/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-overview.md +++ b/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-overview.md @@ -8,7 +8,7 @@ description: "Overview of how to get Dapr running on your Kubernetes cluster" ## Dapr on Kubernetes -Dapr can be configured to run on any Kubernetes cluster. To achieve this, Dapr begins by deploying the `dapr-sidecar-injector`, `dapr-operator`, `dapr-placement`, and `dapr-sentry` Kubernetes services. These provide first-class integration to make running applications with Dapr easy. +Dapr can be configured to run on any supported versions of Kubernetes. To achieve this, Dapr begins by deploying the `dapr-sidecar-injector`, `dapr-operator`, `dapr-placement`, and `dapr-sentry` Kubernetes services. These provide first-class integration to make running applications with Dapr easy. - **dapr-operator:** Manages [component]({{< ref components >}}) updates and Kubernetes services endpoints for Dapr (state stores, pub/subs, etc.) - **dapr-sidecar-injector:** Injects Dapr into [annotated](#adding-dapr-to-a-kubernetes-deployment) deployment pods and adds the environment variables `DAPR_HTTP_PORT` and `DAPR_GRPC_PORT` to enable user-defined applications to easily communicate with Dapr without hard-coding Dapr port values. - **dapr-placement:** Used for [actors]({{< ref actors >}}) only. Creates mapping tables that map actor instances to pods @@ -36,6 +36,14 @@ Deploying and running a Dapr enabled application into your Kubernetes cluster is You can see some examples [here](https://github.com/dapr/quickstarts/tree/master/hello-kubernetes) in the Kubernetes getting started quickstart. +## Supported versions +Dapr is tested and supported on the following versions of Kubernetes. + +| Supported Kubernetes versions | +|-----------------------| +| 1.17.x and above | + + ## Related links - [Deploy Dapr to a Kubernetes cluster]({{< ref kubernetes-deploy >}}) From 6180edfc2f432fd303db5f0c72951d68ed784433 Mon Sep 17 00:00:00 2001 From: Zonciu Liang Date: Thu, 3 Jun 2021 08:24:29 +0800 Subject: [PATCH 3/8] Fix incorrect postgresql connection string example (#1524) Co-authored-by: Aaron Crawfis --- .../supported-state-stores/setup-postgresql.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-postgresql.md b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-postgresql.md index 8aefce32108..3d4a3c5c87d 100644 --- a/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-postgresql.md +++ b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-postgresql.md @@ -34,7 +34,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr | Field | Required | Details | Example | |--------------------|:--------:|---------|---------| -| connectionString | Y | The connection string for PostgreSQL | `"User ID=root;Password=myPassword;Host=localhost;Port=5432"` +| connectionString | Y | The connection string for PostgreSQL | `"host=localhost user=postgres password=example port=5432 connect_timeout=10 database=dapr_test"` | actorStateStore | N | Consider this state store for actors. Defaults to `"false"` | `"true"`, `"false"` From 8f8952372cce300b5d4f1b07ab7e002bb3e38f39 Mon Sep 17 00:00:00 2001 From: Simon Leet <31784195+CodeMonkeyLeet@users.noreply.github.com> Date: Wed, 2 Jun 2021 17:28:05 -0700 Subject: [PATCH 4/8] Update docs on using Codespaces with Dapr repos (#1522) * Update docs on using Codespaces with Dapr repos * Move codespaces.md under the Contributing topic * Update daprdocs/content/en/contributing/codespaces.md Co-authored-by: Aaron Crawfis --- .../content/en/contributing/codespaces.md | 53 +++++++++++++++++++ .../en/contributing/contributing-overview.md | 1 + .../ides/codespaces.md | 32 ----------- 3 files changed, 54 insertions(+), 32 deletions(-) create mode 100644 daprdocs/content/en/contributing/codespaces.md delete mode 100644 daprdocs/content/en/developing-applications/ides/codespaces.md diff --git a/daprdocs/content/en/contributing/codespaces.md b/daprdocs/content/en/contributing/codespaces.md new file mode 100644 index 00000000000..62585e50ff8 --- /dev/null +++ b/daprdocs/content/en/contributing/codespaces.md @@ -0,0 +1,53 @@ +--- +type: docs +title: "Contributing with GitHub Codespaces" +linkTitle: "GitHub Codespaces" +weight: 2500 +description: "How to work with Dapr repos in GitHub Codespaces" +aliases: + - "/developing-applications/ides/codespaces/" +--- + +[GitHub Codespaces](https://github.com/features/codespaces) are the easiest way to get up and running for contributing to a Dapr repo. In as little as a single click, you can have an environment with all of the prerequisites ready to go in your browser. + +{{% alert title="Private Beta" color="warning" %}} +GitHub Codespaces is currently in a private beta. Sign up [here](https://github.com/features/codespaces/signup). +{{% /alert %}} + +## Features + +- **Click and Run**: Get a dedicated and sandboxed environment with all of the required frameworks and packages ready to go. +- **Usage-based Billing**: Only pay for the time you spend developing in the Codespace. Environments are spun down automatically when not in use. +- **Portable**: Run in your browser or in Visual Studio Code + +## Open a Dapr repo in a Codespace + +To open a Dapr repository in a Codespace simply select "Code" from the repo homepage and "Open with Codespaces": + +Screenshot of creating a Dapr Codespace + +If you haven't already forked the repo, creating the Codespace will also create a fork for you and use it inside the Codespace. + +### Supported repos + +- [Dapr](https://github.com/dapr/dapr) +- [Components-contrib](https://github.com/dapr/components-contrib) +- [Python SDK](https://github.com/dapr/python-sdk) + +### Developing Dapr Components in a Codespace + +Developing a new Dapr component requires working with both the [components-contrib](https://github.com/dapr/components-contrib) and [dapr](https://github.com/dapr/dapr) repos together under the `$GOPATH` tree for testing purposes. To facilitate this, the `/go/src/github.com/dapr` folder in the components-contrib Codespace will already be set up with your fork of components-contrib, and a clone of the dapr repo as described in the [component development documentation](https://github.com/dapr/components-contrib/blob/master/docs/developing-component.md). A few things to note in this configuration: + +- The components-contrib and dapr repos only define Codespaces for the Linux amd64 environment at the moment. +- The `/go/src/github.com/dapr/components-contrib` folder is a soft link to Codespace's default `/workspace/components-contrib` folder, so changes in one will be automatically reflected in the other. +- Since the `/go/src/github.com/dapr/dapr` folder uses a clone of the official dapr repo rather than a fork, you will not be able to make a pull request from changes made in that folder directly. You can use the dapr Codespace separately for that PR, or if you would like to use the same Codespace for the dapr changes as well, you should remap the dapr repo origin to your fork in the components-contrib Codespace. For example, to use a dapr fork under `my-git-alias`: + +```bash +cd /go/src/github.com/dapr/dapr +git remote set-url origin https://github.com/my-git-alias/dapr +git fetch +git reset --hard +``` + +## Related links +- [GitHub documentation](https://docs.github.com/en/github/developing-online-with-codespaces/about-codespaces) diff --git a/daprdocs/content/en/contributing/contributing-overview.md b/daprdocs/content/en/contributing/contributing-overview.md index 0a042eb8397..6a8a404b300 100644 --- a/daprdocs/content/en/contributing/contributing-overview.md +++ b/daprdocs/content/en/contributing/contributing-overview.md @@ -49,6 +49,7 @@ All contributions come through pull requests. To submit a proposed change, follo 1. Make sure there's an issue (bug or proposal) raised, which sets the expectations for the contribution you are about to make. 1. Fork the relevant repo and create a new branch + - Some Dapr repos support [Codespaces]({{< ref codespaces.md >}}) to provide an instant environment for you to build and test your changes. 1. Create your change - Code changes require tests 1. Update relevant documentation for the change diff --git a/daprdocs/content/en/developing-applications/ides/codespaces.md b/daprdocs/content/en/developing-applications/ides/codespaces.md deleted file mode 100644 index af4de0e7d58..00000000000 --- a/daprdocs/content/en/developing-applications/ides/codespaces.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -type: docs -title: "Developing with GitHub Codespaces" -linkTitle: "GitHub Codespaces" -weight: 3000 -description: "How to get up and running with Dapr in a GitHub Codespace" ---- - -[GitHub Codespaces](https://github.com/features/codespaces) are the easiest way to get up and running in a Dapr environment. In as little as a single click you have the environment, packages, code, samples, and documentation all ready to go in your browser. - -{{% alert title="Private Beta" color="warning" %}} -GitHub Codespaces is currently in a private beta. Sign up [here](https://github.com/features/codespaces/signup). -{{% /alert %}} - -## Features - -- **Click and Run**: Get a dedicated and sandboxed environment with all of the required frameworks and packages ready to go. -- **Usage-based Billing**: Only pay for the time you spend developing in the Codespace. Environments are spun down automatically when not in use. -- **Portable**: Run in your browser or in Visual Studio Code - -## Open a Dapr repo in a Codespace - -To open a Dapr repository in a Codespace simply select "Code" from the repo homepage and "Open with Codespaces": - -Screenshot of creating a Dapr Codespace - -### Supported repos - -- [Python SDK](https://github.com/dapr/python-sdk) - -## Related links -- [GitHub documentation](https://docs.github.com/en/github/developing-online-with-codespaces/about-codespaces) \ No newline at end of file From e6b27718c18b92e8b4686f57630926b9ccb7871d Mon Sep 17 00:00:00 2001 From: Maarten Mulders Date: Thu, 3 Jun 2021 02:32:29 +0200 Subject: [PATCH 5/8] Fix two typos (#1526) Co-authored-by: Aaron Crawfis --- .../components-reference/supported-pubsub/setup-rabbitmq.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rabbitmq.md b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rabbitmq.md index 6342c3f0123..b16a9392e71 100644 --- a/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rabbitmq.md +++ b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rabbitmq.md @@ -48,11 +48,11 @@ The above example uses secrets as plain strings. It is recommended to use a secr |--------------------|:--------:|---------|---------| | host | Y | Connection-string for the rabbitmq host | `amqp://user:pass@localhost:5672` | durable | N | Whether or not to use [durable](https://www.rabbitmq.com/queues.html#durability) queues. Defaults to `"false"` | `"true"`, `"false"` -| deletedWhenUnused | N | Whether or not the queue sohuld be configured to [auto-delete](https://www.rabbitmq.com/queues.html) Defaults to `"true"` | `"true"`, `"false"` +| deletedWhenUnused | N | Whether or not the queue should be configured to [auto-delete](https://www.rabbitmq.com/queues.html) Defaults to `"true"` | `"true"`, `"false"` | autoAck | N | Whether or not the queue consumer should [auto-ack](https://www.rabbitmq.com/confirms.html) messages. Defaults to `"false"` | `"true"`, `"false"` | deliveryMode | N | Persistence mode when publishing messages. Defaults to `"0"`. RabbitMQ treats `"2"` as persistent, all other numbers as non-persistent | `"0"`, `"2"` | requeueInFailure | N | Whether or not to requeue when sending a [negative acknolwedgement](https://www.rabbitmq.com/nack.html) in case of a failure. Defaults to `"false"` | `"true"`, `"false"` -| prefetchCount | N | Number of messages to [prefecth](https://www.rabbitmq.com/consumer-prefetch.html). Consider changing this to a non-zero value for production environments. Defaults to `"0"`, which means that all available messages will be pre-fetched. | `"2"` +| prefetchCount | N | Number of messages to [prefetch](https://www.rabbitmq.com/consumer-prefetch.html). Consider changing this to a non-zero value for production environments. Defaults to `"0"`, which means that all available messages will be pre-fetched. | `"2"` | reconnectWait | N | How long to wait (in seconds) before reconnecting if a connection failure occurs | `"0"` | concurrencyMode | N | `parallel` is the default, and allows processing multiple messages in parallel (limited by the `app-max-concurrency` annotation, if configured). Set to `single` to disable parallel processing. In most situations there's no reason to change this. | `parallel`, `single` From d2ccd781b329951650c9000d847ee118a117fadb Mon Sep 17 00:00:00 2001 From: Newbe36524 Date: Thu, 3 Jun 2021 08:36:17 +0800 Subject: [PATCH 6/8] Update chinese content (#1527) Co-authored-by: Aaron Crawfis --- translations/docs-zh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/translations/docs-zh b/translations/docs-zh index a567aaeaafa..794330f6cab 160000 --- a/translations/docs-zh +++ b/translations/docs-zh @@ -1 +1 @@ -Subproject commit a567aaeaafa09450e37960dc218e6875cffd7815 +Subproject commit 794330f6cab2db8e09053bb7bf19233eb3237538 From 993cf5e2a2a91c6800810cb34f7678b5c2664648 Mon Sep 17 00:00:00 2001 From: Steven Jenkins De Haro <20492442+StevenJDH@users.noreply.github.com> Date: Thu, 3 Jun 2021 02:41:17 +0200 Subject: [PATCH 7/8] Updated to fix deprecated helm chart location (#1528) The `https://kubernetes-charts.storage.googleapis.com/` location is no longer used, so this change updates this, the command to install, and the missing update step that will cause the install to fail if an update was never done after adding the location. Co-authored-by: Aaron Crawfis --- .../components-reference/supported-bindings/eventgrid.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/daprdocs/content/en/reference/components-reference/supported-bindings/eventgrid.md b/daprdocs/content/en/reference/components-reference/supported-bindings/eventgrid.md index 3c46350291e..87413973525 100644 --- a/daprdocs/content/en/reference/components-reference/supported-bindings/eventgrid.md +++ b/daprdocs/content/en/reference/components-reference/supported-bindings/eventgrid.md @@ -130,8 +130,9 @@ controller: Then install NGINX ingress controller to your Kubernetes cluster with Helm 3 using the annotations ```bash -helm repo add stable https://kubernetes-charts.storage.googleapis.com/ -helm install nginx stable/nginx-ingress -f ./dapr-annotations.yaml -n default +helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx +helm repo update +helm install nginx-ingress ingress-nginx/ingress-nginx -f ./dapr-annotations.yaml -n default # Get the public IP for the ingress controller kubectl get svc -l component=controller -o jsonpath='Public IP is: {.items[0].status.loadBalancer.ingress[0].ip}{"\n"}' ``` From a573434a2960685160362e778cfd57be8437827c Mon Sep 17 00:00:00 2001 From: Abdulaziz Elsheikh Date: Thu, 3 Jun 2021 01:43:27 +0100 Subject: [PATCH 8/8] nr_consul_typo fixed malformed yaml (#1532) Co-authored-by: Aaron Crawfis --- .../supported-name-resolution/setup-nr-consul.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/daprdocs/content/en/reference/components-reference/supported-name-resolution/setup-nr-consul.md b/daprdocs/content/en/reference/components-reference/supported-name-resolution/setup-nr-consul.md index fd2b3876b9a..ab5b44a84f4 100644 --- a/daprdocs/content/en/reference/components-reference/supported-name-resolution/setup-nr-consul.md +++ b/daprdocs/content/en/reference/components-reference/supported-name-resolution/setup-nr-consul.md @@ -84,11 +84,11 @@ spec: checks: - name: "Dapr Health Status" checkID: "daprHealth:${APP_ID}" - interval: "15s", + interval: "15s" http: "http://${HOST_ADDRESS}:${DAPR_HTTP_PORT}/v1.0/healthz" - name: "Service Health Status" checkID: "serviceHealth:${APP_ID}" - interval: "15s", + interval: "15s" http: "http://${HOST_ADDRESS}:${APP_PORT}/health" tags: - "dapr" @@ -129,7 +129,7 @@ spec: check: name: "Dapr Health Status" checkID: "daprHealth:${APP_ID}" - interval: "15s", + interval: "15s" http: "http://${HOST_ADDRESS}:${DAPR_HTTP_PORT}/v1.0/healthz" meta: DAPR_METRICS_PORT: "${DAPR_METRICS_PORT}"