feat: Update GitOps scaffolding #1607

devantler · 2025-12-28T16:24:40Z

Introduce a new GitOpsCRDetector for detecting existing resources and update the scaffolder to generate appropriate CR manifests. Adjust documentation to reflect these changes and correct table formatting in the configuration documentation.

Also remove the Flux interval configuration from KSail to streamline GitOps resource management.

Fixes #1604

Type of change

…ps resources - Removed the Flux interval configuration from the KSail spec. - Updated documentation to reflect changes in GitOps engine scaffolding. - Introduced GitOpsCRDetector for detecting existing FluxInstance and ArgoCD Application resources. - Added generators for FluxInstance and ArgoCD Application CR manifests. - Updated scaffolder to generate GitOps resources based on the configured GitOps engine. - Removed Flux interval validation and related tests. - Adjusted resource building logic to use default interval values from the generated CRs. Signed-off-by: Nikolai Emil Damm <nikolaiemildamm@icloud.com>

Signed-off-by: Nikolai Emil Damm <nikolaiemildamm@icloud.com>

github-actions · 2025-12-28T16:28:20Z

✅MegaLinter analysis: Success

✅ Linters with no issues

actionlint, bash-exec, checkov, git_diff, grype, hadolint, jscpd, jsonlint, lychee, markdown-table-formatter, markdownlint, prettier, prettier, shellcheck, shfmt, syft, trivy, trivy-sbom, trufflehog, v8r, v8r, yamllint

See detailed reports in MegaLinter artifacts

Signed-off-by: Nikolai Emil Damm <nikolaiemildamm@icloud.com>

codecov · 2025-12-28T16:47:59Z

Codecov Report

❌ Patch coverage is 82.16561% with 56 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
pkg/io/scaffolder/scaffolder.go	74.17%	29 Missing and 10 partials ⚠️
pkg/io/detector/gitops.go	82.85%	6 Missing and 6 partials ⚠️
pkg/io/generator/argocd/application.go	95.34%	1 Missing and 1 partial ⚠️
pkg/io/generator/flux/flux_instance.go	94.73%	1 Missing and 1 partial ⚠️
pkg/svc/installer/flux/resources.go	0.00%	1 Missing ⚠️

📢 Thoughts on this report? Let us know!

Copilot

Pull request overview

This PR implements GitOps CR scaffolding support, introducing automated generation of FluxInstance and ArgoCD Application custom resources when a GitOps engine is configured. The feature removes the Flux interval configuration from the KSail config schema (moving it to the FluxInstance CR) and adds detection logic to prevent overwriting existing GitOps CRs.

Key changes:

New GitOpsCRDetector that recursively searches for existing FluxInstance/ArgoCD Application CRs by matching apiVersion, kind, and KSail-managed identifiers (name or label)
New generators for FluxInstance and ArgoCD Application CRs with OCI registry configuration
Removed spec.cluster.flux.interval configuration field and related validation, tests, and field selectors

Reviewed changes

Copilot reviewed 28 out of 29 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
`schemas/ksail-config.schema.json`	Removed Flux interval configuration from schema, marked flux options as alpha placeholder
`pkg/svc/installer/flux/resources.go`	Updated to use fallback interval instead of config-based interval
`pkg/io/validator/ksail/validator_test.go`	Removed test case for Flux interval validation
`pkg/io/validator/ksail/validator.go`	Removed Flux interval validation logic
`pkg/io/scaffolder/scaffolder.go`	Added GitOps CR scaffolding with detection and kustomization resource references
`pkg/io/generator/kustomization/generator.go`	Added nil check for Resources field initialization
`pkg/io/generator/generator.go`	Added BuildOCIURL utility function for constructing OCI registry URLs
`pkg/io/generator/flux/flux_instance.go`	New generator for FluxInstance CR manifests
`pkg/io/generator/argocd/application.go`	New generator for ArgoCD Application CR manifests
`pkg/io/detector/gitops.go`	New detector for finding existing GitOps CRs in source directory
`pkg/io/detector/doc.go`	Package documentation for detector
`pkg/io/config-manager/ksail/manager_test.go`	Removed tests for Flux interval parsing
`pkg/io/config-manager/ksail/field_selector_test.go`	Removed tests and assertions for Flux interval field selector
`pkg/io/config-manager/ksail/field_selector.go`	Removed DefaultFluxIntervalFieldSelector
`pkg/io/config-manager/ksail/binding_test.go`	Removed Flux interval field test cases
`pkg/io/config-manager/ksail/binding.go`	Removed flux-interval field mapping
`pkg/apis/cluster/v1alpha1/types.go`	Removed Interval field from OptionsFlux struct
`pkg/apis/cluster/v1alpha1/marshal.go`	Removed Flux interval marshalling logic
`pkg/apis/cluster/v1alpha1/defaults.go`	Removed DefaultFluxInterval constant and imports
`go.sum`	Updated c2sp.org/CCTV/age and filippo.io/age dependencies
`docs/declarative-configuration.md`	Updated GitOps engine documentation and removed Flux interval option
`docs/core-concepts.md`	Updated GitOps section with CR scaffolding information
`docs/cli-flags/*`	Removed --flux-interval flag from all CLI command documentation

