3a97f34b4b
Add default tag to api conventions
2021-09-13 10:58:32 -07:00
faebec1acf
Update API pluralization docs
...
Based on Service ClusterIPs pluralization.
2021-09-10 16:03:09 -07:00
99780a63a6
add auto resource release
2021-09-07 18:40:57 +00:00
83877032b5
Clarifying API Conventions regarding Kind and Resource in object refs
2021-09-01 15:22:29 -07:00
51b267d7a4
remove bazel build
2021-07-25 16:35:42 +08:00
f9798eb69c
Merge pull request #5869 from msau42/update-api-docs
...
Update steps on how to make a new API version
2021-07-16 05:16:09 -07:00
0c8bda6665
Update steps on how to make a new API version and add guidance around structuring commits for API promotions
2021-07-15 18:10:40 -07:00
a843caa9b1
Merge pull request #5832 from toumorokoshi/feature/consolidate-object-reference-guidance
...
consolidate object ref guidance in api conventions
2021-07-09 10:54:53 -07:00
00d73216d3
consolidate object ref guidance in api conventions
...
API conventions had two semi-duplicated sections for
object references, with slightly different guidance.
Consolidating guidance to point to the most recent
guidance.
Clarifying the naming recommendations for naming of lists
of object references, as the guidance was not explicit.
2021-06-18 13:46:40 -07:00
1cc043a0b8
Merge pull request #5825 from dims/add-guidance-on-SHA-vs-tags-in-dependencies
...
Add guidance on SHA vs tags in dependencies
2021-06-16 09:20:00 -07:00
e519a8ba75
Merge pull request #5630 from kikisdeliveryservice/feature-gates-doc
...
sig-arch: Working with feature gates doc
2021-06-14 18:58:00 -07:00
1445c6177a
Apply suggestions from code review
...
Co-authored-by: Shamsher Ansari <shaansar@redhat.com>
2021-06-13 17:56:42 -04:00
c7d7335957
Add guidance on SHA vs tags in dependencies
...
Signed-off-by: Davanum Srinivas <davanum@gmail.com>
2021-06-10 14:37:33 -04:00
744e270f33
Apply suggestions from code review
...
Co-authored-by: Jordan Liggitt <jordan@liggitt.net>
2021-06-03 22:44:36 -07:00
1df12ac90f
Adding object references security considerations
...
Clarifying practices around object references that help
prevent against privilege escalation.
2021-06-03 22:44:36 -07:00
1aed2f6904
Merge pull request #5782 from alculquicondor/patch-1
...
Explain use of feature labels for alpha and beta releases
2021-06-01 10:43:51 -07:00
545177d8db
Add note to ensure tests run in presubmits
2021-06-01 10:53:39 -04:00
ac7999cb51
Addressing comments
...
including blurb recommending using multi resource object references
if there is a chance it will be used that way.
2021-05-25 22:32:35 -07:00
bda0f5062e
Addressing feeedback
...
- new section around resources with different versions
- called out edge cases around resource not found
- removed very old todo
2021-05-24 21:51:07 -07:00
9b694b1b79
Update contributors/devel/sig-architecture/api-conventions.md
...
Co-authored-by: Daniel Smith <dbsmith@google.com>
2021-05-24 21:51:07 -07:00
fed5c1e6a6
Addressing feedback
...
- switching fieldpath syntax to reference best practices already in the
spec
- clarifying naming of the object reference field
- fixing a poor example with a kind used where a resource value should
have been.
2021-05-24 21:51:07 -07:00
e5fb87eafa
addressing comments
...
- switched from kind to resource.
- extended examples to four kinds of object references.
- clarified use of JSON Pointer to determine the path to the field.
2021-05-24 21:51:07 -07:00
b1f8f5975c
clarifying schema for multi-kind object references
...
There are a few types of patterns for multi-kind object references
that are currently included in the Kubernetes core resources
(EnvVarSource, ObjectReference).
Adding a section to clarify the preferred pattern for future
resources.
2021-05-24 21:51:07 -07:00
bffe980b66
Merge pull request #5470 from ccouzens/patch-1
...
API conventions: escape back-quotes when visible
2021-05-10 04:24:51 -07:00
27e1a81029
Include documentation for listTypes in api conventions
2021-04-05 15:42:41 -07:00
8828f0e589
update and refine feature-gates.md
2021-03-21 17:15:00 -07:00
544dc8c691
Update contributors/devel/sig-architecture/feature-gates.md
...
Co-authored-by: Elana Hashman <ehashman@users.noreply.github.com>
2021-03-13 17:45:22 -08:00
0d97e560fd
Update contributors/devel/sig-architecture/feature-gates.md
...
Co-authored-by: Elana Hashman <ehashman@users.noreply.github.com>
2021-03-13 17:45:22 -08:00
b6e823d655
Update contributors/devel/sig-architecture/feature-gates.md
...
Co-authored-by: Elana Hashman <ehashman@users.noreply.github.com>
2021-03-13 17:45:22 -08:00
eb43242e29
Add a doc on how we work with feature gates
...
Signed-off-by: Davanum Srinivas <davanum@gmail.com>
2021-03-13 17:45:22 -08:00
2e9f1ea2f0
Address comments
2021-03-08 17:56:58 -05:00
9fe0b4c7f9
Describe process for allowing a new enum value in an existing field
2021-03-06 17:01:58 -05:00
f8d9d7294a
Update conformance promotion details round removal of bazel
2021-03-03 12:09:25 +13:00
1847825a90
Merge pull request #5455 from deads2k/objectref-guidance
...
add guidance about avoiding cross namespace references from namespaced resource
2021-02-22 12:54:03 -08:00
86550d6f9b
add guidance about avoiding cross namespace references from namespace resources
2021-02-22 15:50:08 -05:00
d67ae0845e
minor update to api_changes to highlight gate on/off scenario ( #5521 )
...
* minor update to api_changes to highlight gate on/off scenario
* Update contributors/devel/sig-architecture/api_changes.md
Co-authored-by: Jordan Liggitt <jordan@liggitt.net>
* Update contributors/devel/sig-architecture/api_changes.md
Co-authored-by: Jordan Liggitt <jordan@liggitt.net>
* Update contributors/devel/sig-architecture/api_changes.md
Co-authored-by: Jordan Liggitt <jordan@liggitt.net>
* Update contributors/devel/sig-architecture/api_changes.md
Co-authored-by: Jordan Liggitt <jordan@liggitt.net>
* Update contributors/devel/sig-architecture/api_changes.md
Co-authored-by: Jordan Liggitt <jordan@liggitt.net>
Co-authored-by: Jordan Liggitt <jordan@liggitt.net>
2021-02-18 09:42:52 -08:00
7af4f21daf
API conventions: escape back-quotes when visible
...
> When referencing another field name, indicate the name in back-quotes. Example: "must be greater than `request`".
In this sentence, we're meant to see "request" surrounded by back-quotes.
In markdown, backticks (back-quotes) are used to create a code section, and thus aren't shown. By escaping them, they are shown to the user.
2021-02-05 17:28:04 +00:00
929c016930
Move new platform support guide to k/sig-release
...
Moves new platform support guide to live alongside documentation of
support tiers and tier 3 build docs.
Signed-off-by: hasheddan <georgedanielmangum@gmail.com>
2021-02-02 10:44:10 -06:00
c0e8b136e5
Remove licensing subproject, move doc to vendor.md
2021-01-13 15:54:07 +05:30
ec191fa473
Minor corrections to the api conventions.
...
Fixed the API Group convention for readability.
2021-01-10 21:45:50 +09:00
22e4475215
Merge pull request #5371 from bjhaid/master
...
Add an entry for `DELETE` on a collection of resources.
2021-01-04 11:41:56 -08:00
952b06b6e2
Merge pull request #5356 from pweil-/fix-list-examples
...
Correct list api examples and add link to field selector documentation
2021-01-04 08:09:56 -08:00
7e31e7499e
Merge pull request #5300 from saschagrunert/platforms
...
Add guide for shipping alternative platforms
2021-01-04 08:05:57 -08:00
2199f730a5
Add an entry for `DELETE` on a collection of resources.
...
This adds an entry that matches the `GET` on a list of resources.
2020-12-17 14:03:18 -06:00
05334d450a
Correct list api examples and add link to field selector documentation
2020-12-08 13:30:48 -05:00
4c14c6faea
Add guide for shipping alternative platforms
...
This outline should help contributors to get an idea about what needs to
be done to add additional supported platforms to Kubernetes.
Signed-off-by: Sascha Grunert <sgrunert@suse.com>
2020-12-04 13:49:19 +01:00
c2a0c7613b
api-conventions: Typo in initials
2020-11-11 14:55:01 -05:00
fb6963ada1
api-conventions: Clarify that constant rules apply to flags and config
...
Also clarify the use of proper names and acronyms within constants with
examples from existing use cases.
2020-11-11 13:14:16 -05:00
04531ba1ae
Merge pull request #4521 from evankanderson/unconventional
...
Update Condition guidance
2020-09-24 09:42:05 -07:00
0a9d1ebe84
Adjust with suggested language from lavalamp
2020-09-23 22:16:45 -07:00
dd082f4d2c
Add guidance on conditions for long-running reconciliations
2020-09-17 13:51:49 -07:00
243f993094
Merge pull request #4773 from divya-mohan0209/patch-1
...
Updated api-conventions.md
2020-08-07 09:18:18 -07:00
1cf544cb29
doc: describe how to run conformance tests with kind
...
Signed-off-by: knight42 <anonymousknight96@gmail.com>
2020-08-03 11:00:57 +08:00
8c0af106aa
Fix formatting nit in example conformance comment
2020-07-28 16:41:04 -07:00
3302b378b4
Index all SIG contributions to the Developer Guide
...
The initial purpose of this is to make sure there are no orphaned
files in the Developer Guide, so we can make a complete map of all the
content there.
2020-07-15 09:22:06 -07:00
305d8d8ac0
Fix typo
2020-07-03 11:18:37 -07:00
c9ae4756d5
Updated content under Naming Conventions in api-conventiones.md
2020-06-26 16:30:28 +00:00
5f972cff41
Updated with general consensus around resource naming, removed positive-polarity preference
2020-06-25 23:48:12 -07:00
6dab5060b7
Replace refs for conformance.txt to conformance.yaml
2020-06-10 07:30:38 +00:00
19b6ff012e
Updated api-conventions.md
...
Modified the first two bullet points under Naming conventions
2020-05-13 18:57:29 +05:30
49d3a5aad7
Clarify language thanks to liggitt
2020-04-17 15:16:22 -07:00
5cab966cc5
Drop positive-polarity exception for Ready
2020-03-27 14:41:41 -07:00
f0fdf1c914
Merge remote-tracking branch 'upstream/master' into unconventional
2020-03-27 14:38:06 -07:00
95fdc65c13
fixes contrib doc bug #4486 - kubetest replaces hack/e2e.go ( #4563 )
...
* fixes contrib doc bug #4486 - kubetest replaces hack/e2e.go
* Update contributors/devel/sig-testing/e2e-tests.md
Restoring original list formatting for doc consistency.
Co-Authored-By: Bob Killen <killen.bob@gmail.com>
* Update contributors/devel/sig-testing/e2e-tests.md
Co-Authored-By: Bob Killen <killen.bob@gmail.com>
Co-authored-by: Bob Killen <killen.bob@gmail.com>
2020-03-10 10:43:35 -07:00
3a2c17b495
Update Condition guidance
2020-02-14 14:46:56 -08:00
2eb7d04ae5
Add two clarifications to conformance requirements
...
Based on conformance meeting today
- we want to allow a test to exercise the event API to verify it can
be exercised; this isn't depending on a specific component to
generate a specific event
- we don't want to allow tests which are attempting to exercise the
componentstatus API as there is a KEP out to deprecate it, and all
involved don't want to add more code around componentstatus
2020-01-14 15:19:22 -08:00
4b9e4b4ca4
sig-arch/staging: add note about semver-like tags
2019-12-11 10:23:41 +05:30
0f8ce103ad
Remove last-updated date line from api-conventions.md
...
Rationale: The line hasn't been updated since 2017, even though changes were still being made to the doc. We can already see the last-updated date from the git history, and if we just update it now folks will probably continue forgetting to do so in the future.
2019-11-25 13:52:07 -08:00
174ea01d78
Update the location of the list of staging repositories published
...
Since https://github.com/kubernetes/publishing-bot/pull/148/ , the list of staging repositories published has been externalized to https://raw.githubusercontent.com/kubernetes/kubernetes/master/staging/publishing/rules.yaml and https://raw.githubusercontent.com/kubernetes/kubernetes/master/staging/publishing/rules-godeps.yaml .
For repositories, refer to https://git.k8s.io/kubernetes/staging/README.md .
For branches, the output of the following command needs manual processing:
```
```
Also, refer to public CNCF cluster http://git.k8s.io/publishing-bot/k8s-publishing-bot.md
2019-11-19 01:37:03 +01:00
b019e985f9
Add literal string requirement
2019-08-27 10:43:01 +12:00
5663868a88
Conformance Tests: Reduce soak time for new tests
...
New tests don't need to be run for a full release-cycle before getting
promoted to Conformance. Two weeks is sufficient, and more practical.
2019-08-12 17:30:59 -07:00
caf0d1d618
Kubelet API access should not be allowed for conformance tests
2019-08-08 15:06:02 -07:00
3074987725
Merge pull request #3948 from heyste/patch-1
...
Ensure that conformance.txt is regenerated
2019-08-01 09:38:15 -07:00
5be295c8da
Ensure that conformance.txt is regenerated
2019-08-01 10:07:20 +12:00
a2cdce51a0
Document version string pattern
...
Document that the version portion of an apiVersion should be a DNS_LABEL.
This is required for CRDs, as encoded here:
https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/validation/validation.go#L176-L178
It seems like an eminently reasonable convention to have for built-in and aggregated APIs too.
2019-07-30 08:49:53 -07:00
7e4037b332
doc: add an extra space between document and for
2019-07-03 23:47:40 +08:00
47f58b5491
Add rationale for preserving persisted data for alpha fields
2019-06-25 08:18:34 -07:00
0a79b6dc1e
Grammar and Markdown fixes for api-conventions
...
When going through the api-conventions markdown doc online, I noticed a
couple small grammar and Markdown formatting issues. This patch fixes
those up.
2019-05-31 17:24:31 -04:00
95bb2fbd88
Fix link in api-conventions.md ( #3739 )
...
* Correct the link target
* Make the link description more precise
* Correct the link target - once again.
Co-Authored-By: Christoph Blecker <admin@toph.ca>
2019-05-27 10:59:50 -07:00
f2ea353488
Remove inconsistent use of bool as example
2019-05-22 10:07:45 -04:00
d3a393ebe7
Update recommendations for tests that don't meet
...
conformance criteria.
2019-05-08 09:22:59 -05:00
9258fa171f
Merge pull request #3615 from liggitt/vendor
...
vendor doc follow-up
2019-04-19 16:26:06 -07:00
867b9ff62a
Update E2E testing doc link
2019-04-19 08:55:16 -05:00
eea710e005
vendor doc follow-up
2019-04-19 08:59:14 -04:00
e84ea124b8
Merge pull request #3612 from liggitt/godeps-modules
...
Update vendor docs for go modules
2019-04-18 11:14:03 -07:00
c5f13b3dec
Add vendor.md, add note about godep doc only applying to older releases
2019-04-18 01:55:59 -04:00
968cefa1da
Merge pull request #3570 from johnbelamaric/conformance-project-board
...
Add detail on the conformance review process
2019-04-12 11:58:46 -07:00
8c8005b7d3
Merge pull request #3521 from PatrickLang/windows-conformance-notes
...
Start Windows considerations list for conformance tests
2019-04-11 16:02:45 -07:00
4de900588a
Add suggestion to use agnhost for new scenarios
2019-04-11 15:58:04 -07:00
1d114a2240
More review feedback
2019-04-11 14:28:40 -07:00
4c778442fc
Merge branch 'master' into conformance-project-board
2019-04-11 12:33:30 -07:00
b5a2d835b0
Fix metadata link, add conformance.txt remark
2019-04-11 12:29:11 -07:00
3fe7999cbf
Merge pull request #3422 from dims/document-code-freeze-restrictions-for-adding-conformance-tests
...
Document code freeze restrictions for adding conformance tests
2019-04-11 11:00:47 -07:00
418a933506
Add detail on the conformance review process
...
* Adds the criteria to have an e2e test running for one release before
promotion.
* Adds a section on the review board describing the types of PRs that
require approval through that process.
* Updates the link to the review board.
2019-04-09 16:30:52 -07:00
1bc880849b
More updates based on review feedback
2019-04-09 12:30:40 -07:00
2d844e6ffa
Merge in Claudiu's list from #3522 , review feedback
2019-04-02 13:16:17 -07:00
702d10d7a4
Update links in api conventions document
...
As I was reading through api-conventions.md, I noticed a couple of
broken links. This commit updates those links to resolve to their
previously linked content.
2019-03-29 19:03:26 +00:00
b701d73113
Start Windows considerations list for conformance tests
2019-03-27 01:06:50 +00:00
63c52e9440
Document code freeze restrictions for adding conformance tests
...
Bugs are ok, but features are not ok during code freeze.
Change-Id: I5d9e6602396735ee5798792527a0a7110ce02275
2019-03-13 17:15:33 -04:00
216b50c946
Fix typo in godep.md
2019-03-11 17:23:11 +07:00
Jefftree
Tim Hockin
Khaled (Kal) Henidak
Rob Scott
SataQiu
Kubernetes Prow Robot
Michelle Au
Yusuke Tsutsumi
Davanum Srinivas
Aldo Culquicondor
Antoine Pelisse
Kirsten Garrison
Jordan Liggitt
Riaan Kleinhans
David Eads
Chris Couzens
hasheddan
Nikhita Raghunath
Ashish Billore
bjhaid
Paul Weil
Sascha Grunert
Clayton Coleman
Evan Anderson
Evan Anderson
knight42
Aaron Crickenberger
Erik L. Arneson
divya-mohan0209
Stephen Heywood
Robert Kielty
Michael Taufen
Patrick Decat
Caleb Woodbine
Devan Carpenter
Eric Tune
Draven
Jay Pipes
Wojciech Sciesinski
Paul Morie
Timothy St. Clair
Jon Huhn
Patrick Lang
John Belamaric
Lance Bragstad
Patrick Lang
Akshesh Doshi