github/kubernetes
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
96a8df455c
kubernetes/api/api-rules
History
Lee Verberne d22dc5cb72 Switch ephemeralcontainers SR to Pod Kind 
This changes the `/ephemeralcontainers` subresource of `/pods` to use
the `Pod` kind rather than `EphemeralContainers`.

When designing this API initially it seemed preferable to create a new
kind containing only the pod's ephemeral containers, similar to how
binding and scaling work.

It later became clear that this made admission control more difficult
because the controller wouldn't be presented with the entire Pod, so we
updated this to operate on the entire Pod, similar to how `/status`
works.
2021-04-13 13:36:48 +02:00
..
aggregator_violation_exceptions.list Add Apply functions to client-gen 2021-03-06 20:49:06 -05:00
apiextensions_violation_exceptions.list Add Apply functions to client-gen 2021-03-06 20:49:06 -05:00
codegen_violation_exceptions.list Add Apply functions to client-gen 2021-03-06 20:49:06 -05:00
README.md Add UPDATE_API_KNOWN_VIOLATIONS=true to Makefile.generated_files 2018-11-01 17:43:16 -07:00
sample_apiserver_violation_exceptions.list Add Apply functions to client-gen 2021-03-06 20:49:06 -05:00
violation_exceptions.list Switch ephemeralcontainers SR to Pod Kind 2021-04-13 13:36:48 +02:00

README.md

Existing API Rule Violations

This folder contains the checked-in report file of known API rule violations. The file violation_exceptions.list is used by Make rule during OpenAPI spec generation to make sure that no new API rule violation is introduced into our code base.

API Rule Violation Format

The report file violation_exceptions.list is in format of:

  • API rule violation: <RULE>,<PACKAGE>,<TYPE>,<FIELD>

e.g.

  • API rule violation: names_match,k8s.io/api/core/v1,Event,ReportingController

And the violation list is sorted alphabetically in each of the <RULE>, <PACKAGE>, <TYPE>, <FIELD> levels.

How to resolve API Rule Check Failure

Make rule returns an error when the newly generated violation report differs from this checked-in violation report.

Our goal is that exceptions should never be added to this list, only fixed and removed. For new APIs, this is a hard requirement. For APIs that are e.g. being moved between versions or groups without other changes, it is OK for your API reviewer to make an exception.

If you're removing violations from the exception list, or if you have good reasons to add new violations to this list, please update the file using:

  • make generated_files UPDATE_API_KNOWN_VIOLATIONS=true

It is up to API reviewers to review the list and make sure new APIs follow our API conventions.

NOTE: please don't hide changes to this file in a "generated changes" commit, treat it as source code instead.

API Rules Being Enforced

For more information about the API rules being checked, please refer to https://github.com/kubernetes/kube-openapi/tree/master/pkg/generators/rules