-
Notifications
You must be signed in to change notification settings - Fork 612
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.
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
Implement flux debug kustomization
command
#5117
Open
stefanprodan
wants to merge
6
commits into
main
Choose a base branch
from
debug-kc
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
5cf0dcc
Add preview note to `debug hr`
stefanprodan 19568eb
Add missing copyright headers
stefanprodan 5b740c4
Implement `flux debug kustomization` command
stefanprodan 9b1b5e8
Add name completion to debug commands
stefanprodan 928ea24
Add links to status docs in `flux debug` commands
stefanprodan 5208515
Make `flux debug hr` single flag selection required
stefanprodan File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,134 @@ | ||
/* | ||
Copyright 2024 The Flux authors | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
package main | ||
|
||
import ( | ||
"context" | ||
"errors" | ||
"fmt" | ||
"sort" | ||
"strings" | ||
|
||
kustomizev1 "github.com/fluxcd/kustomize-controller/api/v1" | ||
"github.com/fluxcd/pkg/kustomize" | ||
"github.com/spf13/cobra" | ||
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured" | ||
"k8s.io/apimachinery/pkg/runtime" | ||
"k8s.io/apimachinery/pkg/types" | ||
"sigs.k8s.io/yaml" | ||
|
||
"github.com/fluxcd/flux2/v2/internal/utils" | ||
) | ||
|
||
var debugKustomizationCmd = &cobra.Command{ | ||
Use: "kustomization [name]", | ||
Aliases: []string{"ks"}, | ||
Short: "Debug a Flux Kustomization resource", | ||
Long: withPreviewNote(`The debug kustomization command can be used to troubleshoot failing Flux Kustomization reconciliations. | ||
WARNING: This command will print sensitive information if Kubernetes Secrets are referenced in the Kustomization .spec.postBuild.substituteFrom field.`), | ||
Example: ` # Print the status of a Flux Kustomization | ||
flux debug ks podinfo --show-status | ||
|
||
# Export the final variables used for post-build substitutions composed from referred ConfigMaps and Secrets | ||
flux debug ks podinfo --show-vars > vars.env`, | ||
RunE: debugKustomizationCmdRun, | ||
Args: cobra.ExactArgs(1), | ||
ValidArgsFunction: resourceNamesCompletionFunc(kustomizev1.GroupVersion.WithKind(kustomizev1.KustomizationKind)), | ||
} | ||
|
||
type debugKustomizationFlags struct { | ||
showStatus bool | ||
showVars bool | ||
} | ||
|
||
var debugKustomizationArgs debugKustomizationFlags | ||
|
||
func init() { | ||
debugKustomizationCmd.Flags().BoolVar(&debugKustomizationArgs.showStatus, "show-status", false, "print the status of the Flux Kustomization") | ||
debugKustomizationCmd.Flags().BoolVar(&debugKustomizationArgs.showVars, "show-vars", false, "print the final vars of the Flux Kustomization in dot env format") | ||
debugCmd.AddCommand(debugKustomizationCmd) | ||
} | ||
|
||
func debugKustomizationCmdRun(cmd *cobra.Command, args []string) error { | ||
name := args[0] | ||
|
||
if (!debugKustomizationArgs.showStatus && !debugKustomizationArgs.showVars) || | ||
(debugKustomizationArgs.showStatus && debugKustomizationArgs.showVars) { | ||
return fmt.Errorf("either --show-status or --show-vars must be set") | ||
} | ||
|
||
ctx, cancel := context.WithTimeout(context.Background(), rootArgs.timeout) | ||
defer cancel() | ||
|
||
kubeClient, err := utils.KubeClient(kubeconfigArgs, kubeclientOptions) | ||
if err != nil { | ||
return err | ||
} | ||
|
||
ks := &kustomizev1.Kustomization{} | ||
ksName := types.NamespacedName{Namespace: *kubeconfigArgs.Namespace, Name: name} | ||
if err := kubeClient.Get(ctx, ksName, ks); err != nil { | ||
return err | ||
} | ||
|
||
if debugKustomizationArgs.showStatus { | ||
status, err := yaml.Marshal(ks.Status) | ||
if err != nil { | ||
return err | ||
} | ||
rootCmd.Println("# Status documentation: https://fluxcd.io/flux/components/kustomize/kustomizations/#kustomization-status") | ||
rootCmd.Print(string(status)) | ||
darkowlzz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
return nil | ||
} | ||
|
||
if debugKustomizationArgs.showVars { | ||
if ks.Spec.PostBuild == nil { | ||
return errors.New("no post build substitutions found") | ||
} | ||
|
||
ksObj, err := runtime.DefaultUnstructuredConverter.ToUnstructured(ks) | ||
if err != nil { | ||
return err | ||
} | ||
|
||
finalVars, err := kustomize.LoadVariables(ctx, kubeClient, unstructured.Unstructured{Object: ksObj}) | ||
if err != nil { | ||
return err | ||
} | ||
|
||
if len(ks.Spec.PostBuild.Substitute) > 0 { | ||
darkowlzz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
for k, v := range ks.Spec.PostBuild.Substitute { | ||
// Remove new lines from the values as they are not supported. | ||
// Replicates the controller behavior from | ||
// https://github.com/fluxcd/pkg/blob/main/kustomize/kustomize_varsub.go | ||
finalVars[k] = strings.ReplaceAll(v, "\n", "") | ||
darkowlzz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} | ||
} | ||
|
||
keys := make([]string, 0, len(finalVars)) | ||
for k := range finalVars { | ||
keys = append(keys, k) | ||
} | ||
sort.Strings(keys) | ||
|
||
for _, k := range keys { | ||
rootCmd.Println(k + "=" + finalVars[k]) | ||
matheuscscp marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} | ||
} | ||
|
||
return nil | ||
} |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
//go:build unit | ||
// +build unit | ||
|
||
/* | ||
Copyright 2024 The Flux authors | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
package main | ||
|
||
import ( | ||
"testing" | ||
) | ||
|
||
func TestDebugKustomization(t *testing.T) { | ||
namespace := allocateNamespace("debug") | ||
|
||
objectFile := "testdata/debug_kustomization/objects.yaml" | ||
tmpl := map[string]string{ | ||
"fluxns": namespace, | ||
} | ||
testEnv.CreateObjectFile(objectFile, tmpl, t) | ||
|
||
cases := []struct { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can we add 2 more tests: one for both flags set, and one for neither flags set? |
||
name string | ||
arg string | ||
goldenFile string | ||
tmpl map[string]string | ||
}{ | ||
{ | ||
"debug status", | ||
"debug ks test --show-status --show-vars=false", | ||
"testdata/debug_kustomization/status.golden.yaml", | ||
tmpl, | ||
}, | ||
{ | ||
"debug vars", | ||
"debug ks test --show-vars --show-status=false", | ||
"testdata/debug_kustomization/vars.golden.env", | ||
tmpl, | ||
}, | ||
{ | ||
"debug vars from", | ||
"debug ks test-from --show-vars --show-status=false", | ||
"testdata/debug_kustomization/vars-from.golden.env", | ||
tmpl, | ||
}, | ||
} | ||
|
||
for _, tt := range cases { | ||
t.Run(tt.name, func(t *testing.T) { | ||
cmd := cmdTestCase{ | ||
args: tt.arg + " -n=" + namespace, | ||
assert: assertGoldenTemplateFile(tt.goldenFile, tmpl), | ||
} | ||
|
||
cmd.runTestCmd(t) | ||
}) | ||
} | ||
} |
This file contains 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
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,2 @@ | ||
# Status documentation: https://fluxcd.io/flux/components/helm/helmreleases/#helmrelease-status | ||
observedGeneration: -1 |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
apiVersion: v1 | ||
kind: Namespace | ||
metadata: | ||
name: {{ .fluxns }} | ||
--- | ||
apiVersion: kustomize.toolkit.fluxcd.io/v1 | ||
kind: Kustomization | ||
metadata: | ||
name: test | ||
namespace: {{ .fluxns }} | ||
spec: | ||
sourceRef: | ||
kind: GitRepository | ||
name: test | ||
interval: 1m | ||
path: "./" | ||
prune: true | ||
postBuild: | ||
substitute: | ||
TEST_OVERRIDE: "in-line" | ||
TEST_INLINE: "in-line" | ||
substituteFrom: | ||
- kind: ConfigMap | ||
name: test | ||
- kind: Secret | ||
name: test | ||
--- | ||
apiVersion: kustomize.toolkit.fluxcd.io/v1 | ||
kind: Kustomization | ||
metadata: | ||
name: test-from | ||
namespace: {{ .fluxns }} | ||
spec: | ||
sourceRef: | ||
kind: GitRepository | ||
name: test | ||
interval: 1m | ||
path: "./" | ||
prune: true | ||
postBuild: | ||
substituteFrom: | ||
- kind: ConfigMap | ||
name: test | ||
- kind: Secret | ||
name: test | ||
--- | ||
apiVersion: v1 | ||
kind: ConfigMap | ||
metadata: | ||
name: test | ||
namespace: {{ .fluxns }} | ||
data: | ||
TEST_OVERRIDE: "cm" | ||
TEST_CM: "cm" | ||
--- | ||
apiVersion: v1 | ||
kind: Secret | ||
metadata: | ||
name: test | ||
namespace: {{ .fluxns }} | ||
stringData: | ||
TEST_OVERRIDE: "secret" | ||
TEST_SECRET: "secret" |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# Status documentation: https://fluxcd.io/flux/components/kustomize/kustomizations/#kustomization-status | ||
observedGeneration: -1 |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
TEST_CM=cm | ||
TEST_OVERRIDE=secret | ||
TEST_SECRET=secret |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
TEST_CM=cm | ||
TEST_INLINE=in-line | ||
TEST_OVERRIDE=in-line | ||
TEST_SECRET=secret |
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As discussed before, we need to do this for debug helmrelease too. Maybe as part of this change or a separate PR.