dapr · AaronCrawfis · Jun 3, 2021 · May 27, 2021 · May 28, 2021 · Jun 3, 2021
@@ -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":
+
+<img src="/images/codespaces-create.png" alt="Screenshot of creating a Dapr Codespace" width="300">
+
+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)
@@ -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

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

@@ -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</br>| 1.0.0 | Java 1.0.0 </br>Go 1.0.0 </br>PHP 1.0.0 </br>Python 1.0.0 </br>.NET 1.0.0 | 0.6.0 | Supported |
-| Mar 4th 2021  | 1.0.1</br>| 1.0.1 | Java 1.0.2 </br>Go 1.0.0 </br>PHP 1.0.0 </br>Python 1.0.0 </br>.NET 1.0.0 | 0.6.0 | Supported |
+| Feb 17th 2021 | 1.0.0</br>| 1.0.0 | Java 1.0.0 </br>Go 1.0.0 </br>PHP 1.0.0 </br>Python 1.0.0 </br>.NET 1.0.0 | 0.6.0 | Unsupported |
+| Mar 4th 2021  | 1.0.1</br>| 1.0.1 | Java 1.0.2 </br>Go 1.0.0 </br>PHP 1.0.0 </br>Python 1.0.0 </br>.NET 1.0.0 | 0.6.0 | Unsupported |
 | Apr 1st 2021 | 1.1.0</br> | 1.1.0 | Java 1.0.2 </br>Go 1.1.0 </br>PHP 1.0.0 </br>Python 1.1.0 </br>.NET 1.1.0 | 0.6.0 | Supported |
-| Apr 6th 2021 | 1.1.1</br> | 1.1.0 | Java 1.0.2 </br>Go 1.1.0 </br>PHP 1.0.0 </br>Python 1.1.0 </br>.NET 1.1.0 | 0.6.0 | Supported (current) |
-| Apr 16th 2021 | 1.1.2</br> | 1.1.0 | Java 1.0.2 </br>Go 1.1.0 </br>PHP 1.0.0 </br>Python 1.1.0 </br>.NET 1.1.0 | 0.6.0 | Supported (current) |
+| Apr 6th 2021 | 1.1.1</br> | 1.1.0 | Java 1.0.2 </br>Go 1.1.0 </br>PHP 1.0.0 </br>Python 1.1.0 </br>.NET 1.1.0 | 0.6.0 | Supported |
+| Apr 16th 2021 | 1.1.2</br> | 1.1.0 | Java 1.0.2 </br>Go 1.1.0 </br>PHP 1.0.0 </br>Python 1.1.0 </br>.NET 1.1.0 | 0.6.0 | Supported |
+| 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 | 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]({{<ref self-ho
 |--------------------------|-----------------------|------------------------- |
 | 0.11                     |                   N/A |                    1.0.1 |
 |                          |                 1.0.1 |                    1.1.2 |
-| 1.0-rc1 to 1.0-rc4       |                   N/A |                    1.0.1 |
-| 1.0.0 or 1.0.1           |                   N/A |                    1.1.2 |
+| 1.0-rc1 to 1.0-rc4       |                   N/A |                    1.0.1 | 
+| 1.0.0 or 1.0.1           |                   N/A |                    1.1.2 | 
 | 1.1.0 or 1.1.1           |                   N/A |                    1.1.2 |
+| 1.0.0 or 1.0.1           |                 1.1.2 |                    1.2.0 |
+| 1.1.0 to 1.1.2           |                   N/A |                    1.2.0 |
 
 ## 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.

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

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

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

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