text stringlengths 0 59.1k |
|---|
* Container Images: |
* Publicly Accessible Images: Images used in examples MUST be publicly accessible |
from well-known, reputable container registries. |
* Image Tagging: Images MUST be tagged with a specific version instead of using `:latest` tags. |
* If an example requires a custom-built image not available on public registries, the |
`Dockerfile` and all necessary source files (build context) MUST be included within |
the example's subdirectory (e.g., in an `image/` subfolder). |
### Documentation and Commands |
* Linking to Official Docs: On the first mention of a Kubernetes concept, link to its |
official documentation page. |
* Code Highlighting: Use appropriate code highlighting for shell commands and YAML |
manifests, consistent with GitHub's rendering (typically Rouge-supported types). |
* Commands to be copied by the user should use the `shell` syntax highlighting type, |
and do not include any kind of prompt characters (e.g., `$`, `#`). |
* Example output should be in a separate block to distinguish it from the commands. |
* Placeholders: When providing commands or configuration where users need to substitute |
their own values, use angle brackets: e.g., `<YOUR_NAMESPACE>`, `<YOUR_BUCKET_NAME>`. |
* Screenshots/Diagrams (Optional but helpful): For complex examples, screenshots of the |
running application or simple architecture diagrams can be very beneficial. Store these |
within the example's subdirectory. Asciinema recordings for terminal interactions are |
also welcome. |
## Maintenance and Lifecycle |
* Review and Updates: Examples are expected to be kept reasonably up-to-date with current |
Kubernetes versions and best practices. Contributors are encouraged to revisit their |
examples periodically. The `README.md` should specify the Kubernetes version(s) against |
which the example was last tested. |
* Archiving Policy: |
* A process will be established by SIG Apps for identifying outdated, unmaintained, or |
broken examples. |
* Such examples may be moved to an `archive/` directory or removed after a deprecation |
period and attempts to find new maintainers. This ensures the repository remains a |
reliable source of current best practices. |
* The `README.md` of archived examples should clearly state their archived status and |
potential incompatibility with current Kubernetes versions. |
* Community Maintenance: SIG Apps will act as the overall steward, and individual example |
maintainers (original authors or new volunteers) are crucial for the health of the repository. |
<|endoftext|> |
# source: k8s_examples/code-of-conduct.md type: docs |
# Kubernetes Community Code of Conduct |
Please refer to our [Kubernetes Community Code of Conduct](https://git.k8s.io/community/code-of-conduct.md) |
<|endoftext|> |
# source: k8s_examples/SECURITY.md type: docs |
# 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][kubernetes-security-announce-rss]. |
## 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. |
[kubernetes-security-announce]: https://groups.google.com/forum/#!forum/kubernetes-security-announce |
[kubernetes-security-announce-rss]: https://groups.google.com/forum/feed/kubernetes-security-announce/msgs/rss_v2_0.xml?num=50 |
[Kubernetes version and version skew support policy]: https://kubernetes.io/docs/setup/release/version-skew-policy/#supported-versions |
[Kubernetes Security and Disclosure Information]: https://kubernetes.io/docs/reference/issues-security/security/#report-a-vulnerability |
<|endoftext|> |
# source: k8s_examples/README.md type: docs |
# 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](AI/): Demonstrations of AI/ML model training, serving, end-to-end platform |
reference manifests, and MLOps toolchains. |
* [Web](web/): Examples of web-based applications, from simple static sites to more complex multi-tier applications. |
* [Databases](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) |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.