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

Add a simple template API object that assists with config parameterization #35

Closed
smarterclayton opened this issue Jul 20, 2016 · 9 comments

Comments

@smarterclayton
Copy link
Contributor

commented Jul 20, 2016

Description

Simple config parameterization is an important tool for extending the utility of example config. This feature will add an API object that represents a set of standard parameters and a list of objects with replacement syntax, a minimal set of CLI commands that transform templates + parameters into a list of API objects, and an API endpoint that allow templates to be stored.

Progress Tracker

  • Before Alpha
    • Design Approval
      • Design Proposal
      • Initial API review (if API). Maybe same PR as design doc. PR-NUMBER
        • Any code that changes an API (/pkg/apis/...)
        • cc @kubernetes/api
      • Identify shepherd (your SIG lead and/or kubernetes-pm@googlegroups.com will be able to help you). My Shepherd is: @smarterclayton for now
        • A shepherd is an individual who will help acquaint you with the process of getting your feature into the repo, identify reviewers and provide feedback on the feature. They are not (necessarily) the code reviewer of the feature, or tech lead for the area.
        • The shepherd is not responsible for showing up to Kubernetes-PM meetings and/or communicating if the feature is on-track to make the release goals. That is still your responsibility.
      • Identify secondary/backup contact point. My Secondary Contact Point is: replace.me@replaceme.com (and/or GH Handle)
    • Write (code + tests + docs) then get them merged. ALL-PR-NUMBERS
      • Code needs to be disabled by default. Verified by code OWNERS
      • Minimal testing
      • Minimal docs
        • cc @kubernetes/docs on docs PR
        • cc @kubernetes/feature-reviewers on this issue to get approval before checking this off
        • New apis: Glossary Section Item in the docs repo: kubernetes/kubernetes.github.io
      • Update release notes
  • Before Beta
    • Testing is sufficient for beta
    • User docs with tutorials
      • Updated walkthrough / tutorial in the docs repo: kubernetes/kubernetes.github.io
      • cc @kubernetes/docs on docs PR
      • cc @kubernetes/feature-reviewers on this issue to get approval before checking this off
    • Thorough API review
      • cc @kubernetes/api
  • Before Stable
    • docs/proposals/foo.md moved to docs/design/foo.md
      • cc @kubernetes/feature-reviewers on this issue to get approval before checking this off
    • Soak, load testing
    • detailed user docs and examples
      • cc @kubernetes/docs
      • cc @kubernetes/feature-reviewers on this issue to get approval before checking this off

FEATURE_STATUS is used for feature tracking and to be updated by @kubernetes/feature-reviewers.
FEATURE_STATUS: IN_DEVELOPMENT

More advice:

Design

  • Once you get LGTM from a @kubernetes/feature-reviewers member, you can check this checkbox, and the reviewer will apply the "design-complete" label.

Coding

  • Use as many PRs as you need. Write tests in the same or different PRs, as is convenient for you.
  • As each PR is merged, add a comment to this issue referencing the PRs. Code goes in the http://github.com/kubernetes/kubernetes repository,
    and sometimes http://github.com/kubernetes/contrib, or other repos.
  • When you are done with the code, apply the "code-complete" label.
  • When the feature has user docs, please add a comment mentioning @kubernetes/feature-reviewers and they will
    check that the code matches the proposed feature and design, and that everything is done, and that there is adequate
    testing. They won't do detailed code review: that already happened when your PRs were reviewed.
    When that is done, you can check this box and the reviewer will apply the "code-complete" label.

Docs

  • Write user docs and get them merged in.
  • User docs go into http://github.com/kubernetes/kubernetes.github.io.
  • When the feature has user docs, please add a comment mentioning @kubernetes/docs.
  • When you get LGTM, you can check this checkbox, and the reviewer will apply the "docs-complete" label.
@smarterclayton smarterclayton referenced this issue Jul 20, 2016
0 of 12 tasks complete

@idvoretskyi idvoretskyi added this to the v1.4 milestone Jul 20, 2016

@smarterclayton

This comment has been minimized.

Copy link
Contributor Author

commented Aug 22, 2016

Not in 1.4

@smarterclayton smarterclayton modified the milestones: next-candidate, v1.4, v1.5 Aug 22, 2016

@andrewstuart

This comment has been minimized.

Copy link

commented Aug 22, 2016

Some relevant discussion has taken place here: kubernetes/kubernetes#30716

@erictune

This comment has been minimized.

Copy link
Member

commented Oct 4, 2016

I propose removing the 1.5 milestone from this feature.
I'd like to be involved in the discussion about it, but I cannot do that and help drive PetSet to Beta at the same time, so I'd like it to wait until after 1.5.

@idvoretskyi

This comment has been minimized.

Copy link
Member

commented Oct 6, 2016

@smarterclayton do you have any comments regarding @erictune's suggestion above? If it's ok for you, I'll proceed with milestone changes.

@mtaufen

This comment has been minimized.

Copy link
Contributor

commented Oct 10, 2016

/subscribe @mtaufen
/cc @mikedanese @thockin

So we stay in the loop as this seems related to configmaps/dynamic kubelet/other component config/etc.

@smarterclayton

This comment has been minimized.

Copy link
Contributor Author

commented Oct 13, 2016

Moving this out of 1.5 - there's not enough bandwidth right now to implement and the time window is too short. Work will continue in the background.

@fejta-bot

This comment has been minimized.

Copy link

commented Dec 18, 2017

Issues go stale after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

Prevent issues from auto-closing with an /lifecycle frozen comment.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or @fejta.
/lifecycle stale

@luxas

This comment has been minimized.

Copy link
Member

commented Dec 25, 2017

@smarterclayton is this relevant anymore?

@smarterclayton

This comment has been minimized.

Copy link
Contributor Author

commented Dec 30, 2017

No, this is out of date and can be closed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
8 participants
You can’t perform that action at this time.