Implement functions to find referencing ConfigMaps and Secrets in Kubernetes manifests by Warashi · Pull Request #5409 · pipe-cd/pipecd

Warashi · 2024-12-11T00:24:57Z

What this PR does:

as title

Why we need it:

I want to implement annotateConfigHash in the k8s plugin.
To implement this, we need to find the configmap and secrets referenced in the deployments.

pipecd/pkg/app/piped/executor/kubernetes/kubernetes.go

Lines 582 to 587 in e276b89

    
           // annotateConfigHash appends a hash annotation into the workload manifests. 
        
           // The hash value is calculated by hashing the content of all configmaps/secrets 
        
           // that are referenced by the workload. 
        
           // This appending ensures that the workload should be restarted when 
        
           // one of its configurations changed. 
        
           func annotateConfigHash(manifests []provider.Manifest) error {

Which issue(s) this PR fixes:

Part of #4980

Does this PR introduce a user-facing change?: No

How are users affected by this change:
Is this breaking change:
How to migrate (if breaking change):

…ernetes manifests Signed-off-by: Shinnosuke Sawada-Dazai <shin@warashi.dev>

codecov · 2024-12-11T00:29:03Z

Codecov Report

Attention: Patch coverage is 82.35294% with 12 lines in your changes missing coverage. Please review.

Project coverage is 25.81%. Comparing base (e276b89) to head (52a8371).
Report is 2 commits behind head on master.

Files with missing lines	Patch %	Lines
...p/pipedv1/plugin/kubernetes/provider/deployment.go	82.35%	8 Missing and 4 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #5409      +/-   ##
==========================================
+ Coverage   25.74%   25.81%   +0.06%     
==========================================
  Files         449      450       +1     
  Lines       48452    48520      +68     
==========================================
+ Hits        12474    12524      +50     
- Misses      35005    35019      +14     
- Partials      973      977       +4

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

Warashi · 2024-12-11T00:26:04Z

pkg/app/pipedv1/plugin/kubernetes/provider/deployment_test.go

+	}
+}
+
+func TestFindReferencingConfigMaps(t *testing.T) {


This test is mainly copied from below

pipecd/pkg/app/piped/platformprovider/kubernetes/deployment_test.go

Line 26 in e276b89

func TestFindReferencingConfigMapsInDeployment(t *testing.T) {

Warashi · 2024-12-11T00:26:45Z

pkg/app/pipedv1/plugin/kubernetes/provider/deployment_test.go

+	}
+}
+
+func TestFindReferencingSecrets(t *testing.T) {


this test is mainly copied from below

pipecd/pkg/app/piped/platformprovider/kubernetes/deployment_test.go

Line 193 in e276b89

func TestFindReferencingSecretsInDeployment(t *testing.T) {

Warashi · 2024-12-11T00:28:24Z

pkg/app/pipedv1/plugin/kubernetes/provider/deployment.go

+// - spec.template.spec.initContainers.envFrom.configMapRef.name
+// - spec.template.spec.containers.env.valueFrom.configMapKeyRef.name
+// - spec.template.spec.containers.envFrom.configMapRef.name
+func FindReferencingConfigMaps(m *unstructured.Unstructured) []string {


I implemented this function with the reference below.

pipecd/pkg/app/piped/platformprovider/kubernetes/deployment.go

Line 24 in e276b89

func FindReferencingConfigMapsInDeployment(d *appsv1.Deployment) []string {

Warashi · 2024-12-11T00:29:02Z

pkg/app/pipedv1/plugin/kubernetes/provider/deployment.go

+// - spec.template.spec.initContainers.envFrom.secretRef.name
+// - spec.template.spec.containers.env.valueFrom.secretKeyRef.name
+// - spec.template.spec.containers.envFrom.secretRef.name
+func FindReferencingSecrets(m *unstructured.Unstructured) []string {


I implemented this function with the reference below.

pipecd/pkg/app/piped/platformprovider/kubernetes/deployment.go

Line 68 in e276b89

func FindReferencingSecretsInDeployment(d *appsv1.Deployment) []string {

Warashi · 2024-12-11T01:08:41Z

pkg/app/pipedv1/plugin/kubernetes/provider/deployment.go

+// nestedStringSlice extracts a string slice from the given object by following the fields.
+// It returns the extracted string slice.
+// If there is []map[string]any in the middle of the fields, it will be flattened.
+func nestedStringSlice(obj any, fields ...string) []string {


I don't want to convert the unstructured.Unstructured to appsv1.Deployment or something, so I implemented this.
We cannot use unstructured.NestedStringSlice because it handles the []map[string]any differently.

@Warashi
[Ask]

We cannot use unstructured.NestedStringSlice because it handles the []map[string]any differently.

What's the difference between unstructured.NestedStringSlice and nestedStringSlice ?

@ffjlabo
unstructured.NestedStringSlice returns an error when there is []map[string]any in the middle of the fields. On the other hand, nestedStringSlice flattens it.

@Warashi
I got your point. I tried to use unstructured.NestedStringSlice with the data below.
We can't find and flatten slices in the []interface{}{map[string]interface{}{}}.

obj := map[string]interface{}{ "spec": map[string]interface{}{ "template": map[string]interface{}{ "spec": map[string]interface{}{ "volumes": []interface{}{ map[string]interface{}{ "configMap": map[string]interface{}{ "name": "canary-by-config-change", }, }, }, }, }, }, } res, exists, err := unstructured.NestedStringSlice(obj, "spec", "template", "spec", "volumes[]", "configMap", "name") assert.True(t, exists) assert.NoError(t, err) assert.Equal(t, res, []string{"canary-by-config-change"})

=== RUN Test Error: Should be true Error: Received unexpected error: .spec.template.spec.volumes.configMap accessor error: [map[configMap:map[name:canary-by-config-change]]] is of the type []interface {}, expected map[string]interface{} Error: Not equal: expected: []string(nil) actual : []string{"canary-by-config-change"} Diff: --- Expected +++ Actual @@ -1,2 +1,4 @@ -([]string) <nil> +([]string) (len=1) { + (string) (len=23) "canary-by-config-change" +} Test: Test

The test for unstructured.NestedFieldNoCopy (used in the unstructured.NestedStringSlice) shows it.
https://github.com/kubernetes/apimachinery/blob/master/pkg/apis/meta/v1/unstructured/helpers_test.go#L122

khanhtc1202

LGTM 👍

ffjlabo

LGTM 🙆‍♂️

Implement functions to find referencing ConfigMaps and Secrets in Kub…

52a8371

…ernetes manifests Signed-off-by: Shinnosuke Sawada-Dazai <shin@warashi.dev>

github-actions bot added area/go area/pipedv1 labels Dec 11, 2024

Warashi commented Dec 11, 2024

View reviewed changes

Warashi marked this pull request as ready for review December 11, 2024 01:09

Warashi requested review from ffjlabo, kentakozuka, khanhtc1202, nghialv and t-kikuc as code owners December 11, 2024 01:09

khanhtc1202 approved these changes Dec 11, 2024

View reviewed changes

ffjlabo approved these changes Dec 12, 2024

View reviewed changes

Warashi merged commit 6b63206 into master Dec 12, 2024

Warashi deleted the k8s-plugin-find-ref branch December 12, 2024 07:50

github-actions bot mentioned this pull request Jan 21, 2025

Release v0.50.1 #5498

Merged

github-actions bot mentioned this pull request Feb 17, 2025

update RELEASE to v0.50.2 #5571

Merged

github-actions bot mentioned this pull request Mar 14, 2025

Release version v0.50.3 #5665

Closed

github-actions bot mentioned this pull request Mar 25, 2025

Release v0.51.0 #5695

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement functions to find referencing ConfigMaps and Secrets in Kubernetes manifests#5409

Implement functions to find referencing ConfigMaps and Secrets in Kubernetes manifests#5409
Warashi merged 1 commit intomasterfrom
k8s-plugin-find-ref

Warashi commented Dec 11, 2024

Uh oh!

codecov bot commented Dec 11, 2024 •

edited

Loading

Uh oh!

Warashi Dec 11, 2024

Uh oh!

Warashi Dec 11, 2024

Uh oh!

Warashi Dec 11, 2024

Uh oh!

Warashi Dec 11, 2024

Uh oh!

Warashi Dec 11, 2024

Uh oh!

ffjlabo Dec 12, 2024

Uh oh!

Warashi Dec 12, 2024

Uh oh!

ffjlabo Dec 12, 2024

Uh oh!

khanhtc1202 left a comment

Uh oh!

ffjlabo left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	// annotateConfigHash appends a hash annotation into the workload manifests.
	// The hash value is calculated by hashing the content of all configmaps/secrets
	// that are referenced by the workload.
	// This appending ensures that the workload should be restarted when
	// one of its configurations changed.
	func annotateConfigHash(manifests []provider.Manifest) error {

Conversation

Warashi commented Dec 11, 2024

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

khanhtc1202 left a comment

Choose a reason for hiding this comment

Uh oh!

ffjlabo left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented Dec 11, 2024 •

edited

Loading