pkg/io/detector/gitops.go

pkg/io/generator/flux/flux_instance.go

pkg/io/scaffolder/scaffolder.go

pkg/io/detector/gitops.go

pkg/io/generator/flux/flux_instance.go

pkg/io/generator/argocd/application.go

pkg/io/generator/generator.go

…ation-crs

- Fix YAML document separator pattern to handle files starting with '---' - Fix FluxInstance Ref field from 'oci://latest' to 'latest' - Add comprehensive unit tests for GitOpsCRDetector - Add comprehensive unit tests for FluxInstance generator - Add comprehensive unit tests for ArgoCD Application generator - Add comprehensive unit tests for BuildOCIURL utility function

Copilot

Pull request overview

Copilot reviewed 34 out of 34 changed files in this pull request and generated 5 comments.

pkg/io/scaffolder/scaffolder.go

pkg/io/generator/flux/flux_instance.go

pkg/io/generator/argocd/application.go

pkg/io/scaffolder/scaffolder.go

… code - Add json struct tags to FluxInstance types for sigs.k8s.io/yaml compatibility - Add json struct tags to ArgoCD Application types for sigs.k8s.io/yaml compatibility - Remove redundant GitOpsEngineNone case in generateGitOpsConfig (already handled earlier) - Update test snapshots with correct lowercase YAML field names

…ation-crs

Copilot

Pull request overview

Copilot reviewed 34 out of 34 changed files in this pull request and generated 1 comment.

pkg/io/scaffolder/scaffolder.go

…ation-crs

Signed-off-by: Nikolai Emil Damm <nikolaiemildamm@icloud.com>

Copilot

Pull request overview

Copilot reviewed 35 out of 35 changed files in this pull request and generated no new comments.

* feat: remove Flux interval configuration from KSail and scaffold GitOps resources - Removed the Flux interval configuration from the KSail spec. - Updated documentation to reflect changes in GitOps engine scaffolding. - Introduced GitOpsCRDetector for detecting existing FluxInstance and ArgoCD Application resources. - Added generators for FluxInstance and ArgoCD Application CR manifests. - Updated scaffolder to generate GitOps resources based on the configured GitOps engine. - Removed Flux interval validation and related tests. - Adjusted resource building logic to use default interval values from the generated CRs. Signed-off-by: Nikolai Emil Damm <nikolaiemildamm@icloud.com> * fix: correct table formatting in declarative configuration documentation Signed-off-by: Nikolai Emil Damm <nikolaiemildamm@icloud.com> * chore: update generated JSON schema * chore: tidy go modules * chore: update generated CLI flags docs * feat: refactor OCI URL construction to use shared generator function Signed-off-by: Nikolai Emil Damm <nikolaiemildamm@icloud.com> * chore: Apply megalinter fixes * chore: apply golangci-lint fixes * fix: address PR review feedback for GitOps scaffolding - Fix YAML document separator pattern to handle files starting with '---' - Fix FluxInstance Ref field from 'oci://latest' to 'latest' - Add comprehensive unit tests for GitOpsCRDetector - Add comprehensive unit tests for FluxInstance generator - Add comprehensive unit tests for ArgoCD Application generator - Add comprehensive unit tests for BuildOCIURL utility function * fix: add json struct tags for proper YAML field names and remove dead code - Add json struct tags to FluxInstance types for sigs.k8s.io/yaml compatibility - Add json struct tags to ArgoCD Application types for sigs.k8s.io/yaml compatibility - Remove redundant GitOpsEngineNone case in generateGitOpsConfig (already handled earlier) - Update test snapshots with correct lowercase YAML field names * fix: golangci-lint issues Signed-off-by: Nikolai Emil Damm <nikolaiemildamm@icloud.com> * test: add GitOps scaffolding tests for Flux and ArgoCD Signed-off-by: Nikolai Emil Damm <nikolaiemildamm@icloud.com> --------- Signed-off-by: Nikolai Emil Damm <nikolaiemildamm@icloud.com> Co-authored-by: devantler <26203420+devantler@users.noreply.github.com> Co-authored-by: botantler[bot] <185060876+botantler[bot]@users.noreply.github.com>

