Add support for printing published docker image metadata to a file (#17)

Co-authored-by: beniamin.calota <beniamin.calota@emag.ro>

.drone.yml

@@ -14,30 +14,102 @@ steps:
   settings:
     repo: plugins/kaniko
     auto_tag: true
+    auto_tag_suffix: linux-amd64
+    daemon_off: false
     dockerfile: docker/docker/Dockerfile.linux.amd64
     username:
       from_secret: docker_username
     password:
       from_secret: docker_password
+  when:
+    event:
+      exclude:
+      - pull_request
 
 - name: gcr
   image: plugins/docker
   settings:
     repo: plugins/kaniko-gcr
     auto_tag: true
+    auto_tag_suffix: linux-amd64
+    daemon_off: false
     dockerfile: docker/gcr/Dockerfile.linux.amd64
     username:
       from_secret: docker_username
     password:
       from_secret: docker_password
+  when:
+    event:
+      exclude:
+      - pull_request
 
 - name: ecr
   image: plugins/docker
   settings:
     repo: plugins/kaniko-ecr
     auto_tag: true
+    auto_tag_suffix: linux-amd64
+    daemon_off: false
     dockerfile: docker/ecr/Dockerfile.linux.amd64
     username:
       from_secret: docker_username
     password:
       from_secret: docker_password
+  when:
+    event:
+      exclude:
+      - pull_request
+
+---
+kind: pipeline
+type: docker
+name: notifications-docker
+
+platform:
+  os: linux
+  arch: amd64
+
+steps:
+- name: manifest-docker
+  pull: always
+  image: plugins/manifest
+  settings:
+    auto_tag: true
+    ignore_missing: true
+    password:
+      from_secret: docker_password
+    spec: docker/docker/manifest.tmpl
+    username:
+      from_secret: docker_username
+
+- name: manifest-gcr
+  pull: always
+  image: plugins/manifest
+  settings:
+    auto_tag: true
+    ignore_missing: true
+    password:
+      from_secret: docker_password
+    spec: docker/gcr/manifest.tmpl
+    username:
+      from_secret: docker_username
+
+- name: manifest-ecr
+  pull: always
+  image: plugins/manifest
+  settings:
+    auto_tag: true
+    ignore_missing: true
+    password:
+      from_secret: docker_password
+    spec: docker/ecr/manifest.tmpl
+    username:
+      from_secret: docker_username
+
+trigger:
+  ref:
+  - refs/heads/main
+  - "refs/tags/**"
+
+depends_on:
+- default

README.md

@@ -49,5 +49,5 @@ docker run --rm \
     -e PLUGIN_PASSWORD=bar \
     -v $(pwd):/drone \
     -w /drone \
-    plugins/kaniko-docker
+    plugins/kaniko:linux-amd64
 ```

cmd/artifact/artifact.go

@@ -0,0 +1,76 @@
+package artifact
+
+import (
+	"encoding/json"
+	"fmt"
+	"io/ioutil"
+	"os"
+	"path/filepath"
+
+	"github.com/pkg/errors"
+)
+
+const (
+	dockerArtifactV1 string = "docker/v1"
+)
+
+type RegistryTypeEnum string
+
+const (
+	Docker RegistryTypeEnum = "Docker"
+	ECR    RegistryTypeEnum = "ECR"
+	GCR    RegistryTypeEnum = "GCR"
+)
+
+type (
+	Image struct {
+		Image  string `json:"image"`
+		Digest string `json:"digest"`
+	}
+	Data struct {
+		RegistryType RegistryTypeEnum `json:"registryType"`
+		RegistryUrl  string           `json:"registryUrl"`
+		Images       []Image          `json:"images"`
+	}
+	DockerArtifact struct {
+		Kind string `json:"kind"`
+		Data Data   `json:"data"`
+	}
+)
+
+func WritePluginArtifactFile(registryType RegistryTypeEnum, artifactFilePath, registryUrl, imageName, digest string, tags []string) error {
+	var images []Image
+	for _, tag := range tags {
+		images = append(images, Image{
+			Image:  fmt.Sprintf("%s:%s", imageName, tag),
+			Digest: digest,
+		})
+	}
+	data := Data{
+		RegistryType: registryType,
+		RegistryUrl:  registryUrl,
+		Images:       images,
+	}
+
+	dockerArtifact := DockerArtifact{
+		Kind: dockerArtifactV1,
+		Data: data,
+	}
+
+	b, err := json.MarshalIndent(dockerArtifact, "", "\t")
+	if err != nil {
+		return errors.Wrap(err, fmt.Sprintf("failed to marshal output %+v", dockerArtifact))
+	}
+
+	dir := filepath.Dir(artifactFilePath)
+	err = os.MkdirAll(dir, 0644)
+	if err != nil {
+		return errors.Wrap(err, fmt.Sprintf("failed to create %s directory for artifact file", dir))
+	}
+
+	err = ioutil.WriteFile(artifactFilePath, b, 0644)
+	if err != nil {
+		return errors.Wrap(err, fmt.Sprintf("failed to write artifact to artifact file %s", artifactFilePath))
+	}
+	return nil
+}

cmd/artifact/artifact.json

@@ -0,0 +1,17 @@
+{
+	"kind": "docker/v1",
+	"data": {
+		"registryType": "Docker",
+		"registryUrl": "https://index.docker.io/",
+		"images": [
+			{
+				"image": "image:a1",
+				"digest": "sha256:22332233"
+			},
+			{
+				"image": "image:latest",
+				"digest": "sha256:22332233"
+			}
+		]
+	}
+}

cmd/artifact/artifact_test.go

@@ -0,0 +1,38 @@
+package artifact
+
+import (
+	"io/ioutil"
+	"testing"
+)
+
+func TestWritePluginArtifactFile(t *testing.T) {
+
+	testFile := t.TempDir() + "got.json"
+
+	err := WritePluginArtifactFile(Docker, testFile, "https://index.docker.io/", "image", "sha256:22332233", []string{"a1", "latest"})
+	if err != nil {
+		t.Error(err)
+		t.FailNow()
+	}
+
+	gotBytes, err := ioutil.ReadFile(testFile)
+	if err != nil {
+		t.Error(err)
+		t.FailNow()
+	}
+
+	wantBytes, err := ioutil.ReadFile("./artifact.json")
+	if err != nil {
+		t.Error(err)
+		t.FailNow()
+	}
+
+	got := string(gotBytes)
+	want := string(wantBytes)
+
+	if got != want {
+		t.Logf("got:%s", got)
+		t.Logf("want:%s", want)
+		t.FailNow()
+	}
+}

cmd/kaniko-docker/main.go

@@ -12,6 +12,7 @@ import (
 	"github.com/urfave/cli"
 
 	kaniko "github.com/drone/drone-kaniko"
+	"github.com/drone/drone-kaniko/cmd/artifact"
 )
 
 const (
@@ -21,6 +22,8 @@ const (
 
 	v1Registry string = "https://index.docker.io/v1/" // Default registry
 	v2Registry string = "https://index.docker.io/v2/" // v2 registry is not supported
+
+	defaultDigestFile string = "/kaniko/digest-file"
 )
 
 var (
@@ -94,6 +97,36 @@ func main() {
 			Usage:  "docker password",
 			EnvVar: "PLUGIN_PASSWORD",
 		},
+		cli.BoolFlag{
+			Name:   "skip-tls-verify",
+			Usage:  "Skip registry tls verify",
+			EnvVar: "PLUGIN_SKIP_TLS_VERIFY",
+		},
+		cli.StringFlag{
+			Name:   "snapshot-mode",
+			Usage:  "Specify one of full, redo or time as snapshot mode",
+			EnvVar: "PLUGIN_SNAPSHOT_MODE",
+		},
+		cli.BoolFlag{
+			Name:   "enable-cache",
+			Usage:  "Set this flag to opt into caching with kaniko",
+			EnvVar: "PLUGIN_ENABLE_CACHE",
+		},
+		cli.StringFlag{
+			Name:   "cache-repo",
+			Usage:  "Remote repository that will be used to store cached layers. enable-cache needs to be set to use this flag",
+			EnvVar: "PLUGIN_CACHE_REPO",
+		},
+		cli.IntFlag{
+			Name:   "cache-ttl",
+			Usage:  "Cache timeout in hours. Defaults to two weeks.",
+			EnvVar: "PLUGIN_CACHE_TTL",
+		},
+		cli.StringFlag{
+			Name:   "artifact-file",
+			Usage:  "Artifact file location that will be generated by the plugin. This file will include information of docker images that are uploaded by the plugin.",
+			EnvVar: "PLUGIN_ARTIFACT_FILE",
+		},
 	}
 
 	if err := app.Run(os.Args); err != nil {
@@ -109,13 +142,26 @@ func run(c *cli.Context) error {
 
 	plugin := kaniko.Plugin{
 		Build: kaniko.Build{
-			Dockerfile: c.String("dockerfile"),
+			Dockerfile:    c.String("dockerfile"),
-			Context:    c.String("context"),
+			Context:       c.String("context"),
-			Tags:       c.StringSlice("tags"),
+			Tags:          c.StringSlice("tags"),
-			Args:       c.StringSlice("args"),
+			Args:          c.StringSlice("args"),
-			Target:     c.String("target"),
+			Target:        c.String("target"),
-			Repo:       c.String("repo"),
+			Repo:          c.String("repo"),
-			Labels:     c.StringSlice("custom-labels"),
+			Labels:        c.StringSlice("custom-labels"),
+			SkipTlsVerify: c.Bool("skip-tls-verify"),
+			SnapshotMode:  c.String("snapshot-mode"),
+			EnableCache:   c.Bool("enable-cache"),
+			CacheRepo:     c.String("cache-repo"),
+			CacheTTL:      c.Int("cache-ttl"),
+			DigestFile:    defaultDigestFile,
+		},
+		Artifact: kaniko.Artifact{
+			Tags:         c.StringSlice("tags"),
+			Repo:         c.String("repo"),
+			Registry:     c.String("registry"),
+			ArtifactFile: c.String("artifact-file"),
+			RegistryType: artifact.Docker,
 		},
 	}
 	return plugin.Exec()

cmd/kaniko-ecr/main.go

@@ -11,12 +11,15 @@ import (
 	"github.com/urfave/cli"
 
 	kaniko "github.com/drone/drone-kaniko"
+	"github.com/drone/drone-kaniko/cmd/artifact"
 )
 
 const (
 	accessKeyEnv     string = "AWS_ACCESS_KEY_ID"
 	secretKeyEnv     string = "AWS_SECRET_ACCESS_KEY"
 	dockerConfigPath string = "/kaniko/.docker/config.json"
+
+	defaultDigestFile string = "/kaniko/digest-file"
 )
 
 var (
@@ -89,6 +92,31 @@ func main() {
 			Usage:  "ECR secret key",
 			EnvVar: "PLUGIN_SECRET_KEY",
 		},
+		cli.StringFlag{
+			Name:   "snapshot-mode",
+			Usage:  "Specify one of full, redo or time as snapshot mode",
+			EnvVar: "PLUGIN_SNAPSHOT_MODE",
+		},
+		cli.BoolFlag{
+			Name:   "enable-cache",
+			Usage:  "Set this flag to opt into caching with kaniko",
+			EnvVar: "PLUGIN_ENABLE_CACHE",
+		},
+		cli.StringFlag{
+			Name:   "cache-repo",
+			Usage:  "Remote repository that will be used to store cached layers. Cache repo should be present in specified registry. enable-cache needs to be set to use this flag",
+			EnvVar: "PLUGIN_CACHE_REPO",
+		},
+		cli.IntFlag{
+			Name:   "cache-ttl",
+			Usage:  "Cache timeout in hours. Defaults to two weeks.",
+			EnvVar: "PLUGIN_CACHE_TTL",
+		},
+		cli.StringFlag{
+			Name:   "artifact-file",
+			Usage:  "Artifact file location that will be generated by the plugin. This file will include information of docker images that are uploaded by the plugin.",
+			EnvVar: "PLUGIN_ARTIFACT_FILE",
+		},
 	}
 
 	if err := app.Run(os.Args); err != nil {
@@ -104,13 +132,25 @@ func run(c *cli.Context) error {
 
 	plugin := kaniko.Plugin{
 		Build: kaniko.Build{
-			Dockerfile: c.String("dockerfile"),
+			Dockerfile:   c.String("dockerfile"),
-			Context:    c.String("context"),
+			Context:      c.String("context"),
-			Tags:       c.StringSlice("tags"),
+			Tags:         c.StringSlice("tags"),
-			Args:       c.StringSlice("args"),
+			Args:         c.StringSlice("args"),
-			Target:     c.String("target"),
+			Target:       c.String("target"),
-			Repo:       fmt.Sprintf("%s/%s", c.String("registry"), c.String("repo")),
+			Repo:         fmt.Sprintf("%s/%s", c.String("registry"), c.String("repo")),
-			Labels:     c.StringSlice("custom-labels"),
+			Labels:       c.StringSlice("custom-labels"),
+			SnapshotMode: c.String("snapshot-mode"),
+			EnableCache:  c.Bool("enable-cache"),
+			CacheRepo:    fmt.Sprintf("%s/%s", c.String("registry"), c.String("cache-repo")),
+			CacheTTL:     c.Int("cache-ttl"),
+			DigestFile:   defaultDigestFile,
+		},
+		Artifact: kaniko.Artifact{
+			Tags:         c.StringSlice("tags"),
+			Repo:         c.String("repo"),
+			Registry:     c.String("registry"),
+			ArtifactFile: c.String("artifact-file"),
+			RegistryType: artifact.ECR,
 		},
 	}
 	return plugin.Exec()
@@ -118,7 +158,7 @@ func run(c *cli.Context) error {
 
 func setupECRAuth(accessKey, secretKey, registry string) error {
 	if registry == "" {
-		return fmt.Errorf("Registry must be specified")
+		return fmt.Errorf("registry must be specified")
 	}
 
 	// If IAM role is used, access key & secret key are not required
@@ -134,7 +174,7 @@ func setupECRAuth(accessKey, secretKey, registry string) error {
 		}
 	}
 
-	jsonBytes := []byte(fmt.Sprintf(`{"credStore": "ecr-login", "credHelpers": {"%s": "ecr-login"}}`, registry))
+	jsonBytes := []byte(fmt.Sprintf(`{"credStore": "ecr-login", "credHelpers": {"public.ecr.aws": "ecr-login", "%s": "ecr-login"}}`, registry))
 	err := ioutil.WriteFile(dockerConfigPath, jsonBytes, 0644)
 	if err != nil {
 		return errors.Wrap(err, "failed to create docker config file")

cmd/kaniko-gcr/main.go

@@ -11,12 +11,15 @@ import (
 	"github.com/urfave/cli"
 
 	kaniko "github.com/drone/drone-kaniko"
+	"github.com/drone/drone-kaniko/cmd/artifact"
 )
 
 const (
 	// GCR JSON key file path
 	gcrKeyPath     string = "/kaniko/config.json"
 	gcrEnvVariable string = "GOOGLE_APPLICATION_CREDENTIALS"
+
+	defaultDigestFile string = "/kaniko/digest-file"
 )
 
 var (
@@ -85,6 +88,31 @@ func main() {
 			Usage:  "docker username",
 			EnvVar: "PLUGIN_JSON_KEY",
 		},
+		cli.StringFlag{
+			Name:   "snapshot-mode",
+			Usage:  "Specify one of full, redo or time as snapshot mode",
+			EnvVar: "PLUGIN_SNAPSHOT_MODE",
+		},
+		cli.BoolFlag{
+			Name:   "enable-cache",
+			Usage:  "Set this flag to opt into caching with kaniko",
+			EnvVar: "PLUGIN_ENABLE_CACHE",
+		},
+		cli.StringFlag{
+			Name:   "cache-repo",
+			Usage:  "Remote repository that will be used to store cached layers. Cache repo should be present in specified registry. enable-cache needs to be set to use this flag",
+			EnvVar: "PLUGIN_CACHE_REPO",
+		},
+		cli.IntFlag{
+			Name:   "cache-ttl",
+			Usage:  "Cache timeout in hours. Defaults to two weeks.",
+			EnvVar: "PLUGIN_CACHE_TTL",
+		},
+		cli.StringFlag{
+			Name:   "artifact-file",
+			Usage:  "Artifact file location that will be generated by the plugin. This file will include information of docker images that are uploaded by the plugin.",
+			EnvVar: "PLUGIN_ARTIFACT_FILE",
+		},
 	}
 
 	if err := app.Run(os.Args); err != nil {
@@ -104,13 +132,25 @@ func run(c *cli.Context) error {
 
 	plugin := kaniko.Plugin{
 		Build: kaniko.Build{
-			Dockerfile: c.String("dockerfile"),
+			Dockerfile:   c.String("dockerfile"),
-			Context:    c.String("context"),
+			Context:      c.String("context"),
-			Tags:       c.StringSlice("tags"),
+			Tags:         c.StringSlice("tags"),
-			Args:       c.StringSlice("args"),
+			Args:         c.StringSlice("args"),
-			Target:     c.String("target"),
+			Target:       c.String("target"),
-			Repo:       fmt.Sprintf("%s/%s", c.String("registry"), c.String("repo")),
+			Repo:         fmt.Sprintf("%s/%s", c.String("registry"), c.String("repo")),
-			Labels:     c.StringSlice("custom-labels"),
+			Labels:       c.StringSlice("custom-labels"),
+			SnapshotMode: c.String("snapshot-mode"),
+			EnableCache:  c.Bool("enable-cache"),
+			CacheRepo:    fmt.Sprintf("%s/%s", c.String("registry"), c.String("cache-repo")),
+			CacheTTL:     c.Int("cache-ttl"),
+			DigestFile:   defaultDigestFile,
+		},
+		Artifact: kaniko.Artifact{
+			Tags:         c.StringSlice("tags"),
+			Repo:         c.String("repo"),
+			Registry:     c.String("registry"),
+			ArtifactFile: c.String("artifact-file"),
+			RegistryType: artifact.GCR,
 		},
 	}
 	return plugin.Exec()

docker/docker/Dockerfile.linux.amd64

@@ -1,4 +1,4 @@
-FROM gcr.io/kaniko-project/executor:v1.3.0
+FROM gcr.io/kaniko-project/executor:v1.5.2
 
 ADD release/linux/amd64/kaniko-docker /kaniko/
 ENTRYPOINT ["/kaniko/kaniko-docker"]

docker/docker/Dockerfile.linux.arm64

@@ -1,4 +1,4 @@
-FROM gcr.io/kaniko-project/executor:arm64-v1.3.0
+FROM gcr.io/kaniko-project/executor:arm64-v1.5.2
 
 ENV HOME /root
 ENV USER root

docker/ecr/Dockerfile.linux.amd64

@@ -1,4 +1,4 @@
-FROM gcr.io/kaniko-project/executor:v1.3.0
+FROM gcr.io/kaniko-project/executor:v1.5.2
 
 ADD release/linux/amd64/kaniko-ecr /kaniko/
 ENTRYPOINT ["/kaniko/kaniko-ecr"]

docker/ecr/Dockerfile.linux.arm64

@@ -1,4 +1,4 @@
-FROM gcr.io/kaniko-project/executor:arm64-v1.3.0
+FROM gcr.io/kaniko-project/executor:arm64-v1.5.2
 
 ENV HOME /root
 ENV USER root

docker/gcr/Dockerfile.linux.amd64

@@ -1,4 +1,4 @@
-FROM gcr.io/kaniko-project/executor:v1.3.0
+FROM gcr.io/kaniko-project/executor:v1.5.2
 
 ADD release/linux/amd64/kaniko-gcr /kaniko/
-ENTRYPOINT ["/kaniko/kaniko-gcr"]
+ENTRYPOINT ["/kaniko/kaniko-gcr"]

docker/gcr/Dockerfile.linux.arm64

@@ -1,7 +1,7 @@
-FROM gcr.io/kaniko-project/executor:arm64-v1.3.0
+FROM gcr.io/kaniko-project/executor:arm64-v1.5.2
 
 ENV HOME /root
 ENV USER root
 
 ADD release/linux/arm64/kaniko-gcr /kaniko/
-ENTRYPOINT ["/kaniko/kaniko-gcr"]
+ENTRYPOINT ["/kaniko/kaniko-gcr"]

kaniko.go

@@ -2,26 +2,45 @@ package kaniko
 
 import (
 	"fmt"
+	"io/ioutil"
 	"os"
 	"os/exec"
 	"strings"
+
+	"github.com/drone/drone-kaniko/cmd/artifact"
 )
 
 type (
 	// Build defines Docker build parameters.
 	Build struct {
-		Dockerfile string   // Docker build Dockerfile
+		Dockerfile    string   // Docker build Dockerfile
-		Context    string   // Docker build context
+		Context       string   // Docker build context
-		Tags       []string // Docker build tags
+		Tags          []string // Docker build tags
-		Args       []string // Docker build args
+		Args          []string // Docker build args
-		Target     string   // Docker build target
+		Target        string   // Docker build target
-		Repo       string   // Docker build repository
+		Repo          string   // Docker build repository
-		Labels     []string // Label map
+		Labels        []string // Label map
+		SkipTlsVerify bool     // Docker skip tls certificate verify for registry
+		SnapshotMode  string   // Kaniko snapshot mode
+		EnableCache   bool     // Whether to enable kaniko cache
+		CacheRepo     string   // Remote repository that will be used to store cached layers
+		CacheTTL      int      // Cache timeout in hours
+		DigestFile    string   // Digest file location
+	}
+	// Artifact defines content of artifact file
+	Artifact struct {
+		Tags         []string                  // Docker artifact tags
+		Repo         string                    // Docker artifact repository
+		Registry     string                    // Docker artifact registry
+		RegistryType artifact.RegistryTypeEnum // Rocker artifact registry type
+		ArtifactFile string                    // Artifact file location
+
 	}
 
 	// Plugin defines the Docker plugin parameters.
 	Plugin struct {
-		Build Build // Docker build configuration
+		Build    Build    // Docker build configuration
+		Artifact Artifact // Artifact file content
 	}
 )
 
@@ -57,13 +76,52 @@ func (p Plugin) Exec() error {
 		cmdArgs = append(cmdArgs, fmt.Sprintf("--target=%s", p.Build.Target))
 	}
 
+	if p.Build.SkipTlsVerify {
+		cmdArgs = append(cmdArgs, fmt.Sprintf("--skip-tls-verify=true"))
+	}
+
+	if p.Build.SnapshotMode != "" {
+		cmdArgs = append(cmdArgs, fmt.Sprintf("--snapshotMode=%s", p.Build.SnapshotMode))
+	}
+
+	if p.Build.EnableCache == true {
+		cmdArgs = append(cmdArgs, fmt.Sprintf("--cache=true"))
+	}
+
+	if p.Build.CacheRepo != "" {
+		cmdArgs = append(cmdArgs, fmt.Sprintf("--cache-repo=%s", p.Build.CacheRepo))
+	}
+
+	if p.Build.CacheTTL != 0 {
+		cmdArgs = append(cmdArgs, fmt.Sprintf("--cache-ttl=%d", p.Build.CacheTTL))
+	}
+
+	if p.Build.DigestFile != "" {
+		cmdArgs = append(cmdArgs, fmt.Sprintf("--digest-file=%s", p.Build.DigestFile))
+	}
+
 	cmd := exec.Command("/kaniko/executor", cmdArgs...)
 	cmd.Stdout = os.Stdout
 	cmd.Stderr = os.Stderr
 	trace(cmd)
 
 	err := cmd.Run()
-	return err
+	if err != nil {
+		return err
+	}
+
+	if p.Build.DigestFile != "" && p.Artifact.ArtifactFile != "" {
+		content, err := ioutil.ReadFile(p.Build.DigestFile)
+		if err != nil {
+			fmt.Fprintf(os.Stderr, "failed to read digest file contents at path: %s with error: %s\n", p.Build.DigestFile, err)
+		}
+		err = artifact.WritePluginArtifactFile(p.Artifact.RegistryType, p.Artifact.ArtifactFile, p.Artifact.Registry, p.Artifact.Repo, string(content), p.Artifact.Tags)
+		if err != nil {
+			fmt.Fprintf(os.Stderr, "failed to write plugin artifact file at path: %s with error: %s\n", p.Artifact.ArtifactFile, err)
+		}
+	}
+
+	return nil
 }
 
 // trace writes each command to stdout with the command wrapped in an xml