ZeroDownTime/kubezero
3
0
Fork 0
Code Issues 1 Pull Requests 24 Wiki Activity

docs: update all chart READMEs

Browse Source
This commit is contained in:
Stefan Reimer 2024-10-16 13:37:57 +00:00
parent 6ef48c0640
commit 49fc26c1f0
12 changed files with 74 additions and 104 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
CHANGELOG.md
View File

@ -1,46 +0,0 @@
# Changelog
## KubeZero - 2.18 ( Argoless )
### High level / Admin changes
- ArgoCD is now optional and NOT required nor used during initial cluster bootstrap
- the bootstrap process now uses the same config and templates as the optional ArgoCD applications later on
- the bootstrap is can now be restarted at any time and considerably faster
- the top level KubeZero config for the ArgoCD app-of-apps is now also maintained via the gitops workflow. Changes can be applied by a simple git push rather than manual scripts
### Calico
- version bump
### Cert-manager
- local issuers are now cluster issuer to allow them being used across namespaces
- all cert-manager resources moved into the cert-manager namespace
- version bump to 1.10
### Kiam
- set priorty class to cluster essential
- certificates are now issued by the cluster issuer
### EBS / EFS
- version bump
### Istio
- istio operator removed, deployment migrated to helm, various cleanups
- version bump to 1.8
- all ingress resources are now in the dedicated new namespace istio-ingress ( deployed via separate kubezero chart istio-ingress)
- set priorty class of ingress components to cluster essential
### Logging
- ES/Kibana version bump to 7.10
- ECK operator is now installed on demand in logging ns
- Custom event fields configurable via new fluent-bit chart
e.g. clustername could be added to each event allowing easy filtering in case multiple clusters stream events into a single central ES cluster
### ArgoCD
- version bump, new app of app architecure
### Metrics
- version bump
- all servicemonitor resources are now in the same namespaces as the respective apps to avoid deployments across multiple namespaces
### upstream Kubernetes 1.18
https://sysdig.com/blog/whats-new-kubernetes-1-18/

2
Makefile
View File

