Solve yaml warnings in the scaffolds

[camilamacedo86]

What do you want to happen?

Check in the makefile that we have the target:

.PHONY: yamllint
yamllint:
	@docker run --rm $$(tty -s && echo "-it" || echo) -v $(PWD):/data cytopia/yamllint:latest testdata -d "{extends: relaxed, rules: {line-length: {max: 120}}}" --no-warnings

Then, remove the flag --no-warnings and run make yamllint.
See that the following warnings will be raised

 $ git checkout master
Switched to branch 'master'
Your branch is up to date with 'origin/master'.
camiladeomacedo@camilas-MacBook-Air ~/go/src/sigs.k8s.io/kubebuilder (master) $ make yamllint
testdata/project-v2/config/crd/bases/crew.testproject.org_admirals.yaml
  1:1       warning  too many blank lines (1 > 0)  (empty-lines)

testdata/project-v2/config/crd/bases/crew.testproject.org_captains.yaml
  1:1       warning  too many blank lines (1 > 0)  (empty-lines)

testdata/project-v2/config/crd/bases/crew.testproject.org_firstmates.yaml
  1:1       warning  too many blank lines (1 > 0)  (empty-lines)

testdata/project-v2/config/prometheus/monitor.yaml
  1:1       warning  too many blank lines (1 > 0)  (empty-lines)

testdata/project-v2/config/rbac/role.yaml
  1:1       warning  too many blank lines (1 > 0)  (empty-lines)

testdata/project-v2/config/webhook/manifests.yaml
  1:1       warning  too many blank lines (1 > 0)  (empty-lines)

testdata/project-v2/config/webhook/service.yaml
  1:1       warning  too many blank lines (1 > 0)  (empty-lines)

testdata/project-v3/config/default/kustomization.yaml
  34:1      warning  too many blank lines (3 > 2)  (empty-lines)

testdata/project-v3/config/default/manager_auth_proxy_patch.yaml
  17:15     warning  wrong indentation: expected 12 but found 14  (indentation)

testdata/project-v3/config/manager/manager.yaml
  79:15     warning  wrong indentation: expected 12 but found 14  (indentation)

testdata/project-v3/config/prometheus/monitor.yaml
  1:1       warning  too many blank lines (1 > 0)  (empty-lines)

testdata/project-v3/config/webhook/service.yaml
  1:1       warning  too many blank lines (1 > 0)  (empty-lines)

testdata/project-v4/config/default/kustomization.yaml
  36:1      warning  too many blank lines (3 > 2)  (empty-lines)

testdata/project-v4/config/default/manager_auth_proxy_patch.yaml
  17:15     warning  wrong indentation: expected 12 but found 14  (indentation)

testdata/project-v4/config/manager/manager.yaml
  79:15     warning  wrong indentation: expected 12 but found 14  (indentation)

testdata/project-v4/config/prometheus/monitor.yaml
  1:1       warning  too many blank lines (1 > 0)  (empty-lines)

testdata/project-v4/config/webhook/service.yaml
  1:1       warning  too many blank lines (1 > 0)  (empty-lines)

testdata/project-v4-multigroup/config/default/kustomization.yaml
  36:1      warning  too many blank lines (3 > 2)  (empty-lines)

testdata/project-v4-multigroup/config/default/manager_auth_proxy_patch.yaml
  17:15     warning  wrong indentation: expected 12 but found 14  (indentation)

testdata/project-v4-multigroup/config/manager/manager.yaml
  84:15     warning  wrong indentation: expected 12 but found 14  (indentation)

testdata/project-v4-multigroup/config/prometheus/monitor.yaml
  1:1       warning  too many blank lines (1 > 0)  (empty-lines)

testdata/project-v4-multigroup/config/samples/example.com_v1alpha1_busybox.yaml
  9:1       warning  too many blank lines (1 > 0)  (empty-lines)

testdata/project-v4-multigroup/config/webhook/service.yaml
  1:1       warning  too many blank lines (1 > 0)  (empty-lines)

