pull docker images from ghcr and fallback to docker if necessary (#926)

* pulling images from ghcr by default

Signed-off-by: Pravin Pushkar <[email protected]>

* fixing self_hosted e2e tests

Signed-off-by: Pravin Pushkar <[email protected]>

* default all tests with ghcr and removing tests for --image-registry

Signed-off-by: Pravin Pushkar <[email protected]>

* adding tests for dockerhub install and custom registry

Signed-off-by: Pravin Pushkar <[email protected]>

* fixing review comments

Signed-off-by: Pravin Pushkar <[email protected]>

* Fixing review comments

Signed-off-by: Pravin Pushkar <[email protected]>

* Review comments fix

Signed-off-by: Pravin Pushkar <[email protected]>

* Some refactoring

Signed-off-by: Pravin Pushkar <[email protected]>

* fix for review comments

Signed-off-by: Pravin Pushkar <[email protected]>

Author: pravinpushkar

.github/workflows/self_hosted_e2e.yaml

@@ -20,6 +20,7 @@ on:
       - release-*
   schedule:
     - cron: '0 */3 * * *'
+    - cron: '0 0 * * *'
   pull_request:
     branches:
       - master
@@ -37,7 +38,6 @@ jobs:
       ARCHIVE_OUTDIR: dist/archives
       DAPR_RUNTIME_VERSION: "1.6.0"
       DAPR_DASHBOARD_VERSION: 0.9.0
-      CUSTOM_IMAGE_REGISTRY: docker.io
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest]
@@ -76,7 +76,19 @@ jobs:
           echo "DAPR_DASHBOARD_VERSION=$DASHBOARD_VERSION" >> $GITHUB_ENV
           echo "Found $DASHBOARD_VERSION"
         shell: bash
-      - name: Run E2E tests 
+      - name: Run E2E tests with GHCR
+        if: github.event.schedule != '0 0 * * *'
+        run: |
+          export TEST_OUTPUT_FILE=$GITHUB_WORKSPACE/test-e2e-standalone.json
+          echo "TEST_OUTPUT_FILE=$TEST_OUTPUT_FILE" >> $GITHUB_ENV
+          export GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}
+          make e2e-build-run-sh
+        shell: bash
+      - name: Run E2E tests with Docker hub
+        # only runs once in a day
+        if: github.event.schedule == '0 0 * * *'
+        env:
+          DAPR_DEFAULT_IMAGE_REGISTRY: dockerhub
         run: |
           export TEST_OUTPUT_FILE=$GITHUB_WORKSPACE/test-e2e-standalone.json
           echo "TEST_OUTPUT_FILE=$TEST_OUTPUT_FILE" >> $GITHUB_ENV

README.md

@@ -129,10 +129,12 @@ Runtime version: v1.0.0
 ```
 #### Install by providing a docker container registry url
 
-You can install Dapr runtime by pulling docker images from a given registry url by using `--image-repository` flag.
+You can install Dapr runtime by pulling docker images from a given private registry uri by using `--image-registry` flag.
+> Note: This command expects that images have been hosted like example.io/<username>/dapr/dapr:<tag>, example.io/<username>/dapr/3rdparty/redis:<tag>, example.io/<username>/dapr/3rdparty/zipkin:<tag>
 
 ```bash
-$ dapr init --image-repository <registry-url>
+# Example of pulling images from a private registry.
+$ dapr init --image-registry example.io/<username>
 ```
 
 #### Install to a specific Docker network

cmd/init.go

@@ -46,14 +46,14 @@ var InitCmd = &cobra.Command{
 	Short: "Install Dapr on supported hosting platforms. Supported platforms: Kubernetes and self-hosted",
 	PreRun: func(cmd *cobra.Command, args []string) {
 		viper.BindPFlag("network", cmd.Flags().Lookup("network"))
-		viper.BindPFlag("image-repository", cmd.Flags().Lookup("image-repository"))
+		viper.BindPFlag("image-registry", cmd.Flags().Lookup("image-registry"))
 	},
 	Example: `
 # Initialize Dapr in self-hosted mode
 dapr init
 
-#Initialize Dapr in self-hosted mode with a provided docker image repository. Image looked up as <repository-url>/<image>
-dapr init --image-repository <repository-url>
+#Initialize Dapr in self-hosted mode with a provided docker image registry. Image looked up as <registry-url>/<image>
+dapr init --image-registry <registry-url>
 
 # Initialize Dapr in Kubernetes
 dapr init -k
