charts/README.org

131 lines
4.1 KiB
Org Mode
Raw Normal View History

2023-12-23 09:06:28 +00:00
#+TITLE: Minimal and Opinionated Helm Charts
2023-10-20 11:29:42 +00:00
#+DATE: 2023-10-18
2023-12-23 09:08:37 +00:00
#+ATTR_HTML: :align center
#+HTML: <div align="center">
#+HTML: <img src="https://helm.sh/img/helm.svg" align="center" width="144px" height="144px"/>
#+HTML: <p>... powered by a Norwegian bear 🐻</p>
#+HTML: </div>
2023-12-23 09:06:28 +00:00
2023-12-23 09:09:21 +00:00
#+ATTR_HTML: :align center
#+HTML: <div align="center">
2023-12-23 09:06:28 +00:00
#+CAPTION: Releases
2023-12-23 09:08:37 +00:00
#+NAME: fig:gh-actions-releases
2023-12-23 09:11:12 +00:00
[[[https://github.com/tommy-skaug/charts/actions/workflows/build-and-publish.yml/badge.svg]][Releases building]]
2023-12-23 09:06:28 +00:00
#+CAPTION: Index updates
2023-12-23 09:08:37 +00:00
#+NAME: fig:gh-actions-index-updates
2023-12-23 09:06:28 +00:00
[[https://github.com/tommy-skaug/charts/actions/workflows/pages/pages-build-deployment/badge.svg]]
2023-12-23 09:09:21 +00:00
#+HTML: </div>
2023-10-20 11:29:42 +00:00
Backend-focused and UX optimized minmal charts built for use with deployments based on Flux. Generally
contains Helm charts for infrastructure and some related to security operations.
2023-10-29 08:43:04 +00:00
This is a Helm Chart repository that provides packages for [[https://helm.sh/][Helm]], the Kubernetes
package manager. The builds are made available on GitHub Releases and on GitHub Pages.
2023-10-29 08:43:04 +00:00
Some charts only have Docker images available somewhere else or built by me, and others have badly
implemented Charts which I've chosen to simplify: opinionated and minimal. Opinionated means that
they're adapted to [FluxCD](https://fluxcd.io/) and uses best practices such as [external-secrets](https://external-secrets.io/latest/).
2023-12-15 17:54:46 +00:00
As with everything Kubernetes it is a learning journey, however, so feel free to open an issue.
2023-12-15 17:54:46 +00:00
Below you'll find an overview of the charts and an intro to get you started.
2023-12-23 09:06:28 +00:00
*** 📖 Overview
2023-10-20 11:29:42 +00:00
- [[charts/conduit][Conduit]]: An efficient and self-contained Matrix server using an embedded RocksDB
database.
2023-10-20 11:29:42 +00:00
- [[charts/attic][Attic]]: Nix Binary Cache server that reduces the time to compile and distribute
builds (introduction post [[https://discourse.nixos.org/t/introducing-attic-a-self-hostable-nix-binary-cache-server/24343][here]])
2023-10-20 11:29:42 +00:00
- [[charts/][Dispatch]]: A incident management and coordination system developed by Netflix.
2023-10-20 11:29:42 +00:00
- [[charts/foundationdb][FoundationDB]]: Distributed database with ACID transactions developed by Apple.
2023-10-28 06:28:23 +00:00
- [[charts/hasura-engine][Hasura]]: Connects to databases and services to provide a realtime GraphQL API.
2023-10-28 06:28:23 +00:00
- [[charts/netbox][Netbox]]: Modeling and docs for IP address management (IPAM) and datacenter
infrastructure management (DCIM).
2023-10-20 11:29:42 +00:00
2023-10-20 11:41:14 +00:00
*** Usage
2023-10-20 11:29:42 +00:00
**** Manual Installation
2023-10-20 11:29:42 +00:00
You can explore this repo by using the following commands if you have the Kubernetes package manager
installed:
2023-10-20 11:29:42 +00:00
#+BEGIN_SRC shell
2023-12-23 09:06:28 +00:00
# add the package source
helm repo add 252 https://charts.252.no
2023-12-23 09:06:28 +00:00
# search for a specific chart
helm search repo dispatch
2023-12-23 09:06:28 +00:00
# or list all available charts
helm search repo 252 -l
2023-10-20 11:29:42 +00:00
2023-12-23 09:06:28 +00:00
# show configuration options
helm show values 252/dispatch
2023-10-20 11:42:46 +00:00
2023-12-23 09:06:28 +00:00
# install a chart
helm install dispatch helm-charts/charts/dispatch --namespace=toolbox
#+END_SRC
**** As Code with FluxCD
2023-12-15 17:54:46 +00:00
First take care to setup the chart:
2023-12-15 17:54:46 +00:00
#+BEGIN_SRC yaml
apiVersion: source.toolkit.fluxcd.io/v1beta2
kind: HelmRepository
metadata:
name: 252-charts
namespace: flux-system
spec:
interval: 15m
url: https://charts.252.no
#+END_SRC
2023-12-15 17:54:46 +00:00
You can reference e.g. the Dispatch chart like this:
#+BEGIN_SRC yaml
---
apiVersion: helm.toolkit.fluxcd.io/v2beta2
kind: HelmRelease
metadata:
name: &app dispatch
spec:
interval: 30m
chart:
spec:
chart: dispatch
version: 0.3.2
sourceRef:
kind: HelmRepository
name: 252-charts
namespace: flux-system
maxHistory: 2
install:
remediation:
retries: 3
upgrade:
cleanupOnFail: true
remediation:
retries: 3
uninstall:
keepHistory: false
values:
envFromSecret: &secret dispatch-secret
[...]
#+END_SRC
Check out the ingress configuration in [[./docs/ingress.org][ingress.org]]
2023-12-15 17:54:46 +00:00
** Licenses and Gratitude 🤩
2023-12-15 17:54:46 +00:00
Repo was inspired by [[https://gitlab.com/ananace/charts][ananace]] (some parts imported and rewritten).
2023-12-15 17:54:46 +00:00
The general license of this repo is DWTFYWTPB, but respect Apache v2 in some of the repos which were
built on other's work. See the individual chart directory for details and these applies.