testdata/project-v4-with-deploy-image/config/default/kustomization.yaml
  36:1      warning  too many blank lines (3 > 2)  (empty-lines)

testdata/project-v4-with-deploy-image/config/default/manager_auth_proxy_patch.yaml
  17:15     warning  wrong indentation: expected 12 but found 14  (indentation)

testdata/project-v4-with-deploy-image/config/manager/manager.yaml
  84:15     warning  wrong indentation: expected 12 but found 14  (indentation)

testdata/project-v4-with-deploy-image/config/prometheus/monitor.yaml
  1:1       warning  too many blank lines (1 > 0)  (empty-lines)

testdata/project-v4-with-deploy-image/config/samples/example.com_v1alpha1_busybox.yaml
  9:1       warning  too many blank lines (1 > 0)  (empty-lines)

testdata/project-v4-with-deploy-image/config/webhook/service.yaml
  1:1       warning  too many blank lines (1 > 0)  (empty-lines)

testdata/project-v4-with-grafana/config/default/kustomization.yaml
  36:1      warning  too many blank lines (3 > 2)  (empty-lines)

testdata/project-v4-with-grafana/config/default/manager_auth_proxy_patch.yaml
  17:15     warning  wrong indentation: expected 12 but found 14  (indentation)

testdata/project-v4-with-grafana/config/manager/manager.yaml
  79:15     warning  wrong indentation: expected 12 but found 14  (indentation)

testdata/project-v4-with-grafana/config/prometheus/monitor.yaml
  1:1       warning  too many blank lines (1 > 0)  (empty-lines)

To solve them out you will need to:

• Perform the fixes in the bullerplate of kustomize/v2 plugin, see:https://github.com/kubernetes-sigs/kubebuilder/tree/master/pkg/plugins/common/kustomize/v2
• Then, run make generate to re-gen all samples under testdata as docs
• Ensure that your PR will be pushed without the no-warmings flag so that start to be checked and tested in the CI

Extra Labels

No response

[ashutosh887]

I can do this one @camilamacedo86

/assign

[varshaprasad96]

@ashutosh887 Adding some pointers to what needs to be done here:

So yamllint as mentioned in the target, is similar to any other linter (Linter is a tool that performs many checks in the static code (the code that we write) in the project. In this case, you can refer to the yamllint documentation here: https://yamllint.readthedocs.io.

Now if you follow the steps in the issue and run it, you can see errors like this:

testdata/project-v4-with-grafana/config/default/kustomization.yaml
  1:1       warning  too many blank lines (1 > 0)  (empty-lines)

Now let's see what this means. It says that the kustomization.yaml in the particular project has too many blank lines in this yaml file. kustomization files are scaffolded by the kustomize plugin in Kubebuilder which is located here: https://github.com/kubernetes-sigs/kubebuilder/tree/master/pkg/plugins/common/kustomize. Within there, you can see that there are templates defined for kustomization files, for example, in case of config/default/kustomization.yaml the template is defined here: https://github.com/kubernetes-sigs/kubebuilder/blob/master/pkg/plugins/golang/v2/scaffolds/internal/templates/config/kdefault/kustomization.go#L57.

You can find the version of kustomize plugin being used (which is usually v2 for go/v3 projects and above). Then check for filename along with its path here:

kubebuilder/pkg/plugins/golang/v2/scaffolds/internal/templates/config/kdefault/kustomization.go

Line 38 in 6bd9e01

f.Path = filepath.Join("config", "default", "kustomization.yaml")

, followed by which you can fix the template. If the linter says too many blank lines, you can accordingly remove the extra blank lines from the defined yaml template.

Things to consider:

1. Based on the path, you would have to first identify which plugin is scaffolding that particular file.
2. The plugin code is present in plg/plugins folder.
3. You would have to check the path defined in there, and fix the template.

Ignore the errors in the crd and rbac generation files, as they are scaffolded by controller-gen. We would have to fix in that project instead of KB.

Hope this helps, let us know if you need any help.

[ashutosh887]

Thank you so much @varshaprasad96 for the explanation