1
0
Fork 0
mirror of https://github.com/kyverno/kyverno.git synced 2025-03-28 18:38:40 +00:00

update README.md

This commit is contained in:
Jim Bugwadia 2019-05-21 00:33:50 -07:00
parent 971b2d7048
commit 7ab611b51d

View file

@ -2,9 +2,13 @@
![logo](documentation/images/Kyverno_Horizontal.png)
Kyverno is a policy engine built for Kubernetes.
Kyverno is a policy engine designed for Kubernetes.
Kyverno policies are Kubernetes custom resources that can be written in YAML or JSON. Kyverno policies can validate, mutate, and generate any Kubernetes resources.
Kubernetes supports declarative management of objects using configurations written in YAML or JSON. Often, parts of the configuration will need to vary based on the runtime environment. For portability, and for separation of concerns, its best to mantain environment specific configurations separately from workload configurations.
Kyverno allows cluster adminstrators to manage environment specific configurations independently of workload configurations and enforce configuration best practices for their clusters.
Kyverno policies are Kubernetes resources that can be written in YAML or JSON. Kyverno policies can validate, mutate, and generate any Kubernetes resources.
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 and applies matching polcies to return results that enforce admission policies or reject requests.
@ -14,10 +18,6 @@ Mutating policies can be written as overlays (similar to [Kustomize](https://kub
Policy enforcement is captured using Kubernetes events. Kyverno also reports policy violations for existing resources.
## Status
*Kyverno is under active development and not ready for production use. Key components and policy definitions are likely to change as we complete core features.*
## Examples
### 1. Validating resources
@ -102,18 +102,24 @@ spec:
Additional examples are available in [examples](/examples).
## Status
*Kyverno is under active development and not ready for production use. Key components and policy definitions are likely to change as we complete core features.*
## Documentation
* [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)
* [Validate](documentation/writing-policies.md)
* [Mutate](documentation/writing-policies.md)
* [Generate](documentation/writing-policies.md)
* [Testing Policies](documentation/testing-policies.md)
* [Using kubectl](documentation/testing-policies-kubectl.md)
* [Using the Kyverno CLI](documentation/testing-policies-kyverno-cli.md)
## Status and Roadmap
## Roadmap
Here are some the major features we plan on completing before a 1.0 release: