Skip to content

Commit ed91064

Browse files
committed
update README
Signed-off-by: tianya <[email protected]>
1 parent 003646e commit ed91064

File tree

1 file changed

+41
-6
lines changed

1 file changed

+41
-6
lines changed

README.md

+41-6
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,49 @@ The Dapr CLI allows you to setup Dapr on your local dev machine or on a Kubernet
1111

1212
### Prerequisites
1313

14-
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).
14+
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).
1515

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

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

2020
>__Note: On Windows, Docker must be running in Linux Containers mode__
2121
22+
#### If you want to use podman as a runtime, then please refer to the installation.
23+
24+
* Install [Podman](https://podman-desktop.io/docs/Installation)
25+
26+
#### If you want to use containerd as a runtime, then please refer to the installation.
27+
28+
**Windows and Linux**
29+
30+
* Step 1: Install [Containerd](https://github.com/containerd/containerd/blob/main/docs/getting-started.md).
31+
32+
* Step 2: Install [nerdctl](https://github.com/containerd/nerdctl/blob/main/docs/installation.md).
33+
34+
__MacOS__
35+
36+
> 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.
37+
>
38+
39+
* [Lima](https://github.com/lima-vm/lima):
40+
41+
```
42+
brew install lima
43+
limactl start
44+
ln -s $(which nerdctl.lima) /usr/local/bin/nerdctl
45+
```
46+
47+
* [Colima](https://github.com/abiosoft/colima):
48+
49+
```
50+
brew install colima
51+
colima start --runtime containerd
52+
colima nerdctl install
53+
```
54+
55+
* [Rancher-desktop](https://docs.rancherdesktop.io/getting-started/installation#installing-rancher-desktop-on-macos)
56+
2257
### Installing Dapr CLI
2358
2459
#### Using script to install the latest release
@@ -139,7 +174,7 @@ Runtime version: v1.0.0
139174

140175
#### Install with mariner images
141176

142-
You can install Dapr Runtime using mariner images using the `--image-variant` flag.
177+
You can install Dapr Runtime using mariner images using the `--image-variant` flag.
143178

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

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

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

280315
```bash
281-
dapr init -k --set global.tag=1.0.0 --set dapr_operator.logLevel=error
316+
dapr init -k --set global.tag=1.0.0 --set dapr_operator.logLevel=error
282317
```
283318

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

344379
```bash
345-
dapr upgrade -k --runtime-version=1.0.0 --set global.tag=my-tag --set dapr_operator.logLevel=error
380+
dapr upgrade -k --runtime-version=1.0.0 --set global.tag=my-tag --set dapr_operator.logLevel=error
346381
```
347382

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

0 commit comments

Comments
 (0)