Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: promotion directives foundation #2536

Merged
merged 26 commits into from
Sep 16, 2024
Merged

feat: promotion directives foundation #2536

merged 26 commits into from
Sep 16, 2024

Conversation

hiddeco
Copy link
Contributor

@hiddeco hiddeco commented Sep 16, 2024 •
edited
Loading

This adds the low-level code for Promotion directives as described in #2219. It does not include the wiring of the Promotion directives engine into any controller and/or reconciler, nor does it contain changes to Kargo's declarative API.

It does contain:

  • A primitive engine to run directive steps
  • A set of "Promotion directives"
    • copy
    • helm-update-image
    • helm-update-chart
    • helm-template
    • kustomize-set-image
    • kustomize-build
  • Not fully implemented:
    • git-checkout
    • git-commit
    • git-push

hiddeco and others added 26 commits September 16, 2024 17:10
@hiddeco
feat: Promotion Directives engine outline
22c288e 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
feat: outline directive implementation example
ee6b9dd 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
chore: slightly reorganize namings
1186022 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@krancour @hiddeco
initial scaffolding for directive validation and git-based directives
9b79add 
Signed-off-by: Kent Rancourt <kent.rancourt@gmail.com>
@krancour @hiddeco
fix minor lint issues
0a8b0a6 
Signed-off-by: Kent Rancourt <kent.rancourt@gmail.com>
@krancour @hiddeco
update directive registration and execution engine to manage special …
83d7cb7 
…privileges

Signed-off-by: Kent Rancourt <kent.rancourt@gmail.com>
@krancour @hiddeco
fix directive execution engine bug that was creating a file instead o…
f44d48d 
…f a dir

Signed-off-by: Kent Rancourt <kent.rancourt@gmail.com>
@hiddeco
feat: implement copy directive
3c73d1d 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@krancour @hiddeco
feat: add Output to directive Result
9ebac87 
Signed-off-by: Kent Rancourt <kent.rancourt@gmail.com>
@hiddeco
chore: allow precise control over returned Result
13b845b 
With an eye on more status types getting introduced later. It is of
importance to maintain control over what `Result` is being returned,
instead of marking everything as a `Failure` on any error.

Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
chore: prepare Freight utils to work without Stage
67c7222 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
feat: introduce helm-update-chart directive
3fc47d2 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
feat: add helm-update-image directive
4562bb7 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
feat: add helm-template directive
df54a38 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
chore: improve and add helm-update-chart tests
e361719 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
chore: improve helm-update-image code and tests
21be15f 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
chore: avoid returning duplicate error string
cea0eb6 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
chore: tweak directive constructors
d9f3137 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
chore: incorporate Result changes
1983c7d 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
feat: provide commit msg output for helm-update-image
6d9f7b5 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
feat: provide commit msg output for helm-chart-update
6a82ed0 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
feat(yaml): enrich YAML modification utilities
02c3ee7 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
feat: implement kustomize edit set-image directive
3f384e9 
This includes some tiny changes to existing Helm directive configs.
In the hope it would solve the issue of the origin suddenly being
generated as `ChartFromOrigin`, which (sadly) did not resolve the
issue.

Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
feat: implement kustomize build directive
3321673 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
chore: re-use FindImage logic in kustomize-set-image
e50268e 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco
feat: provide commit msg output for kustomize-set-image
41b3181 
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
@hiddeco hiddeco requested a review from a team as a code owner September 16, 2024 15:13
@netlify Netlify
Copy link

netlify bot commented Sep 16, 2024 •
edited
Loading

✅ Deploy Preview for docs-kargo-akuity-io ready!

Name Link
🔨 Latest commit 41b3181
🔍 Latest deploy log https://app.netlify.com/sites/docs-kargo-akuity-io/deploys/66e84b2839dd9c0008cd7186
😎 Deploy Preview https://deploy-preview-2536.kargo.akuity.io
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@codecov Codecov
Copy link

codecov bot commented Sep 16, 2024 •
edited
Loading

Codecov Report

Attention: Patch coverage is 77.88066% with 215 lines in your changes missing coverage. Please review.

Project coverage is 49.74%. Comparing base (7a07a29) to head (41b3181).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...ternal/directives/kustomize_set_image_directive.go 73.18% 34 Missing and 14 partials ⚠️
internal/directives/helm_update_chart_directive.go 79.39% 29 Missing and 12 partials ⚠️
internal/directives/helm_template_directive.go 76.74% 16 Missing and 4 partials ⚠️
internal/directives/kustomize_build_directive.go 54.54% 14 Missing and 6 partials ⚠️
internal/directives/helm_update_image_directive.go 83.33% 14 Missing and 2 partials ⚠️
internal/helm/registry.go 0.00% 14 Missing ⚠️
internal/directives/copy_directive.go 70.73% 10 Missing and 2 partials ⚠️
internal/directives/engine.go 73.68% 5 Missing and 5 partials ⚠️
internal/yaml/update.go 90.00% 6 Missing and 3 partials ⚠️
internal/directives/directive.go 72.72% 3 Missing and 3 partials ⚠️
... and 8 more
Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #2536      +/-   ##
==========================================
+ Coverage   48.26%   49.74%   +1.48%     
==========================================
  Files         255      272      +17     
  Lines       18141    19078     +937     
==========================================
+ Hits         8755     9490     +735     
- Misses       8897     9044     +147     
- Partials      489      544      +55

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

krancour
krancour approved these changes Sep 16, 2024
View reviewed changes
Copy link
Member

@krancour krancour left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hiddeco and I have closely collaborated on what is in hiddeco:promotion-directives, so this is a token LGTM.

@krancour krancour added this to the v0.9.0 milestone Sep 16, 2024
@hiddeco hiddeco added this pull request to the merge queue Sep 16, 2024
Merged via the queue into akuity:main with commit a03e949 Sep 16, 2024
24 checks passed
@krancour krancour mentioned this pull request Sep 26, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@krancour krancour krancour approved these changes

Assignees

@hiddeco hiddeco

Labels
kind/enhancement priority/normal size/xx-large
Projects
None yet
Milestone
v0.9.0
Development

Successfully merging this pull request may close these issues.
2 participants
@hiddeco @krancour