Added yamllint, fixed current linting errors, added github action #1727

[priyanshikhetwani]

What this PR does / why we need it: Enhance linting to cover yaml files (to avoid issues as - 7cd7fcc)

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #1497

Test Workflow:

[linux-foundation-easycla]

• ✅ login: yuanning6 / name: Yuanning Liu (5ce3a9b)
• ❌ - login: @priyanshikhetwani . The commit (fe2261e, 703a0cd, f7c3135, 14959ec) is not authorized under a signed CLA. Please click here to be authorized. For further assistance with EasyCLA, please submit a support request ticket.

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: priyanshikhetwani
Once this PR has been reviewed and has the lgtm label, please assign prajyot-parab for approval. For more information see the Kubernetes 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:

• OWNERS

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

[k8s-ci-robot]

Welcome @priyanshikhetwani!

It looks like this is your first PR to kubernetes-sigs/cluster-api-provider-ibmcloud 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/cluster-api-provider-ibmcloud has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[k8s-ci-robot]

Hi @priyanshikhetwani. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

[netlify]

✅ Deploy Preview for kubernetes-sigs-cluster-api-ibmcloud ready!

Name	Link
🔨 Latest commit	14959ec
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-sigs-cluster-api-ibmcloud/deploys/67351f8c050ee60008157eef
😎 Deploy Preview	https://deploy-preview-2013--kubernetes-sigs-cluster-api-ibmcloud.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[Amulyam24]

Thank you for the PR @priyanshikhetwani!

Did you happen to verify the workflow against your fork? It'll be helpful if you could share a sample run here.

[priyanshikhetwani]

Thank you for the PR @priyanshikhetwani!

Did you happen to verify the workflow against your fork? It'll be helpful if you could share a sample run here.

Added the same

[Prajyot-Parab]

@priyanshikhetwani please squash the commits.

[Prajyot-Parab]

/ok-to-test

[priyanshikhetwani]

@priyanshikhetwani please squash the commits.

Done

[Amulyam24]

@priyanshikhetwani, when I run this locally, see quite a lot of errors regarding trailing spaces, can you please cross check?

./templates/cluster-template-powervs-clusterclass/cluster-with-kcp.yaml
  56:21     error    too many spaces after colon  (colons)
  61:21     error    too many spaces after colon  (colons)
  169:1     error    trailing spaces  (trailing-spaces)
  183:1     error    trailing spaces  (trailing-spaces)
  185:1     error    trailing spaces  (trailing-spaces)
  188:1     error    trailing spaces  (trailing-spaces)
  194:1     error    trailing spaces  (trailing-spaces)
  196:1     error    trailing spaces  (trailing-spaces)
  201:1     error    trailing spaces  (trailing-spaces)
  206:1     error    trailing spaces  (trailing-spaces)

./templates/bases/powervs/kcp.yaml
  125:1     error    trailing spaces  (trailing-spaces)
  139:1     error    trailing spaces  (trailing-spaces)
  141:1     error    trailing spaces  (trailing-spaces)
  144:1     error    trailing spaces  (trailing-spaces)
  150:1     error    trailing spaces  (trailing-spaces)
  152:1     error    trailing spaces  (trailing-spaces)
  157:1     error    trailing spaces  (trailing-spaces)
  162:1     error    trailing spaces  (trailing-spaces)

./templates/bases/vpc/kcp.yaml
  29:26     error    trailing spaces  (trailing-spaces)
  36:26     error    trailing spaces  (trailing-spaces)

./templates/cluster-template-vpc-clusterclass/cluster-with-kcp.yaml
  107:30    error    trailing spaces  (trailing-spaces)
  114:30    error    trailing spaces  (trailing-spaces)

[Prajyot-Parab]

See if you can reuse this - https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/blob/main/.github/workflows/weekly-security-scan.yaml#L20-L30

[Prajyot-Parab]

The installation way needs to change. refer - https://github.com/kubernetes-sigs/cluster-api-provider-ibmcloud/blob/main/hack/tools/Makefile#L59-L61

[Prajyot-Parab]

@Karthik-K-N @Amulyam24

also I am wondering if we should explore on reliability of yamllint source.

For ref kubebuilder - https://github.com/kubernetes-sigs/kubebuilder/blob/master/.github/workflows/lint.yml#L29-L34

For ref test-infra - https://github.com/kubernetes/test-infra/blob/master/hack/make-rules/verify/yamllint.sh

[Amulyam24]

Good point @Prajyot-Parab, wasilibs/go-yamllint looks like it is recently developed, not sure how well it will be maintained going further. Do we want to explore with another reliable source?

[Prajyot-Parab]

@Amulyam24 IMO yes we should try out something more stable/matured source.

[Amulyam24]

@priyanshikhetwani, initially adrienverge/yamllint was being considered, were there any challenges with it which made you switch to go-yamllint ?

[priyanshikhetwani]

@Amulyam24 @Prajyot-Parab I primarily switched because adrienverge/yamllint requires Python and pip.
I am exploring other better/mature options as well.

[Prajyot-Parab]

Suggested change

	run: make lint-yaml
	run: make lint-yaml

[Amulyam24]

I am exploring other better/mature options as well.

@priyanshikhetwani, any update?

[priyanshikhetwani]

Trying yamlfmt, it's a Go-based tool, well maintained.

It automatically formats YAML files but doesn't provide detailed error messages. If we want more verbose feedback, we might need an additional tool.

Next Steps:

• Decide whether to keep auto-formatting enabled.
• Consider adding a custom linter if needed.

[k8s-ci-robot]

@priyanshikhetwani: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
pull-cluster-api-provider-ibmcloud-verify	14959ec	link	true	/test pull-cluster-api-provider-ibmcloud-verify

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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. I understand the commands that are listed here.

[Karthik-K-N]

Hi, Thanks for the work on this, I believe still some work is left here, So lets not hurry as it involves configuration yaml files. We have decided to take this for next release.

[Karthik-K-N]

@priyanshikhetwani what else should we need on this PR

[priyanshikhetwani]

Hi @Karthik-K-N , ideally, we wanted a go based yaml linting tool that was well maintained.
the tool that we are currently using yamlfmt is not very verbose with lint errors, it shows comparison of current and expected format.
Now we can either go with python based linter and can enable auto formatting with yamlfmt or have a custom linter with yamlfmt.
Currently, we have go based yamllint tool for linting messages (this is not very accurate so using yamlfmt as well)
yamlfmt for comparison and auto formatting