@ -17,7 +17,7 @@ update-chart-docs:
for c in charts/*; do \
[[ $$c =~ "kubezero-lib" ]] && continue ; \
[[ $$c =~ "kubeadm" ]] && continue ; \
helm-docs -c $$c ; \
helm-docs --skip-version-footer -c $$c ; \
done
publish-charts:

3
charts/clamav/README.md
View File

@ -36,6 +36,3 @@ Kubernetes: `>= 1.26.0`
| replicaCount | int | `1` | |
| resources | object | `{"requests":{"cpu":"300m","memory":"2000M"}}` | The resource requests and limits for the clamav service |
| service.port | int | `3310` | The port to be used by the clamav service |
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)

11
charts/kubezero-falco/README.md
View File

@ -45,20 +45,19 @@ Kubernetes: `>= 1.26.0`
| k8saudit.falco.rules_file[0] | string | `"/etc/falco/rules.d"` | |
| k8saudit.falco.syslog_output.enabled | bool | `false` | |
| k8saudit.falcoctl.artifact.follow.enabled | bool | `false` | |
| k8saudit.falcoctl.artifact.install.enabled | bool | `false` | |
| k8saudit.falcoctl.config.artifact.allowedTypes[0] | string | `"plugin"` | |
| k8saudit.falcoctl.config.artifact.install.refs[0] | string | `"k8saudit:0.7.0"` | |
| k8saudit.falcoctl.config.artifact.install.refs[1] | string | `"json:0.7.2"` | |
| k8saudit.fullnameOverride | string | `"falco-k8saudit"` | |
| k8saudit.mounts.volumeMounts[0].mountPath | string | `"/etc/falco/rules.d"` | |
| k8saudit.mounts.volumeMounts[0].name | string | `"rules-volume"` | |
| k8saudit.mounts.volumes[0].configMap.name | string | `"falco-k8saudit-rules"` | |
| k8saudit.mounts.volumes[0].name | string | `"rules-volume"` | |
| k8saudit.nodeSelector."node-role.kubernetes.io/control-plane" | string | `""` | |
| k8saudit.resources.limits.cpu | string | `"1000m"` | |
| k8saudit.resources.limits.cpu | int | `1` | |
| k8saudit.resources.limits.memory | string | `"512Mi"` | |
| k8saudit.resources.requests.cpu | string | `"100m"` | |
| k8saudit.resources.requests.memory | string | `"256Mi"` | |
| k8saudit.resources.requests.memory | string | `"64Mi"` | |
| k8saudit.services[0].name | string | `"webhook"` | |
| k8saudit.services[0].ports[0].port | int | `9765` | |
| k8saudit.services[0].ports[0].protocol | string | `"TCP"` | |
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)

5
charts/kubezero-istio-gateway/README.md
View File

@ -47,6 +47,5 @@ Kubernetes: `>= 1.26.0-0`
## Resources
- https://istio.io/latest/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec
- https://github.com/istio/istio/blob/master/manifests/profiles/default.yaml
- https://istio.io/latest/docs/setup/install/standalone-operator/
- https://github.com/cilium/cilium/blob/main/operator/pkg/model/translation/envoy_listener.go#L134

1
charts/kubezero-keyvalue/README.md
View File

@ -37,6 +37,7 @@ Kubernetes: `>= 1.26.0`
| redis.architecture | string | `"standalone"` | |
| redis.auth.enabled | bool | `false` | |
| redis.enabled | bool | `false` | |
| redis.image.tag | string | `"7.2.5-debian-12-r4"` | |
| redis.master.persistence.enabled | bool | `false` | |
| redis.metrics.enabled | bool | `false` | |
| redis.metrics.serviceMonitor.enabled | bool | `false` | |

10
charts/kubezero-logging/README.md
View File

@ -90,14 +90,16 @@ Kubernetes: `>= 1.26.0`
| fluent-bit.serviceMonitor.selector.release | string | `"metrics"` | |
| fluent-bit.testFramework.enabled | bool | `false` | |
| fluent-bit.tolerations[0].effect | string | `"NoSchedule"` | |
| fluent-bit.tolerations[0].key | string | `"kubezero-workergroup"` | |
| fluent-bit.tolerations[0].operator | string | `"Exists"` | |
| fluent-bit.tolerations[0].key | string | `"node-role.kubernetes.io/control-plane"` | |
| fluent-bit.tolerations[1].effect | string | `"NoSchedule"` | |
| fluent-bit.tolerations[1].key | string | `"nvidia.com/gpu"` | |
| fluent-bit.tolerations[1].key | string | `"kubezero-workergroup"` | |
| fluent-bit.tolerations[1].operator | string | `"Exists"` | |
| fluent-bit.tolerations[2].effect | string | `"NoSchedule"` | |
| fluent-bit.tolerations[2].key | string | `"aws.amazon.com/neuron"` | |
| fluent-bit.tolerations[2].key | string | `"nvidia.com/gpu"` | |
| fluent-bit.tolerations[2].operator | string | `"Exists"` | |
| fluent-bit.tolerations[3].effect | string | `"NoSchedule"` | |
| fluent-bit.tolerations[3].key | string | `"aws.amazon.com/neuron"` | |
| fluent-bit.tolerations[3].operator | string | `"Exists"` | |
| fluentd.configMapConfigs[0] | string | `"fluentd-prometheus-conf"` | |
| fluentd.dashboards.enabled | bool | `false` | |
| fluentd.enabled | bool | `false` | |

10
charts/kubezero-mq/README.md
View File

@ -14,7 +14,7 @@ KubeZero umbrella chart for MQ systems like NATS, RabbitMQ
## Requirements
Kubernetes: `>= 1.25.0`
Kubernetes: `>= 1.26.0`
| Repository | Name | Version |
|------------|------|---------|
@ -27,14 +27,14 @@ Kubernetes: `>= 1.25.0`
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| nats.config.jetstream.enabled | bool | `true` | |
| nats.enabled | bool | `false` | |
| nats.exporter.serviceMonitor.enabled | bool | `false` | |
| nats.istio.enabled | bool | `false` | |
| nats.istio.gateway | string | `"istio-ingress/private-ingressgateway"` | |
| nats.mqtt.enabled | bool | `false` | |
| nats.nats.advertise | bool | `false` | |
| nats.nats.jetstream.enabled | bool | `true` | |
| nats.natsbox.enabled | bool | `false` | |
| nats.natsBox.enabled | bool | `false` | |
| nats.promExporter.enabled | bool | `false` | |
| nats.promExporter.podMonitor.enabled | bool | `false` | |
| rabbitmq-cluster-operator.clusterOperator.metrics.enabled | bool | `false` | |
| rabbitmq-cluster-operator.clusterOperator.metrics.serviceMonitor.enabled | bool | `true` | |
| rabbitmq-cluster-operator.enabled | bool | `false` | |

3
charts/kubezero-operators/README.md
View File

@ -39,6 +39,3 @@ Kubernetes: `>= 1.26.0`
| opensearch-operator.nodeSelector."node-role.kubernetes.io/control-plane" | string | `""` | |
| opensearch-operator.tolerations[0].effect | string | `"NoSchedule"` | |
| opensearch-operator.tolerations[0].key | string | `"node-role.kubernetes.io/control-plane"` | |
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)

35
charts/kubezero-storage/README.md
View File

@ -1,6 +1,6 @@
# kubezero-storage
![Version: 0.8.3](https://img.shields.io/badge/Version-0.8.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
![Version: 0.8.8](https://img.shields.io/badge/Version-0.8.8-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
KubeZero umbrella chart for all things storage incl. AWS EBS/EFS, openEBS-lvm, gemini
@ -20,10 +20,10 @@ Kubernetes: `>= 1.26.0`
|------------|------|---------|
| https://cdn.zero-downtime.net/charts/ | kubezero-lib | >= 0.1.6 |
| https://charts.fairwinds.com/stable | gemini | 2.1.3 |
| https://k8up-io.github.io/k8up | k8up | 4.4.1 |
| https://kubernetes-sigs.github.io/aws-ebs-csi-driver | aws-ebs-csi-driver | 2.22.0 |
| https://kubernetes-sigs.github.io/aws-efs-csi-driver | aws-efs-csi-driver | 2.4.9 |
| https://openebs.github.io/lvm-localpv | lvm-localpv | 1.2.0 |
| https://k8up-io.github.io/k8up | k8up | 4.7.0 |
| https://kubernetes-sigs.github.io/aws-ebs-csi-driver | aws-ebs-csi-driver | 2.32.0 |
| https://kubernetes-sigs.github.io/aws-efs-csi-driver | aws-efs-csi-driver | 3.0.6 |
| https://openebs.github.io/lvm-localpv | lvm-localpv | 1.6.0 |
## Values
@ -38,6 +38,7 @@ Kubernetes: `>= 1.26.0`
| aws-ebs-csi-driver.controller.resources.requests.memory | string | `"24Mi"` | |
| aws-ebs-csi-driver.controller.tolerations[0].effect | string | `"NoSchedule"` | |
| aws-ebs-csi-driver.controller.tolerations[0].key | string | `"node-role.kubernetes.io/control-plane"` | |
| aws-ebs-csi-driver.controller.volumeModificationFeature.enabled | bool | `false` | |
| aws-ebs-csi-driver.controller.volumeMounts[0].mountPath | string | `"/var/run/secrets/sts.amazonaws.com/serviceaccount/"` | |
| aws-ebs-csi-driver.controller.volumeMounts[0].name | string | `"aws-token"` | |
| aws-ebs-csi-driver.controller.volumeMounts[0].readOnly | bool | `true` | |
@ -46,7 +47,10 @@ Kubernetes: `>= 1.26.0`
| aws-ebs-csi-driver.controller.volumes[0].projected.sources[0].serviceAccountToken.expirationSeconds | int | `86400` | |
| aws-ebs-csi-driver.controller.volumes[0].projected.sources[0].serviceAccountToken.path | string | `"token"` | |
| aws-ebs-csi-driver.enabled | bool | `false` | |
| aws-ebs-csi-driver.helmTester.enabled | bool | `false` | |
| aws-ebs-csi-driver.node.loggingFormat | string | `"json"` | |
| aws-ebs-csi-driver.node.priorityClassName | string | `"system-node-critical"` | |
| aws-ebs-csi-driver.node.reservedVolumeAttachments | int | `3` | |
| aws-ebs-csi-driver.node.resources.limits.memory | string | `"32Mi"` | |
| aws-ebs-csi-driver.node.resources.requests.cpu | string | `"10m"` | |
| aws-ebs-csi-driver.node.resources.requests.memory | string | `"16Mi"` | |
@ -76,15 +80,22 @@ Kubernetes: `>= 1.26.0`
| aws-efs-csi-driver.controller.create | bool | `true` | |
| aws-efs-csi-driver.controller.logLevel | int | `2` | |
| aws-efs-csi-driver.controller.nodeSelector."node-role.kubernetes.io/control-plane" | string | `""` | |
| aws-efs-csi-driver.controller.regionalStsEndpoints | bool | `true` | |
| aws-efs-csi-driver.controller.tolerations[0].effect | string | `"NoSchedule"` | |
| aws-efs-csi-driver.controller.tolerations[0].key | string | `"node-role.kubernetes.io/control-plane"` | |
| aws-efs-csi-driver.controller.volumeMounts[0].mountPath | string | `"/var/run/secrets/sts.amazonaws.com/serviceaccount/"` | |
| aws-efs-csi-driver.controller.volumeMounts[0].name | string | `"aws-token"` | |
| aws-efs-csi-driver.controller.volumes[0].name | string | `"aws-token"` | |
| aws-efs-csi-driver.controller.volumes[0].projected.sources[0].serviceAccountToken.audience | string | `"sts.amazonaws.com"` | |
| aws-efs-csi-driver.controller.volumes[0].projected.sources[0].serviceAccountToken.expirationSeconds | int | `86400` | |
| aws-efs-csi-driver.controller.volumes[0].projected.sources[0].serviceAccountToken.path | string | `"token"` | |
| aws-efs-csi-driver.enabled | bool | `false` | |
| aws-efs-csi-driver.node.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[0].matchExpressions[0].key | string | `"node.kubernetes.io/csi.efs.fs"` | |
| aws-efs-csi-driver.node.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[0].matchExpressions[0].operator | string | `"Exists"` | |
| aws-efs-csi-driver.node.logLevel | int | `2` | |
| aws-efs-csi-driver.node.resources.limits.memory | string | `"128Mi"` | |
| aws-efs-csi-driver.node.resources.limits.memory | string | `"256Mi"` | |
| aws-efs-csi-driver.node.resources.requests.cpu | string | `"20m"` | |
| aws-efs-csi-driver.node.resources.requests.memory | string | `"64Mi"` | |
| aws-efs-csi-driver.node.resources.requests.memory | string | `"96Mi"` | |
| aws-efs-csi-driver.node.tolerations[0].effect | string | `"NoSchedule"` | |
| aws-efs-csi-driver.node.tolerations[0].key | string | `"kubezero-workergroup"` | |
| aws-efs-csi-driver.node.tolerations[0].operator | string | `"Exists"` | |
@ -94,8 +105,8 @@ Kubernetes: `>= 1.26.0`
| aws-efs-csi-driver.node.tolerations[2].effect | string | `"NoSchedule"` | |
| aws-efs-csi-driver.node.tolerations[2].key | string | `"aws.amazon.com/neuron"` | |
| aws-efs-csi-driver.node.tolerations[2].operator | string | `"Exists"` | |
| aws-efs-csi-driver.node.volMetricsOptIn | bool | `true` | |
| aws-efs-csi-driver.replicaCount | int | `1` | |
| crd.volumeSnapshot | bool | `true` | |
| gemini.enabled | bool | `false` | |
| gemini.resources.limits.cpu | string | `"400m"` | |
| gemini.resources.limits.memory | string | `"128Mi"` | |
@ -112,6 +123,7 @@ Kubernetes: `>= 1.26.0`
| k8up.tolerations[0].effect | string | `"NoSchedule"` | |
| k8up.tolerations[0].key | string | `"node-role.kubernetes.io/control-plane"` | |
| lvm-localpv.analytics.enabled | bool | `false` | |
| lvm-localpv.crds.csi.volumeSnapshots.enabled | bool | `false` | |
| lvm-localpv.enabled | bool | `false` | |
| lvm-localpv.lvmController.logLevel | int | `2` | |
| lvm-localpv.lvmController.nodeSelector."node-role.kubernetes.io/control-plane" | string | `""` | |
@ -126,13 +138,14 @@ Kubernetes: `>= 1.26.0`
| lvm-localpv.storageClass.default | bool | `false` | |
| lvm-localpv.storageClass.vgpattern | string | `""` | |
| snapshotController.enabled | bool | `false` | |
| snapshotController.image.name | string | `"registry.k8s.io/sig-storage/snapshot-controller"` | |
| snapshotController.image.tag | string | `"v7.0.1"` | |
| snapshotController.logLevel | int | `2` | |
| snapshotController.nodeSelector."node-role.kubernetes.io/control-plane" | string | `""` | |
| snapshotController.replicas | int | `1` | |
| snapshotController.resources.limits.cpu | string | `"100m"` | |
| snapshotController.resources.limits.memory | string | `"64Mi"` | |
| snapshotController.resources.requests.cpu | string | `"20m"` | |
| snapshotController.resources.requests.memory | string | `"16Mi"` | |
| snapshotController.resources.requests.cpu | string | `"10m"` | |
| snapshotController.resources.requests.memory | string | `"24Mi"` | |
| snapshotController.tolerations[0].effect | string | `"NoSchedule"` | |
| snapshotController.tolerations[0].key | string | `"node-role.kubernetes.io/control-plane"` | |

49
charts/kubezero/README.md
View File

@ -1,6 +1,6 @@
# kubezero
![Version: 1.26.6](https://img.shields.io/badge/Version-1.26.6-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
![Version: 1.30.5](https://img.shields.io/badge/Version-1.30.5-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
KubeZero - Root App of Apps chart
@ -14,7 +14,7 @@ KubeZero - Root App of Apps chart
## Requirements
Kubernetes: `>= 1.26.0`
Kubernetes: `>= 1.26.0-0`
| Repository | Name | Version |
|------------|------|---------|
@ -32,54 +32,65 @@ Kubernetes: `>= 1.26.0`
| addons.external-dns.enabled | bool | `false` | |
| addons.forseti.enabled | bool | `false` | |
| addons.sealed-secrets.enabled | bool | `false` | |
| addons.targetRevision | string | `"0.7.5"` | |
| argocd.argocd-image-updater.enabled | bool | `false` | |
| argocd.enabled | bool | `false` | |
| argocd.istio.enabled | bool | `false` | |
| argocd.namespace | string | `"argocd"` | |
| argocd.targetRevision | string | `"0.12.1"` | |
| addons.targetRevision | string | `"0.8.9"` | |
| argo.argo-cd.enabled | bool | `false` | |
| argo.argo-cd.istio.enabled | bool | `false` | |
| argo.argocd-image-updater.enabled | bool | `false` | |
| argo.enabled | bool | `false` | |
| argo.namespace | string | `"argocd"` | |
| argo.targetRevision | string | `"0.2.4"` | |
| cert-manager.enabled | bool | `false` | |
| cert-manager.namespace | string | `"cert-manager"` | |
| cert-manager.targetRevision | string | `"0.9.4"` | |
| cert-manager.targetRevision | string | `"0.9.9"` | |
| falco.enabled | bool | `false` | |
| falco.k8saudit.enabled | bool | `false` | |
| falco.targetRevision | string | `"0.1.2"` | |
| global.aws | object | `{}` | |
| global.clusterName | string | `"zdt-trial-cluster"` | |
| global.gcp | object | `{}` | |
| global.highAvailable | bool | `false` | |
| global.platform | string | `"aws"` | |
| istio-ingress.chart | string | `"kubezero-istio-gateway"` | |
| istio-ingress.enabled | bool | `false` | |
| istio-ingress.gateway.service | object | `{}` | |
| istio-ingress.namespace | string | `"istio-ingress"` | |
| istio-ingress.targetRevision | string | `"0.10.0"` | |
| istio-ingress.targetRevision | string | `"0.22.3-1"` | |
| istio-private-ingress.chart | string | `"kubezero-istio-gateway"` | |
| istio-private-ingress.enabled | bool | `false` | |
| istio-private-ingress.gateway.service | object | `{}` | |
| istio-private-ingress.namespace | string | `"istio-ingress"` | |
| istio-private-ingress.targetRevision | string | `"0.10.0"` | |
| istio-private-ingress.targetRevision | string | `"0.22.3-1"` | |
| istio.enabled | bool | `false` | |
| istio.namespace | string | `"istio-system"` | |
| istio.targetRevision | string | `"0.10.0"` | |
| istio.targetRevision | string | `"0.22.3-1"` | |
| kubezero.defaultTargetRevision | string | `"*"` | |
| kubezero.gitSync | object | `{}` | |
| kubezero.repoURL | string | `"https://cdn.zero-downtime.net/charts"` | |
| kubezero.server | string | `"https://kubernetes.default.svc"` | |
| logging.enabled | bool | `false` | |
| logging.namespace | string | `"logging"` | |
| logging.targetRevision | string | `"0.8.6"` | |
| logging.targetRevision | string | `"0.8.12"` | |
| metrics.enabled | bool | `false` | |
| metrics.istio.grafana | object | `{}` | |
| metrics.istio.prometheus | object | `{}` | |
| metrics.kubezero.prometheus.prometheusSpec.additionalScrapeConfigs | list | `[]` | |
| metrics.namespace | string | `"monitoring"` | |
| metrics.targetRevision | string | `"0.9.2"` | |
| metrics.targetRevision | string | `"0.10.0"` | |
| network.cilium.cluster | object | `{}` | |
| network.enabled | bool | `true` | |
| network.retain | bool | `true` | |
| network.targetRevision | string | `"0.4.4"` | |
| network.targetRevision | string | `"0.5.5"` | |
| operators.enabled | bool | `false` | |
| operators.namespace | string | `"operators"` | |
| operators.targetRevision | string | `"0.1.4"` | |
| storage.aws-ebs-csi-driver.enabled | bool | `false` | |
| storage.aws-efs-csi-driver.enabled | bool | `false` | |
| storage.enabled | bool | `false` | |
| storage.gemini.enabled | bool | `false` | |
| storage.k8up.enabled | bool | `false` | |
| storage.lvm-localpv.enabled | bool | `false` | |
| storage.snapshotController.enabled | bool | `false` | |
| storage.targetRevision | string | `"0.8.2"` | |
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
| storage.targetRevision | string | `"0.8.8"` | |
| telemetry.enabled | bool | `false` | |
| telemetry.namespace | string | `"telemetry"` | |
| telemetry.targetRevision | string | `"0.4.0"` | |

3
charts/manticore/README.md
View File

@ -27,6 +27,3 @@ Kubernetes: `>= 1.20.0`
|-----|------|---------|-------------|
| manticoresearch.worker.replicaCount | int | `1` | |
| manticoresearch.worker.volume.size | string | `"4Gi"` | |
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)