* docs: rework documentation for configuration - Created documentation for `ksail workload install`, `logs`, `push`, `reconcile`, `root`, `scale`, `validate`, and `wait` commands. - Added a comprehensive `declarative-configuration.md` file detailing the `ksail.yaml` structure and examples. - Updated `index.md` to include new configuration documentation and improved navigation. - Enhanced `core-concepts.md` and `use-cases.md` to reference the new documentation structure. Signed-off-by: Nikolai Emil Damm <nikolaiemildamm@icloud.com> * feat: Update GitOps scaffolding (#1607) * feat: remove Flux interval configuration from KSail and scaffold GitOps resources - Removed the Flux interval configuration from the KSail spec. - Updated documentation to reflect changes in GitOps engine scaffolding. - Introduced GitOpsCRDetector for detecting existing FluxInstance and ArgoCD Application resources. - Added generators for FluxInstance and ArgoCD Application CR manifests. - Updated scaffolder to generate GitOps resources based on the configured GitOps engine. - Removed Flux interval validation and related tests. - Adjusted resource building logic to use default interval values from the generated CRs. Signed-off-by: Nikolai Emil Damm <nikolaiemildamm@icloud.com> * fix: correct table formatting in declarative configuration documentation Signed-off-by: Nikolai Emil Damm <nikolaiemildamm@icloud.com> * chore: update generated JSON schema * chore: tidy go modules * chore: update generated CLI flags docs * feat: refactor OCI URL construction to use shared generator function Signed-off-by: Nikolai Emil Damm <nikolaiemildamm@icloud.com> * chore: Apply megalinter fixes * chore: apply golangci-lint fixes * fix: address PR review feedback for GitOps scaffolding - Fix YAML document separator pattern to handle files starting with '---' - Fix FluxInstance Ref field from 'oci://latest' to 'latest' - Add comprehensive unit tests for GitOpsCRDetector - Add comprehensive unit tests for FluxInstance generator - Add comprehensive unit tests for ArgoCD Application generator - Add comprehensive unit tests for BuildOCIURL utility function * fix: add json struct tags for proper YAML field names and remove dead code - Add json struct tags to FluxInstance types for sigs.k8s.io/yaml compatibility - Add json struct tags to ArgoCD Application types for sigs.k8s.io/yaml compatibility - Remove redundant GitOpsEngineNone case in generateGitOpsConfig (already handled earlier) - Update test snapshots with correct lowercase YAML field names * fix: golangci-lint issues Signed-off-by: Nikolai Emil Damm <nikolaiemildamm@icloud.com> * test: add GitOps scaffolding tests for Flux and ArgoCD Signed-off-by: Nikolai Emil Damm <nikolaiemildamm@icloud.com> --------- Signed-off-by: Nikolai Emil Damm <nikolaiemildamm@icloud.com> Co-authored-by: devantler <26203420+devantler@users.noreply.github.com> Co-authored-by: botantler[bot] <185060876+botantler[bot]@users.noreply.github.com> * docs: simplify argument handling in generate_command_docs function Signed-off-by: Nikolai Emil Damm <nikolaiemildamm@icloud.com> --------- Signed-off-by: Nikolai Emil Damm <nikolaiemildamm@icloud.com> Co-authored-by: devantler <26203420+devantler@users.noreply.github.com> Co-authored-by: botantler[bot] <185060876+botantler[bot]@users.noreply.github.com>

devantler added 2 commits December 28, 2025 17:23

fix: correct table formatting in declarative configuration documentation

5dcaac5

Signed-off-by: Nikolai Emil Damm <nikolaiemildamm@icloud.com>

github-project-automation bot added this to 🌊 Project Board Dec 28, 2025

github-project-automation bot moved this to 🏃🏻‍♂️ In Progress in 🌊 Project Board Dec 28, 2025

devantler self-assigned this Dec 28, 2025

devantler added 2 commits December 28, 2025 16:25

chore: update generated JSON schema

f58311c

chore: tidy go modules

88547b7

botantler bot and others added 4 commits December 28, 2025 16:30

chore: update generated CLI flags docs

bfe399c

feat: refactor OCI URL construction to use shared generator function

d3f0964

Signed-off-by: Nikolai Emil Damm <nikolaiemildamm@icloud.com>

chore: Apply megalinter fixes

3224829

chore: apply golangci-lint fixes

5ef3076

devantler marked this pull request as ready for review December 28, 2025 16:52

Copilot AI review requested due to automatic review settings December 28, 2025 16:52

Copilot started reviewing on behalf of devantler December 28, 2025 16:52 View session

Copilot AI reviewed Dec 28, 2025

View reviewed changes

Copilot AI mentioned this pull request Dec 28, 2025

[WIP] Update GitOps scaffolding changes based on feedback #1613

Closed

5 tasks

devantler-tech deleted a comment from Copilot AI Dec 28, 2025

Merge branch 'main' into feat/scaffold-fluxinstance-and-argocd-applic…

87612c1

…ation-crs

github-actions bot approved these changes Dec 28, 2025

View reviewed changes

botantler bot enabled auto-merge (squash) December 28, 2025 17:07

Copilot AI review requested due to automatic review settings December 28, 2025 17:09

Copilot started reviewing on behalf of devantler December 28, 2025 17:10 View session

Copilot AI reviewed Dec 28, 2025

View reviewed changes

devantler and others added 2 commits December 28, 2025 18:24

Merge branch 'main' into feat/scaffold-fluxinstance-and-argocd-applic…

7c146fc

…ation-crs

Copilot AI review requested due to automatic review settings December 28, 2025 17:25

Copilot started reviewing on behalf of devantler December 28, 2025 17:25 View session

Copilot AI reviewed Dec 28, 2025

View reviewed changes

pkg/io/scaffolder/scaffolder.go Show resolved Hide resolved

devantler and others added 2 commits December 28, 2025 18:34

Merge branch 'main' into feat/scaffold-fluxinstance-and-argocd-applic…

7a6e30b

…ation-crs

fix: golangci-lint issues

5fce16f

Signed-off-by: Nikolai Emil Damm <nikolaiemildamm@icloud.com>

Copilot AI review requested due to automatic review settings December 28, 2025 17:44

Copilot started reviewing on behalf of devantler December 28, 2025 17:45 View session

test: add GitOps scaffolding tests for Flux and ArgoCD

66bd582

Signed-off-by: Nikolai Emil Damm <nikolaiemildamm@icloud.com>

Copilot AI reviewed Dec 28, 2025

View reviewed changes

devantler disabled auto-merge December 28, 2025 18:09

devantler merged commit 0dac39c into main Dec 28, 2025
48 of 50 checks passed

devantler deleted the feat/scaffold-fluxinstance-and-argocd-application-crs branch December 28, 2025 18:09

github-project-automation bot moved this from 🏃🏻‍♂️ In Progress to ✅ Done in 🌊 Project Board Dec 28, 2025

Uh oh!

feat: Update GitOps scaffolding #1607

feat: Update GitOps scaffolding #1607

Conversation

devantler commented Dec 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Type of change

Uh oh!

github-actions bot commented Dec 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅MegaLinter analysis: Success

✅ Linters with no issues

Uh oh!

codecov bot commented Dec 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

devantler commented Dec 28, 2025 •

edited

Loading

github-actions bot commented Dec 28, 2025 •

edited

Loading

codecov bot commented Dec 28, 2025 •

edited

Loading