Installing | Upgrading | Downgrading | Uninstalling Weave GitopsSets Controller on Weave GitOps Enterprise

Summary

If you are reading this it is likely because you have already installed Weave GitOps Enterprise and you are now in a position to utilise the GitOpsSets Controller to extend the functionality that Weave GitOps Enterprise adds to your organisation.

Prerequisites

A correctly installed instance of Weave GitOps Enterprise. We advise always checking the changelog at https://docs.gitops.weave.works/docs/next/enterprise/getting-started/releases-enterprise/ - identify both the existing version from your manifest and version you would like to upgrade/downgrade to. Be sure to note the Kubernetes Distribution and flux version as a precaution to whether the component you are installing will require upgrade of either of those components.

Any upgrade/downgrade process will require you to locate the Weave GitOps Enterprise install manifest. If you have installed the weave gitops enterprise helm chart as originally instructed this should be at 'clusters/management/weave-gitops-enterprise.yaml'. If you have customised the location of this you need to retrieve the location. You may find that searching the repository for the line 'chart: mccp' will corrrectly identify the manifest/resource of 'kind: HelmRelease' which contains your installation. If you have installed in multiple environments take a moment to check the path name references the correct cluster.

Process: Installation

Please see https://docs.gitops.weave.works/docs/gitopssets/installation/#installing-the-gitopssets-controller for the canonical method to install. If you have already Weave GitOps Enterprise but do not have a running GitopsSets Controller it is likely that it has been disabled as part of the initial install. In the Helmrelease previously specified you may find the following:

apiVersion: helm.toolkit.fluxcd.io/v2beta1
kind: HelmRelease
metadata:
  name: weave-gitops-enterprise
  namespace: flux-system
spec:
  chart:
    ...
    gitopssets-controller:
      enabled: false

You will need to change this to:

apiVersion: helm.toolkit.fluxcd.io/v2beta1
kind: HelmRelease
metadata:
  name: weave-gitops-enterprise
  namespace: flux-system
spec:
  chart:
    ...
    gitopssets-controller:
      enabled: true

If you wish to manage the specifics of the controller you will need to review the values using these can be retrieved from the chart by running:

- helm repo add age https://artifacts.wge.dev.weave.works/dev/charts

- helm show values age/weave-gitops-controller

Process: Upgrade/Downgrade

If you need to upgrade/downgrade the GitOpsSets controller for any reason you can configure the controller version separately from the installation by adding the below configuration to the Weave GitOps Enterprise HelmRelease. Please remember to cross reference the release you are installing with the published notes https://docs.gitops.weave.works/docs/next/enterprise/getting-started/releases-enterprise/ and raise a ticket if there are any concerns of incompatibility.

Amend the Helmrelease values with the following lines:

    gitopssets-controller:
      enabled: true
      manager:
        image: 
           tag: v0.13.2

Follow you normal process to reconcile and update the installation.

Process: Uninstall

To uninstall the GitopsSets controller you can simply disable it within the Weave Gitops Enterprise Helm Release manifest. Any prior configuration lines under the. gitopssets-controller stanza will be ignored until it is renabled:

apiVersion: helm.toolkit.fluxcd.io/v2beta1
kind: HelmRelease
metadata:
  name: weave-gitops-enterprise
  namespace: flux-system
spec:
  chart:
    ...
    gitopssets-controller:
      enabled: false

NOTE: Removing the controller will not remove reconciled workloads. There may be numerous resources which these would remove and we would advise to see all resources with the below labels:



app.kubernetes.io/part-of: gitopssets-controller
app.kubernetes.io/created-by: gitopssets-controller

using a query such as `kubectl get all --selector-key app.kubernetes.io/created-by:=gitopssets-controller`

We recommend that in the event you wish to remove all managed/reconciled workloads that prior to uninstalling you remove all gitopsset custom resources from the cluster whilst the CRD which these reference is still intact. This will ensure the GitopsSets controller removes the managed resources without the need for manual intervention.

downgrade gitopssets install uninstall upgrade weave_gitops_enterprise

Creation date: 03/07/2023 11:16 Updated: 03/07/2023 17:20