add docker image

Author: kamushadenes

.github/resources/benchmark_comparison.svg

@@ -18,25 +18,25 @@ jobs:
           fetch-depth: 0
 
       - name: Set up Go
-        uses: actions/setup-go@v4
+        uses: actions/setup-go@v5
 
-      - name: Install Protoc
-        uses: arduino/setup-protoc@v3
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
 
-      - name: Install protoc-gen-go
-        run: go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
 
-      - name: Install protoc-gen-go-grpc
-        run: go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2
+      - name: Login to DockerHub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
 
       - name: Run GoReleaser
         uses: goreleaser/goreleaser-action@v5
         with:
-          # either 'goreleaser' (default) or 'goreleaser-pro'
           distribution: goreleaser
           version: latest
           args: release --clean
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          # Your GoReleaser Pro key, if you are using the 'goreleaser-pro' distribution
-          # GORELEASER_KEY: ${{ secrets.GORELEASER_KEY }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/resources/memory_usage_over_time.svg

@@ -18,9 +18,11 @@ builds:
       - CGO_ENABLED=0
     goos:
       - linux
-      - windows
-      - darwin
+    goarch:
+      - amd64
+      - arm64
     main: ./cmd/dockersync
+    binary: docker-sync
 
 archives:
   - format: tar.gz
@@ -29,10 +31,6 @@ archives:
       {{- .Os }}_
       {{- .Arch }}
       {{- if .Arm }}v{{ .Arm }}{{ end }}
-    # use zip for windows archives
-    format_overrides:
-      - goos: windows
-        format: zip
 
 changelog:
   sort: asc
@@ -46,4 +44,23 @@ release:
     owner: "Altinity"
     name: "docker-sync"
 
-  name_template: "{{.ProjectName}}-v{{.Version}}"
+  name_template: "{{.ProjectName}}-v{{.Version}}"
+
+dockers:
+  - image_templates:
+      - "altinity/docker-sync:{{.Version}}-amd64"
+    use: buildx
+    dockerfile: Dockerfile
+    build_flag_templates:
+      - "--platform linux/amd64"
+  - image_templates:
+      - "altinity/docker-sync:{{.Version}}-arm64v6"
+    use: buildx
+    dockerfile: Dockerfile
+    build_flag_templates:
+      - "--platform linux/arm64/v8"
+docker_manifests:
+  - name_template: "altinity/docker-sync:{{.Version}}"
+    image_templates:
+      - "altinity/docker-sync:{{.Version}}-amd64"
+      - "altinity/docker-sync:{{.Version}}-arm64v8"

.github/workflows/goreleaser.yml

@@ -0,0 +1,7 @@
+FROM scratch
+
+COPY docker-sync /
+
+EXPOSE 9090
+
+ENTRYPOINT ["/docker-sync"]

.goreleaser.yaml

@@ -0,0 +1,4 @@
+all:
+	mkdir dist 2>/dev/null || true
+	cd cmd/dockersync && go build -o ../../dist/dockersync
+	echo "Binary is in dist/dockersync"

Dockerfile

@@ -1,2 +1,154 @@
 # docker-sync
