From cfbb2f611bdddb1d146b16845dc2f7173445877a Mon Sep 17 00:00:00 2001 From: Andrii Vakarev Date: Mon, 23 Sep 2024 21:45:56 +0200 Subject: [PATCH] Obsolete --- charts/gatus/CHANGELOG.md | 4 + charts/gatus/Chart.yaml | 2 +- charts/gatus/README.md | 157 ++++--------------------------- charts/gatus/templates/NOTES.txt | 35 +++++++ 4 files changed, 58 insertions(+), 140 deletions(-) create mode 100644 charts/gatus/templates/NOTES.txt diff --git a/charts/gatus/CHANGELOG.md b/charts/gatus/CHANGELOG.md index 4292a66..05a268d 100644 --- a/charts/gatus/CHANGELOG.md +++ b/charts/gatus/CHANGELOG.md @@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [3.4.6] - 2024-09-23 +### Changed +- Gatus chart moved to https://github.com/TwiN/helm-charts + ## [3.4.5] - 2024-05-30 ### Changed - Bump Gatus image v5.10.0 => v5.11.0 diff --git a/charts/gatus/Chart.yaml b/charts/gatus/Chart.yaml index 32dd0d4..0bf9455 100644 --- a/charts/gatus/Chart.yaml +++ b/charts/gatus/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 name: gatus description: Automated service health dashboard icon: https://raw.githubusercontent.com/TwiN/gatus/a1c8422c2ff2b9d0a6f184c99e4dc728d3f2cd75/web/static/logo-192x192.png -version: 3.4.5 +version: 3.4.6 appVersion: v5.11.0 type: application engine: gotpl diff --git a/charts/gatus/README.md b/charts/gatus/README.md index ced3de3..757c614 100644 --- a/charts/gatus/README.md +++ b/charts/gatus/README.md @@ -2,155 +2,34 @@ > Installs the automated service health dashboard [Gatus](https://github.com/TwiN/gatus) -## Get Repo Info +**THIS REPOSITORY IS NO LONGER MAINTAINED.** -```console -helm repo add minicloudlabs https://minicloudlabs.github.io/helm-charts -helm repo update -``` +The gatus chart has been moved to the https://github.com/TwiN/helm-charts repo, and the new gatus chart version 1.0.0 +from TwiN/helm-charts is a drop-in replacement for 3.4.5 from minicloudlabs/helm-charts. -_See [helm repo](https://helm.sh/docs/helm/helm_repo/) for command documentation._ +To migrate your helmfile to the new repo, please replace -## Install Chart -```console -helm install --name [RELEASE_NAME] minicloudlabs/gatus ``` - -_See [configuration](#configuration) below._ -_See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ - -## Uninstall Chart - -```console -helm delete --purge [RELEASE_NAME] -``` - -This removes all the Kubernetes components associated with the chart and deletes the release. -_See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ - -## Upgrading an existing Release to a new major version - -### To 3.0.0 - -This version bumps Gatus image from 4.4.0 to 5.1.0, so your config from v4 could potentially have incompatibilities with v5. -Please check corresponding Gatus release changelog: [v5.0.0](https://github.com/TwiN/gatus/releases/tag/v5.0.0) and -[v5.1.0](https://github.com/TwiN/gatus/releases/tag/v5.1.0). - -### To 2.0.0 - -This version requires Helm >= 3 -Gatus version is upgraded from 2 to 3. Gatus 3 deprecates `memory` type of storage, supports `sqlite` and `postgres`. -`storage` is not part of `persistence` anymore and is part of `config` now. Check the example below. - -## Configuration - -| Parameter | Description | Default | -|-------------------------------------------|-------------------------------------------------|-------------------------------------| -| `deployment.strategy` | Deployment strategy | `RollingUpdate` | -| `deployment.annotateConfigChecksum` | Restart pod when config changed | `true` | -| `readinessProbe.enabled` | Enable readiness probe | `true` | -| `livenessProbe.enabled` | Enable liveness probe | `true` | -| `image.repository` | Image repository | `twinproduction/gatus` | -| `image.tag` | Overrides the Gatus image tag | `` | -| `image.sha` | Image sha | `` | -| `image.pullPolicy` | Image pull policy | `IfNotPresent` | -| `image.pullSecrets` | Image pull secrets | `{}` | -| `hostNetwork.enabled` | Enable host network mode | `false` | -| `annotations` | Deployment annotations | `{}` | -| `labels` | Deployment labels | `{}` | -| `podAnnotations` | Pod annotations | `{}` | -| `podLabels` | Pod labels | `{}` | -| `extraLabels` | Extra labels for all manifests | `{}` | -| `serviceAccount.create` | Create service account | `false` | -| `serviceAccount.name` | Service account name to use | `` | -| `serviceAccount.annotations` | ServiceAccount annotations | `{}` | -| `serviceAccount.autoMount` | Automount the service account token in the pod | `false` | -| `podSecurityContext.fsGroup` | Pod volume's ownership GID | `65534` | -| `securityContext.runAsNonRoot` | Container runs as a non-root user | `true` | -| `securityContext.runAsUser` | Container processes' UID to run the entrypoint | `65534` | -| `securityContext.runAsGroup` | Container processes' GID to run the entrypoint | `65534` | -| `securityContext.readOnlyRootFilesystem` | Container's root filesystem is read-only | `true` | -| `service.type` | Type of service | `ClusterIP` | -| `service.port` | Port for kubernetes service | `80` | -| `service.targetPort` | Port for container | `8080` | -| `service.annotations` | Service annotations | `{}` | -| `service.labels` | Custom labels | `{}` | -| `ingress.enabled` | Enables Ingress | `false` | -| `ingress.ingressClassName` | Ingress ClassName (for k8s 1.18+) | `` | -| `ingress.name` | Ingress name | `` | -| `ingress.annotations` | Ingress annotations (values are templated) | `{}` | -| `ingress.labels` | Custom labels | `{}` | -| `ingress.path` | Ingress accepted path | `/` | -| `ingress.pathType` | Ingress type of path | `Prefix` | -| `ingress.extraPaths` | Ingress extra paths to prepend to every host | `[]` | -| `ingress.hosts` | Ingress accepted hostnames | `["chart-example.local"]` | -| `ingress.tls` | Ingress TLS configuration | `[]` | -| `env` | Extra environment variables passed to pods | `{}` | -| `sidecarContainers` | Sidecar containers in the pod | `{}` | -| `extraVolumeMounts` | Extra volume mounts | `[]` | -| `secrets` | Include secret's content in pod environment | `false` | -| `resources` | CPU/Memory resource requests/limits | `{}` | -| `nodeSelector` | Node labels for pod assignment | `{}` | -| `tolerations` | Tolerations for pod assignment | `[]` | -| `extraInitContainers` | Init containers to add to the gatus pod | `[]` | -| `persistence.enabled` | Use persistent volume to store data | `false` | -| `persistence.size` | Size of persistent volume claim | `200Mi` | -| `persistence.mounthPath` | Persistent data volume's mount path | `/data` | -| `persistence.subPath` | Mount a sub dir of the persistent volume | `nil` | -| `persistence.accessModes` | Persistence access modes | `[ReadWriteOnce]` | -| `persistence.finalizers` | PersistentVolumeClaim finalizers | `["kubernetes.io/pvc-protection"]` | -| `persistence.annotations` | PersistentVolumeClaim annotations | `{}` | -| `persistence.selectorLabels` | PersistentVolumeClaim selector labels | `{}` | -| `persistence.existingClaim` | Use an existing PVC to persist data | `nil` | -| `persistence.storageClassName` | Type of persistent volume claim | `nil` | -| `serviceMonitor.enabled` | Use servicemonitor from prometheus operator | `false` | -| `serviceMonitor.namespace` | Namespace this servicemonitor is installed in | `` | -| `serviceMonitor.interval` | How frequently Prometheus should scrape | `1m` | -| `serviceMonitor.path` | Path to scrape | `/metrics` | -| `serviceMonitor.scheme` | Scheme to use for metrics scraping | `http` | -| `serviceMonitor.tlsConfig` | TLS configuration block for the endpoint | `{}` | -| `serviceMonitor.labels` | Labels for the servicemonitor object | `{}` | -| `serviceMonitor.scrapeTimeout` | Timeout after which the scrape is ended | `30s` | -| `serviceMonitor.relabelings` | RelabelConfigs for samples before ingestion | `[]` | -| `networkPolicy.enabled` | Enable creation of NetworkPolicy resources | `false` | -| `networkPolicy.ingress.selectors` | List of Ingress Rule selectors | `[]` | -| `config` | [Gatus configuration][gatus-config] | `{}` | - -_See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing)._ - -To see all configurable options with detailed comments, visit the chart's [values.yaml](./gatus/values.yaml), or run - -```console -helm inspect values minicloudlabs/gatus -``` - -### `helmfile.yaml` example - -```yaml ---- repositories: - - name: minicloudlabs +- name: minicloudlabs url: https://minicloudlabs.github.io/helm-charts - +--- releases: - - name: gatus - namespace: gatus +- name: gatus chart: minicloudlabs/gatus version: 3.4.5 - values: - - persistence: - enabled: true - - config: - storage: - type: sqlite - path: /data/data.db - endpoints: - - name: Example - url: https://example.com - conditions: - - '[STATUS] == 200' ``` +with -[gatus-config]: https://github.com/TwiN/gatus#configuration +``` +repositories: +- name: twin + url: https://twin.github.io/helm-charts +--- +releases: +- name: gatus + chart: twin/gatus + version: 1.0.0 +``` diff --git a/charts/gatus/templates/NOTES.txt b/charts/gatus/templates/NOTES.txt new file mode 100644 index 0000000..c8f1ac9 --- /dev/null +++ b/charts/gatus/templates/NOTES.txt @@ -0,0 +1,35 @@ +============= MIGRATION NOTICE ============= +Hey there, + +Just a quick heads-up that the minicloudlabs/helm-charts repository is no longer maintained. + +The gatus chart has been moved to the TwiN/helm-charts repo, and the new gatus chart version 1.0.0 +from TwiN/helm-charts is a drop-in replacement for gatus 3.4.5 from minicloudlabs/helm-charts. + +To migrate your helmfile to the new repo, please replace + + +``` +repositories: + - name: minicloudlabs + url: https://minicloudlabs.github.io/helm-charts +--- +releases: + - name: gatus + chart: minicloudlabs/gatus + version: 3.4.5 +``` + +with + +``` +repositories: + - name: twin + url: https://twin.github.io/helm-charts +--- +releases: + - name: gatus + chart: twin/gatus + version: 1.0.0 +``` +============================================