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

Document which PodSpec fields are valid #2085

Closed
duglin opened this issue Jan 7, 2020 · 22 comments
Closed

Document which PodSpec fields are valid #2085

duglin opened this issue Jan 7, 2020 · 22 comments

Comments

@duglin
Copy link

duglin commented Jan 7, 2020

Describe the change you'd like to see
While the yaml for a KnService leverages the Kubernetes PodSpec definition, not all of the PodSpec fields are valid for KnServices. We should document which fields people can use.

@duglin
Copy link
Author

duglin commented Jan 7, 2020

Perhaps just a pointer to https://github.com/knative/docs/blob/master/docs/serving/spec/knative-api-specification-1.0.md#container since I didn't see how to get to this doc from our md files.
Seem like https://knative.dev/docs/reference/serving-api/#serving.knative.dev/v1beta1.Revision might be a duplicate, which is unfortunate since that might mean they get out of sync.

@arghya88
Copy link

is initcontainers allowed?

@duglin
Copy link
Author

duglin commented Jan 15, 2020

@arghya88 no I do not think they are supported yet

@knative-housekeeping-robot

Issues go stale after 90 days of inactivity.
Mark the issue as fresh by adding the comment /remove-lifecycle stale.
Stale issues rot after an additional 30 days of inactivity and eventually close.
If this issue is safe to close now please do so by adding the comment /close.

Send feedback to Knative Productivity Slack channel or file an issue in knative/test-infra.

/lifecycle stale

@knative-prow-robot knative-prow-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 15, 2020
@knative-housekeeping-robot

Stale issues rot after 30 days of inactivity.
Mark the issue as fresh by adding the comment /remove-lifecycle rotten.
Rotten issues close after an additional 30 days of inactivity.
If this issue is safe to close now please do so by adding the comment /close.

Send feedback to Knative Productivity Slack channel or file an issue in knative/test-infra.

/lifecycle rotten

@knative-prow-robot knative-prow-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels May 15, 2020
@knative-housekeeping-robot

Rotten issues close after 30 days of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh by adding the comment /remove-lifecycle rotten.

Send feedback to Knative Productivity Slack channel or file an issue in knative/test-infra.

/close

@knative-prow-robot
Copy link
Contributor

@knative-housekeeping-robot: Closing this issue.

In response to this:

Rotten issues close after 30 days of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh by adding the comment /remove-lifecycle rotten.

Send feedback to Knative Productivity Slack channel or file an issue in knative/test-infra.

/close

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.

@duglin
Copy link
Author

duglin commented Jun 14, 2020

/reopen

@knative-prow-robot
Copy link
Contributor

@duglin: Reopened this issue.

In response to this:

/reopen

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.

@knative-housekeeping-robot

Rotten issues close after 30 days of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh by adding the comment /remove-lifecycle rotten.

Send feedback to Knative Productivity Slack channel or file an issue in knative/test-infra.

/close

@knative-prow-robot
Copy link
Contributor

@knative-housekeeping-robot: Closing this issue.

In response to this:

Rotten issues close after 30 days of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh by adding the comment /remove-lifecycle rotten.

Send feedback to Knative Productivity Slack channel or file an issue in knative/test-infra.

/close

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.

@duglin
Copy link
Author

duglin commented Jul 15, 2020

/reopen

@knative-prow-robot
Copy link
Contributor

@duglin: Reopened this issue.

In response to this:

/reopen

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.

@duglin
Copy link
Author

duglin commented Jul 15, 2020

/remove-lifecycle rotten

@knative-prow-robot knative-prow-robot removed the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Jul 15, 2020
@github-actions
Copy link

This issue is stale because it has been open for 90 days with no
activity. It will automatically close after 30 more days of
inactivity. Reopen the issue with /reopen.Mark the issue as
fresh by adding the comment /remove-lifecycle stale.

@github-actions github-actions bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Oct 13, 2020
@duglin
Copy link
Author

duglin commented Oct 13, 2020

/remove-lifecycle stale

@knative-prow-robot knative-prow-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Oct 13, 2020
@abrennan89 abrennan89 modified the milestones: Backlog, Icebox Jan 6, 2021
@abrennan89 abrennan89 added help wanted lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. triage/needs-eng-input Engineering input is requested priority/nice-to-have and removed priority/high labels Jan 6, 2021
@abrennan89 abrennan89 removed lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. priority/nice-to-have labels Jan 26, 2021
@evankanderson
Copy link
Member

This is currently only available in code, AFAIK.

The code is here (ValidatePodSpec), but I don't think there's an easy way to go from that code to any sort of documentation. If this is still a high priority, it will probably require some amount of pairing, plus some type of tracking checking for items getting out of date between code and docs. (Possibly as simple as a list of PRs from some date to now affecting the file which could be used to update the documentation.)

/triage needs-eng-input

(We should pair-assign this to an engineer for pairing if it becomes high enough priority that someone wants to start writing this and the code isn't clear on its own.)

@evankanderson
Copy link
Member

/remove-triage needs-eng-input

@knative-prow-robot knative-prow-robot removed the triage/needs-eng-input Engineering input is requested label Mar 23, 2021
@duglin
Copy link
Author

duglin commented Mar 24, 2021

Not sure about its relative priority but as it stands today, only reading the docs I'm not sure someone can figure out which podSpec fields are supported - and I think that's an important concern.

@markusthoemmes
Copy link
Contributor

For whatever that's worth: We now also have this as part of the openAPI schema of the Revision (and Service and Configuration). Maybe we can generate something from that?

@evankanderson
Copy link
Member

Fixing #3523 would close this issue, and may be the fastest path to be able to do so on an ongoing basis.

@abrennan89
Copy link
Contributor

I think we should close this one since it seems that #3523 supersedes it, and it has been open for over 1.5 years with no meaningful action or eng input provided to create docs. Please bring the discussion to the DUX WG if you feel that there's something important stemming from this that needs to be raised.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

9 participants