Skip to content
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

kyaml should implement KRM Functions Spec v1 #4024

Open
7 of 8 tasks
frankfarzan opened this issue Jun 30, 2021 · 14 comments
Open
7 of 8 tasks

kyaml should implement KRM Functions Spec v1 #4024

frankfarzan opened this issue Jun 30, 2021 · 14 comments
Assignees
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@frankfarzan
Copy link
Contributor

frankfarzan commented Jun 30, 2021

Following changes are needed to adhere to Functions Spec v1:

  • Migrate internal annotations:

    • config.k8s.io/id -> internal.config.kubernetes.io/id
    • config.kubernetes.io/path -> internal.config.kubernetes.io/path
    • config.kubernetes.io/index -> internal.config.kubernetes.io/index

    But we should be aware that this is a backwards incompatible change. Here are the migration steps using the path annotation as a concrete example:

    1. Update all orchestrators so they add both legacy and new annotation when reading files. A function may mutate the legacy annotation (existing functions) or the new annotation (future functions). When writing files, the orchestrator should consume both and reconcile things correctly.
    2. Update all functions we know of so that they use the new annotation.
    3. Some grace period for any other function to migrate
    4. Orchestrator drops support for legacy annotation.
  • PR: Migrate index path id annotations #4190

  • .results field of ResourceList has been standardized in v1. There are small changes between implementation in kyaml and the spec.

  • Change the apiVersion of ResourceList: config.kubernetes.io/v1alpha1 -> config.kubernetes.io/v1

  • Provide utility helpers in SDKs to preserve annotations with internal.config.kubernetes.io prefix.

  • kustomize should drop support for the legacy annotations

@k8s-ci-robot k8s-ci-robot added needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Jun 30, 2021
@natasha41575 natasha41575 added the kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. label Jun 30, 2021
@k8s-ci-robot k8s-ci-robot removed the needs-kind Indicates a PR lacks a `kind/foo` label and requires one. label Jun 30, 2021
@natasha41575 natasha41575 added the triage/accepted Indicates an issue or PR is ready to be actively worked on. label Jun 30, 2021
@k8s-ci-robot k8s-ci-robot removed the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Jun 30, 2021
@natasha41575
Copy link
Contributor

/assign

@natasha41575
Copy link
Contributor

Working on this now

@natasha41575
Copy link
Contributor

All tasks are completed, but I am going to leaving this issue open as a tracker to remind us to remove the deprecated legacy annotations.

@k8s-triage-robot
Copy link

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

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 31, 2022
@natasha41575
Copy link
Contributor

natasha41575 commented Jan 31, 2022

/remove-lifecycle stale

We are planning to release tomorrow. After this release IMO we can remove the legacy annotations.

FYI @mengqiy @KnVerey

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 31, 2022
@k8s-triage-robot
Copy link

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

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label May 2, 2022
@KnVerey KnVerey removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label May 6, 2022
@k8s-triage-robot
Copy link

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

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Aug 4, 2022
@KnVerey
Copy link
Contributor

KnVerey commented Aug 10, 2022

/remove-lifecycle stale

We still need to remove the legacy annotations

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Aug 10, 2022
@natasha41575
Copy link
Contributor

We still need to remove the legacy annotations

+1

/help

@k8s-ci-robot
Copy link
Contributor

@natasha41575:
This request has been marked as needing help from a contributor.

Guidelines

Please ensure that the issue body includes answers to the following questions:

  • Why are we solving this issue?
  • To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
  • Does this issue have zero to low barrier of entry?
  • How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

We still need to remove the legacy annotations

+1

/help

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/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. label Aug 10, 2022
@natasha41575 natasha41575 added the good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. label Aug 10, 2022
@natasha41575
Copy link
Contributor

/lifecycle frozen

@k8s-ci-robot k8s-ci-robot added the lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. label Aug 10, 2022
@natasha41575
Copy link
Contributor

natasha41575 commented Jul 21, 2023

The only thing left to do is to remove the legacy annotations.

We no longer need:

  • config.k8s.io/id
  • config.kubernetes.io/path
  • config.kubernetes.io/index

So the last thing left to do here is remove these from the code & all references to them. If tests fail after their removal (they shouldn't), we need to look into why.

@natasha41575 natasha41575 removed their assignment Aug 18, 2023
@irvifa
Copy link
Member

irvifa commented Aug 24, 2023

/assign

@varshaprasad96
Copy link
Member

/assign

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
Development

Successfully merging a pull request may close this issue.

7 participants