1
0
Fork 0
mirror of https://github.com/kyverno/kyverno.git synced 2024-12-14 11:57:48 +00:00
kyverno/README.md

42 lines
1.9 KiB
Markdown
Raw Normal View History

2019-05-21 03:43:38 +00:00
# Kyverno - Kubernetes Native Policy Management
2019-02-04 16:30:38 +00:00
2019-05-21 03:43:38 +00:00
![logo](documentation/images/Kyverno_Horizontal.png)
2019-05-03 12:10:54 +00:00
2019-05-21 03:43:38 +00:00
Kyverno is a policy engine built for Kubernetes.
2019-05-03 12:10:54 +00:00
2019-05-21 03:43:38 +00:00
Kyverno policies are custom resources that are written in YAML or JSON. Kyverno policies can validate, mutate, and generate any Kubernetes resources.
2019-05-03 12:10:54 +00:00
2019-05-21 03:43:38 +00:00
Kyverno runs as a [dynamic admission controller](https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/) in a Kubernetes cluster. Kyverno receives validating and mutating admission webhook HTTP callbacks from the kube-apiserver, applies matching polcies, and returns results that enforce admission policies or reject requests.
2019-05-03 12:10:54 +00:00
2019-05-21 03:43:38 +00:00
Policies match resources using the resource kind, name, and label selectors. Wildcards are supported in names.
2019-05-03 12:10:54 +00:00
2019-05-21 03:43:38 +00:00
Mutating policies can be written as overlays (similar to [Kustomize](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/kustomization/#bases-and-overlays)) or as a [JSON Patch](http://jsonpatch.com/). Validating policies also use an overlay style syntax, with support for pattern matching and conditional (if-then-else) processing.
2019-05-03 12:10:54 +00:00
2019-05-21 03:43:38 +00:00
Policy enforcement is captured using Kubernetes events. Kyverno also reports policy violations for existing resources.
2019-02-04 16:30:38 +00:00
## Examples
2019-05-21 03:43:38 +00:00
### 1. Validating resources
2019-05-21 03:43:38 +00:00
### 2. Mutating resources
2019-05-21 03:43:38 +00:00
### 2. Generating resources
2019-05-21 03:43:38 +00:00
## Documentation
2019-05-21 03:43:38 +00:00
* [Getting Started](documentation/installation.md)
* [Writing Policies](documentation/writing-policies.md)
* [Validate Rules](documentation/writing-policies.md)
* [Mutate Rules](documentation/writing-policies.md)
* [Generate Rules](documentation/writing-policies.md)
* [Testing Policies](documentation/testing-policies.md)
2019-05-21 03:43:38 +00:00
## Roadmap
2019-05-21 03:43:38 +00:00
## Getting help
2019-05-21 03:43:38 +00:00
* For feature requests and bugs, file an [issue][https://github.com/nirmata/kyverno/issues].
* For general discussion about both using and developing dex, join the [dex-dev][dex-dev] mailing list.