pub/charts
1
0
Fork 0
Code Issues Pull requests Releases Packages 19 Activity Actions

style: Update docs

Browse source 
Clarify what charts are actively maintained/used. Additionally minor changes.
This commit is contained in:
Tommy Skaug 2024-04-03 11:54:53 +02:00 committed by GitHub
parent ff215517a8
commit 1d7dd6c4af
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 24 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

59
README.org
View file

@ -1,7 +1,7 @@
#+DATE: 2023-10-18 #+DATE: 2024-04-03
#+BEGIN_QUOTE #+BEGIN_QUOTE
⚠️ I'm porting my Helm charts to cdk8s, so these Helm charts are left for reference. There are no guarantees they will be updated. ⚠️ There are no guarantees with these Helm Charts. I provide basic patching and they are maintained in the sense that I use most of them myself. If charts are unused they may be removed.
#+END_QUOTE #+END_QUOTE
#+BEGIN_HTML #+BEGIN_HTML
@ -28,50 +28,42 @@
<p>&nbsp;</p> <p>&nbsp;</p>
#+END_HTML #+END_HTML
Backend-focused and UX optimized minmal charts built for use with deployments based on Flux. Generally 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.
contains Helm charts for infrastructure and some related to security operations.
This is a Helm Chart repository that provides packages for [[https://helm.sh/][Helm]], the Kubernetes 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.
package manager. The builds are made available on GitHub Releases and on GitHub Pages.
Some charts only have Docker images available somewhere else or built by me, and others have badly Some charts have images made available somewhere else or by me, while others were in such a bad state that I chose to simplify them according to the key principle in here: opinionated and minimal. Opinionated means that they're adapted to [[https://fluxcd.io/][FluxCD]] and uses best practices such as [[https://external-secrets.io/latest/][external-secrets]].
implemented Charts which I've chosen to simplify: opinionated and minimal. Opinionated means that
they're adapted to [[https://fluxcd.io/][FluxCD]] and uses best practices such as [[https://external-secrets.io/latest/][external-secrets]].
As with everything Kubernetes it is a learning journey, so feel free to open an issue. As with everything Kubernetes this is a learning journey, so feel free to open an issue.
Below you'll find an overview of the charts and an intro to get you started. Below you'll find an overview of the charts and an intro to get you started.
*** 📖 Overview *** 📖 Overview
- [[charts/conduit][Conduit]]: An efficient and self-contained Matrix server using an embedded RocksDB ⚠️ [[charts/conduit][Conduit]]: An efficient and self-contained Matrix server using an embedded RocksDB database. Currently I use Synapse instead.
database.
- [[charts/attic][Attic]]: Nix Binary Cache server that reduces the time to compile and distribute 🚧 [[charts/attic][Attic]]: Nix Binary Cache server that reduces the time to compile and distribute builds ([[https://discourse.nixos.org/t/introducing-attic-a-self-hostable-nix-binary-cache-server/24343][intro post]])
builds ([[https://discourse.nixos.org/t/introducing-attic-a-self-hostable-nix-binary-cache-server/24343][intro post]])
- [[charts/][Dispatch]]: A incident management and coordination system developed by Netflix. 🟢 [[charts/][Dispatch]]: A incident management and coordination system developed by Netflix.
- [[charts/foundationdb][FoundationDB]] (=fdb-operator=): Distributed database with ACID transactions developed by Apple. ⚠️ [[charts/foundationdb][FoundationDB]] (=fdb-operator=): Distributed database with ACID transactions developed by Apple. This buils and deploys, but I don't actively use it at the moment.
This buils and deploys, but I don't actively use it at the moment.
- [[charts/hasura-engine][Hasura]]: Connects to databases and services to provide a realtime GraphQL API. I'm a little ⚠️ [[charts/hasura-engine][Hasura]]: Connects to databases and services to provide a realtime GraphQL API. I'm a little skeptical of their licensing model, but I have tested it and it deploys well. Currently I use Postgraphile instead for a dev project.
skeptical of their licensing model, but I have tested it and it deploys well.
- [[charts/netbox][Netbox]]: Modeling and docs for IP address management (IPAM) and datacenter ⚠️ [[charts/netbox][Netbox]]: Modeling and docs for IP address management (IPAM) and datacenter infrastructure management (DCIM). This deploys ok but has a few moving parts.
infrastructure management (DCIM). I plan to clean up this Helm, but for now it has only been imported.
- [[charts/penpot][Penpot]]: Design and prototyping tool. For visual collaboration on visuals, prototypes, UX and more. ⚠️ [[charts/penpot][Penpot]]: Design and prototyping tool. For visual collaboration on visuals, prototypes, UX and more. Don't use atm.
*** Requirements *** Requirements
You may need the following: You may need to bring your own:
- S3 compatible storage - S3 compatible object storage
- PostgreSQL - Block storage
- PostgreSQL, such as Cloudnative-PG
- Redis-compatible server, such as Dragonfly
All tests are run on the latest version of Kubernetes and Helm and no consideration is taken to vendor-specific All tests are run on the latest version of Kubernetes and Helm and no consideration is taken to vendor-specific implementations.
implementations.
*** Principles *** Principles
@ -95,8 +87,7 @@ So what makes this repo different from others? It is KISS and Safe of course.
- Charts are validated for structure, security and syntax before compilation - Charts are validated for structure, security and syntax before compilation
- Regardless of journey level everyone should be able to read or learn the chart - Regardless of journey level everyone should be able to read or learn the chart
Some of these principles are implicit and means you'll have to deploy with e.g. kustomize to Some of these principles are implicit and means you'll have to deploy with e.g. kustomize to get going.
get going.
If you see a chart that does not comply with these principles, please open an issue. If you see a chart that does not comply with these principles, please open an issue.
@ -104,8 +95,7 @@ If you see a chart that does not comply with these principles, please open an is
**** Exploration **** Exploration
You can explore this repo by using the following commands if you have the Kubernetes package manager You can explore this repo by using the following commands if you have the Kubernetes package manager installed:
installed:
#+BEGIN_SRC shell #+BEGIN_SRC shell
# add the package source # add the package source
@ -125,7 +115,7 @@ helm show values 252/dispatch
helm install dispatch helm-charts/charts/dispatch --namespace=toolbox helm install dispatch helm-charts/charts/dispatch --namespace=toolbox
#+END_SRC #+END_SRC
**** As Code with FluxCD **** As-code with FluxCD
First take care to setup the chart: First take care to setup the chart:
@ -144,7 +134,6 @@ A reference kustomization directory is shown in [[./kustomization-components][./
** 🤩 Licenses and Gratitude ** 🤩 Licenses and Gratitude
Repo was inspired by [[https://gitlab.com/ananace/charts][ananace]] (some parts imported and rewritten). Parts of the repo was inspired by [[https://gitlab.com/ananace/charts][ananace]] (some parts imported and rewritten).
The general license of this repo is DWTFYWTPB, but respect Apache v2 in some of the repos which were 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.
built on other's work. See the individual chart directory for details and these applies.