add containerd runtime

README.md

@@ -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
@@ -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
@@ -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 .
@@ -292,7 +327,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
@@ -356,7 +391,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*

cmd/init.go

@@ -49,7 +49,7 @@ var (
 var InitCmd = &cobra.Command{
 	Use:   "init",
 	Short: "Install Dapr on supported hosting platforms. Supported platforms: Kubernetes and self-hosted",
-	PreRun: func(cmd *cobra.Command, args []string) {
+	PreRun: func(cmd *cobra.Command, _ []string) {
 		viper.BindPFlag("network", cmd.Flags().Lookup("network"))
 		viper.BindPFlag("image-registry", cmd.Flags().Lookup("image-registry"))
 
@@ -92,7 +92,7 @@ dapr init --runtime-path <path-to-install-directory>
 
 # See more at: https://docs.dapr.io/getting-started/
 `,
-	Run: func(cmd *cobra.Command, args []string) {
+	Run: func(cmd *cobra.Command, _ []string) {
 		print.PendingStatusEvent(os.Stdout, "Making the jump to hyperspace...")
 		imageRegistryFlag := strings.TrimSpace(viper.GetString("image-registry"))
 
@@ -161,7 +161,7 @@ dapr init --runtime-path <path-to-install-directory>
 			}
 
 			if !utils.IsValidContainerRuntime(containerRuntime) {
-				print.FailureStatusEvent(os.Stdout, "Invalid container runtime. Supported values are docker and podman.")
+				print.FailureStatusEvent(os.Stdout, "Invalid container runtime. Supported values are docker, podman and containerd.")
 				os.Exit(1)
 			}
 			err := standalone.Init(runtimeVersion, dashboardVersion, dockerNetwork, slimMode, imageRegistryURI, fromDir, containerRuntime, imageVariant, daprRuntimePath)
@@ -215,7 +215,7 @@ func init() {
 	InitCmd.Flags().BoolP("help", "h", false, "Print this help message")
 	InitCmd.Flags().StringArrayVar(&values, "set", []string{}, "set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)")
 	InitCmd.Flags().String("image-registry", "", "Custom/private docker image repository URL")
-	InitCmd.Flags().StringVarP(&containerRuntime, "container-runtime", "", defaultContainerRuntime, "The container runtime to use. Supported values are docker (default) and podman")
+	InitCmd.Flags().StringVarP(&containerRuntime, "container-runtime", "", defaultContainerRuntime, "The container runtime to use. Supported values are docker (default), podman and containerd")
 	InitCmd.Flags().StringVarP(&caRootCertificateFile, "ca-root-certificate", "", "", "The root certificate file")
 	InitCmd.Flags().StringVarP(&issuerPrivateKeyFile, "issuer-private-key", "", "", "The issuer certificate private key")
 	InitCmd.Flags().StringVarP(&issuerPublicCertificateFile, "issuer-public-certificate", "", "", "The issuer certificate")

cmd/uninstall.go

@@ -52,11 +52,11 @@ dapr uninstall -k
 # This will remove the .dapr directory present in the path <path-to-install-directory>
 dapr uninstall --runtime-path <path-to-install-directory>
 `,
-	PreRun: func(cmd *cobra.Command, args []string) {
+	PreRun: func(cmd *cobra.Command, _ []string) {
 		viper.BindPFlag("network", cmd.Flags().Lookup("network"))
 		viper.BindPFlag("install-path", cmd.Flags().Lookup("install-path"))
 	},
-	Run: func(cmd *cobra.Command, args []string) {
+	Run: func(*cobra.Command, []string) {
 		var err error
 
 		if uninstallKubernetes {
@@ -69,7 +69,7 @@ dapr uninstall --runtime-path <path-to-install-directory>
 			err = kubernetes.Uninstall(uninstallNamespace, uninstallAll, timeout)
 		} else {
 			if !utils.IsValidContainerRuntime(uninstallContainerRuntime) {
-				print.FailureStatusEvent(os.Stdout, "Invalid container runtime. Supported values are docker and podman.")
+				print.FailureStatusEvent(os.Stdout, "Invalid container runtime. Supported values are docker, podman and containerd.")
 				os.Exit(1)
 			}
 			print.InfoStatusEvent(os.Stdout, "Removing Dapr from your machine...")
@@ -92,6 +92,6 @@ func init() {
 	UninstallCmd.Flags().String("network", "", "The Docker network from which to remove the Dapr runtime")
 	UninstallCmd.Flags().StringVarP(&uninstallNamespace, "namespace", "n", "dapr-system", "The Kubernetes namespace to uninstall Dapr from")
 	UninstallCmd.Flags().BoolP("help", "h", false, "Print this help message")
-	UninstallCmd.Flags().StringVarP(&uninstallContainerRuntime, "container-runtime", "", "docker", "The container runtime to use. Supported values are docker (default) and podman")
+	UninstallCmd.Flags().StringVarP(&uninstallContainerRuntime, "container-runtime", "", "docker", "The container runtime to use. Supported values are docker (default),  podman and containerd")
 	RootCmd.AddCommand(UninstallCmd)
 }

pkg/standalone/standalone.go

@@ -161,9 +161,8 @@ func Init(runtimeVersion, dashboardVersion string, dockerNetwork string, slimMod
 	fromDir = strings.TrimSpace(fromDir)
 	setAirGapInit(fromDir)
 	if !slimMode {
-		// If --slim installation is not requested, check if docker is installed.
-		conatinerRuntimeAvailable := utils.IsDockerInstalled() || utils.IsPodmanInstalled()
-		if !conatinerRuntimeAvailable {
+		// If --slim installation is not requested, check if docker, podman or containerd is installed.
+		if !utils.ContainerRuntimeAvailable(containerRuntime) {
 			return fmt.Errorf("could not connect to %s. %s may not be installed or running", containerRuntime, containerRuntime)
 		}
 
@@ -363,10 +362,8 @@ func runZipkin(wg *sync.WaitGroup, errorChan chan<- error, info initInfo) {
 		)
 
 		if info.dockerNetwork != "" {
-			args = append(
-				args,
-				"--network", info.dockerNetwork,
-				"--network-alias", DaprZipkinContainerName)
+			networks := withContainerNetwork(info.containerRuntime, info.dockerNetwork, DaprZipkinContainerName)
+			args = append(args, networks...)
 		} else {
 			args = append(
 				args,
@@ -430,10 +427,8 @@ func runRedis(wg *sync.WaitGroup, errorChan chan<- error, info initInfo) {
 		)
 
 		if info.dockerNetwork != "" {
-			args = append(
-				args,
-				"--network", info.dockerNetwork,
-				"--network-alias", DaprRedisContainerName)
+			networks := withContainerNetwork(info.containerRuntime, info.dockerNetwork, DaprRedisContainerName)
+			args = append(args, networks...)
 		} else {
 			args = append(
 				args,
@@ -510,9 +505,8 @@ func runPlacementService(wg *sync.WaitGroup, errorChan chan<- error, info initIn
 	}
 
 	if info.dockerNetwork != "" {
-		args = append(args,
-			"--network", info.dockerNetwork,
-			"--network-alias", DaprPlacementContainerName)
+		networks := withContainerNetwork(info.containerRuntime, info.dockerNetwork, DaprPlacementContainerName)
+		args = append(args, networks...)
 	} else {
 		osPort := 50005
 		if runtime.GOOS == daprWindowsOS {
@@ -1011,6 +1005,19 @@ func createDefaultConfiguration(zipkinHost, filePath string) error {
 	return err
 }
 
+// withContainerNetwork connect a container to a network.
+// Network alias is now only parsed by docker,
+// `podman` is only compatible with docker commands
+// and does not really implement this feature.
+// `containerd` does not support network alias.
+func withContainerNetwork(containerCmd, network, containerName string) []string {
+	networks := []string{"--network", network}
+	if utils.GetContainerRuntimeCmd(containerCmd) == string(utils.DOCKER) {
+		networks = append(networks, "--network-alias", containerName)
+	}
+	return networks
+}
+
 func checkAndOverWriteFile(filePath string, b []byte) error {
 	_, err := os.Stat(filePath)
 	if os.IsNotExist(err) {

pkg/standalone/uninstall.go

@@ -90,11 +90,9 @@ func Uninstall(uninstallAll bool, dockerNetwork string, containerRuntime string,
 		print.WarningStatusEvent(os.Stdout, "WARNING: could not delete dapr bin dir: %s", daprBinDir)
 	}
 
-	containerRuntime = strings.TrimSpace(containerRuntime)
-	runtimeCmd := utils.GetContainerRuntimeCmd(containerRuntime)
-	conatinerRuntimeAvailable := false
-	conatinerRuntimeAvailable = utils.IsDockerInstalled() || utils.IsPodmanInstalled()
-	if conatinerRuntimeAvailable {
+	if utils.ContainerRuntimeAvailable(containerRuntime) {
+		containerRuntime = strings.TrimSpace(containerRuntime)
+		runtimeCmd := utils.GetContainerRuntimeCmd(containerRuntime)
 		containerErrs = removeContainers(uninstallPlacementContainer, uninstallAll, dockerNetwork, runtimeCmd)
 	}
 

utils/utils.go

@@ -38,30 +38,38 @@ import (
 type ContainerRuntime string
 
 const (
-	DOCKER ContainerRuntime = "docker"
-	PODMAN ContainerRuntime = "podman"
+	DOCKER     ContainerRuntime = "docker"
+	PODMAN     ContainerRuntime = "podman"
+	CONTAINERD ContainerRuntime = "containerd"
+
+	NERDCTL = "nerdctl"
 
 	marinerImageVariantName = "mariner"
 
 	socketFormat = "%s/dapr-%s-%s.socket"
 )
 
 // IsValidContainerRuntime checks if the input is a valid container runtime.
-// Valid container runtimes are docker and podman.
+// Valid container runtimes are docker and podman and containerd.
 func IsValidContainerRuntime(containerRuntime string) bool {
 	containerRuntime = strings.TrimSpace(containerRuntime)
-	return containerRuntime == string(DOCKER) || containerRuntime == string(PODMAN)
+	return containerRuntime == string(DOCKER) || containerRuntime == string(PODMAN) || containerRuntime == string(CONTAINERD)
 }
 
 // GetContainerRuntimeCmd returns a valid container runtime to be used by CLI operations.
-// If the input is a valid container runtime, it is returned as is.
+// If the input is a valid container runtime, it is returned client tool.
 // Otherwise the default container runtime, docker, is returned.
 func GetContainerRuntimeCmd(containerRuntime string) string {
-	if IsValidContainerRuntime(containerRuntime) {
-		return strings.TrimSpace(containerRuntime)
+	switch strings.TrimSpace(containerRuntime) {
+	case string(CONTAINERD):
+		// containerd runtime use nerdctl tool.
+		return NERDCTL
+	case string(PODMAN):
+		return string(PODMAN)
+	default:
+		// Default to docker.
+		return string(DOCKER)
 	}
-	// Default to docker.
-	return string(DOCKER)
 }
 
 // Contains returns true if vs contains x.
@@ -188,6 +196,27 @@ func IsPodmanInstalled() bool {
 	return true
 }
 
+// IsContainerdInstalled checks whether nerdctl and containerd is installed/running.
+func IsContainerdInstalled() bool {
+	if _, err := RunCmdAndWait("nerdctl", "info"); err != nil {
+		print.FailureStatusEvent(os.Stderr, err.Error())
+		return false
+	}
+	return true
+}
+
+func ContainerRuntimeAvailable(containerRuntime string) bool {
+	containerRuntime = strings.TrimSpace(containerRuntime)
+	switch ContainerRuntime(containerRuntime) {
+	case PODMAN:
+		return IsPodmanInstalled()
+	case CONTAINERD:
+		return IsContainerdInstalled()
+	default:
+		return IsDockerInstalled()
+	}
+}
+
 // IsDaprListeningOnPort checks if Dapr is litening to a given port.
 func IsDaprListeningOnPort(port int, timeout time.Duration) error {
 	start := time.Now()

utils/utils_test.go

@@ -30,6 +30,18 @@ func TestContainerRuntimeUtils(t *testing.T) {
 		expected string
 		valid    bool
 	}{
+		{
+			name:     "containerd runtime is valid, and nerdctl is returned",
+			input:    "containerd",
+			expected: "nerdctl",
+			valid:    true,
+		},
+		{
+			name:     "containerd runtime with extra spaces is valid, and nerdctl is returned",
+			input:    "  containerd  ",
+			expected: "nerdctl",
+			valid:    true,
+		},
 		{
 			name:     "podman runtime is valid, and is returned as is",
 			input:    "podman",
@@ -176,7 +188,9 @@ func TestGetVersionAndImageVariant(t *testing.T) {
 
 func TestValidateFilePaths(t *testing.T) {
 	dirName := createTempDir(t, "test_validate_paths")
-	defer cleanupTempDir(t, dirName)
+	t.Cleanup(func() {
+		cleanupTempDir(t, dirName)
+	})
 	validFile := createTempFile(t, dirName, "valid_test_file.yaml")
 	testcases := []struct {
 		name        string
@@ -254,7 +268,9 @@ func TestGetAbsPath(t *testing.T) {
 
 func TestReadFile(t *testing.T) {
 	fileName := createTempFile(t, "", "test_read_file")
-	defer cleanupTempDir(t, fileName)
+	t.Cleanup(func() {
+		cleanupTempDir(t, fileName)
+	})
 	testcases := []struct {
 		name        string
 		input       string