yaml.v3 fork maintenance story

[natasha41575]

Background

Upgrading go-yaml causes a breaking indentation change for kustomize. The details are described in this comment. To remedy this issue, we added a PR to go-yaml in the hopes that it would be accepted in time for the k/k code freeze (July 8, 2021). There was no response for the go-yaml maintainer, so we forked the go-yaml library under kyaml/internal to use the old indentation: link to forking PR. This fork will also integrated into kubernetes via kustomize-in-kubectl.

Maintenance

There is a script that will allow us to pull in new commits from yaml.v3 when needed. If there are urgent security fixes in yaml.v3 upstream, we will need to prioritize pulling those commits in and back-porting them into kustomize release branches. We will need to ensure that the security fixes are pulled into the fork integrated in k/k.

Future

Whenever the sequence indentation style is made configurable in yaml.v3 upstream, we need to upgrade to the newest version of yaml.v3 and remove the internal fork.

See instructions at https://github.com/kubernetes-sigs/kustomize/blob/master/kyaml/internal/forked/update-go-yaml.sh

The following issues need to be resolved upstream:
go-yaml/yaml#755
go-yaml/yaml#720

[KnVerey]

We've sent a reminder ping on our PR today. If we end up carrying the internal fork past the current k/k release, we should reconsider our options, such as approaching API Machinery about a permanent fork, or maybe supporting/leveraging the effort to have kubernetes-sigs/yaml use v3 (kubernetes-sigs/yaml#61 mentions a KEP for v2 of that lib).

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle stale
• Mark this issue or PR as rotten with /lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[natasha41575]

/remove-lifecycle stale
/lifecycle frozen

[natasha41575]

Jordan has pinged me on the go-yaml fork PR, so I'm going to try to wrap it up soon.

[natasha41575]

go-yaml fork is created and we have removed our internal fork!