feat(file): implement file domain - #531
Open
lukas016 wants to merge 15 commits into
Open
Conversation
lukas016
force-pushed
the
feat-lk-file-domain
branch
from
August 3, 2026 10:20
e80b714 to
616d3b7
Compare
lukas016
commented
Aug 3, 2026
lukas016
commented
Aug 3, 2026
lukas016
commented
Aug 3, 2026
lukas016
commented
Aug 3, 2026
lukas016
commented
Aug 3, 2026
lukas016
commented
Aug 3, 2026
lukas016
commented
Aug 3, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces a new file domain/operator module to the controlplane monorepo, including CRDs (FileType, FileExposure, FileSubscription, ZoneServiceConfig), controllers/handlers, a validating webhook, deployment manifests, docs, and CI/release wiring.
Changes:
- Added a new
fileoperator module with controllers, handlers, indices, webhook validation, and samples. - Added CRDs + kustomize manifests (RBAC/manager/webhook/default overlays) for deploying the operator.
- Integrated
file-operatorinto CI and GoReleaser.
Reviewed changes
Copilot reviewed 76 out of 79 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| sftp/Makefile | Builds sftp manager with CGO_ENABLED=0. |
| file/PROJECT | Kubebuilder project definition for file domain resources. |
| file/Makefile | Build/test/lint/manifests targets for the file module. |
| file/internal/webhook/v1/zoneserviceconfig_webhook.go | Validating webhook for ZoneServiceConfig. |
| file/internal/webhook/v1/zoneserviceconfig_webhook_test.go | Unit tests for ZoneServiceConfig validator. |
| file/internal/webhook/v1/webhook_suite_test.go | Envtest webhook suite bootstrap. |
| file/internal/index/index.go | Field index registrations for file resources. |
| file/internal/handler/zoneserviceconfig/handler.go | Reconcile logic projecting ZoneServiceConfig into identity/gateway/sftp resources. |
| file/internal/handler/zoneserviceconfig/handler_suite_test.go | Ginkgo suite for ZoneServiceConfig handler. |
| file/internal/handler/util/util_suite_test.go | Ginkgo suite for handler util package. |
| file/internal/handler/util/refs.go | Helper ObjectRef builders for SFTP resources and source refs. |
| file/internal/handler/util/refs_test.go | Tests for ref helpers and labeling helpers. |
| file/internal/handler/util/publickeys.go | SSH key canonicalization + SFTP user/instance sync helpers. |
| file/internal/handler/util/publickeys_test.go | Tests for public key canonicalization and sync/delete helpers. |
| file/internal/handler/util/labels.go | Child resource labeling + selectors. |
| file/internal/handler/util/getters.go | Getters for FileType, ZoneServiceConfig, active exposures, etc. |
| file/internal/handler/suite_test.go | Root handler test suite. |
| file/internal/handler/filetype/handler.go | FileType handler (selects active exposure, sets status refs/conditions). |
| file/internal/handler/filetype/handler_test.go | Unit tests for FileType handler behavior. |
| file/internal/handler/filetype/handler_suite_test.go | Ginkgo suite for FileType handler. |
| file/internal/handler/filesubscription/handler.go | FileSubscription handler (approval flow + subscriber SFTP user sync). |
| file/internal/handler/filesubscription/handler_suite_test.go | Ginkgo suite for FileSubscription handler. |
| file/internal/handler/fileexposure/handler.go | FileExposure handler (enforces single active exposure, instance/user provisioning). |
| file/internal/handler/fileexposure/handler_test.go | Unit tests for FileExposure handler behavior. |
| file/internal/handler/fileexposure/handler_suite_test.go | Ginkgo suite for FileExposure handler. |
| file/internal/controller/zoneserviceconfig_controller.go | ZoneServiceConfig controller wiring + watches/owns. |
| file/internal/controller/zoneserviceconfig_controller_test.go | Envtest controller test for ZoneServiceConfig reconciler. |
| file/internal/controller/suite_test.go | Envtest controller suite bootstrap for file controllers. |
| file/internal/controller/schema.go | Scheme registration for dependent APIs. |
| file/internal/controller/filetype_controller.go | FileType controller wiring + watch exposure events. |
| file/internal/controller/filetype_controller_test.go | Envtest controller test for FileType reconciler. |
| file/internal/controller/filesubscription_controller.go | FileSubscription controller wiring + watch filetype events. |
| file/internal/controller/filesubscription_controller_test.go | Envtest controller test for FileSubscription reconciler. |
| file/internal/controller/fileexposure_controller.go | FileExposure controller wiring + watch filetype/zoneserviceconfig events. |
| file/internal/controller/fileexposure_controller_test.go | Envtest controller test for FileExposure reconciler. |
| file/go.sum.license | REUSE/SPDX metadata for module go.sum. |
| file/go.mod | File operator module dependencies and local replaces. |
| file/config/webhook/manifests.yaml | ValidatingWebhookConfiguration manifest. |
| file/config/samples/file_v1_zoneserviceconfig.yaml | Sample ZoneServiceConfig instance. |
| file/config/samples/file_v1_filetype.yaml | Sample FileType instance. |
| file/config/samples/file_v1_filesubscription.yaml | Sample FileSubscription instance. |
| file/config/samples/file_v1_fileexposure.yaml | Sample FileExposure instance. |
| file/config/rbac/service_account.yaml | ServiceAccount for file operator. |
| file/config/rbac/role.yaml | ClusterRole for operator permissions. |
| file/config/rbac/role_binding.yaml | ClusterRoleBinding for operator. |
| file/config/rbac/metrics_reader_role.yaml | Metrics reader ClusterRole. |
| file/config/rbac/metrics_auth_role.yaml | Metrics auth ClusterRole. |
| file/config/rbac/metrics_auth_role_binding.yaml | Metrics auth ClusterRoleBinding. |
| file/config/rbac/leader_election_role.yaml | Leader election Role. |
| file/config/rbac/leader_election_role_binding.yaml | Leader election RoleBinding. |
| file/config/rbac/kustomization.yaml | RBAC kustomize aggregation. |
| file/config/manager/manager.yaml | Controller manager Deployment. |
| file/config/manager/kustomization.yaml | Manager kustomization (image override). |
| file/config/default/namespace_patch.yaml | Namespace patch enabling secret-manager integration label. |
| file/config/default/kustomization.yaml | Default overlay kustomization. |
| file/config/default/deployment_patch.yaml | Deployment patch adding projected secret-manager token + trust bundle mount. |
| file/config/crd/kustomization.yaml | CRD kustomization. |
| file/config/crd/bases/file.cp.ei.telekom.de_zoneserviceconfigs.yaml | ZoneServiceConfig CRD. |
| file/config/crd/bases/file.cp.ei.telekom.de_filetypes.yaml | FileType CRD. |
| file/config/crd/bases/file.cp.ei.telekom.de_filesubscriptions.yaml | FileSubscription CRD. |
| file/config/crd/bases/file.cp.ei.telekom.de_fileexposures.yaml | FileExposure CRD. |
| file/cmd/file-operator/main.go | Operator entrypoint (controllers, indices, metrics, webhook server). |
| file/api/v1/zz_generated.deepcopy.go | Generated deepcopy implementations for file APIs. |
| file/api/v1/zoneserviceconfig_types.go | ZoneServiceConfig API type definitions. |
| file/api/v1/shared_types.go | Shared enums/types (visibility, approval strategy, SSH keys, labels). |
| file/api/v1/groupversion_info.go | API group/version registration. |
| file/api/v1/filetype_types.go | FileType API type definitions. |
| file/api/v1/filesubscription_types.go | FileSubscription API type definitions. |
| file/api/v1/fileexposure_types.go | FileExposure API type definitions. |
| file/api/go.sum.license | REUSE/SPDX metadata for api module go.sum. |
| file/api/go.mod | API submodule dependencies and local replaces. |
| file/.gitignore | Ignores binaries and test artifacts for file module. |
| docs/docs/architecture/file.mdx | Architecture documentation for the new file domain. |
| .goreleaser.yaml | Adds file-operator build to releases. |
| .github/workflows/ci.yaml | Adds reusable CI job for the file module. |
Files not reviewed (1)
- file/api/v1/zz_generated.deepcopy.go: Generated file
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
lukas016
force-pushed
the
feat-lk-file-domain
branch
from
August 4, 2026 12:12
b4c0207 to
f78b00a
Compare
lukas016
force-pushed
the
feat-lk-file-domain
branch
from
August 6, 2026 13:30
e9edb99 to
972c03f
Compare
lukas016
requested review from
BjoernKarma,
iagarba,
julius-malcovsky and
stefan-ctrl
August 18, 2026 09:06
ron96g
requested changes
Aug 31, 2026
ron96g
left a comment
ron96g
left a comment
Member
There was a problem hiding this comment.
This review was done by hand ;) I might ask AI to review it also, this might result in more comments:
- Please check the conditions in common and align where applicable
- Think about the caching improvement in main.go
- I think the idea with the Active-Exposure via FileType-Status is fine but it does break our current pattern
|
|
||
| list := &filev1.FileExposureList{} | ||
| err := r.List(ctx, list, | ||
| client.InNamespace(fileType.Namespace), |
Member
There was a problem hiding this comment.
The FileType can be in a different NS. e.g. specified by team-a and exposed by team-b
Contributor
Author
There was a problem hiding this comment.
we have open discussion about it somewhere, if we want to support it. Because you can still data with this approach from another team.
|
|
||
| list := &filev1.FileExposureList{} | ||
| if err := r.List(ctx, list, | ||
| client.InNamespace(zoneServiceConfig.Labels[cconfig.EnvironmentLabelKey]), |
Member
There was a problem hiding this comment.
The FileExposure is in the team-NS or not? So it cannot be selected via environment
| type FileExposureSpec struct { | ||
| // Provider optionally identifies the providing application. | ||
| // +kubebuilder:validation:Optional | ||
| Provider string `json:"provider,omitempty"` |
Member
There was a problem hiding this comment.
Why optionally? And why string in favour of ObjectRef?
Contributor
Author
There was a problem hiding this comment.
we will implement it later as additional field.
| Provider string `json:"provider,omitempty"` | ||
|
|
||
| // +kubebuilder:validation:Required | ||
| FileType string `json:"fileType"` |
Member
There was a problem hiding this comment.
would be nice to have a comment on here. Like "This is the unique identifier of the FileType that is being exposed"
| FileSolutionSFTP FileSolution = "sftp" | ||
| ) | ||
|
|
||
| func (s FileSolution) OrDefault() FileSolution { |
| metricsServerOptions.KeyName = metricsCertKey | ||
| } | ||
|
|
||
| mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), ctrl.Options{ |
Member
There was a problem hiding this comment.
I propose to add a cache-selector similiar to event to avoid caching Consumer, Routes, etc. that do not belong to this domains as otherwise this will drastically increase the cache-size without any benefit
| return apiClient, nil | ||
| } | ||
|
|
||
| weekBeforeExp := apiClient.Status.SecretExpiresAt.Add(-7 * 24 * time.Hour) |
Member
There was a problem hiding this comment.
Internal realms will have the secret-rotation disabled for now. Thus, this is dead-code. I would propose to remove it and then in the future when it comes to it, we need to find a central solution
Contributor
Author
There was a problem hiding this comment.
do you need central solution for it? Technically this client is created and manage by sftp operator. SO it should control secret rotation too.
| } | ||
| } | ||
|
|
||
| clientSecretPath := fmt.Sprintf("zones/%s/file/%s/%s/clientSecret", zone.Name, obj.Namespace, obj.Name) |
Member
There was a problem hiding this comment.
Why is namespace and name needed? The idea is 1 ZoneConfig per Zone
Contributor
Author
There was a problem hiding this comment.
yes it is. but this for me more user-friendly because you have direct mapping between zoneserviceconfig and related credential
Contributor
Author
There was a problem hiding this comment.
without resource name
| } | ||
|
|
||
| // createOrUpdateSFTPAPIClient creates or updates an identity Client for the SFTP API. | ||
| func createOrUpdateSFTPAPIClient(ctx context.Context, obj *filev1.ZoneServiceConfig, zone *adminv1.Zone) (*identityv1.Client, error) { |
Member
There was a problem hiding this comment.
I would propose to refactor this function and remove the creation part into a separate function?
| secretsapi.WithSecretValue(clientSecretPath, secretValue), | ||
| } | ||
|
|
||
| availableSecret, err := secretsapi.API().UpsertEnvironment(ctx, zone.Labels[cconfig.EnvironmentLabelKey], options...) |
Member
There was a problem hiding this comment.
zone.Labels[cconfig.EnvironmentLabelKey] can be replaced by contextutil.EnvFromContextOrDie
- implement proper webhook - add support for metrics - unified ssh keys validation with sftp domain
- remove leftoversa - simplified function for getting canonical keys
lukas016
force-pushed
the
feat-lk-file-domain
branch
from
September 2, 2026 12:59
972c03f to
e51cdf3
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR introduces the new file domain to controlplane by adding the v1 API types and generated CRD manifests for FileType, FileExposure, FileSubscription, and ZoneServiceConfig, along with the required kubebuilder registration, typed references, label utilities, and validation/webhook scaffolding needed to manage file-based resources and zone-scoped configuration in the platform. It also includes test coverage for handler and webhook behavior to confirm the expected lifecycle and validation logic.