Improve README
This commit is contained in:
25
README.md
25
README.md
@@ -1,5 +1,28 @@
|
|||||||
# Kubernetes NixOps cluster setup
|
# NixOps Kubernetes clusters
|
||||||
|
|
||||||
|
This repository contains a batteries included, production ready, opinionated
|
||||||
|
Kubernetes cluster setup. It only requires editing two simple configuration
|
||||||
|
files to deploy a fully functional cluster using NixOps.
|
||||||
|
|
||||||
|
Together, NixOS and Kubernetes is a powerful combination. NixOS enables
|
||||||
|
programmatic configuration of the base Kubernetes system services at the OS
|
||||||
|
level. Just enabling the basic service is still a long way from having a
|
||||||
|
production ready, multi node Kubernetes cluster up and running. Setting up a
|
||||||
|
cluster at the OS level gives you a functional system shell, lacking most of the
|
||||||
|
services needed for actually deploying, accessing and monitoring services.
|
||||||
|
|
||||||
|
This project will do to things: It will configure the cluster at the OS level,
|
||||||
|
setting up services, networking, certificates, access tokens etc. It will then
|
||||||
|
bootstrap the running Kubernetes instance, fixing permissions and configuring
|
||||||
|
the following services:
|
||||||
|
|
||||||
|
* Helm for deploying services
|
||||||
|
* Nginx-ingress for external access
|
||||||
|
* cert-manager with issuers (Let's encrypt, cluster-ca and self-sign)
|
||||||
|
* nfs-client-provisioner for automatic volume management
|
||||||
|
* kubernetes-dashboard for managing the cluster and services
|
||||||
|
* metrics-server for monitoring
|
||||||
|
* Prometheus, node exporters and grafana for monitoring
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user