Skip to content

Commit

Permalink
docs: generate README_CHECKS.md
Browse files Browse the repository at this point in the history
  • Loading branch information
zegl committed Jan 5, 2024
1 parent 8e178b1 commit a4cdc9a
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README_CHECKS.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
<!-- This file was generated by hack/generate-list-docs.py -->
| ID | Target | Description | Enabled |
|----|--------|-------------|---------|
| deployment-strategy | Deployment | Makes sure that all Deployments targeted by service use RollingUpdate strategy | default |
| deployment-replicas | Deployment | Makes sure that Deployment has multiple replicas | default |
| ingress-targets-service | Ingress | Makes sure that the Ingress targets a Service | default |
| cronjob-has-deadline | CronJob | Makes sure that all CronJobs has a configured deadline | default |
| cronjob-restartpolicy | CronJob | Makes sure CronJobs have a valid RestartPolicy | default |
| container-resources | Pod | Makes sure that all pods have resource limits and requests set. The --ignore-container-cpu-limit flag can be used to disable the requirement of having a CPU limit | default |
| container-resource-requests-equal-limits | Pod | Makes sure that all pods have the same requests as limits on resources set. | optional |
| container-cpu-requests-equal-limits | Pod | Makes sure that all pods have the same CPU requests as limits set. | optional |
Expand All @@ -12,6 +15,7 @@
| container-ephemeral-storage-request-and-limit | Pod | Makes sure all pods have ephemeral-storage requests and limits set | default |
| container-ephemeral-storage-request-equals-limit | Pod | Make sure all pods have matching ephemeral-storage requests and limits | optional |
| container-ports-check | Pod | Container Ports Checks | optional |
| environment-variable-key-duplication | Pod | Makes sure that duplicated environment variable keys are not duplicated | default |
| statefulset-has-poddisruptionbudget | StatefulSet | Makes sure that all StatefulSets are targeted by a PDB | default |
| deployment-has-poddisruptionbudget | Deployment | Makes sure that all Deployments are targeted by a PDB | default |
| poddisruptionbudget-has-policy | PodDisruptionBudget | Makes sure that PodDisruptionBudgets specify minAvailable or maxUnavailable | default |
Expand All @@ -33,4 +37,4 @@
| statefulset-pod-selector-labels-match-template-metadata-labels | StatefulSet | Ensure the StatefulSet selector labels match the template metadata labels. | default |
| label-values | all | Validates label values | default |
| horizontalpodautoscaler-has-target | HorizontalPodAutoscaler | Makes sure that the HPA targets a valid object | default |
| environment-variable-key-duplication | Pod | Makes sure that no duplicated environment variable keys. | default |
| pod-topology-spread-constraints | Pod | Pod Topology Spread Constraints | default |

0 comments on commit a4cdc9a

Please sign in to comment.