feat(api): add endpoints to get AnalysisTemplate config resources

[devholic]

This commit adds endpoints to get env resources - ConfigMap and Secret - which can be used in the AnalysisTemplate, to allow users to manage those resources in the Kargo UI. The ConfigMap and Secret must be labeled with kargo.akuity.io/analysis-env: "true" to be returned in API.

Note

• We may leverage existing Create/Update/DeleteResource API to manage ConfigMap and Secret, same as the AnalysisTemplate (cc @gdsoumya)

Open Questions

• I'm not sure about the kargo.akuity.io/analysis-env key naming, could anyone give other suggestions?

[netlify]

✅ Deploy Preview for docs-kargo-akuity-io canceled.

Name	Link
🔨 Latest commit	a3a8feb
🔍 Latest deploy log	https://app.netlify.com/sites/docs-kargo-akuity-io/deploys/66e10a2157f096000856b482

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 160 lines in your changes missing coverage. Please review.

Project coverage is 48.32%. Comparing base (2ab4270) to head (a3a8feb).
Report is 19 commits behind head on main.

Files with missing lines	Patch %	Lines
...l/api/get_analysis_template_config_map_v1alpha1.go	0.00%	52 Missing ⚠️
...ernal/api/get_analysis_template_secret_v1alpha1.go	0.00%	52 Missing ⚠️
...api/list_analysis_template_config_maps_v1alpha1.go	0.00%	28 Missing ⚠️
...nal/api/list_analysis_template_secrets_v1alpha1.go	0.00%	28 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2480      +/-   ##
==========================================
+ Coverage   48.27%   48.32%   +0.04%     
==========================================
  Files         246      254       +8     
  Lines       17739    18133     +394     
==========================================
+ Hits         8564     8762     +198     
- Misses       8749     8889     +140     
- Partials      426      482      +56     

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

[gdsoumya]

LGTM

[hiddeco]

What about just calling the annotation /ui-managed (to compliment /managed), so that we can eventually utilize it in other places without having to introduce a bazillion annotations?

[hiddeco]

The other option I can think of, as it's theoretically not just the UI, is to call it /api-managed or /api-accessible.

[hiddeco]

Talked this through some more offline, and the worry with a /api-managed or /api-accessible endpoint is that a value of true would not allow the caller to "categorize" the ConfigMaps and/or Secrets they retrieve.

Given this, and with an eye on the future, I propose looking for a generic label name with a special categorized value, e.g., env. This way, we allow room for future enhancements in which we add new categories, potentially using a generic endpoint that accepts a query parameter to set the value.

[devholic]

@hiddeco

Talked this through some more offline, and the worry with a /api-managed or /api-accessible endpoint is that a value of true would not allow the caller to "categorize" the ConfigMaps and/or Secrets they retrieve.

Given this, and with an eye on the future, I propose looking for a generic label name with a special categorized value, e.g., env. This way, we allow room for future enhancements in which we add new categories, potentially using a generic endpoint that accepts a query parameter to set the value.

If we have generic label name and using categorized value, couldn’t we leverage the Kubernetes’s label selector? For example, kargo.akuity.io/configmaps: "analysis-env" and if we add another categorized value (such as) stage-env , the label should be kargo.akuity.io/configmaps: "analysis-env, stage-env" but not sure if we can leverage label selector in this case.

[hiddeco]

Yes, you can use a label selector, which we have already been doing for credential secrets (and what is being practiced in this PR). However, this does not work when getting a specific object, which requires additional verification.

[devholic]

Then I'll choose to use kargo.akuity.io/analysis-run-template: "config" for both ConfigMap and Secret - The reason I chose config over env is that both of them can be used as a volume

WDYT? @hiddeco @gdsoumya