Skip to content

Commit

Permalink
Removing notes and updating versions in commands
Browse files Browse the repository at this point in the history
  • Loading branch information
Ori Zohar committed Feb 11, 2021
1 parent ecb5cc0 commit 2768f83
Show file tree
Hide file tree
Showing 7 changed files with 34 additions and 48 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,8 @@ The following branches are currently maintained:

| Branch | Website | Description |
|--------|---------|-------------|
| [v0.11](https://github.com/dapr/docs) (primary) | https://docs.dapr.io | Latest Dapr release documentation. Typo fixes, clarifications, and most documentation goes here.
| [v1.0-rc3](https://github.com/dapr/docs/tree/v1.0-rc3) | https://v1-rc3.docs.dapr.io/ | Latest Dapr release candidate release documentation. Doc updates that are only applicable to v1.0-rc2+ go here.
| [v1.0](https://github.com/dapr/docs/tree/v1.0) (pre-release) | https://v1-0.docs.dapr.io/ | Pre-release documentation. Doc updates that are only applicable to v1.0+ go here.
| [v1.0](https://github.com/dapr/docs) (primary) | https://docs.dapr.io | Latest Dapr release documentation. Typo fixes, clarifications, and most documentation goes here.
| [v1.1](https://github.com/dapr/docs/tree/v1.1) (pre-release) | https://v1-1.docs.dapr.io/ | Pre-release documentation. Doc updates that are only applicable to v1.1+ go here.

For more information visit the [Dapr branch structure](https://docs.dapr.io/contributing/contributing-docs/#branch-guidance) document.

Expand Down
14 changes: 5 additions & 9 deletions daprdocs/content/en/getting-started/install-dapr-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,37 +7,33 @@ weight: 10

The Dapr CLI is the main tool you'll be using for various Dapr related tasks. You can use it to run an application with a Dapr sidecar, as well as review sidecar logs, list running services, and run the Dapr dashboard. The Dapr CLI works with both [self-hosted]({{< ref self-hosted >}}) and [Kubernetes]({{< ref Kubernetes >}}) environments.

Begin by downloading and installing the Dapr CLI for v1.0.0-rc.3. This is used to initialize your environment on your desired platform.

{{% alert title="Note" color="warning" %}}
This command downloads and install Dapr CLI v1.0-rc.4. To install v0.11, the latest release prior to the release candidates for the [upcoming v1.0 release](https://blog.dapr.io/posts/2020/10/20/the-path-to-v.1.0-production-ready-dapr/), please visit the [v0.11 docs](https://docs.dapr.io).
{{% /alert %}}
Begin by downloading and installing the Dapr CLI:

{{< tabs Linux Windows MacOS Binaries>}}

{{% codetab %}}
This command installs the latest linux Dapr CLI to `/usr/local/bin`:
```bash
wget -q https://raw.githubusercontent.com/dapr/cli/master/install/install.sh -O - | /bin/bash -s 1.0.0-rc.4
wget -q https://raw.githubusercontent.com/dapr/cli/master/install/install.sh -O - | /bin/bash
```
{{% /codetab %}}

{{% codetab %}}
This Command Prompt command installs the latest windows Dapr cli to `C:\dapr` and adds this directory to User PATH environment variable.
```powershell
powershell -Command "$script=iwr -useb https://raw.githubusercontent.com/dapr/cli/master/install/install.ps1; $block=[ScriptBlock]::Create($script); invoke-command -ScriptBlock $block -ArgumentList 1.0.0-rc.4"
powershell -Command "iwr -useb https://raw.githubusercontent.com/dapr/cli/master/install/install.ps1 | iex"
```
{{% /codetab %}}

{{% codetab %}}
This command installs the latest darwin Dapr CLI to `/usr/local/bin`:
```bash
curl -fsSL https://raw.githubusercontent.com/dapr/cli/master/install/install.sh | /bin/bash -s 1.0.0-rc.4
curl -fsSL https://raw.githubusercontent.com/dapr/cli/master/install/install.sh | /bin/bash
```

Or you can install via [Homebrew](https://brew.sh):
```bash
brew install dapr/tap/dapr-cli@1.0.0-rc.4
brew install dapr/tap/dapr-cli
```

{{% alert title="Note for M1 Macs" color="primary" %}}
Expand Down
11 changes: 3 additions & 8 deletions daprdocs/content/en/getting-started/install-dapr-selfhost.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,6 @@ In addition, the default initialization process also creates a development envir
1. Creating a **default components folder** with component definitions for the above
1. Running a **Dapr placement service container instance** for local actor support


{{% alert title="Note" color="warning" %}}
This command downloads and installs Dapr runtime v1.0-rc.3. To install v0.11, the latest release prior to the release candidates for the [upcoming v1.0 release](https://blog.dapr.io/posts/2020/10/20/the-path-to-v.1.0-production-ready-dapr/), please visit the [v0.11 docs](https://docs.dapr.io).
{{% /alert %}}

{{% alert title="Docker" color="primary" %}}
This recommended development environment requires [Docker](https://docs.docker.com/install/). It is possible to initialize Dapr without a dependency on Docker (see [this guidance]({{<ref self-hosted-no-docker.md>}})) but next steps in this guide assume the recommended development environment.
{{% /alert %}}
Expand All @@ -46,7 +41,7 @@ This recommended development environment requires [Docker](https://docs.docker.c
Install the latest Dapr runtime binaries:

```bash
dapr init --runtime-version 1.0.0-rc.3
dapr init
```

### Step 3: Verify Dapr version
Expand All @@ -57,8 +52,8 @@ dapr --version

Output should look like this:
```
CLI version: 1.0.0-rc.4
Runtime version: 1.0.0-rc.3
CLI version: 1.0.0
Runtime version: 1.0.0
```

### Step 4: Verify containers are running
Expand Down
18 changes: 9 additions & 9 deletions daprdocs/content/en/getting-started/quickstarts.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ weight: 60
description: "Tutorials with code samples that are aimed to get you started quickly with Dapr"
---

The [Dapr Quickstarts](https://github.com/dapr/quickstarts/tree/v1.0.0-rc.3) are a collection of tutorials with code samples that are aimed to get you started quickly with Dapr, each highlighting a different Dapr capability.
The [Dapr Quickstarts](https://github.com/dapr/quickstarts/tree/v1.0.0) are a collection of tutorials with code samples that are aimed to get you started quickly with Dapr, each highlighting a different Dapr capability.

- A good place to start is the hello-world quickstart, it demonstrates how to run Dapr in standalone mode locally on your machine and demonstrates state management and service invocation in a simple application.
- Next, if you are familiar with Kubernetes and want to see how to run the same application in a Kubernetes environment, look for the hello-kubernetes quickstart. Other quickstarts such as pub-sub, bindings and the distributed-calculator quickstart explore different Dapr capabilities include instructions for running both locally and on Kubernetes and can be completed in any order. A full list of the quickstarts can be found below.
Expand All @@ -17,11 +17,11 @@ The [Dapr Quickstarts](https://github.com/dapr/quickstarts/tree/v1.0.0-rc.3) are

| Quickstart | Description |
|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Hello World](https://github.com/dapr/quickstarts/tree/v1.0.0-rc.3/hello-world) | Demonstrates how to run Dapr locally. Highlights service invocation and state management. |
| [Hello Kubernetes](https://github.com/dapr/quickstarts/tree/v1.0.0-rc.3/hello-kubernetes) | Demonstrates how to run Dapr in Kubernetes. Highlights service invocation and state management. |
| [Distributed Calculator](https://github.com/dapr/quickstarts/tree/v1.0.0-rc.3/distributed-calculator) | Demonstrates a distributed calculator application that uses Dapr services to power a React web app. Highlights polyglot (multi-language) programming, service invocation and state management. |
| [Pub/Sub](https://github.com/dapr/quickstarts/tree/v1.0.0-rc.3/pub-sub) | Demonstrates how to use Dapr to enable pub-sub applications. Uses Redis as a pub-sub component. |
| [Bindings](https://github.com/dapr/quickstarts/tree/v1.0.0-rc.3/bindings) | Demonstrates how to use Dapr to create input and output bindings to other components. Uses bindings to Kafka. |
| [Middleware](https://github.com/dapr/quickstarts/tree/v1.0.0-rc.3/middleware) | Demonstrates use of Dapr middleware to enable OAuth 2.0 authorization. |
| [Observability](https://github.com/dapr/quickstarts/tree/v1.0.0-rc.3/observability) | Demonstrates Dapr tracing capabilities. Uses Zipkin as a tracing component. |
| [Secret Store](https://github.com/dapr/quickstarts/tree/v1.0.0-rc.3/secretstore) | Demonstrates the use of Dapr Secrets API to access secret stores. |
| [Hello World](https://github.com/dapr/quickstarts/tree/v1.0.0/hello-world) | Demonstrates how to run Dapr locally. Highlights service invocation and state management. |
| [Hello Kubernetes](https://github.com/dapr/quickstarts/tree/v1.0.0/hello-kubernetes) | Demonstrates how to run Dapr in Kubernetes. Highlights service invocation and state management. |
| [Distributed Calculator](https://github.com/dapr/quickstarts/tree/v1.0.0/distributed-calculator) | Demonstrates a distributed calculator application that uses Dapr services to power a React web app. Highlights polyglot (multi-language) programming, service invocation and state management. |
| [Pub/Sub](https://github.com/dapr/quickstarts/tree/v1.0.0/pub-sub) | Demonstrates how to use Dapr to enable pub-sub applications. Uses Redis as a pub-sub component. |
| [Bindings](https://github.com/dapr/quickstarts/tree/v1.0.0/bindings) | Demonstrates how to use Dapr to create input and output bindings to other components. Uses bindings to Kafka. |
| [Middleware](https://github.com/dapr/quickstarts/tree/v1.0.0/middleware) | Demonstrates use of Dapr middleware to enable OAuth 2.0 authorization. |
| [Observability](https://github.com/dapr/quickstarts/tree/v1.0.0/observability) | Demonstrates Dapr tracing capabilities. Uses Zipkin as a tracing component. |
| [Secret Store](https://github.com/dapr/quickstarts/tree/v1.0.0/secretstore) | Demonstrates the use of Dapr Secrets API to access secret stores. |
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,6 @@ Both the Dapr CLI and the Dapr Helm chart automatically deploy with affinity for

You can install Dapr to a Kubernetes cluster using the [Dapr CLI]({{< ref install-dapr-cli.md >}}).

{{% alert title="Release candidate" color="warning" %}}
This command downloads and install Dapr runtime v1.0-rc.3. To install v0.11, the latest release prior to the release candidates for the [upcoming v1.0 release](https://blog.dapr.io/posts/2020/10/20/the-path-to-v.1.0-production-ready-dapr/), please visit the [v0.11 docs](https://docs.dapr.io).
{{% /alert %}}

### Install Dapr

The `-k` flag initializes Dapr on the Kubernetes cluster in your current context.
Expand All @@ -56,7 +52,7 @@ Make sure the correct "target" cluster is set. Check `kubectl context (kubectl c
Run on your local machine:

```bash
dapr init -k --runtime-version 1.0.0-rc.3
dapr init -k
```

```
Expand All @@ -72,7 +68,7 @@ dapr init -k --runtime-version 1.0.0-rc.3
The default namespace when initializing Dapr is `dapr-system`. You can override this with the `-n` flag.

```bash
dapr init -k -n mynamespace --runtime-version 1.0.0-rc.3
dapr init -k -n mynamespace
```


Expand All @@ -81,15 +77,15 @@ dapr init -k -n mynamespace --runtime-version 1.0.0-rc.3
You can run Dapr with 3 replicas of each control plane pod with the exception of the Placement pod in the dapr-system namespace for [production scenarios]({{< ref kubernetes-production.md >}}).

```bash
dapr init -k --enable-ha=true --runtime-version 1.0.0-rc.3
dapr init -k --enable-ha=true
```

### Disable mTLS

Dapr is initialized by default with [mTLS]({{< ref "security-concept.md#sidecar-to-sidecar-communication" >}}). You can disable it with:

```bash
dapr init -k --enable-mtls=false --runtime-version 1.0.0-rc.3
dapr init -k --enable-mtls=false
```

### Uninstall Dapr on Kubernetes with CLI
Expand Down Expand Up @@ -127,7 +123,7 @@ The latest Dapr helm chart no longer supports Helm v2. Please migrate from Helm

```bash
helm upgrade --install dapr dapr/dapr \
--version=1.0.0-rc.3 \
--version=1.0.0 \
--namespace dapr-system \
--create-namespace \
--wait
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,30 +11,30 @@ description: "Follow these steps to upgrade Dapr on Kubernetes and ensure a smoo
- [Dapr CLI]({{< ref install-dapr-cli.md >}}))
- [Helm 3](https://github.com/helm/helm/releases) (if using Helm)

## Upgrade existing cluster to 1.0.0 / 1.0.0-rc.3
## Upgrade existing cluster to 1.0.0
There are two ways to upgrade the Dapr control plane on a Kubernetes cluster using either the Dapr CLI or Helm. The preferred way is to use the Dapr CLI.

### Dapr CLI
The example below shows how to upgrade to version 1.0.0-rc.3
The example below shows how to upgrade to version 1.0.0

```bash
dapr upgrade -k --runtime-version=1.0.0-rc.3
dapr upgrade -k --runtime-version=1.0.0
```

You can provide all the available Helm chart configurations using the Dapr CLI.
See [here](https://github.com/dapr/cli#supplying-helm-values) for more info.

### Helm
From version 1.0.0-rc.3 onwards, upgrading Dapr using Helm is no longer a disruptive action since existing certificate values will automatically be re-used.
From version 1.0.0 onwards, upgrading Dapr using Helm is no longer a disruptive action since existing certificate values will automatically be re-used.

1. Upgrade Dapr from 1.0.0-rc.1 (or newer) to 1.0.0-rc.3 (or newer):
1. Upgrade Dapr from 1.0.0 (or newer) to any [NEW VERSION] > v1.0.0:

```bash
helm repo update
```

```bash
helm upgrade dapr dapr/dapr --version 1.0.0-rc.3 --namespace dapr-system --wait
helm upgrade dapr dapr/dapr --version [NEW VERSION] --namespace dapr-system --wait
```
*If you're using a values file, remember to add the `--values` option when running the upgrade command.*

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@ description: "Follow these steps to upgrade Dapr in self-hosted mode and ensure
1. Initialize the Dapr runtime:

```bash
dapr init --runtime-version=1.0.0-rc.3
dapr init
```

1. Ensure you are using the latest version of Dapr (1.0.0-rc.3) with:
1. Ensure you are using the latest version of Dapr (1.0.0) with:

```bash
$ dapr --version

CLI version: 1.0.0-rc.3
Runtime version: 1.0.0-rc.3
CLI version: 1.0.0
Runtime version: 1.0.0
```

0 comments on commit 2768f83

Please sign in to comment.