1
0
Fork 0
mirror of https://github.com/kyverno/kyverno.git synced 2025-03-24 16:48:20 +00:00
kyverno/README.md
Karthik Manam c0c9cec7c3
docs: add popular use cases section to README (#12297)
* docs: add popular use cases section to README

   This commit adds a new section to the README that outlines common
   use cases for Kyverno, helping new users quickly understand its
   practical applications. The section is organized into four key
   categories: Security & Compliance, Operational Excellence, Cost
   Optimization, and Developer Guardrails.

Signed-off-by: Karthik babu Manam <karthikmanam@gmail.com>

* docs: add popular use cases section to README

This commit adds a new section to the README that outlines common
use cases for Kyverno, helping new users quickly understand its
practical applications. The section is organized into four key
categories: Security & Compliance, Operational Excellence, Cost
Optimization, and Developer Guardrails.

Signed-off-by: Karthik babu Manam <karthikmanam@gmail.com>

---------

Signed-off-by: Karthik babu Manam <karthikmanam@gmail.com>
2025-03-05 19:10:30 +00:00

6.4 KiB
Raw Blame History

Kyverno Tweet

Cloud Native Policy Management 🎉

Go Report Card License: Apache-2.0 GitHub Repo stars CII Best Practices OpenSSF Scorecard SLSA 3 Artifact HUB codecov FOSSA Status

logo

Kyverno is a policy engine designed for cloud native platform engineering teams. It enables security, automation, compliance, and governance using policy-as-code. Kyverno can validate, mutate, generate, and cleanup configurations using Kubernetes admission controls, background scans, and source code respository scans. Kyverno policies can also be used to verify OCI images, for software supply chain security. Kyverno policies can be managed as Kubernetes resources and do not require learning a new language. Kyverno is designed to work nicely with tools you already use like kubectl, kustomize, and Git.

Open Source Security Index - Fastest Growing Open Source Security Projects

📙 Documentation

Kyverno installation and reference documents are available at kyverno.io.

👉 Quick Start

👉 Installation

👉 Sample Policies

Kyverno helps platform teams enforce best practices and security policies. Here are some common use cases:

  1. Security & Compliance

    • Enforce pod security standards
    • Require specific security contexts
    • Validate image sources and signatures
    • Ensure resource limits and requests
  2. Operational Excellence

    • Automatically add labels and annotations
    • Enforce naming conventions
    • Generate default network policies
    • Validate resource configurations
  3. Cost Optimization

    • Enforce resource quotas
    • Require cost allocation labels
    • Clean up unused resources
    • Validate instance types
  4. Developer Guardrails

    • Enforce ingress/egress rules
    • Require liveness/readiness probes
    • Validate container images
    • Auto-mount configuration

Each use case includes ready-to-use policies in our policy library.

🙋‍♂️ Getting Help

We are here to help!

👉 For feature requests and bugs, file an issue.

👉 For discussions or questions, join the Kyverno Slack channel.

👉 For community meeting access, see mailing list.

👉 To get follow updates star this repository.

Contributing

Thanks for your interest in contributing to Kyverno! Here are some steps to help get you started:

✔ Read and agree to the Contribution Guidelines.

✔ Browse through the GitHub discussions.

✔ Read Kyverno design and development details on the GitHub Wiki.

✔ Check out the good first issues list. Add a comment with /assign to request assignment of the issue.

✔ Check out the Kyverno Community page for other ways to get involved.

Software Bill of Materials

All Kyverno images include a Software Bill of Materials (SBOM) in CycloneDX JSON format. SBOMs for Kyverno images are stored in a separate repository at ghcr.io/kyverno/sbom. More information on this is available at Fetching the SBOM for Kyverno.

Contributors

Kyverno is built and maintained by our growing community of contributors!

Made with contributors-img.

License

Copyright 2024, the Kyverno project. All rights reserved. Kyverno is licensed under the Apache License 2.0.

Kyverno is a Cloud Native Computing Foundation (CNCF) Incubating project and was contributed by Nirmata.