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

apps: address known issues in apps/README.md #2386

Open
spiffxp opened this issue Jul 22, 2021 · 5 comments
Open

apps: address known issues in apps/README.md #2386

spiffxp opened this issue Jul 22, 2021 · 5 comments
Labels
area/infra Infrastructure management, infrastructure design, code in infra/ lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. sig/k8s-infra Categorizes an issue or PR as relevant to SIG K8s Infra.

Comments

@spiffxp
Copy link
Member

spiffxp commented Jul 22, 2021

I'm breaking this issue out of #2150

I had hopes of making all apps follow some easily templated conventions that we could enforce so that:

  • boilerplate could be automated away
  • it's easy to tell what resources belong to which app
  • it's easy to tell who "owns" an app (and how that maps to who can admin/deploy it, who can approve changes to its files, etc)

I documented the proposed conventions here: https://github.com/kubernetes/k8s.io/tree/main/apps#proposed-format

Some complexities showed up right away during the course of migrating apps over: https://github.com/kubernetes/k8s.io/tree/main/apps#known-issues

  • app: label convention
    • cert-manager has multiple app: labels: cainjector, cert-manager, webhook, and many empty
    • consider a custom label k8s-infra-app:; could do prefix but then need to decide on a DNS name
    • is this a convention worth enforcing? perhaps namespace is enough?
  • *.yaml can be more than k8s resources
    • consider a resources/ subdir convention for all k8s resources
    • allows for config files etc. at app root
  • enforcement
    • OWNER constraints enforcemed by humans - we should automate this (and I know there are some OWNERS files that lack a sig/foo label right now)
    • no validation of yaml beyond yamllint - we now use conftest, but I don't know how much "it's valid kubernetes" it's doing for us
    • app: convention enforcement by humans - we should decide if we want this

Figure out which of these to turn into issues, checklist it up, make the known issues go away through deciding we don't care about them, or addressing/enforcing them.

/wg k8s-infra
/area cluster-infra
/milestone v1.23

@k8s-ci-robot k8s-ci-robot added wg/k8s-infra area/infra Infrastructure management, infrastructure design, code in infra/ labels Jul 22, 2021
@k8s-ci-robot k8s-ci-robot added this to the v1.23 milestone Jul 22, 2021
@spiffxp
Copy link
Member Author

spiffxp commented Jul 22, 2021

/priority important-longterm

@k8s-ci-robot k8s-ci-robot added the priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. label Jul 22, 2021
@spiffxp
Copy link
Member Author

spiffxp commented Jul 22, 2021

I'm proposing that we add area/apps/foo for each app foo as part of #508 (comment)

@ameukam
Copy link
Member

ameukam commented Dec 14, 2021

/milestone clear

@k8s-ci-robot k8s-ci-robot removed this from the v1.23 milestone Dec 14, 2021
@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 Mar 14, 2022
@ameukam
Copy link
Member

ameukam commented Mar 15, 2022

/remove-lifecycle stale
/lifecycle frozen
/milestone clear

@k8s-ci-robot k8s-ci-robot added lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Mar 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/infra Infrastructure management, infrastructure design, code in infra/ lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. sig/k8s-infra Categorizes an issue or PR as relevant to SIG K8s Infra.
Projects
None yet
Development

No branches or pull requests

4 participants