mirror of
https://github.com/kyverno/kyverno.git
synced 2025-03-05 15:37:19 +00:00
add brief explanations of rules in QuickStart and combine community sections
This commit is contained in:
parent
65ceaea58a
commit
a72947b500
1 changed files with 24 additions and 17 deletions
41
README.md
41
README.md
|
@ -24,7 +24,11 @@ kubectl create -f https://github.com/nirmata/kyverno/raw/master/definitions/inst
|
||||||
|
|
||||||
You can also install Kyverno using a [Helm chart](https://github.com/nirmata/kyverno/blob/master/documentation/installation.md#install-kyverno-using-helm).
|
You can also install Kyverno using a [Helm chart](https://github.com/nirmata/kyverno/blob/master/documentation/installation.md#install-kyverno-using-helm).
|
||||||
|
|
||||||
Add the policy below. It requires that all pods have a `app.kubernetes.io/name` label:
|
Add the policy below. It contains a single validation rule that requires that all pods have
|
||||||
|
a `app.kubernetes.io/name` label. Kyverno supports different rule types to validate,
|
||||||
|
mutate, and generate configurations. The `validationFailureAction` is set to `enforce`
|
||||||
|
to block requests that are non-compliant (the value `audit` will report violations but
|
||||||
|
not block requests.)
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
apiVersion: kyverno.io/v1
|
apiVersion: kyverno.io/v1
|
||||||
|
@ -78,7 +82,8 @@ spec:
|
||||||
image: "nginx:latest"
|
image: "nginx:latest"
|
||||||
```
|
```
|
||||||
|
|
||||||
This pod is allowed. Clean up by deleting all cluster policies:
|
This pod configuration is compliant with the policy rules, and not blocked.
|
||||||
|
Clean up by deleting all cluster policies:
|
||||||
|
|
||||||
```console
|
```console
|
||||||
kubectl delete cpol --all
|
kubectl delete cpol --all
|
||||||
|
@ -108,10 +113,26 @@ As a next step, browse the [sample policies](https://github.com/nirmata/kyverno/
|
||||||
|
|
||||||
[Apache License 2.0](https://github.com/nirmata/kyverno/blob/master/LICENSE)
|
[Apache License 2.0](https://github.com/nirmata/kyverno/blob/master/LICENSE)
|
||||||
|
|
||||||
## Community Call
|
## Community
|
||||||
|
|
||||||
|
### Community Meetings
|
||||||
|
|
||||||
To attend our next monthly community meeting join the [Kyverno group](https://groups.google.com/g/kyverno). You will then be sent a meeting invite and get access to the [agenda and meeting notes](https://docs.google.com/document/d/10Hu1qTip1KShi8Lf_v9C5UVQtp7vz_WL3WVxltTvdAc/edit#).
|
To attend our next monthly community meeting join the [Kyverno group](https://groups.google.com/g/kyverno). You will then be sent a meeting invite and get access to the [agenda and meeting notes](https://docs.google.com/document/d/10Hu1qTip1KShi8Lf_v9C5UVQtp7vz_WL3WVxltTvdAc/edit#).
|
||||||
|
|
||||||
|
### Getting Help
|
||||||
|
|
||||||
|
- For feature requests and bugs, file an [issue](https://github.com/nirmata/kyverno/issues).
|
||||||
|
- For discussions or questions, join the **#kyverno** channel on the [Kubernetes Slack](https://kubernetes.slack.com/) or the [mailing list](https://groups.google.com/g/kyverno).
|
||||||
|
|
||||||
|
### Contributing
|
||||||
|
|
||||||
|
Thanks for your interest in contributing!
|
||||||
|
|
||||||
|
- Please review and agree to abide with the [Code of Conduct](/CODE_OF_CONDUCT.md) before contributing.
|
||||||
|
- We encourage all contributions and encourage you to read our [contribution guidelines](./CONTRIBUTING.md).
|
||||||
|
- See the [Wiki](https://github.com/nirmata/kyverno/wiki) for developer documentation.
|
||||||
|
- Browse through the [open issues](https://github.com/nirmata/kyverno/issues)
|
||||||
|
|
||||||
## Presentations and Articles
|
## Presentations and Articles
|
||||||
|
|
||||||
- [Introducing Kyverno - blog post](https://nirmata.com/2019/07/11/managing-kubernetes-configuration-with-policies/)
|
- [Introducing Kyverno - blog post](https://nirmata.com/2019/07/11/managing-kubernetes-configuration-with-policies/)
|
||||||
|
@ -121,20 +142,6 @@ To attend our next monthly community meeting join the [Kyverno group](https://gr
|
||||||
- [Virtual Rejekts Video](https://www.youtube.com/watch?v=caFMtSg4A6I)
|
- [Virtual Rejekts Video](https://www.youtube.com/watch?v=caFMtSg4A6I)
|
||||||
- [TGIK Video](https://www.youtube.com/watch?v=ZE4Zu9WQET4&list=PL7bmigfV0EqQzxcNpmcdTJ9eFRPBe-iZa&index=18&t=0s)
|
- [TGIK Video](https://www.youtube.com/watch?v=ZE4Zu9WQET4&list=PL7bmigfV0EqQzxcNpmcdTJ9eFRPBe-iZa&index=18&t=0s)
|
||||||
|
|
||||||
## Getting help
|
|
||||||
|
|
||||||
- For feature requests and bugs, file an [issue](https://github.com/nirmata/kyverno/issues).
|
|
||||||
- For discussions or questions, join the **#kyverno** channel on the [Kubernetes Slack](https://kubernetes.slack.com/) or the [mailing list](https://groups.google.com/g/kyverno).
|
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
Thanks for your interest in contributing!
|
|
||||||
|
|
||||||
- Please review and agree to abide with the [Code of Conduct](/CODE_OF_CONDUCT.md) before contributing.
|
|
||||||
- We encourage all contributions and encourage you to read our [contribution guidelines](./CONTRIBUTING.md).
|
|
||||||
- See the [Wiki](https://github.com/nirmata/kyverno/wiki) for developer documentation.
|
|
||||||
- Browse through the [open issues](https://github.com/nirmata/kyverno/issues)
|
|
||||||
|
|
||||||
|
|
||||||
## Alternatives
|
## Alternatives
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue