feat: add support for image labels

This will allow to link our packages back to the source repos.

Signed-off-by: Andrey Smirnov <[email protected]>

Author: smira

.drone.yml

@@ -1,49 +1,35 @@
 ---
 kind: pipeline
 name: default
-
-services:
-  - name: docker
-    image: docker:19.03.3-rc1-dind
-    privileged: true
-    entrypoint:
-    - dockerd
-    command:
-      - --mtu=1440
-      - --insecure-registry=registry.ci.svc:5000
-    volumes:
-      - name: docker-socket
-        path: /var/run
+type: kubernetes
 
 steps:
-  - name: fetch
-    image: docker:git
+  - name: setup-ci
+    image: autonomy/build-container:latest
     commands:
       - git fetch --tags
-    when:
-      event: tag
+      - install-ci-key
+      - setup-buildx-amd64-arm64
+    volumes:
+      - name: docker-socket
+        path: /var/run
+      - name: docker
+        path: /root/.docker/buildx
 
   - name: build-and-test
     image: autonomy/build-container:latest
     pull: always
     environment:
       PLATFORM: linux/amd64,linux/arm64
-      SSH_KEY:
-        from_secret: ssh_key
-      DOCKER_USERNAME:
-        from_secret: docker_username
-      DOCKER_PASSWORD:
-        from_secret: docker_password
+      REGISTRY: registry.dev.talos-systems.io
     commands:
-      - install-ci-key
-      - setup-buildx-amd64-arm64
-      - docker login --username "$${DOCKER_USERNAME}" --password "$${DOCKER_PASSWORD}"
-      - make # build everything
-      - make frontend PUSH=true  # push only frontend for integration tests
+      - make PUSH=true
       - make integration
     volumes:
       - name: docker-socket
         path: /var/run
+      - name: docker
+        path: /root/.docker/buildx
     when:
       event:
         include:
@@ -54,33 +40,35 @@ steps:
     pull: always
     environment:
       PLATFORM: linux/amd64,linux/arm64
-      BUILDKIT_HOST: ${BUILDKIT_HOST=tcp://buildkitd.ci.svc:1234}
-      SSH_KEY:
-        from_secret: ssh_key
-      DOCKER_USERNAME:
-        from_secret: docker_username
-      DOCKER_PASSWORD:
-        from_secret: docker_password
+      GHCR_USERNAME:
+        from_secret: ghcr_username
+      GHCR_PASSWORD:
+        from_secret: ghcr_token
     commands:
-      - install-ci-key
-      - setup-buildx-amd64-arm64
-      - docker login --username "$${DOCKER_USERNAME}" --password "$${DOCKER_PASSWORD}"
+      - docker login ghcr.io --username "$${GHCR_USERNAME}" --password "$${GHCR_PASSWORD}"
       - make PUSH=true
       - make integration
     volumes:
       - name: docker-socket
         path: /var/run
+      - name: docker
+        path: /root/.docker/buildx
     when:
       event:
         exclude:
           - pull_request
 
 volumes:
   - name: docker-socket
+    host:
+      path: /var/ci-docker
+  - name: docker
     temp: {}
+
 ---
 kind: pipeline
 name: notify
+type: kubernetes
 
 clone:
   disable: true

Dockerfile

@@ -34,10 +34,12 @@ COPY hack/golang/golangci-lint.yaml .
 RUN --mount=type=cache,target=/root/.cache/go-build golangci-lint run --config golangci-lint.yaml
 
 FROM scratch AS bldr
+LABEL org.opencontainers.image.source https://github.com/talos-systems/bldr
 COPY --from=build /bldr /bldr
 
 FROM scratch AS integration.test
 COPY --from=build /src/integration.test /integration.test
 
 FROM bldr AS frontend
+LABEL org.opencontainers.image.source https://github.com/talos-systems/bldr
 ENTRYPOINT ["/bldr", "frontend"]

Makefile

@@ -1,5 +1,5 @@
-REGISTRY ?= docker.io
-USERNAME ?= autonomy
+REGISTRY ?= ghcr.io
+USERNAME ?= talos-systems
 TAG ?= $(shell git describe --tag --always --dirty)
 REGISTRY_AND_USERNAME := $(REGISTRY)/$(USERNAME)
 RUN_TESTS ?= TestIntegration

README.md

@@ -129,12 +129,15 @@ names are ignored.
 ### `Pkgfile`
 
 ```yaml
-# syntax = docker.io/autonomy/bldr:v0.1.0-alpha.0-frontend
+# syntax = ghcr.io/talos-systems/bldr:v0.2.0-alpha.3-frontend
 
 format: v1alpha2
 
 vars:
-  TOOLCHAIN_IMAGE: docker.io/autonomy/toolchain:0714f82
+  TOOLCHAIN_IMAGE: ghcr.io/talos-systems/tools:v0.3.0-8-ge86a8f3
+
+labels:
+  org.opencontainers.image.source: https://github.com/talos-systems/bldr
 ```
 
 First line of the file should always be magic comment which is picked up by
@@ -145,6 +148,7 @@ Rest of the `Pkgfile` is regular YAML file with the following fields:
 
 - `format` (*string*, *required*): format of the `pkg.yaml` files, the only allowed value today is `v1alpha2`.
 - `vars` (*map[str]str*, *optional*): set of variables which are used to process `pkg.yaml` as a template.
+- `labels` (*map[str]str*, *optional*): labels to apply to the output images (only in frontend mode).
 
 `bldr` parses `Pkgfile` as the first thing during the build, it should always
 reside at the root of the build tree.
@@ -233,7 +237,7 @@ Internal dependency:
 External dependency:
 
 ```yaml
-- image: docker.io/autonomy/toolchain:0714f82
+- image: ghcr.io/talos-systems/tools:v0.3.0-8-ge86a8f3
   runtime: false
   to: /
 ```

cmd/frontend.go

@@ -23,7 +23,7 @@ var frontendCmd = &cobra.Command{
 
 To activate, put following line as the first line of Pkgfile:
 
-# syntax = docker.io/autonomy/bldr:<version>-frontend
+# syntax = ghcr.io/talos-systems/bldr:<version>-frontend
 
 Run with:
 

internal/pkg/pkgfile/build.go

@@ -66,7 +66,7 @@ func Build(ctx context.Context, c client.Client, options *environment.Options) (
 		}
 
 		if !b && exportMap {
-			return nil, fmt.Errorf("returning multiple target plaforms is not allowed")
+			return nil, fmt.Errorf("returning multiple target platforms is not allowed")
 		}
 
 		exportMap = b
@@ -139,6 +139,11 @@ func Build(ctx context.Context, c client.Client, options *environment.Options) (
 						Type: "layers",
 					},
 				},
+				Config: dockerfile2llb.ImageConfig{
+					ImageConfig: specs.ImageConfig{
+						Labels: packages.ImageLabels(),
+					},
+				},
 				Variant: platform.PlatformSpec.Variant,
 			}
 

