Deletion PRs don't remove cluster directories

[LutzLange]

WGE release:

• 0.8.0-rc.1

I'm expecting Deletion PRs to clear out my cluster directory as well clusters/lm18 does still exist and holds profiles.yaml and the whole flux system of the leaf cluster.

[foot]

So really we're trying to do something like this:

Warning
clusters-service does not actually call git directly like this:

git clone $repo
# this is what we're currently doing right now..
git rm clusters/management/clusters/my-old-cluster.yaml

# .. but now we also want to clean up this directory too:
git rm -r ./clusters/my-old-cluster

git commit -avm "deletes cluster"
git push

However the clusters-service doesn't call git directly and instead uses the github / gitlab HTTP apis, like this one https://docs.github.com/en/rest/pulls/pulls#create-a-pull-request

However, to make it a bit more complicated it doesn't call the github/gitlab HTTP APIs directly but instead delegates to another go module https://github.com/fluxcd/go-git-providers

Approach

Unfortunately

1. git doesn't track directories, only files (git rm -r is a helper function that hides this from you)
2. github/gitlab HTTP APIs don't really have a nice equivalent of git rm -r

So we have to explicitly provide a list of files we want to delete.

That means we have to:

1. Get a list of files under a path recursively (e.g. these are the common files):

   clusters/my-old-cluster/flux-system/kustomization.yaml
   clusters/my-old-cluster/flux-system/gotk-sync.yaml
   clusters/my-old-cluster/flux-system/gotk-components.yaml
   clusters/my-old-cluster/common-kustomization.yaml
   clusters/my-old-cluster/profiles.yaml
   

2. Create a commit and a PR that deletes all the files

Point 2. here is quite easy and we have some examples of doing this e.g. here

weave-gitops-enterprise/cmd/clusters-service/pkg/server/clusters.go

Lines 222 to 225 in 25da7e2

	filesList = append(filesList, gitprovider.CommitFile{
	Path: &path,
	Content: nil,
	})

Point 1. is the harder one which we don't do anywhere yet and will require some changes to the go-git-provider. 🤔 .

So now I'm thinking about that a bit more..

[foot]

So I think we need to tackle this one fluxcd/go-git-providers#143

Shouldn't be too hard. 🤔

[LutzLange]

Closing as this is now very different in 0.9.0-rc.3

[foot]

This one we're addressing at the moment and I think it is still very useful to implement.