Merge pull request #153 from vshn/feat/pullSecret

Add support for k8ify.imagePullSecret label

README.md

@@ -97,6 +97,7 @@ Service Labels
 
 | Label  | Effect  |
 | ------ | ------- |
+| `k8ify.imagePullSecret: $env_var` | Creates an ImagePullSecret from the referenced environment variable([example](https://github.com/vshn/k8ify/blob/22b814f1ee0e7c0be2b8788096702678f359a71b/tests/golden/imagepullsecrets.yml)). Can be used once per service.|
 | `k8ify.singleton: true`  | Compose service is only deployed once per environment instead of once per `$ref` per environment  |
 | `k8ify.expose: $host`  | The first port is exposed to the internet via a HTTPS ingress with the host name set to `$host`  |
 | `k8ify.expose.$port: $host`  | The port `$port` is exposed to the internet via a HTTPS ingress with the host name set to `$host`  |

pkg/converter/converter.go

@@ -2,7 +2,6 @@ package converter
 
 import (
 	"fmt"
-	v1 "k8s.io/api/policy/v1"
 	"log"
 	"maps"
 	"os"
@@ -11,6 +10,8 @@ import (
 	"strconv"
 	"strings"
 
+	v1 "k8s.io/api/policy/v1"
+
 	composeTypes "github.com/compose-spec/compose-go/types"
 	"github.com/sirupsen/logrus"
 	"github.com/vshn/k8ify/pkg/ir"
@@ -157,6 +158,18 @@ func composeServiceToSecret(workload *ir.Service, refSlug string, labels map[str
 	return &secret
 }
 
+func composeServiceToPullSecret(authConf string, name string, labels map[string]string) *core.Secret {
+	secret := core.Secret{}
+	secret.APIVersion = "v1"
+	secret.Kind = "Secret"
+	secret.Type = core.SecretTypeDockerConfigJson
+	secret.Name = name + "-image-pull"
+	secret.Labels = labels
+	secret.Annotations = util.Annotations(labels, "Secret")
+	secret.StringData = map[string]string{".dockerconfigjson": authConf}
+	return &secret
+}
+
 func composeServiceToDeployment(
 	workload *ir.Service,
 	refSlug string,
@@ -271,13 +284,30 @@ func composeServiceToPodTemplate(
 	if secret != nil {
 		secrets = append(secrets, *secret)
 	}
-
+	imagePullSecretReference := []core.LocalObjectReference{}
+	if util.ImagePullSecret(workload.AsCompose().Labels) != nil {
+		imagePullSecret := composeServiceToPullSecret(
+			*util.ImagePullSecret(workload.AsCompose().Labels),
+			workload.Name+refSlug,
+			labels)
+		secrets = append(secrets, *imagePullSecret)
+		imagePullSecretReference = append(imagePullSecretReference, core.LocalObjectReference{Name: imagePullSecret.Name + "-secret"})
+	}
 	for _, part := range workload.GetParts() {
 		c, s, cvs := composeServiceToContainer(part, refSlug, projectVolumes, labels)
 		containers = append(containers, c)
 		if s != nil {
 			secrets = append(secrets, *s)
 		}
+		if util.ImagePullSecret(part.AsCompose().Labels) != nil {
+			imagePullSecret := composeServiceToPullSecret(
+				*util.ImagePullSecret(part.AsCompose().Labels),
+				part.Name+refSlug,
+				labels)
+			secrets = append(secrets, *imagePullSecret)
+			imagePullSecretReference = append(imagePullSecretReference, core.LocalObjectReference{Name: imagePullSecret.Name + "-secret"})
+
+		}
 		maps.Copy(volumes, cvs)
 	}
 
@@ -296,6 +326,7 @@ func composeServiceToPodTemplate(
 
 	podSpec := core.PodSpec{
 		EnableServiceLinks: &enableServiceLinks,
+		ImagePullSecrets:   imagePullSecretReference,
 		Containers:         containers,
 		RestartPolicy:      core.RestartPolicyAlways,
 		Volumes:            volumesArray,

pkg/ir/ir.go

@@ -1,11 +1,12 @@
 package ir
 
 import (
+	"strconv"
+	"strings"
+
 	composeTypes "github.com/compose-spec/compose-go/types"
 	"github.com/vshn/k8ify/pkg/util"
 	"k8s.io/apimachinery/pkg/api/resource"
-	"strconv"
-	"strings"
 )
 
 type Inputs struct {

pkg/util/configutils.go

@@ -2,13 +2,14 @@ package util
 
 import (
 	"fmt"
-	core "k8s.io/api/core/v1"
 	"maps"
 	"os"
 	"regexp"
 	"strconv"
 	"strings"
 
+	core "k8s.io/api/core/v1"
+
 	"github.com/docker/go-units"
 	"github.com/sirupsen/logrus"
 	"k8s.io/apimachinery/pkg/api/resource"
@@ -106,6 +107,10 @@ func PartOf(labels map[string]string) *string {
 	return GetOptional(labels, "k8ify.partOf")
 }
 
+func ImagePullSecret(labels map[string]string) *string {
+	return GetOptional(labels, "k8ify.imagePullSecret")
+}
+
 // StorageSize determines the requested storage size for a volume, or a
 // fallback value.
 func StorageSize(labels map[string]string, fallback string) resource.Quantity {

tests/golden/imagepullsecrets.yml

@@ -0,0 +1,55 @@
+---
+environments:
+  prod:
+    vars:
+      REGULAR_DEPLOYMENT_IMAGEPULLSECRET: |
+        {
+          "auths": {
+            "https://index.docker.io/v1/": {
+              "auth": "foo"
+            }
+          }
+        }
+      REGULAR_STATEFULSET_IMAGEPULLSECRET: |
+        {
+          "auths": {
+            "https://index.docker.io/v1/": {
+              "auth": "bar"
+            }
+          }
+        }
+      PART_OF_DEPLOYMENT_IMAGEPULLSECRET: |
+        {
+          "auths": {
+            "https://index.docker.io/v1/": {
+              "auth": "foo-baz"
+            }
+          }
+        }
+      PART_OF_DEPLOYMENT_SIDECAR_IMAGEPULLSECRET: |
+        {
+          "auths": {
+            "https://index.docker.io/v1/": {
+              "auth": "foo-baz-part"
+            }
+          }
+        }
+      PART_OF_STATEFULSET_IMAGEPULLSECRET: |
+        {
+          "auths": {
+            "https://index.docker.io/v1/": {
+              "auth": "bar-baz"
+            }
+          }
+        }
+      PART_OF_STATEFULSET_SIDECAR_IMMAGEPULLSECRET: |
+        {
+          "auths": {
+            "https://index.docker.io/v1/": {
+              "auth": "bar-baz-part"
+            }
+          }
+        }
+      FOO : "one"
+      BAR : "two"
+      BAZ : "three"

tests/golden/imagepullsecrets/docker-compose-prod.yml

@@ -0,0 +1,76 @@
+version: '3.4'
+services:
+  regular-deployment:
+    image: nginx
+    labels:
+      k8ify.imagePullSecret: '$REGULAR_DEPLOYMENT_IMAGEPULLSECRET'
+    environment:
+      - FOO
+      - BAR=${BAR}
+      - something_else=${BAZ}
+      - "PASSWORD=$_ref_:mongodb-secret:password"
+      - "FOOREF=$_ref_:foo:fooooooo"
+      - "BARREF=$_ref_:bar:baaaaaar"
+
+  regular-statefulset:
+    image: mongodb
+    labels:
+      k8ify.imagePullSecret: '$REGULAR_STATEFULSET_IMAGEPULLSECRET'
+      k8ify.singleton: true
+    volumes:
+      - regular-statefulset:/data
+    environment:
+      - FOO
+      - BAR=${BAR}
+      - something_else=${BAZ}
+      - "PASSWORD=$_ref_:mongodb-secret:password"
+      - "FOOREF=$_ref_:foo:fooooooo"
+      - "BARREF=$_ref_:bar:baaaaaar"  
+
+  part-of-deployment:
+    image: nginx-frontend
+    labels:
+      k8ify.imagePullSecret: '$PART_OF_DEPLOYMENT_IMAGEPULLSECRET'
+    environment:
+      - FOO
+      - BAR=${BAR}
+      - something_else=${BAZ}
+      - "PASSWORD=$_ref_:mongodb-secret:password"
+      - "FOOREF=$_ref_:foo:fooooooo"
+      - "BARREF=$_ref_:bar:baaaaaar"
+
+  part-of-deployment-sidecar:
+    image: php-backend
+    labels:
+      k8ify.imagePullSecret: '$PART_OF_DEPLOYMENT_SIDECAR_IMAGEPULLSECRET'
+      k8ify.partOf: 'part-of-deployment'
+
+  part-of-statefulset:
+    labels:
+      k8ify.imagePullSecret: '$PART_OF_STATEFULSET_IMAGEPULLSECRET'
+      k8ify.singleton: true
+    image: postgres
+    volumes:
+      - part-of-statefulset:/data
+    environment:
+      - FOO
+      - BAR=${BAR}
+      - something_else=${BAZ}
+      - "PASSWORD=$_ref_:mongodb-secret:password"
+      - "FOOREF=$_ref_:foo:fooooooo"
+      - "BARREF=$_ref_:bar:baaaaaar"
+
+  part-of-statefulset-sidecar:
+    labels:
+      k8ify.imagePullSecret: '$PART_OF_STATEFULSET_SIDECAR_IMMAGEPULLSECRET'
+      k8ify.partOf: 'part-of-statefulset'
+      k8ify.singleton: true
+    image: pgpool
+
+volumes:
+  regular-statefulset:
+    labels:
+      k8ify.singleton: true
+  part-of-statefulset:
+    labels:
+      k8ify.singleton: true

tests/golden/imagepullsecrets/manifests/part-of-deployment-oasp-deployment.yaml

@@ -0,0 +1,66 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  creationTimestamp: null
+  labels:
+    k8ify.ref-slug: oasp
+    k8ify.service: part-of-deployment
+  name: part-of-deployment-oasp
+spec:
+  selector:
+    matchLabels:
+      k8ify.ref-slug: oasp
+      k8ify.service: part-of-deployment
+  strategy:
+    type: Recreate
+  template:
+    metadata:
+      creationTimestamp: null
+      labels:
+        k8ify.ref-slug: oasp
+        k8ify.service: part-of-deployment
+    spec:
+      affinity:
+        podAntiAffinity:
+          requiredDuringSchedulingIgnoredDuringExecution:
+          - labelSelector:
+              matchExpressions:
+              - key: k8ify.service
+                operator: In
+                values:
+                - part-of-deployment
+            topologyKey: kubernetes.io/hostname
+      containers:
+      - env:
+        - name: BARREF
+          valueFrom:
+            secretKeyRef:
+              key: baaaaaar
+              name: bar
+        - name: FOOREF
+          valueFrom:
+            secretKeyRef:
+              key: fooooooo
+              name: foo
+        - name: PASSWORD
+          valueFrom:
+            secretKeyRef:
+              key: password
+              name: mongodb-secret
+        envFrom:
+        - secretRef:
+            name: part-of-deployment-oasp-env
+        image: nginx-frontend
+        imagePullPolicy: Always
+        name: part-of-deployment-oasp
+        resources: {}
+      - image: php-backend
+        imagePullPolicy: Always
+        name: part-of-deployment-sidecar-oasp
+        resources: {}
+      enableServiceLinks: false
+      imagePullSecrets:
+      - name: part-of-deployment-oasp-image-pull-secret
+      - name: part-of-deployment-sidecar-oasp-image-pull-secret
+      restartPolicy: Always
+status: {}

tests/golden/imagepullsecrets/manifests/part-of-deployment-oasp-env-secret.yaml

@@ -0,0 +1,12 @@
+apiVersion: v1
+kind: Secret
+metadata:
+  creationTimestamp: null
+  labels:
+    k8ify.ref-slug: oasp
+    k8ify.service: part-of-deployment
+  name: part-of-deployment-oasp-env
+stringData:
+  BAR: two
+  FOO: one
+  something_else: three

tests/golden/imagepullsecrets/manifests/part-of-deployment-oasp-image-pull-secret.yaml

@@ -0,0 +1,18 @@
+apiVersion: v1
+kind: Secret
+metadata:
+  creationTimestamp: null
+  labels:
+    k8ify.ref-slug: oasp
+    k8ify.service: part-of-deployment
+  name: part-of-deployment-oasp-image-pull
+stringData:
+  .dockerconfigjson: |
+    {
+      "auths": {
+        "https://index.docker.io/v1/": {
+          "auth": "foo-baz"
+        }
+      }
+    }
+type: kubernetes.io/dockerconfigjson

tests/golden/imagepullsecrets/manifests/part-of-deployment-sidecar-oasp-image-pull-secret.yaml

@@ -0,0 +1,18 @@
+apiVersion: v1
+kind: Secret
+metadata:
+  creationTimestamp: null
+  labels:
+    k8ify.ref-slug: oasp
+    k8ify.service: part-of-deployment
+  name: part-of-deployment-sidecar-oasp-image-pull
+stringData:
+  .dockerconfigjson: |
+    {
+      "auths": {
+        "https://index.docker.io/v1/": {
+          "auth": "foo-baz-part"
+        }
+      }
+    }
+type: kubernetes.io/dockerconfigjson

tests/golden/imagepullsecrets/manifests/part-of-statefulset-env-secret.yaml

@@ -0,0 +1,11 @@
+apiVersion: v1
+kind: Secret
+metadata:
+  creationTimestamp: null
+  labels:
+    k8ify.service: part-of-statefulset
+  name: part-of-statefulset-env
+stringData:
+  BAR: two
+  FOO: one
+  something_else: three