internal/pkg/solver/buildkit_loader.go

@@ -63,7 +63,7 @@ func (bkfl *BuildkitFrontendLoader) walk(path string, process packageProcess) er
 }
 
 // Load implements PackageLoader.
-func (bkfl *BuildkitFrontendLoader) Load() ([]*v1alpha2.Pkg, error) {
+func (bkfl *BuildkitFrontendLoader) Load() (*LoadResult, error) {
 	if bkfl.Logger == nil {
 		bkfl.Logger = log.New(log.Writer(), "[loader] ", log.Flags())
 	}
@@ -106,5 +106,8 @@ func (bkfl *BuildkitFrontendLoader) Load() ([]*v1alpha2.Pkg, error) {
 
 	err = bkfl.walk("/", process)
 
-	return pkgs, multierror.Append(multiErr, err).ErrorOrNil()
+	return &LoadResult{
+		Pkgfile: bkfl.pkgFile,
+		Pkgs:    pkgs,
+	}, multierror.Append(multiErr, err).ErrorOrNil()
 }

internal/pkg/solver/filesystem_loader.go

@@ -63,7 +63,7 @@ func (fspl *FilesystemPackageLoader) walkFunc() filepath.WalkFunc {
 }
 
 // Load implements PackageLoader.
-func (fspl *FilesystemPackageLoader) Load() ([]*v1alpha2.Pkg, error) {
+func (fspl *FilesystemPackageLoader) Load() (*LoadResult, error) {
 	if fspl.Logger == nil {
 		fspl.Logger = log.New(log.Writer(), "[loader] ", log.Flags())
 	}
@@ -87,7 +87,10 @@ func (fspl *FilesystemPackageLoader) Load() ([]*v1alpha2.Pkg, error) {
 
 	err = filepath.Walk(fspl.Root, fspl.walkFunc())
 
-	return fspl.pkgs, multierror.Append(fspl.multiErr, err).ErrorOrNil()
+	return &LoadResult{
+		Pkgfile: fspl.pkgFile,
+		Pkgs:    fspl.pkgs,
+	}, multierror.Append(fspl.multiErr, err).ErrorOrNil()
 }
 
 func (fspl *FilesystemPackageLoader) loadPkg(path string) (*v1alpha2.Pkg, error) {

internal/pkg/solver/loader.go

@@ -8,7 +8,13 @@ import (
 	"github.com/talos-systems/bldr/internal/pkg/types/v1alpha2"
 )
 
+// LoadResult is a result of PackageLoader.Load function.
+type LoadResult struct {
+	Pkgfile *v1alpha2.Pkgfile
+	Pkgs    []*v1alpha2.Pkg
+}
+
 // PackageLoader implements some way to fetch collection of Pkgs.
 type PackageLoader interface {
-	Load() ([]*v1alpha2.Pkg, error)
+	Load() (*LoadResult, error)
 }

internal/pkg/solver/packages.go

@@ -13,20 +13,22 @@ import (
 // Packages is a collect of Pkg objects with dependencies tracked.
 type Packages struct {
 	packages map[string]*v1alpha2.Pkg
+	pkgfile  *v1alpha2.Pkgfile
 }
 
 // NewPackages builds Packages using PackageLoader.
 func NewPackages(loader PackageLoader) (*Packages, error) {
-	pkgs, err := loader.Load()
+	loadResult, err := loader.Load()
 	if err != nil {
 		return nil, err
 	}
 
 	result := &Packages{
-		packages: make(map[string]*v1alpha2.Pkg),
+		packages: make(map[string]*v1alpha2.Pkg, len(loadResult.Pkgs)),
+		pkgfile:  loadResult.Pkgfile,
 	}
 
-	for _, pkg := range pkgs {
+	for _, pkg := range loadResult.Pkgs {
 		name := pkg.Name
 
 		if dup, exists := result.packages[name]; exists {
@@ -111,3 +113,8 @@ func (pkgs *Packages) ToSet() (set PackageSet) {
 
 	return
 }
+
+// ImageLabels returns set of image labels to apply to the output image.
+func (pkgs *Packages) ImageLabels() map[string]string {
+	return pkgs.pkgfile.Labels
+}