Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ContainerSolutions/kubernetes-examples
Minimal self-contained examples of standard Kubernetes features and patterns in YAML
https://github.com/ContainerSolutions/kubernetes-examples
hacktoberfest kubernetes yaml
Last synced: 17 days ago
JSON representation
Minimal self-contained examples of standard Kubernetes features and patterns in YAML
- Host: GitHub
- URL: https://github.com/ContainerSolutions/kubernetes-examples
- Owner: ContainerSolutions
- License: mit
- Created: 2020-06-01T14:26:42.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-10-03T10:18:57.000Z (about 1 year ago)
- Last Synced: 2024-10-14T22:41:12.929Z (29 days ago)
- Topics: hacktoberfest, kubernetes, yaml
- Language: Shell
- Homepage: https://k8s-examples.container-solutions.com/
- Size: 330 KB
- Stars: 1,394
- Watchers: 44
- Forks: 299
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Kubernetes Examples
A reference repository of YAML with canonical and as-simple-as-possible demonstrations of kubernetes functionality and features.
See here for a searchable front-end: https://k8s-examples.container-solutions.com/
## Why?
At Container Solutions we find we regularly need chunks of YAML to demonstrate something specific, such as:
- A simple deployment
- A simple pod
- A pod with a volume
This might be to do a basic test of an environment, find an example to tinker with, or send to someone to get them going.
## Usage
The examples can be used by a kubectl plugin `examples`. This plugin can be installed
by [krew](https://krew.sigs.k8s.io/):
- first [install krew](https://krew.sigs.k8s.io/docs/user-guide/setup/install/)
- Install a custom plugin index: `kubectl krew index add cs https://github.com/ContainerSolutions/kubernetes-examples.git`
- Install this plugin: `kubectl krew install cs/examples`
Interactively discover by first selecting the resource type:
```
$ kubectl examples
```
filter by resource type
```
$ kubectl examples Service
```
filter by resource type and pattern
```
$ kubectl examples Pod res
```
If there is only a single match selected by the parameters, it is printed to the stdout.
So you can deploy a modified version of a sample by:
```
$ export KUBE_EDITOR='code -w'
$ kubectl examples Ingress fanout | kubectl create -f - --edit
```
## Sections
`broken-*` - yamls that exemplify broken kubernetes yaml states
`[A-Z][a-zA-Z]*` - Example yamls that correspond to resource types.
`test` - Scripts to test or validate the YAML
Within those folders are either simple/canonical examples, or examples in subfolders that expose particular items of functionality that are highlighted by their yaml path, eg `Pod/spec.initContainers/`.
If an example is an exemplar of a particular feature but tightly related to another resource, then an absolute folder might be added eg in Service there is `Service/Pod.spec.subdomain`.
Symlinks are also used to make finding things easier, eg `Service/headless-service -> Service/spec.clusterIP`.
`plugins` - a directory following the spec for a Custom krew [plugin index](https://krew.sigs.k8s.io/docs/user-guide/custom-indexes/)
## Principles
The examples seek to be:
- As simple as possible to illustrate the functionality
- Self-contained (ie limited to one .yaml file)
- Non-conflicting (eg resource names are unique)
- Clear (eg resource names are verbose and unambiguous)
## Release Process
See [here](RELEASE_PROCESS.md)
## Sources / Thanks To
[Official Kubernetes docs](https://kubernetes.io/docs/)
[Kubernetes by Example](https://kubernetesbyexample.com/)
[Practical Kubernetes](https://github.com/kubernauts/practical-kubernetes-problems)
[Security Examples](https://github.com/NodyHub/docker-k8s-resources/tree/master/k8s-pods)