feat(controller): move configuration from internal to pkg (#2281)

fabianburth · matthiasbruns · web-flow · commit 351735d7c99d · 2026-04-14T19:05:39.000+02:00
&lt;!-- markdownlint-disable MD041 --&gt;
#### What this PR does / why we need it
Move internal/configuration to pkg/configuration to make the
configuration loading API available to external consumers. Add package
documentation with an API stability disclaimer. Update all internal
import paths accordingly.

#### Which issue(s) this PR fixes
&lt;!--
Usage: `Fixes #&lt;issue number&gt;`, or `Fixes (paste link of issue)`.
--&gt;

#### Testing

##### How to test the changes

&lt;!--
Required files to test the changes:

.ocmconfig
```yaml
type: generic.config.ocm.software/v1
configurations:
  - type: credentials.config.ocm.software
    repositories:
      - repository:
          type: DockerConfig/v1
          dockerConfigFile: "~/.docker/config.json"
```

Commands that test the change:

```bash
ocm get cv xxx

ocm transfer xxx
```
--&gt;

##### Verification

- [ ] I have tested the changes locally by running `ocm`

---------

Signed-off-by: Fabian Burth &lt;fabian.burth@sap.com&gt;
Co-authored-by: Matthias Bruns &lt;github@matthiasbruns.com&gt;
diff --git a/kubernetes/controller/Dockerfile b/kubernetes/controller/Dockerfile
@@ -15,6 +15,7 @@ RUN go mod download
 COPY cmd/main.go cmd/main.go
 COPY api/ api/
 COPY internal/ internal/
+COPY pkg/ pkg/
 
 # Build
 # the GOARCH has not a default value to allow the binary be built according to the host where the command
diff --git a/kubernetes/controller/internal/controller/component/component_controller.go b/kubernetes/controller/internal/controller/component/component_controller.go
@@ -33,14 +33,14 @@ import (
 	"ocm.software/open-component-model/bindings/go/runtime"
 	"ocm.software/open-component-model/bindings/go/signing"
 	"ocm.software/open-component-model/kubernetes/controller/api/v1alpha1"
-	"ocm.software/open-component-model/kubernetes/controller/internal/configuration"
 	"ocm.software/open-component-model/kubernetes/controller/internal/event"
 	"ocm.software/open-component-model/kubernetes/controller/internal/ocm"
 	"ocm.software/open-component-model/kubernetes/controller/internal/resolution"
 	"ocm.software/open-component-model/kubernetes/controller/internal/resolution/workerpool"
 	"ocm.software/open-component-model/kubernetes/controller/internal/status"
 	"ocm.software/open-component-model/kubernetes/controller/internal/util"
 	"ocm.software/open-component-model/kubernetes/controller/internal/verification"
+	"ocm.software/open-component-model/kubernetes/controller/pkg/configuration"
 )
 
 // Reconciler reconciles a Component object.
diff --git a/kubernetes/controller/internal/controller/deployer/deployer_controller.go b/kubernetes/controller/internal/controller/deployer/deployer_controller.go
@@ -39,7 +39,6 @@ import (
 	"ocm.software/open-component-model/bindings/go/plugin/manager"
 	ocmruntime "ocm.software/open-component-model/bindings/go/runtime"
 	deliveryv1alpha1 "ocm.software/open-component-model/kubernetes/controller/api/v1alpha1"
-	"ocm.software/open-component-model/kubernetes/controller/internal/configuration"
 	"ocm.software/open-component-model/kubernetes/controller/internal/controller/applyset"
 	"ocm.software/open-component-model/kubernetes/controller/internal/controller/deployer/cache"
 	"ocm.software/open-component-model/kubernetes/controller/internal/controller/deployer/dynamic"
@@ -51,6 +50,7 @@ import (
 	"ocm.software/open-component-model/kubernetes/controller/internal/status"
 	"ocm.software/open-component-model/kubernetes/controller/internal/util"
 	"ocm.software/open-component-model/kubernetes/controller/internal/verification"
+	"ocm.software/open-component-model/kubernetes/controller/pkg/configuration"
 )
 
 const (
diff --git a/kubernetes/controller/internal/controller/repository/repository_controller.go b/kubernetes/controller/internal/controller/repository/repository_controller.go
@@ -25,10 +25,10 @@ import (
 
 	"ocm.software/open-component-model/bindings/go/runtime"
 	"ocm.software/open-component-model/kubernetes/controller/api/v1alpha1"
-	"ocm.software/open-component-model/kubernetes/controller/internal/configuration"
 	"ocm.software/open-component-model/kubernetes/controller/internal/ocm"
 	"ocm.software/open-component-model/kubernetes/controller/internal/resolution"
 	"ocm.software/open-component-model/kubernetes/controller/internal/status"
+	"ocm.software/open-component-model/kubernetes/controller/pkg/configuration"
 )
 
 var repositoryKey = ".spec.repositoryRef"
diff --git a/kubernetes/controller/internal/controller/resource/resource_controller.go b/kubernetes/controller/internal/controller/resource/resource_controller.go
@@ -29,14 +29,14 @@ import (
 	"ocm.software/open-component-model/bindings/go/plugin/manager"
 	"ocm.software/open-component-model/bindings/go/runtime"
 	"ocm.software/open-component-model/kubernetes/controller/api/v1alpha1"
-	"ocm.software/open-component-model/kubernetes/controller/internal/configuration"
 	"ocm.software/open-component-model/kubernetes/controller/internal/event"
 	"ocm.software/open-component-model/kubernetes/controller/internal/ocm"
 	"ocm.software/open-component-model/kubernetes/controller/internal/resolution"
 	"ocm.software/open-component-model/kubernetes/controller/internal/resolution/workerpool"
 	"ocm.software/open-component-model/kubernetes/controller/internal/status"
 	"ocm.software/open-component-model/kubernetes/controller/internal/util"
 	"ocm.software/open-component-model/kubernetes/controller/internal/verification"
+	"ocm.software/open-component-model/kubernetes/controller/pkg/configuration"
 )
 
 type Reconciler struct {
diff --git a/kubernetes/controller/internal/ocm/resource.go b/kubernetes/controller/internal/ocm/resource.go
@@ -12,10 +12,10 @@ import (
 	v2 "ocm.software/open-component-model/bindings/go/descriptor/v2"
 	"ocm.software/open-component-model/bindings/go/plugin/manager"
 	"ocm.software/open-component-model/bindings/go/runtime"
-	"ocm.software/open-component-model/kubernetes/controller/internal/configuration"
 	"ocm.software/open-component-model/kubernetes/controller/internal/resolution"
 	"ocm.software/open-component-model/kubernetes/controller/internal/resolution/workerpool"
 	"ocm.software/open-component-model/kubernetes/controller/internal/setup"
+	"ocm.software/open-component-model/kubernetes/controller/pkg/configuration"
 )
 
 var ErrPluginNotFound = errors.New("digest processor plugin not found")
diff --git a/kubernetes/controller/internal/resolution/cached_repository.go b/kubernetes/controller/internal/resolution/cached_repository.go
@@ -18,9 +18,9 @@ import (
 	"ocm.software/open-component-model/bindings/go/repository"
 	"ocm.software/open-component-model/bindings/go/repository/component/resolvers"
 	"ocm.software/open-component-model/bindings/go/runtime"
-	"ocm.software/open-component-model/kubernetes/controller/internal/configuration"
 	"ocm.software/open-component-model/kubernetes/controller/internal/resolution/workerpool"
 	"ocm.software/open-component-model/kubernetes/controller/internal/verification"
+	"ocm.software/open-component-model/kubernetes/controller/pkg/configuration"
 )
 
 // CacheBackedRepository provides a cache-backed implementation of repository.ComponentVersionRepository.
diff --git a/kubernetes/controller/internal/resolution/service.go b/kubernetes/controller/internal/resolution/service.go
@@ -13,10 +13,10 @@ import (
 	"ocm.software/open-component-model/bindings/go/plugin/manager/registries/signinghandler"
 	"ocm.software/open-component-model/bindings/go/repository/component/resolvers"
 	"ocm.software/open-component-model/bindings/go/runtime"
-	"ocm.software/open-component-model/kubernetes/controller/internal/configuration"
 	"ocm.software/open-component-model/kubernetes/controller/internal/resolution/workerpool"
 	"ocm.software/open-component-model/kubernetes/controller/internal/setup"
 	"ocm.software/open-component-model/kubernetes/controller/internal/verification"
+	"ocm.software/open-component-model/kubernetes/controller/pkg/configuration"
 )
 
 // ErrResolutionInProgress is returned when a component version is being resolved in the background.
diff --git a/kubernetes/controller/internal/resolution/service_test.go b/kubernetes/controller/internal/resolution/service_test.go
@@ -25,7 +25,7 @@ import (
 	"ocm.software/open-component-model/bindings/go/repository"
 	ocmruntime "ocm.software/open-component-model/bindings/go/runtime"
 	"ocm.software/open-component-model/kubernetes/controller/api/v1alpha1"
-	"ocm.software/open-component-model/kubernetes/controller/internal/configuration"
+	"ocm.software/open-component-model/kubernetes/controller/pkg/configuration"
 	"ocm.software/open-component-model/kubernetes/controller/internal/resolution"
 	"ocm.software/open-component-model/kubernetes/controller/internal/resolution/workerpool"
 )
diff --git a/kubernetes/controller/internal/setup/integration_test.go b/kubernetes/controller/internal/setup/integration_test.go
@@ -23,7 +23,7 @@ import (
 	"ocm.software/open-component-model/bindings/go/repository/component/resolvers"
 	ocmruntime "ocm.software/open-component-model/bindings/go/runtime"
 	"ocm.software/open-component-model/kubernetes/controller/api/v1alpha1"
-	"ocm.software/open-component-model/kubernetes/controller/internal/configuration"
+	"ocm.software/open-component-model/kubernetes/controller/pkg/configuration"
 	"ocm.software/open-component-model/kubernetes/controller/internal/setup"
 )
 
diff --git a/kubernetes/controller/pkg/configuration/config.go b/kubernetes/controller/pkg/configuration/config.go
@@ -1,5 +1,3 @@
-// Package configuration provides functionality to load and manage OCM configurations
-// from Kubernetes resources (Secrets and ConfigMaps).
 package configuration
 
 import (
diff --git a/kubernetes/controller/pkg/configuration/config_test.go b/kubernetes/controller/pkg/configuration/config_test.go
diff --git a/kubernetes/controller/pkg/configuration/doc.go b/kubernetes/controller/pkg/configuration/doc.go
@@ -0,0 +1,13 @@
+// Package configuration provides functions for loading and merging OCM
+// configurations from Kubernetes Secrets and ConfigMaps.
+//
+// It supports native OCM config entries as well as docker-style registry
+// credentials and
+//   - flattens multiple configuration sources into a single [Configuration],
+//   - calculates a content-addressable hash, and
+//   - enforces a hardcoded strict allowlist of accepted config types (config
+//     types outside of the allowlist are dropped).
+//
+// WARNING: This package is still under active development. APIs may change in
+// backwards-incompatible ways at any time. We make no stability guarantees.
+package configuration

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ import (`
`25`	`25`	`"ocm.software/open-component-model/bindings/go/repository"`
`26`	`26`	`ocmruntime "ocm.software/open-component-model/bindings/go/runtime"`
`27`	`27`	`"ocm.software/open-component-model/kubernetes/controller/api/v1alpha1"`
`28`		`- "ocm.software/open-component-model/kubernetes/controller/internal/configuration"`
	`28`	`+ "ocm.software/open-component-model/kubernetes/controller/pkg/configuration"`
`29`	`29`	`"ocm.software/open-component-model/kubernetes/controller/internal/resolution"`
`30`	`30`	`"ocm.software/open-component-model/kubernetes/controller/internal/resolution/workerpool"`
`31`	`31`	`)`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ import (`
`23`	`23`	`"ocm.software/open-component-model/bindings/go/repository/component/resolvers"`
`24`	`24`	`ocmruntime "ocm.software/open-component-model/bindings/go/runtime"`
`25`	`25`	`"ocm.software/open-component-model/kubernetes/controller/api/v1alpha1"`
`26`		`- "ocm.software/open-component-model/kubernetes/controller/internal/configuration"`
	`26`	`+ "ocm.software/open-component-model/kubernetes/controller/pkg/configuration"`
`27`	`27`	`"ocm.software/open-component-model/kubernetes/controller/internal/setup"`
`28`	`28`	`)`
`29`	`29`