Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
Signed-off-by: tianya <[email protected]>
  • Loading branch information
tianyax committed Feb 28, 2023
1 parent 003646e commit ed91064
Showing 1 changed file with 41 additions and 6 deletions.
47 changes: 41 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,49 @@ The Dapr CLI allows you to setup Dapr on your local dev machine or on a Kubernet

### Prerequisites

On default, during initialization the Dapr CLI will install the Dapr binaries as well as setup a developer environment to help you get started easily with Dapr. This environment uses Docker containers, therefore Docker needs to be installed. If you prefer to run Dapr without this environment and no dependency on Docker, after installation of the CLI make sure to follow the instructions to initialize Dapr using [slim init](#slim-init).
On default, during initialization the Dapr CLI will install the Dapr binaries as well as setup a developer environment to help you get started easily with Dapr. This environment uses `Docker`, `Podman` or `Containerd` containers, therefore container runtime needs to be installed. If you prefer to run Dapr without this environment and without any container dependencies, after installation of the CLI make sure to follow the instructions to initialize Dapr using [slim init](#slim-init).

Note, if you are a new user, it is strongly recommended to install Docker and use the regular init command.
#### Note, if you are a new user, it is strongly recommended to install Docker and use the regular init command.

* Install [Docker](https://docs.docker.com/install/)

>__Note: On Windows, Docker must be running in Linux Containers mode__
#### If you want to use podman as a runtime, then please refer to the installation.

* Install [Podman](https://podman-desktop.io/docs/Installation)

#### If you want to use containerd as a runtime, then please refer to the installation.

**Windows and Linux**

* Step 1: Install [Containerd](https://github.com/containerd/containerd/blob/main/docs/getting-started.md).

* Step 2: Install [nerdctl](https://github.com/containerd/nerdctl/blob/main/docs/installation.md).

__MacOS__

> containerd and nerdctl are not supported on macOS. Instead, you can use `lima`, `colima`, or `rancher-desktop` to get containerd support on macOS. The steps below show how to install these tools using brew.
>
* [Lima](https://github.com/lima-vm/lima):

```
brew install lima
limactl start
ln -s $(which nerdctl.lima) /usr/local/bin/nerdctl
```

* [Colima](https://github.com/abiosoft/colima):

```
brew install colima
colima start --runtime containerd
colima nerdctl install
```

* [Rancher-desktop](https://docs.rancherdesktop.io/getting-started/installation#installing-rancher-desktop-on-macos)

### Installing Dapr CLI

#### Using script to install the latest release
Expand Down Expand Up @@ -139,7 +174,7 @@ Runtime version: v1.0.0

#### Install with mariner images

You can install Dapr Runtime using mariner images using the `--image-variant` flag.
You can install Dapr Runtime using mariner images using the `--image-variant` flag.

```bash
# Installing Dapr with Mariner images
Expand Down Expand Up @@ -178,7 +213,7 @@ docker run --name "dapr_zipkin" --restart always -d -p 9411:9411 openzipkin/zipk
docker run --name "dapr_redis" --restart always -d -p 6379:6379 redis
```

Alternatively to the above, you can also have slim installation as well to install dapr without running any Docker containers in airgap mode.
Alternatively to the above, you can also have slim installation as well to install dapr without running any Docker containers in airgap mode.

```bash
./dapr init --slim --from-dir .
Expand Down Expand Up @@ -278,7 +313,7 @@ Output should look like as follows:
All available [Helm Chart values](https://github.com/dapr/dapr/tree/master/charts/dapr#configuration) can be set by using the `--set` flag:

```bash
dapr init -k --set global.tag=1.0.0 --set dapr_operator.logLevel=error
dapr init -k --set global.tag=1.0.0 --set dapr_operator.logLevel=error
```

#### Installing to a custom namespace
Expand Down Expand Up @@ -342,7 +377,7 @@ The example above shows how to upgrade from your current version to version `1.0
All available [Helm Chart values](https://github.com/dapr/dapr/tree/master/charts/dapr#configuration) can be set by using the `--set` flag:

```bash
dapr upgrade -k --runtime-version=1.0.0 --set global.tag=my-tag --set dapr_operator.logLevel=error
dapr upgrade -k --runtime-version=1.0.0 --set global.tag=my-tag --set dapr_operator.logLevel=error
```

*Note: do not use the `dapr upgrade` command if you're upgrading from 0.x versions of Dapr*
Expand Down

0 comments on commit ed91064

Please sign in to comment.