From 2261b1c2f93e83679d40dbc409b8a710e5ebed12 Mon Sep 17 00:00:00 2001 From: Aaron Crawfis Date: Thu, 3 Jun 2021 10:25:39 -0700 Subject: [PATCH] Upmerge2 06 03 (#1536) * 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 * Adding K8s versions table (#1521) * Adding table of kubernetes versions * Updating intro * Fix incorrect postgresql connection string example (#1524) Co-authored-by: Aaron Crawfis * 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 * Fix two typos (#1526) Co-authored-by: Aaron Crawfis * Update chinese content (#1527) Co-authored-by: Aaron Crawfis * 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 * nr_consul_typo fixed malformed yaml (#1532) Co-authored-by: Aaron Crawfis Co-authored-by: Bernd Verst Co-authored-by: Mark Fussell Co-authored-by: Zonciu Liang Co-authored-by: Simon Leet <31784195+CodeMonkeyLeet@users.noreply.github.com> Co-authored-by: Maarten Mulders Co-authored-by: Newbe36524 Co-authored-by: Steven Jenkins De Haro <20492442+StevenJDH@users.noreply.github.com> Co-authored-by: Abdulaziz Elsheikh --- .../content/en/contributing/codespaces.md | 53 +++++++++++++++++++ .../en/contributing/contributing-overview.md | 1 + .../ides/codespaces.md | 32 ----------- .../hosting/kubernetes/kubernetes-overview.md | 10 +++- .../support/support-release-policy.md | 15 +++--- .../supported-bindings/eventgrid.md | 5 +- .../setup-nr-consul.md | 6 +-- .../supported-pubsub/setup-rabbitmq.md | 4 +- .../setup-postgresql.md | 2 +- translations/docs-zh | 2 +- 10 files changed, 82 insertions(+), 48 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 000000000..62585e50f --- /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 0a042eb83..6a8a404b3 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 af4de0e7d..000000000 --- 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 diff --git a/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-overview.md b/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-overview.md index 781050e26..d6e9cde72 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 >}}) diff --git a/daprdocs/content/en/operations/support/support-release-policy.md b/daprdocs/content/en/operations/support/support-release-policy.md index 9c3e689ec..20594c89d 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]({{