github/kubernetes
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
958cba1c82
kubernetes/api/api-rules
History
Krzysztof Jastrzebski 958cba1c82 Replace scale down forbidden window 
Replacement is scale down stabilization window. HPA will scale down only
    to max of recommendations it made during that window. More details in

    https://docs.google.com/document/d/1IdG3sqgCEaRV3urPLA29IDudCufD89RYCohfBPNeWIM
2018-08-31 20:24:38 +02:00
..
README.md Move api rules list under api-approvers-owned package 2018-07-20 10:16:08 -04:00
violation_exceptions.list Replace scale down forbidden window 2018-08-31 20:24:38 +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.

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

Make rule returns error when new generated violation report differs from this checked-in violation report. If new API rule violation is detected, please fix the API Go source file to pass the API rule check. The entries in the checked-in violation report should only be removed when existing API rule violation is being fixed, but not added.

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