@@ -98,15 +98,18 @@ dapr init --from-dir <path-to-directory>
 			print.SuccessStatusEvent(os.Stdout, fmt.Sprintf("Success! Dapr has been installed to namespace %s. To verify, run `dapr status -k' in your terminal. To get started, go here: https://aka.ms/dapr-getting-started", config.Namespace))
 		} else {
 			dockerNetwork := ""
-			imageRepositoryURL := ""
+			imageRegistryURL := ""
 			if !slimMode {
 				dockerNetwork = viper.GetString("network")
-				imageRepositoryURL = viper.GetString("image-repository")
+				imageRegistryURL = viper.GetString("image-registry")
 			}
 			if fromDir != "" {
 				print.WarningStatusEvent(os.Stdout, "Local bundle installation using from-dir flag is currently a preview feature.")
 			}
-			err := standalone.Init(runtimeVersion, dashboardVersion, dockerNetwork, slimMode, imageRepositoryURL, fromDir)
+			if imageRegistryURL != "" {
+				print.WarningStatusEvent(os.Stdout, "Flag --image-registry is a preview feature and is subject to change. It is only available from CLI version 1.7 onwards.")
+			}
+			err := standalone.Init(runtimeVersion, dashboardVersion, dockerNetwork, slimMode, imageRegistryURL, fromDir)
 			if err != nil {
 				print.FailureStatusEvent(os.Stderr, err.Error())
 				os.Exit(1)
@@ -142,6 +145,6 @@ func init() {
 	InitCmd.Flags().StringVarP(&fromDir, "from-dir", "", "", "Use Dapr artifacts from local directory instead of from network to 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-repository", "", "Custom/Private docker image repository url")
+	InitCmd.Flags().String("image-registry", "", "Custom/Private docker image repository url")
 	RootCmd.AddCommand(InitCmd)
 }

pkg/standalone/docker.go

@@ -127,3 +127,12 @@ func imageFileName(image string) string {
 	filename = strings.ReplaceAll(filename, ":", "-")
 	return filename
 }
+
+func TryPullImage(imageName string) bool {
+	args := []string{
+		"pull",
+		imageName,
+	}
+	_, err := utils.RunCmdAndWait("docker", args...)
+	return err == nil
+}

pkg/standalone/standalone.go

@@ -51,6 +51,13 @@ const (
 	redisDockerImageName       = "redislabs/rejson"
 	zipkinDockerImageName      = "openzipkin/zipkin"
 
+	githubContainerRegistryName = "ghcr"
+	ghcrURI                     = "ghcr.io/dapr"
+	daprGhcrImageName           = "dapr"
+	dockerContainerRegistryName = "dockerhub"
+	redisGhcrImageName          = "3rdparty/redis"
+	zipkinGhcrImageName         = "3rdparty/zipkin"
+
 	// DaprPlacementContainerName is the container name of placement service.
 	DaprPlacementContainerName = "dapr_placement"
 	// DaprRedisContainerName is the container name of redis.
@@ -64,6 +71,11 @@ const (
 	dockerImageSubDir = "docker"
 )
 
+var (
+	defaultImageRegistryName string
+	privateRegTemplateString = "%s/dapr/%s"
+)
+
 type configuration struct {
 	APIVersion string `yaml:"apiVersion"`
 	Kind       string `yaml:"kind"`
@@ -99,12 +111,12 @@ type componentMetadataItem struct {
 }
 
 type initInfo struct {
-	fromDir            string
-	slimMode           bool
-	runtimeVersion     string
-	dashboardVersion   string
-	dockerNetwork      string
-	imageRepositoryURL string
+	fromDir          string
+	slimMode         bool
+	runtimeVersion   string
+	dashboardVersion string
+	dockerNetwork    string
+	imageRegistryURL string
 }
 
 // Check if the previous version is already installed.
@@ -120,16 +132,20 @@ func isBinaryInstallationRequired(binaryFilePrefix, installDir string) (bool, er
 }
 
 // Init installs Dapr on a local machine using the supplied runtimeVersion.
-func Init(runtimeVersion, dashboardVersion string, dockerNetwork string, slimMode bool, imageRepositoryURL string, fromDir string) error {
+func Init(runtimeVersion, dashboardVersion string, dockerNetwork string, slimMode bool, imageRegistryURL string, fromDir string) error {
+	var err error
 	if !slimMode {
 		dockerInstalled := utils.IsDockerInstalled()
 		if !dockerInstalled {
 			return errors.New("could not connect to Docker. Docker may not be installed or running")
 		}
+		defaultImageRegistryName, err = utils.GetDefaultRegistry(githubContainerRegistryName, dockerContainerRegistryName)
+		if err != nil {
+			return err
+		}
 	}
 
 	if runtimeVersion == latestVersion && fromDir == "" {
-		var err error
 		runtimeVersion, err = cli_ver.GetDaprVersion()
 		if err != nil {
 			return fmt.Errorf("cannot get the latest release version: '%w'. Try specifying --runtime-version=<desired_version>", err)
@@ -139,7 +155,6 @@ func Init(runtimeVersion, dashboardVersion string, dockerNetwork string, slimMod
 	print.InfoStatusEvent(os.Stdout, "Installing runtime version %s", runtimeVersion)
 
 	if dashboardVersion == latestVersion && fromDir == "" {
-		var err error
 		dashboardVersion, err = cli_ver.GetDashboardVersion()
 		if err != nil {
 			print.WarningStatusEvent(os.Stdout, "cannot get the latest dashboard version: '%s'. Try specifying --dashboard-version=<desired_version>", err)
@@ -157,7 +172,7 @@ func Init(runtimeVersion, dashboardVersion string, dockerNetwork string, slimMod
 	}
 
 	daprBinDir := defaultDaprBinPath()
-	err := prepareDaprInstallDir(daprBinDir)
+	err = prepareDaprInstallDir(daprBinDir)
 	if err != nil {
 		return err
 	}
@@ -197,12 +212,12 @@ func Init(runtimeVersion, dashboardVersion string, dockerNetwork string, slimMod
 	}
 
 	info := initInfo{
-		fromDir:            fromDir,
-		slimMode:           slimMode,
-		runtimeVersion:     runtimeVersion,
-		dashboardVersion:   dashboardVersion,
-		dockerNetwork:      dockerNetwork,
-		imageRepositoryURL: imageRepositoryURL,
+		fromDir:          fromDir,
+		slimMode:         slimMode,
+		runtimeVersion:   runtimeVersion,
+		dashboardVersion: dashboardVersion,
+		dockerNetwork:    dockerNetwork,
+		imageRegistryURL: imageRegistryURL,
 	}
 	for _, step := range initSteps {
 		// Run init on the configurations and containers.
@@ -268,13 +283,22 @@ func runZipkin(wg *sync.WaitGroup, errorChan chan<- error, info initInfo) {
 	}
 	args := []string{}
 
+	var imageName string
+
 	if exists {
 		// do not create container again if it exists.
 		args = append(args, "start", zipkinContainerName)
 	} else {
-		imageName := zipkinDockerImageName
-		if info.imageRepositoryURL != "" {
-			imageName = fmt.Sprintf("%s/%s", info.imageRepositoryURL, imageName)
+		if info.imageRegistryURL != "" && info.imageRegistryURL != ghcrURI && info.imageRegistryURL != "docker.io" {
+			imageName = fmt.Sprintf(privateRegTemplateString, info.imageRegistryURL, zipkinGhcrImageName)
+		} else if defaultImageRegistryName == githubContainerRegistryName && info.imageRegistryURL == "" {
+			imageName = fmt.Sprintf("%s/%s", ghcrURI, zipkinGhcrImageName)
+		} else if defaultImageRegistryName == dockerContainerRegistryName && info.imageRegistryURL == "" {
+			imageName = zipkinDockerImageName
+		} else {
+			err = fmt.Errorf("either %s or Env variable %s not set properly", "--image-registry", "DAPR_DEFAULT_IMAGE_REGISTRY")
+			errorChan <- err
+			return
 		}
 
 		args = append(args,
@@ -327,13 +351,21 @@ func runRedis(wg *sync.WaitGroup, errorChan chan<- error, info initInfo) {
 	}
 	args := []string{}
 
+	var imageName string
 	if exists {
 		// do not create container again if it exists.
 		args = append(args, "start", redisContainerName)
 	} else {
-		imageName := redisDockerImageName
-		if info.imageRepositoryURL != "" {
-			imageName = fmt.Sprintf("%s/%s", info.imageRepositoryURL, imageName)
+		if info.imageRegistryURL != "" && info.imageRegistryURL != ghcrURI && info.imageRegistryURL != "docker.io" {
+			imageName = fmt.Sprintf(privateRegTemplateString, info.imageRegistryURL, redisGhcrImageName)
+		} else if defaultImageRegistryName == githubContainerRegistryName && info.imageRegistryURL == "" {
+			imageName = fmt.Sprintf("%s/%s", ghcrURI, redisGhcrImageName)
+		} else if defaultImageRegistryName == dockerContainerRegistryName && info.imageRegistryURL == "" {
+			imageName = redisDockerImageName
+		} else {
+			err = fmt.Errorf("either %s or Env variable %s not set properly", "--image-registry", "DAPR_DEFAULT_IMAGE_REGISTRY")
+			errorChan <- err
+			return
 		}
 
 		args = append(args,
@@ -378,14 +410,24 @@ func runPlacementService(wg *sync.WaitGroup, errorChan chan<- error, info initIn
 
 	placementContainerName := utils.CreateContainerName(DaprPlacementContainerName, info.dockerNetwork)
 
-	image := fmt.Sprintf("%s:%s", daprDockerImageName, info.runtimeVersion)
-	if info.imageRepositoryURL != "" {
-		image = fmt.Sprintf("%s/%s", info.imageRepositoryURL, image)
-	}
-
-	// Use only image for latest version.
-	if info.runtimeVersion == latestVersion {
-		image = daprDockerImageName
+	var image string
+
+	if info.imageRegistryURL != "" && info.imageRegistryURL != ghcrURI && info.imageRegistryURL != "docker.io" {
+		image = getPlacementImageWithTag(daprGhcrImageName, info.runtimeVersion)
+		image = fmt.Sprintf(privateRegTemplateString, info.imageRegistryURL, image)
+	} else if defaultImageRegistryName == githubContainerRegistryName && info.imageRegistryURL == "" {
+		image = getPlacementImageWithTag(daprGhcrImageName, info.runtimeVersion)
+		image = fmt.Sprintf("%s/%s", ghcrURI, image)
+		if !TryPullImage(image) {
+			print.InfoStatusEvent(os.Stdout, "Placement image not found in Github container registry, pulling it from Docker Hub")
+			image = getPlacementImageWithTag(daprDockerImageName, info.runtimeVersion)
+		}
+	} else if defaultImageRegistryName == dockerContainerRegistryName && info.imageRegistryURL == "" {
+		image = getPlacementImageWithTag(daprDockerImageName, info.runtimeVersion)
+	} else {
+		err := fmt.Errorf("either %s or Env variable %s not set properly", "--image-registry", "DAPR_DEFAULT_IMAGE_REGISTRY")
+		errorChan <- err
+		return
 	}
 
 	exists, err := confirmContainerIsRunningOrExists(placementContainerName, false)
@@ -1013,3 +1055,10 @@ func parseVersionFile(fromDir string) (string, string) {
 
 	return versions[daprRuntimeFilePrefix], versions[dashboardFilePrefix]
 }
+
+func getPlacementImageWithTag(name, version string) string {
+	if version == latestVersion {
+		return name
+	}
+	return fmt.Sprintf("%s:%s", name, version)
+}

tests/e2e/standalone/standalone_test.go

@@ -41,9 +41,8 @@ import (
 )
 
 var (
-	daprRuntimeVersion        = os.Getenv("DAPR_RUNTIME_VERSION")
-	daprDashboardVersion      = os.Getenv("DAPR_DASHBOARD_VERSION")
-	dockerImageCustomRegistry = os.Getenv("CUSTOM_IMAGE_REGISTRY")
+	daprRuntimeVersion   = os.Getenv("DAPR_RUNTIME_VERSION")
+	daprDashboardVersion = os.Getenv("DAPR_DASHBOARD_VERSION")
 )
 
 var socketCases = []string{"", "/tmp"}
@@ -57,7 +56,6 @@ func TestStandaloneInstall(t *testing.T) {
 		phase func(*testing.T)
 	}{
 		{"test install", testInstall},
-		{"test install from custom registry", testInstallWithCustomImageRegsitry},
 		{"test run log json enabled", testRunLogJSON},
 		{"test run", testRun},
 		{"test stop", testStop},
@@ -136,6 +134,22 @@ func TestNegativeScenarios(t *testing.T) {
 	})
 }
 
+func TestPrivateRegistry(t *testing.T) {
+	// Ensure a clean environment.
+	uninstall()
+
+	tests := []struct {
+		name  string
+		phase func(*testing.T)
+	}{
+		{"test install fails", testInstallWithPrivateRegsitry},
+	}
+
+	for _, tc := range tests {
+		t.Run(tc.name, tc.phase)
+	}
+}
+
 func getDaprPath() string {
 	distDir := fmt.Sprintf("%s_%s", runtime.GOOS, runtime.GOARCH)
 
@@ -195,19 +209,11 @@ func testInstall(t *testing.T) {
 	verifyArtifactsAfterInstall(t)
 }
 
-func testInstallWithCustomImageRegsitry(t *testing.T) {
-	if dockerImageCustomRegistry == "" {
-		t.Skip("Custom image registry is not set, skipping the test for now..")
-	}
-	// Uninstall the previously installed Dapr
-	uninstall()
+func testInstallWithPrivateRegsitry(t *testing.T) {
 	daprPath := getDaprPath()
-	output, err := spawn.Command(daprPath, "init", "--runtime-version", daprRuntimeVersion, "--image-repository", dockerImageCustomRegistry, "--log-as-json")
+	output, err := spawn.Command(daprPath, "init", "--runtime-version", daprRuntimeVersion, "--image-registry", "smplregistry.io/owner", "--log-as-json")
 	t.Log(output)
-	require.NoError(t, err, "init failed")
-
-	// verify all artifacts after successfull install
-	verifyArtifactsAfterInstall(t)
+	require.Error(t, err, "init failed")
 }
 
 func verifyArtifactsAfterInstall(t *testing.T) {