-Keep registries in sync
+
+Simple tool to keep images in sync between different registries.
+
+It uses the OCI distribution spec to pull and push images, so it should work with any compliant registry.
+
+Currently, it doesn't support the deprecated v1 manifests, and there are no plans to support them.
+
+## Usage
+
+Clone the repository:
+
+```console
+git clone https://github.com/Altinity/docker-sync.git
+```
+
+Change to the project directory:
+
+```console
+cd docker-sync
+```
+
+Build the project:
+
+```console
+make
+```
+
+Write the default config file:
+
+```console
+dist/dockersync writeConfig -o config.yaml`
+```
+
+Edit the config file accordingly, then run:
+
+```console
+dist/dockersync
+```
+
+## Configuration
+
+The default configuration looks like this: 
+
+```yaml
+ecr:
+    region: us-east-1
+logging:
+    colors: true
+    format: text
+    level: INFO
+    output: stdout
+    timeformat: "15:04:05"
+sync:
+    images:
+        - source: docker.io/library/ubuntu
+          targets:
+            - docker.io/kamushadenes/ubuntu
+    interval: 5m
+    maxerrors: 5
+    registries:
+        - auth:
+            helper: ""
+            password: ""
+            token: ""
+            username: ""
+          name: Docker Hub
+          url: docker.io
+telemetry:
+    enabled: false
+    metrics:
+        exporter: prometheus
+        prometheus:
+            address: 127.0.0.1:9090
+            path: /metrics
+        stdout:
+            interval: 5s
+```
+
+The `sync` section is where you define the images you want to keep in sync. The `interval` is the time between syncs, and `maxerrors` is the maximum number of errors before the sync is stopped and the program exits.
+
+### Authentication
+
+To provide authentication for registries, put them under `sync.registries` in the following format:
+
+```yaml
+sync:
+      registries:
+            - auth:
+                helper: "" 
+                password: ""
+                token: ""
+                username: ""
+              name: Docker Hub
+              url: docker.io
+```
+
+#### ECR
+
+To authenticate against ECR, you can leave `password`, `token` and `username` empty, and set `helper` to `ecr`:
+
+```yaml
+sync:
+      registries:
+            - auth:
+                helper: ecr
+                password: ""
+                token: ""
+                username: ""
+              name: ECR
+              url: 123456789012.dkr.ecr.us-east-1.amazonaws.com
+```
+
+The same applies to ecr-public, since it uses the url prefix to differentiate between the two.
+
+Now, any image under `123456789012.dkr.ecr.us-east-1.amazonaws.com` will be authenticated using the default AWS credentials.
+
+#### GCR
+
+To authenticate against ECR, get either a access token or service account key.
+
+##### Access Token
+
+Check the [GCR documentation](https://cloud.google.com/artifact-registry/docs/docker/authentication#token) for more information.
+
+Note that access tokens are short lived.
+
+```yaml
+sync:
+  registries:
+    - auth:
+        helper: ""
+        password: "PASSWORD"
+        token: ""
+        username: "oauth2accesstoken"
+      name: GCR / GAR
+      url: gcr.io
+```
+
+##### Service Account Key
+
+Check the [GCR documentation](https://cloud.google.com/artifact-registry/docs/docker/authentication#json-key) for more information.
+
+```yaml
+sync:
+  registries:
+    - auth:
+        helper: ""
+        password: "BASE64_ENCODED_JSON_KEY"
+        token: ""
+        username: "_json_key_base64"
+      name: GCR / GAR
+      url: gcr.io
+```

Makefile

@@ -58,10 +58,20 @@ var (
 		WithValidDuration())
 	// endregion
 
-	// region Repositories
+	// region Sync
 
-	// Repositories specifies the repositories to use for pulling and pushing images.
-	Repositories = NewKey("repositories",
+	// SyncMaxErrors specifies the maximum number of errors that can occur before the application exits.
+	SyncMaxErrors = NewKey("sync.maxErrors",
+		WithDefaultValue(5),
+		WithValidInt())
+
+	// SyncInterval specifies the interval at which images are synchronized.
+	SyncInterval = NewKey("sync.interval",
+		WithDefaultValue("5m"),
+		WithValidDuration())
+
+	// SyncRegistries specifies the repositories to use for pulling and pushing images.
+	SyncRegistries = NewKey("sync.registries",
 		WithDefaultValue([]map[string]interface{}{
 			{
 				"name": "Docker Hub",
@@ -70,22 +80,19 @@ var (
 					"username": "",
 					"password": "",
 					"token":    "",
-					"helper":   "docker-credential-desktop",
+					"helper":   "",
 				},
 			},
 		}),
 		WithValidRepositories())
-	// endregion
-
-	// region Images
 
-	// Images specifies the images to synchronize.
-	Images = NewKey("images",
+	// SyncImages specifies the images to synchronize.
+	SyncImages = NewKey("sync.images",
 		WithDefaultValue([]map[string]interface{}{
 			{
 				"source": "docker.io/library/ubuntu",
 				"targets": []string{
-					"docker.io/library/ubuntu:latest",
+					"docker.io/library/ubuntu",
 				},
 			},
 		}),