feat: Add configuration for image registries (#1172)

Author: gfyrag

deployments/pulumi/pkg/api/deployment.go

@@ -153,7 +153,7 @@ func createDeployment(ctx *pulumi.Context, args createDeploymentArgs, resourceOp
 					Containers: corev1.ContainerArray{
 						corev1.ContainerArgs{
 							Name:            pulumi.String("ledger-api"),
-							Image:           utils.GetMainImage(args.Tag),
+							Image:           utils.GetMainImage(args.ImageConfiguration),
 							ImagePullPolicy: args.ImagePullPolicy.ToOutput(ctx.Context()).Untyped().(pulumi.StringOutput),
 							Args: pulumi.StringArray{
 								pulumi.String("serve"),

deployments/pulumi/pkg/common/common.go

@@ -2,14 +2,15 @@ package common
 
 import (
 	"github.com/formancehq/ledger/deployments/pulumi/pkg/monitoring"
+	"github.com/formancehq/ledger/deployments/pulumi/pkg/utils"
 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 	"github.com/pulumi/pulumi/sdk/v3/go/pulumix"
 )
 
 type CommonArgs struct {
+	utils.ImageConfiguration
 	Namespace       pulumix.Input[string]
 	Monitoring      *monitoring.Args
-	Tag             pulumix.Input[string]
 	ImagePullPolicy pulumix.Input[string]
 	Debug           pulumix.Input[bool]
 }
@@ -37,4 +38,5 @@ func (args *CommonArgs) SetDefaults() {
 	if args.Monitoring != nil {
 		args.Monitoring.SetDefaults()
 	}
+	args.ImageConfiguration.SetDefaults()
 }

deployments/pulumi/pkg/config/config.go

@@ -3,6 +3,8 @@ package config
 import (
 	"errors"
 	"fmt"
+	"time"
+
 	. "github.com/formancehq/go-libs/v2/collectionutils"
 	pulumi_ledger "github.com/formancehq/ledger/deployments/pulumi/pkg"
 	"github.com/formancehq/ledger/deployments/pulumi/pkg/api"
@@ -11,11 +13,11 @@ import (
 	"github.com/formancehq/ledger/deployments/pulumi/pkg/monitoring"
 	"github.com/formancehq/ledger/deployments/pulumi/pkg/provision"
 	"github.com/formancehq/ledger/deployments/pulumi/pkg/storage"
+	"github.com/formancehq/ledger/deployments/pulumi/pkg/utils"
 	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/rds"
 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
 	"github.com/pulumi/pulumi/sdk/v3/go/pulumix"
-	"time"
 )
 
 type Ingress struct {
@@ -181,8 +183,8 @@ func (a *PostgresDatabase) toInput() *storage.PostgresDatabaseArgs {
 
 	return &storage.PostgresDatabaseArgs{
 		Install: &storage.PostgresInstallArgs{
-			Username: pulumix.Val(a.Install.Username),
-			Password: pulumix.Val(a.Install.Password),
+			Username:     pulumix.Val(a.Install.Username),
+			Password:     pulumix.Val(a.Install.Password),
 			ChartVersion: pulumix.Val(a.Install.ChartVersion),
 		},
 	}
@@ -460,8 +462,12 @@ type Common struct {
 	Monitoring *Monitoring `json:"monitoring" yaml:"monitoring"`
 
 	// Tag is the version tag for the ledger
+	// deprecated
 	Tag string `json:"version" yaml:"version"`
 
+	// Image configuration
+	Image *ImageConfiguration `json:"image"`
+
 	// ImagePullPolicy is the image pull policy for the ledger
 	ImagePullPolicy string `json:"image-pull-policy" yaml:"image-pull-policy"`
 
@@ -471,11 +477,11 @@ type Common struct {
 
 func (c Common) toInput() common.CommonArgs {
 	return common.CommonArgs{
-		Namespace:       pulumix.Val(c.Namespace),
-		Monitoring:      c.Monitoring.ToInput(),
-		Tag:             pulumix.Val(c.Tag),
-		ImagePullPolicy: pulumix.Val(c.ImagePullPolicy),
-		Debug:           pulumix.Val(c.Debug),
+		Namespace:          pulumix.Val(c.Namespace),
+		Monitoring:         c.Monitoring.ToInput(),
+		ImageConfiguration: imageConfigurationOrTag(c.Image, c.Tag),
+		ImagePullPolicy:    pulumix.Val(c.ImagePullPolicy),
+		Debug:              pulumix.Val(c.Debug),
 	}
 }
 
@@ -546,6 +552,7 @@ func (g GeneratorLedgerConfiguration) toInput() generator.LedgerConfiguration {
 
 type Generator struct {
 	// GeneratorVersion is the version of the generator
+	// deprecated
 	GeneratorVersion string `json:"generator-version" yaml:"generator-version"`
 
 	// Ledgers are the ledgers to run the generator against
@@ -601,6 +608,12 @@ func (cfg Config) ToInput() pulumi_ledger.ComponentArgs {
 	}
 }
 
+type ImageConfiguration struct {
+	Registry   string `json:"registry" yaml:"registry"`
+	Repository string `json:"repository" yaml:"repository"`
+	Tag        string `json:"version" yaml:"version"`
+}
+
 func Load(ctx *pulumi.Context) (*Config, error) {
 	cfg := config.New(ctx, "")
 
@@ -657,6 +670,13 @@ func Load(ctx *pulumi.Context) (*Config, error) {
 		generator = nil
 	}
 
+	image := &ImageConfiguration{}
+	if err := cfg.TryObject("image", image); err != nil {
+		if !errors.Is(err, config.ErrMissingVar) {
+			return nil, fmt.Errorf("error reading generator config: %w", err)
+		}
+	}
+
 	namespace := cfg.Get("namespace")
 	if namespace == "" {
 		namespace = ctx.Stack()
@@ -669,6 +689,7 @@ func Load(ctx *pulumi.Context) (*Config, error) {
 			Namespace:       namespace,
 			Tag:             cfg.Get("version"),
 			Monitoring:      monitoring,
+			Image:           image,
 			ImagePullPolicy: cfg.Get("image-pull-policy"),
 		},
 		InstallDevBox: cfg.GetBool("install-dev-box"),
@@ -679,3 +700,21 @@ func Load(ctx *pulumi.Context) (*Config, error) {
 		Generator:     generator,
 	}, nil
 }
+
+func imageConfigurationOrTag(configuration *ImageConfiguration, tag string) utils.ImageConfiguration {
+	if configuration == nil {
+		return utils.ImageConfiguration{
+			Tag: pulumix.Val(tag),
+		}
+	}
+
+	if configuration.Tag != "" {
+		tag = configuration.Tag
+	}
+
+	return utils.ImageConfiguration{
+		Registry:   pulumix.Val(configuration.Registry),
+		Repository: pulumix.Val(configuration.Repository),
+		Tag:        pulumix.Val(tag),
+	}
+}

deployments/pulumi/pkg/generator/component.go

@@ -3,6 +3,10 @@ package generator
 import (
 	"errors"
 	"fmt"
+	"os"
+	"path/filepath"
+	"time"
+
 	"github.com/formancehq/ledger/deployments/pulumi/pkg/api"
 	"github.com/formancehq/ledger/deployments/pulumi/pkg/common"
 	"github.com/formancehq/ledger/deployments/pulumi/pkg/utils"
@@ -12,9 +16,6 @@ import (
 	metav1 "github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/meta/v1"
 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 	"github.com/pulumi/pulumi/sdk/v3/go/pulumix"
-	"os"
-	"path/filepath"
-	"time"
 )
 
 type Component struct {
@@ -48,15 +49,6 @@ type Args struct {
 }
 
 func (a *Args) SetDefaults() {
-	if a.GeneratorVersion == nil {
-		a.GeneratorVersion = pulumix.Val("")
-	}
-	a.GeneratorVersion = pulumix.Apply(a.GeneratorVersion, func(generatorVersion string) string {
-		if generatorVersion == "" {
-			return "latest"
-		}
-		return generatorVersion
-	})
 	if a.Ledgers == nil {
 		a.Ledgers = make(map[string]LedgerConfiguration)
 	}
@@ -149,12 +141,10 @@ func NewComponent(ctx *pulumi.Context, name string, args ComponentArgs, opts ...
 				corev1.ContainerArgs{
 					Name: pulumi.String("generator"),
 					Args: generatorArgs.ToOutput(ctx.Context()).Untyped().(pulumi.StringArrayOutput),
-					Image: utils.GetImage(pulumi.String("ledger-generator"), pulumix.Apply2(args.GeneratorVersion, args.Tag, func(generatorVersion string, ledgerVersion string) string {
-						if generatorVersion == "" {
-							return ledgerVersion
-						}
-						return generatorVersion
-					})),
+					Image: utils.GetImage(
+						args.ImageConfiguration.WithFallbackTag(args.GeneratorVersion),
+						pulumi.String("ledger-generator"),
+					),
 					ImagePullPolicy: pulumi.String("Always"),
 					VolumeMounts: corev1.VolumeMountArray{
 						corev1.VolumeMountArgs{

deployments/pulumi/pkg/provision/component.go

@@ -2,6 +2,7 @@ package provision
 
 import (
 	"fmt"
+
 	"github.com/formancehq/ledger/deployments/pulumi/pkg/api"
 	"github.com/formancehq/ledger/deployments/pulumi/pkg/common"
 	"github.com/formancehq/ledger/deployments/pulumi/pkg/utils"
@@ -24,7 +25,7 @@ type LedgerConfigArgs struct {
 }
 
 type Args struct {
-	ProvisionerVersion pulumi.String
+	ProvisionerVersion pulumix.Input[string]
 	Ledgers            map[string]LedgerConfigArgs `json:"ledgers"`
 }
 
@@ -126,12 +127,10 @@ func NewComponent(ctx *pulumi.Context, name string, args ComponentArgs, opts ...
 								pulumi.String("--state-store"),
 								pulumi.Sprintf("k8s:///%s/provisioner", args.Namespace),
 							},
-							Image: utils.GetImage(pulumi.String("ledger-provisioner"), pulumix.Apply2(args.Tag, args.ProvisionerVersion, func(ledgerVersion, provisionerVersion string) string {
-								if provisionerVersion != "" {
-									return provisionerVersion
-								}
-								return ledgerVersion
-							})),
+							Image: utils.GetImage(
+								args.ImageConfiguration.WithFallbackTag(args.ProvisionerVersion),
+								pulumi.String("ledger-provisioner"),
+							),
 							VolumeMounts: corev1.VolumeMountArray{
 								corev1.VolumeMountArgs{
 									Name:      pulumi.String("config"),

deployments/pulumi/pkg/storage/migrate.go

@@ -38,7 +38,7 @@ func runMigrateJob(ctx *pulumi.Context, args migrationArgs, opts ...pulumi.Resou
 							Args: pulumi.StringArray{
 								pulumi.String("migrate"),
 							},
-							Image:           utils.GetMainImage(args.Tag),
+							Image:           utils.GetMainImage(args.ImageConfiguration),
 							ImagePullPolicy: args.ImagePullPolicy.ToOutput(ctx.Context()).Untyped().(pulumi.StringOutput),
 							Env:             envVars,
 						},

deployments/pulumi/pkg/utils/convert.go

@@ -5,17 +5,33 @@ import (
 	"github.com/pulumi/pulumi/sdk/v3/go/pulumix"
 )
 
-func GetMainImage(tag pulumix.Input[string]) pulumi.StringOutput {
-	return GetImage(pulumi.String("ledger"), tag)
+func GetMainImage(imageConfiguration ImageConfiguration) pulumi.StringOutput {
+	return GetImage(imageConfiguration, pulumi.String("ledger"))
 }
 
-func GetImage(component, tag pulumix.Input[string]) pulumi.StringOutput {
-	return pulumi.Sprintf("ghcr.io/formancehq/%s:%s", component, pulumix.Apply(tag, func(version string) string {
-		if version == "" {
-			return "latest"
-		}
-		return version
-	}))
+func GetImage(imageConfiguration ImageConfiguration, component pulumix.Input[string]) pulumi.StringOutput {
+	return pulumi.Sprintf(
+		"%s/%s/%s:%s",
+		pulumix.Apply(imageConfiguration.Registry, func(registry string) string {
+			if registry == "" {
+				return "ghcr.io"
+			}
+			return registry
+		}),
+		pulumix.Apply(imageConfiguration.Repository, func(repository string) string {
+			if repository == "" {
+				return "formancehq"
+			}
+			return repository
+		}),
+		component,
+		pulumix.Apply(imageConfiguration.Tag, func(version string) string {
+			if version == "" {
+				return "latest"
+			}
+			return version
+		}),
+	)
 }
 
 func BoolToString(output pulumix.Input[bool]) pulumix.Output[string] {
@@ -26,3 +42,54 @@ func BoolToString(output pulumix.Input[bool]) pulumix.Output[string] {
 		return "false"
 	})
 }
+
+type ImageConfiguration struct {
+	Registry   pulumix.Input[string]
+	Repository pulumix.Input[string]
+	Tag        pulumix.Input[string]
+}
+
+func (args ImageConfiguration) WithFallbackTag(input pulumix.Input[string]) ImageConfiguration {
+	args.Tag = pulumix.Apply2(args.Tag, input, func(providedVersion, fallbackVersion string) string {
+		if providedVersion == "" {
+			return fallbackVersion
+		}
+		return providedVersion
+	})
+	return args
+}
+
+func (args *ImageConfiguration) SetDefaults() {
+	if args.Registry == nil {
+		args.Registry = pulumi.String("ghcr.io")
+	} else {
+		args.Registry = pulumix.Apply(args.Registry, func(registry string) string {
+			if registry == "" {
+				return "ghcr.io"
+			}
+			return registry
+		})
+	}
+
+	if args.Repository == nil {
+		args.Repository = pulumi.String("formancehq")
+	} else {
+		args.Repository = pulumix.Apply(args.Repository, func(repository string) string {
+			if repository == "" {
+				return "formancehq"
+			}
+			return repository
+		})
+	}
+
+	if args.Tag == nil {
+		args.Tag = pulumi.String("latest")
+	} else {
+		args.Tag = pulumix.Apply(args.Tag, func(tag string) string {
+			if tag == "" {
+				return "latest"
+			}
+			return tag
+		})
+	}
+}