krd

KO | EN

gitlite — search

#typescript #ai-agents #ai #dsh-plugin #deepseek-harness #open-source #cli #claude-code #codex #developer-tools #react #windows

★ 40 Open GitHub ↗

Kubernetes Reference Deployment

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Kubernetes Reference Deployment

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![GitHub Super-Linter](https://github.com/electrocucaracha/krd/workflows/Lint%20Code%20Base/badge.svg)](https://github.com/marketplace/actions/super-linter)
[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)

![visitors](https://visitor-badge.laobi.icu/badge?page_id=electrocucaracha.krd)
[![Scc Code Badge](https://sloc.xyz/github/electrocucaracha/krd?category=code)](https://github.com/boyter/scc/)
[![Scc COCOMO Badge](https://sloc.xyz/github/electrocucaracha/krd?category=cocomo)](https://github.com/boyter/scc/)

## Summary

KRD (Kubernetes Reference Deployment) is a framework for easily deploying Kubernetes clusters on bare-metal or virtual machines using Ansible.
It provides a configurable and extensible platform for validating Cloud Native technologies across various Linux distributions.

A central concept in KRD is the use of the POD Descriptor File (PDF)—a YAML file that defines your cluster configuration.
You can start with the [default configuration](config/default.yml) or explore [the sample setups](config/samples) for advanced scenarios.

## Supported Linux Distributions

## Included Components

KRD integrates a wide range of Kubernetes-related components for testing, benchmarking, or production experimentation:

## Quick Deployment

Use the [All-in-One script](aio.sh) for a streamlined, unattended deployment:

curl -fsSL http://bit.ly/KRDaio | bash

This will clone the repository, install dependencies, and provision a default cluster setup.

![Provisioning](https://raw.githubusercontent.com/electrocucaracha/krd/master/docs/src/img/provisioning.png)

## Customizing your Cluster

KRD supports custom cluster definitions using the PDF (YAML) format. Vagrant uses the [default configuration](config/default.yml), but this can be overridden via a `config/pdf.yml` file.

You can also visualize your cluster topology using:

tox -e diagram

![Sample diagram](https://raw.githubusercontent.com/electrocucaracha/krd/master/docs/src/img/sample_tox_diagram.png)

## Installing Add-Ons

Use [KRD command script](krd_command.sh) to install optional components on an existing cluster.

./krd_command.sh -h

To install Kubernetes add-ons:

KRD_ADDONS_LIST=nfd ./krd_command.sh -a install_k8s_addons

> _Note_: Some add-ons include validation scripts in the [tests](tests) directory.

## Day-2 Operations

KRD supports full lifecycle operations, including upgrades, node addition, and service removal.

Example: Upgrade your Kubernetes cluster to version `v1.18.10` using Kubespray `v2.14.2`:

KRD_KUBE_VERSION=v1.18.10 KRD_KUBESPRAY_VERSION=v2.14.2 ./krd_command.sh -a upgrade_k8s

## Environment Configuration

KRD relies on environment variables to control behavior and customization. Below are some of the most relevant variables.

### Global Variables

### Kubespray

## Contribution

KRD is an open-source initiative with contributions from developers, testers, and documenters across the community.

We welcome all forms of collaboration. Please see our [CONTRIBUTING](CONTRIBUTING.md) guide for details.

Thanks to everyone who has contributed so far!

![Visualization of the codebase](https://raw.githubusercontent.com/electrocucaracha/krd/master/codebase-structure.svg)

[1]: https://github.com/kubernetes-sigs/kubespray
[2]: https://github.com/k8snetworkplumbingwg/multus-cni
[4]: playbooks/roles/nfd
[5]: https://kubernetes.io/docs/tasks/administer-cluster/nodelocaldns/
[6]: playbooks/roles/pmem
[7]: https://man.cx/?page=ipvsadm(8)
[8]: playbooks/roles/qat_plugin
[9]: playbooks/roles/sriov_plugin
[10]: https://cert-manager.io/
[11]: https://kubernetes.github.io/ingress-nginx/
[12]: https://kubernetes.io/docs/tasks/access-application-cluster/web-ui-dashboard/
[13]: https://katacontainers.io/
[15]: https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/
[17]: https://www.kernel.org/doc/html/latest/admin-guide/mm/hugetlbpage.html
[18]: https://github.com/containers/crun
[19]: https://metallb.universe.tf/
[20]: https://github.com/kubernetes-sigs/sig-storage-local-static-provisioner
[21]: https://kubernetes.io/blog/2022/12/05/forensic-container-checkpointing-alpha/
[22]: https://metallb.universe.tf/
[23]: https://kubernetes.io/docs/tasks/debug-application-cluster/audit/
[24]: https://kubernetes.io/docs/concepts/cluster-administration/logging/
[25]: https://gvisor.dev/docs/
[26]: https://youki-dev.github.io/youki/

krd

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README