CONTRIBUTING
Contributing
Thanks for taking the time to join our community and start contributing!
The Contributor Guide
provides detailed instructions on how to get your ideas and bug fixes seen and accepted.
Please remember to sign the CNCF CLA and
read and observe the Code of Conduct.
README
Kubernetes Examples
Welcome to the official Kubernetes Examples repository! This curated collection,
stewarded by SIG Apps, provides high-quality, educational examples for running a
diverse range of applications and workloads on Kubernetes.
Our goal is to offer a central hub where you can:
- Discover practical implementations for various use cases.
- Learn common patterns and best practices for deploying applications on Kubernetes.
- Explore configurations for general-purpose applications as well as specialized
ones like AI/ML workloads and platforms.
Browse Examples
We encourage you to explore the subdirectories to find examples relevant to your needs.
Examples are organized into categories, such as:
- AI: Demonstrations of AI/ML model training, serving, end-to-end platform
reference manifests, and MLOps toolchains. - Web: Examples of web-based applications, from simple static sites to more complex multi-tier applications.
- Databases: Best practices and configurations for deploying various types of databases on Kubernetes.
- ... (and more as the collection grows!)
Each example includes its own detailed README.md file covering:
- Purpose and learning objectives
- Prerequisites (including Kubernetes version and hardware if applicable)
- Step-by-step deployment instructions
- Verification and cleanup commands
- Key Kubernetes concepts used
Contributing to Kubernetes Examples
We welcome contributions from the community! If you have an example that showcases
how to run applications or workloads on Kubernetes effectively and educates users,
please consider sharing it.
Before contributing, please thoroughly review our:
- Example Guidelines: These outline the standards, structure,
and best practices all examples must follow. - CONTRIBUTING.md: This provides instructions on the contribution
process, including how to propose, submit, and review examples.
Your contributions help make Kubernetes more accessible and understandable for everyone.
Our Philosophy
We aim for these examples to be:
- Educational: Clearly explaining how and why things work.
- Practical: Demonstrating real-world (though possibly simplified) applications and platforms.
- Current: Reflecting modern Kubernetes features and best practices.
- Maintained: Kept up-to-date by the community and SIG Apps.
SECURITY
Security Policy
Security Announcements
Join the kubernetes-security-announce group for security and vulnerability announcements.
You can also subscribe to an RSS feed of the above using this link.
Reporting a Vulnerability
Instructions for reporting a vulnerability can be found on the
Kubernetes Security and Disclosure Information page.
Supported Versions
Information about supported Kubernetes versions can be found on the
Kubernetes version and version skew support policy page on the Kubernetes website.