docs/release_notes/template.md
We're happy to announce the release of Dapr $dapr_version!
We would like to extend our thanks to all the new and existing contributors who helped make this release happen.
Highlights
If you're new to Dapr, visit the getting started page and familiarize yourself with Dapr.
Docs have been updated with all the new features and changes of this release. To get started with new capabilities introduced in this release, go to the Concepts and the Developing applications.
$warnings
See this section on upgrading Dapr to version $dapr_version.
Thanks to everyone who made this release possible!
$dapr_contributors
+++++ Include contributions and acknowledgements to individuals/organisations involved in the release effort e.g. comprehensive testing. This is not automated +++++
$dapr_changes
To upgrade to this release of Dapr, follow the steps here to ensure a smooth upgrade. You know, the one where you don't get red errors on the terminal.. we all hate that, right?
Uninstall Dapr using the CLI you currently have installed. Note that this will remove the default $HOME/.dapr directory, binaries and all containers dapr_redis, dapr_placement and dapr_zipkin. Linux users need to run sudo if docker command needs sudo:
dapr uninstall --all
For RC releases like this, download the latest and greatest release from here and put the dapr binary in your PATH.
Once you have installed the CLI, run:
dapr init --runtime-version=$dapr_version
Wait for the update to finish, ensure you are using the latest version of Dapr($dapr_version) with:
$ dapr --version
CLI version: $dapr_version
Runtime version: $dapr_version
You can perform zero-downtime upgrades using both Helm 3 and the Dapr CLI.
Download the latest RC release from here and put the dapr binary in your PATH.
To upgrade Dapr, run:
dapr upgrade --runtime-version $dapr_version -k
To upgrade with high availability mode:
dapr upgrade --runtime-version $dapr_version --enable-ha=true -k
Wait until the operation is finished and check your status with dapr status -k.
All done!
Note: Make sure your deployments are restarted to pick the latest version of the Dapr sidecar
To upgrade Dapr using Helm, run:
helm repo add dapr https://dapr.github.io/helm-charts/
helm repo update
helm upgrade dapr dapr/dapr --version $dapr_version --namespace=dapr-system --wait
Wait until the operation is finished and check your status with dapr status -k.
All done!
Note: Make sure your deployments are restarted to pick the latest version of the Dapr sidecar
Please see how to deploy Dapr on a Kubernetes cluster for a complete guide to installing Dapr on Kubernetes
You can use Helm 3 to install Dapr:
helm repo add dapr https://dapr.github.io/helm-charts/
helm repo update
kubectl create namespace dapr-system
helm install dapr dapr/dapr --version $dapr_version --namespace dapr-system --wait
Alternatively, you can use the latest version of CLI:
dapr init --runtime-version=$dapr_version -k
Verify the control plane pods are running and are healthy:
$ dapr status -k
NAME NAMESPACE HEALTHY STATUS REPLICAS VERSION AGE CREATED
dapr-sidecar-injector dapr-system True Running 1 $dapr_version 15s $today 13:07.39
dapr-sentry dapr-system True Running 1 $dapr_version 15s $today 13:07.39
dapr-operator dapr-system True Running 1 $dapr_version 15s $today 13:07.39
dapr-placement dapr-system True Running 1 $dapr_version 15s $today 13:07.39
After Dapr $dapr_version has been installed, perform a rolling restart for your deployments to pick up the new version of the sidecar. This can be done with:
kubectl rollout restart deploy/<deployment-name>
$dapr_breaking_changes
$dapr_deprecation_notices