feat: replace image registry dynamically

[cjc7373]

When does image replcaement happen

Bascially, replacement will happen when workload resources (like pod, job, deployment, statefulset) are created.

Specifically, the replacement will inject to:

• instanceset controller, so that it affects:

  • new cluster creation
  • cluster upgrade

  But it won't affect:

  • cluster scaling
  • instance template

• addon controller, so that it affects helm install jobs

• backup/restore controller

Replace Configs

sample config:

registries:
  defaultRegistry: foo.bar
  defaultNamespace: default
  registriyConfig:
  - from: docker.io
    to: docker-mirror.io
  - from: k8s.io
    to: company-registry.io
    registryDefaultNamespace: k8sio
    namespaces:
    - from: special-ns
      to: my-special-ns

The replacement rules are as follows:

• If there's no specific registry config (registriyConfig field), or registry does not match any specific registry config, defaultRegistry and defaultNamespace will be used.
  • If defaultNamespace is not defined, namespace remains unchanged.
  • If defaultRegistry is not defined, registry remains unchanged.
• If image's registry matches a specific registry config:
  • from and to should not be empty. Registry to will be used.
  • If there's no namespace config, or namespace does not match any specific namespace config, registryDefaultNamespace will be used. If registryDefaultNamespace is not defined, namespace remains unchanged.
  • If namespace matches a specific namespace config, namespace to will be used.
    • from and to of the namespace may be empty (empty namespace is legal)

Other things to note

One side effect of this change is that omitted image name (e.g. busybox) will be expanded to full format (e.g. docker.io/library/busybox). IMO this will not have any user facing change.

[codecov]

Codecov Report

Attention: Patch coverage is 77.04918% with 28 lines in your changes missing coverage. Please review.

Project coverage is 60.38%. Comparing base (a5bcd50) to head (c74f60d).
Report is 4 commits behind head on main.

Files with missing lines	Patch %	Lines
pkg/controllerutil/image_util.go	74.74%	24 Missing and 1 partial ⚠️
pkg/dataprotection/backup/deleter.go	0.00%	2 Missing ⚠️
pkg/dataprotection/utils/backuprepo.go	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #8018      +/-   ##
==========================================
+ Coverage   60.28%   60.38%   +0.10%     
==========================================
  Files         376      377       +1     
  Lines       45858    45965     +107     
==========================================
+ Hits        27645    27756     +111     
+ Misses      15614    15612       -2     
+ Partials     2599     2597       -2     

Flag	Coverage Δ
unittests	60.38% <77.04%> (+0.10%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[weicao]

so if namespace is not found, the original namespace rather than the defaultNamespace is used.

[zjx20]

Maybe add a DefaultNamespace field to the RegistryConfig struct:

type RegistryConfig struct {
	From       string
	To         string
	DefaultNamespace string
	Namespaces []RegistryNamespaceConfig
}

When the namespace is not found in Namespaces, use the DefaultNamespace if it's not empty, otherwise use the original namespace.

[cjc7373]

I think simply use the global defaultNamespace is enough.

It does seem better.

[zjx20]

@cjc7373 Please resolve conflicts and cover the case at #8539 .

[leon-inf]

NamespaceMapping -> Namespaces

[cjc7373]

This name was suggested by @zjx20. I think it's more accurate.

[leon-inf]

RegistryConfig -> registryConfig?

[leon-inf]

RegistriesConfig -> registriesConfig?

[cjc7373]

The config will be used in a test outside this package, so it needs to be exported.