style: README

Minor changes to language and spelling
This commit is contained in:
Tommy Skaug 2024-04-03 12:41:16 +02:00 committed by GitHub
parent 385eb67b9e
commit f6411a52cd
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1,7 +1,7 @@
#+DATE: 2024-04-03
#+BEGIN_QUOTE
⚠️ 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.
⚠️ There are no guarantees with these Helm Charts. I provide basic patching and watering in the sense that I use most of them myself. If charts are unused they may be removed.
#+END_QUOTE
#+BEGIN_HTML
@ -30,9 +30,9 @@
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.
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.
This is a Helm Chart repository that provides packages for [[https://helm.sh/][Helm]], a Kubernetes configuration manager.Builds are made available on GitHub Releases and at charts.252.no.
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]].
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 facilitates best practices such as [[https://external-secrets.io/latest/][external-secrets]].
As with everything Kubernetes this is a learning journey, so feel free to open an issue.
@ -71,7 +71,7 @@ All tests are run on the latest version of Kubernetes and Helm and no considerat
*** Principles
So what makes this repo different from others? It is KISS and Safe of course.
So what makes this repo different from others? It is KISS-Safe of course.
- Secrets and ingresses are defined external from the chart
- Expect that an ingress terminates external connection and TLS
@ -79,15 +79,15 @@ So what makes this repo different from others? It is KISS and Safe of course.
- Never rely on vendor-specific components
- Prefer open source
- No plaintext secrets - be sane
- Leave room for initContainers
- Use as few values as possible in values.yaml
- Leaving room for initContainers
- Use as few values as possible in values.yaml (making sane choices)
- Use external databases and transports
- Configure for OIDC when possible
- The values file should be possible to read up on in minutes
- Only support the current major version of Kubernetes and application
- Enable service accounts
- Use semver for versioning
- Chart should install on a small scale with default values
- Charts should install on a small scale by default
- Charts are validated for structure, security and syntax before compilation
- Regardless of journey level everyone should be able to read or learn the chart