kubeadm: Replace the yaml in the log/comments with a generic term. #130345

HirazawaUi · 2025-02-21T14:46:41Z

What type of PR is this?

/kind cleanup

What this PR does / why we need it:

Currently, kubeadm supports both yaml and json configuration file types, but in our log output, we only explicitly mention the yaml format.
We haven't printed warning logs for unknown GVKs in all the documentMapToXXX functions. To ensure consistent behavior across the documentMapToXXX functions and to provide sufficient warnings to users, we should print warning logs.

Which issue(s) this PR fixes:

Fixes kubernetes/kubeadm#3163 kubernetes/kubeadm#3162

Special notes for your reviewer:

To make the functions appear more consistent, I also renamed the SplitYAMLDocuments function to SplitYAMLOrJSONDocuments. If this is an unnecessary change, I can roll it back.

Does this PR introduce a user-facing change?

kubeadm: Use generic terminology in logs instead of direct mentions of yaml/json.

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

k8s-ci-robot · 2025-02-21T14:46:52Z

This issue is currently awaiting triage.

If a SIG or subproject determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

carlory · 2025-02-24T02:36:53Z

/release-note-none
/lgtm

k8s-ci-robot · 2025-02-24T02:36:59Z

LGTM label has been added.

Git tree hash: 4de94b209ce33e899d62167ce8ea44456d8afa39

neolit123

thanks for the pr @HirazawaUi

cmd/kubeadm/app/cmd/config_test.go

cmd/kubeadm/app/util/config/initconfiguration.go

cmd/kubeadm/app/util/config/joinconfiguration.go

cmd/kubeadm/app/util/config/upgradeconfiguration.go

cmd/kubeadm/app/util/config/upgradeconfiguration_test.go

neolit123 · 2025-02-24T09:09:45Z

cmd/kubeadm/app/util/config/upgradeconfiguration_test.go

-		})
+				docmap, err := kubeadmutil.SplitYAMLOrJSONDocuments(b)
+				if err != nil {
+					t.Fatalf("Unexpected error of SplitYAMLOrJSONDocuments: %v", err)


SplitConfigDocuments

why is initconfiguration_test.go not calling docmap, err := kubeadmutil.SplitYAMLOrJSONDocuments(b) as well?

Because the BytesToInitConfiguration function already includes SplitYAMLDocuments() and documentMapToInitConfiguration().
ref:

kubernetes/cmd/kubeadm/app/util/config/initconfiguration.go

Lines 293 to 304 in 7bd0477

// BytesToInitConfiguration converts a byte slice to an internal, defaulted and validated InitConfiguration object.

// The map may contain many different YAML documents. These YAML documents are parsed one-by-one

// and well-known ComponentConfig GroupVersionKinds are stored inside of the internal InitConfiguration struct.

// The resulting InitConfiguration is then dynamically defaulted and validated prior to return.

func BytesToInitConfiguration(b []byte, skipCRIDetect bool) (*kubeadmapi.InitConfiguration, error) {

gvkmap, err := kubeadmutil.SplitYAMLDocuments(b)

if err != nil {

return nil, err

}

return documentMapToInitConfiguration(gvkmap, false, false, false, skipCRIDetect)

}

we should probably add BytesToXConfiguration for all kinds of config

cmd/kubeadm/app/util/marshal.go

neolit123 · 2025-02-24T09:13:03Z

cmd/kubeadm/app/util/config/upgradeconfiguration_test.go

+		for _, format := range formats {
+			t.Run(fmt.Sprintf("%s_%s", tt.name, format.name), func(t *testing.T) {


since you are adding multi format testing for init and upgrade config, should you also add it to reset and join config?

neolit123 · 2025-02-24T09:13:58Z

Does this PR introduce a user-facing change?

needs a simple release note explaining the user facing aspect of the change.

k8s-ci-robot · 2025-02-24T12:47:31Z

New changes are detected. LGTM label has been removed.

k8s-ci-robot · 2025-02-24T12:47:42Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: HirazawaUi
Once this PR has been reviewed and has the lgtm label, please ask for approval from carlory. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

cmd/kubeadm/OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

neolit123 · 2025-02-25T14:30:29Z

cmd/kubeadm/app/util/config/common.go

 	}

 	if _, present := deprecatedAPIVersions[gvString]; present && !allowDeprecated {
-		klog.Warningf("your configuration file uses a deprecated API spec: %q (kind: %q). Please use 'kubeadm config migrate --old-config old.yaml --new-config new.yaml', which will write the new, similar spec using a newer API version.", gvString, gvk.Kind)
+		klog.Warningf("your configuration file uses a deprecated API spec: %q (kind: %q). Please use 'kubeadm config migrate ---old-config old-config-file --new-config new-config-file', which will write the new, similar spec using a newer API version.", gvString, gvk.Kind)


Suggested change

klog.Warningf("your configuration file uses a deprecated API spec: %q (kind: %q). Please use 'kubeadm config migrate ---old-config old-config-file --new-config new-config-file', which will write the new, similar spec using a newer API version.", gvString, gvk.Kind)

klog.Warningf("your configuration file uses a deprecated API spec: %q (kind: %q). Please use 'kubeadm config migrate --old-config old-config-file --new-config new-config-file', which will write the new, similar spec using a newer API version.", gvString, gvk.Kind)

neolit123 · 2025-02-25T14:32:02Z

cmd/kubeadm/app/util/config/joinconfiguration.go

+	return BytesToJoinConfiguration(b, opts)
+}
+
+// BytesToJoinConfiguration converts a byte slice to an internal, defaulted and validated ResetConfiguration object.


JoinConfiguration

neolit123 · 2025-02-25T14:32:19Z

cmd/kubeadm/app/util/config/joinconfiguration.go

+
+// BytesToJoinConfiguration converts a byte slice to an internal, defaulted and validated ResetConfiguration object.
+// The map may contain many different YAML/JSON documents. These documents are parsed one-by-one
+// and well-known ComponentConfig GroupVersionKinds are stored inside of the internal ResetConfiguration struct.


there are no component configs in reset config

neolit123 · 2025-02-25T14:34:54Z

cmd/kubeadm/app/util/config/joinconfiguration_test.go

 				}

-				if obj == nil {
-					t.Error("Unexpected nil return value")
+				got, _ := LoadJoinConfigurationFromFile(tt.cfgPath, options)


why not use bytestojoinconfiguration instead of writing a file and reading it
we should make this consistent across xconfiguration_tests.go.

neolit123 · 2025-02-25T14:35:16Z

cmd/kubeadm/app/util/config/resetconfiguration.go

+
+// BytesToResetConfiguration converts a byte slice to an internal, defaulted and validated ResetConfiguration object.
+// The map may contain many different YAML/JSON documents. These documents are parsed one-by-one
+// and well-known ComponentConfig GroupVersionKinds are stored inside of the internal ResetConfiguration struct.


there are no component configs in reset config

neolit123 · 2025-02-25T14:37:15Z

cmd/kubeadm/app/util/config/resetconfiguration_test.go

 				}

-				if obj == nil {
-					t.Error("Unexpected nil return value")
+				got, _ := LoadResetConfigurationFromFile(tt.cfgPath, options)


again we should use bytestoresetconfiguration here instead of writing and loading

the load* functions can have another simple test, maybe

neolit123 · 2025-02-25T14:37:49Z

cmd/kubeadm/app/util/config/upgradeconfiguration.go

+// BytesToUpgradeConfiguration converts a byte slice to an internal, defaulted and validated InitConfiguration object.
+// The map may contain many different YAML/JSON documents. These documents are parsed one-by-one
+// and well-known ComponentConfig GroupVersionKinds are stored inside of the internal UpgradeConfiguration struct.
+// The resulting UpgradeConfiguration is then dynamically defaulted and validated prior to return.


similar copy paste errors

k8s-ci-robot requested review from carlory and neolit123 February 21, 2025 14:47

HirazawaUi force-pushed the kubeadm-yaml-json branch from 8a02227 to fb63528 Compare February 21, 2025 14:57

k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Feb 24, 2025

k8s-ci-robot assigned carlory Feb 24, 2025

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 24, 2025

neolit123 reviewed Feb 24, 2025

View reviewed changes

k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed release-note-none Denotes a PR that doesn't merit a release note. labels Feb 24, 2025

HirazawaUi added 3 commits February 24, 2025 20:20

distinguish between YAML and JSON file formats during log output

12ed0f4

Add warning logs for uninteresting kind

ca2e881

rename SplitYAMLDocuments function

c9df9ba

HirazawaUi force-pushed the kubeadm-yaml-json branch from fb63528 to 43ab8e3 Compare February 24, 2025 12:47

k8s-ci-robot removed lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Feb 24, 2025

k8s-ci-robot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Feb 24, 2025

add BytesToXConfiguration function

bf89648

HirazawaUi force-pushed the kubeadm-yaml-json branch from 43ab8e3 to bf89648 Compare February 24, 2025 12:53

neolit123 reviewed Feb 25, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

kubeadm: Replace the yaml in the log/comments with a generic term. #130345

kubeadm: Replace the yaml in the log/comments with a generic term. #130345

HirazawaUi commented Feb 21, 2025 •

edited

Loading

k8s-ci-robot commented Feb 21, 2025

carlory commented Feb 24, 2025

k8s-ci-robot commented Feb 24, 2025

neolit123 left a comment

neolit123 Feb 24, 2025

neolit123 Feb 24, 2025

HirazawaUi Feb 24, 2025

neolit123 Feb 24, 2025

HirazawaUi Feb 24, 2025

neolit123 Feb 24, 2025

HirazawaUi Feb 24, 2025

neolit123 commented Feb 24, 2025

k8s-ci-robot commented Feb 24, 2025

k8s-ci-robot commented Feb 24, 2025

neolit123 Feb 25, 2025

neolit123 Feb 25, 2025

neolit123 Feb 25, 2025

neolit123 Feb 25, 2025

neolit123 Feb 25, 2025

neolit123 Feb 25, 2025

neolit123 Feb 25, 2025

	// BytesToInitConfiguration converts a byte slice to an internal, defaulted and validated InitConfiguration object.
	// The map may contain many different YAML documents. These YAML documents are parsed one-by-one
	// and well-known ComponentConfig GroupVersionKinds are stored inside of the internal InitConfiguration struct.
	// The resulting InitConfiguration is then dynamically defaulted and validated prior to return.
	func BytesToInitConfiguration(b []byte, skipCRIDetect bool) (*kubeadmapi.InitConfiguration, error) {
	gvkmap, err := kubeadmutil.SplitYAMLDocuments(b)
	if err != nil {
	return nil, err
	}

	return documentMapToInitConfiguration(gvkmap, false, false, false, skipCRIDetect)
	}

		for _, format := range formats {
		t.Run(fmt.Sprintf("%s_%s", tt.name, format.name), func(t *testing.T) {

	klog.Warningf("your configuration file uses a deprecated API spec: %q (kind: %q). Please use 'kubeadm config migrate ---old-config old-config-file --new-config new-config-file', which will write the new, similar spec using a newer API version.", gvString, gvk.Kind)
	klog.Warningf("your configuration file uses a deprecated API spec: %q (kind: %q). Please use 'kubeadm config migrate --old-config old-config-file --new-config new-config-file', which will write the new, similar spec using a newer API version.", gvString, gvk.Kind)

kubeadm: Replace the yaml in the log/comments with a generic term. #130345

Are you sure you want to change the base?

kubeadm: Replace the yaml in the log/comments with a generic term. #130345

Conversation

HirazawaUi commented Feb 21, 2025 • edited Loading

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for your reviewer:

Does this PR introduce a user-facing change?

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

k8s-ci-robot commented Feb 21, 2025

carlory commented Feb 24, 2025

k8s-ci-robot commented Feb 24, 2025

neolit123 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neolit123 commented Feb 24, 2025

k8s-ci-robot commented Feb 24, 2025

k8s-ci-robot commented Feb 24, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HirazawaUi commented Feb 21, 2025 •

edited

Loading