diff --git a/docs/maintenance-plan.md b/docs/maintenance-plan.md new file mode 100644 index 00000000..ce1a29aa --- /dev/null +++ b/docs/maintenance-plan.md @@ -0,0 +1,189 @@ +# Maintenance plan + +This document outlines every piece of the platform that need upgrading and +updating. + +## Lagoon + +Update interval: 1-4 months +Release URL: +Upgrade Docs URL: +Expect downtime: Highly likely +Time to do: Unknown at the time of writing (most likely a day the first time) +Runbook: [Upgrading Lagoon](./runbooks/upgrading-lagoon.md) +Notes: + +## AKS + +Update interval: monthly +Release URL: +Upgrade Docs URL: + +Expect downtime: yes, there'll be a very short outage alike to releases +Time to do: 2-6 hours +Runbook: [Update AKS](./runbooks/upgrading-aks.md) +Notes: + +## Support Workloads + +We have a number of support workloads. Which at the time of writing is all +Helm Charts. +Information on Helm upgrades can be found +on the [Helm website](https://helm.sh/docs/helm/helm_upgrade/). +There's a general runbook for upgrading the support workloads here: +[Upgrade Support Workloads](./runbooks/upgrading-support-workloads.md). + +### Cert-manager + +Update interval: weekly-monthly +Release URL: +Upgrade Docs URL: +Expect downtime: Unknown, but likely none +Time to do: Unknown, but likely < 1 hour +Runbook: [Upgrade Cert-manager](./runbooks/upgrading-support-workloads.md#cert-manager). +Notes: + +### Grafana + +Update interval: weekly +Release URL: +Upgrade Docs URL: +Expect downtime: No, maybe a little for Grafana, but nothing that affects the + libraries. +Time to do: Unknown +Runbook: [Upgrade Grafana](./runbooks/upgrading-support-workloads.md#grafana) +Notes: + +### Harbor + +Update interval: somewhat monthly +Release URL: +Upgrade Docs URL: +Expect downtime: Harbor will have downtime, it will affect sites that need + redeployment as well as developers who firing up and environment. +Time to do: Unknown +Runbook: [Upgrading Harboar](./runbooks/upgrading-support-workloads.md#harbor) +Notes: + +### Ingress Nginx + +Update interval: Monthly +Release URL: +Upgrade Docs URL: +Expect downtime: Highly likely +Time to do: Unkonwn +Runbook: [Upgrading Nginx-ingresss](./runbooks/upgrading-support-workloads#ingress-nginx) +Notes: + +### K8up + +DO NOT UPGRADE. +From time to time we should checkin with this page [K8Up in lagoon](https://docs.lagoon.sh/installing-lagoon/lagoon-backups/#lagoon-backups) +, where they'll hopefully give and update when it is possible to update K8Up +to a later version than version 1.x.x + +### Loki + +Update interval: somewhat monthly +Release URL: +Upgrade Docs URL: +Expect downtime: Might be some, but nothing that will hit the libraries +Time to do: Unkown +Runbook: [Upgrade Loki](./runbooks/upgrading-support-workloads.md#loki) +Notes: + +### Minio + +As we're replacing Minio, we will have to do a section on what ever tool + we're replacing it with. + +### Prometheus + +Update interval: Weekly +Release URL: +Upgrade Docs URL: +Expect downtime: Probably, but nothing the libraries will be affected by +Time to do: Unkown +Runbook: [Upgrading Prometheus](./runbooks/upgrading-support-workloads.md#prometheus) +Notes: + +### Promtail + +Update interval: monthly-quarterly +Release URL: +Upgrade Docs URL: +Expect downtime: Probably, but nothing that concerns the libraries. +Time to do: Unknown +Runbook: [Upgrading Promtail](./runbooks/upgrading-support-workloads.md#upgrade-promtail) +Notes: + +## DPL Shell parts + +The DPL Shell integrates our day to day tools. The ones, that are not upgraded +automatically when a new version of DPL Shell is created, are listed below. +Most of these, if not all, are watched by dependabot on GitHub, so we +are notified about updates pretty quickly. + +### Terraform + +Update interval: Monthly +Release URL: +Expect downtime: None +Time to do: 1 hour +Runbook: +Notes: + +### Azure CLI + +Update interval: Unknown +Release URL: +Expect downtime: None +Time to do: 1 hour +Runbook: +Notes: + +### KubeCTL + +Update interval: Quarterly +Release URL: +Expect downtime: None +Time to do: 1 hour +Runbook: +Notes: + +### Krew + +Update interval: Unkown, hasen't been updated since 2023 +Release URL: +Expect downtime: None +Time to do: 1 hour +Runbook: +Notes: + +### Task + +Update interval: Monthly +Release URL: +Expect downtime: None +Time to do: 1 hour +Runbook: +Notes: + +### Lagoon CLI + +Update interval: Quaterly +Release URL: +Expect downtime: None +Time to do: 1 hour +Runbook: +Notes: Dependabot has not as of yet notified us of any available updates, + so we have to check manually. + +### Helm + +Update interval: Monthly +Release URL: +Expect downtime: None +Time to do: 1 hour +Runbook: +Notes: