[installer]: sort the kubernetes charts so correctly installed

This orders the kubernetes charts so that installation and upgrades happen in the correct order

Author: Simon Emms

installer/cmd/render.go

@@ -85,26 +85,33 @@ A config file is required which can be generated with the init command.`,
 			return fmt.Errorf("unsupported installation kind: %s", cfg.Kind)
 		}
 
-		objs, err := common.CompositeRenderFunc(renderable, components.CommonObjects)(ctx)
-		if err != nil {
-			return err
-		}
-
-		charts, err := common.CompositeHelmFunc(helmCharts, components.CommonHelmDependencies)(ctx)
+		objs, err := common.CompositeRenderFunc(components.CommonObjects, renderable)(ctx)
 		if err != nil {
 			return err
 		}
 
+		k8s := make([]string, 0)
 		for _, o := range objs {
 			fc, err := yaml.Marshal(o)
 			if err != nil {
 				return err
 			}
 
-			fmt.Printf("---\n%s\n", string(fc))
+			k8s = append(k8s, fmt.Sprintf("---\n%s\n", string(fc)))
+		}
+
+		charts, err := common.CompositeHelmFunc(components.CommonHelmDependencies, helmCharts)(ctx)
+		if err != nil {
+			return err
+		}
+		k8s = append(k8s, charts...)
+
+		sortedCharts, err := common.DependencySortingRenderFunc(k8s)
+		if err != nil {
+			return err
 		}
 
-		for _, c := range charts {
+		for _, c := range sortedCharts {
 			fmt.Printf("---\n%s\n", c)
 		}
 

installer/pkg/common/render.go

@@ -5,8 +5,6 @@
 package common
 
 import (
-	"sort"
-
 	"github.com/gitpod-io/gitpod/installer/pkg/config/v1"
 	"github.com/gitpod-io/gitpod/installer/pkg/config/versions"
 
@@ -52,31 +50,6 @@ func CompositeHelmFunc(f ...HelmFunc) HelmFunc {
 	}
 }
 
-var kubernetesObjOrder = map[string]int{
-	TypeMetaClusterRole.GetObjectKind().GroupVersionKind().String():    -100,
-	TypeMetaServiceAccount.GetObjectKind().GroupVersionKind().String(): -90,
-	TypeMetaDaemonset.GetObjectKind().GroupVersionKind().String():      0,
-	TypeMetaPod.GetObjectKind().GroupVersionKind().String():            10,
-}
-
-func DependencySortingRenderFunc(f RenderFunc) RenderFunc {
-	return func(ctx *RenderContext) ([]runtime.Object, error) {
-		objs, err := f(ctx)
-		if err != nil {
-			return nil, err
-		}
-
-		sort.Slice(objs, func(i, j int) bool {
-			scoreI := kubernetesObjOrder[objs[i].GetObjectKind().GroupVersionKind().String()]
-			scoreJ := kubernetesObjOrder[objs[j].GetObjectKind().GroupVersionKind().String()]
-
-			return scoreI < scoreJ
-		})
-
-		return objs, nil
-	}
-}
-
 type GeneratedValues struct {
 	StorageAccessKey         string
 	StorageSecretKey         string

installer/pkg/common/render_test.go

@@ -0,0 +1,99 @@
+// Copyright (c) 2021 Gitpod GmbH. All rights reserved.
+// Licensed under the GNU Affero General Public License (AGPL).
+// See License-AGPL.txt in the project root for license information.
+
+package common
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"regexp"
+	"sigs.k8s.io/yaml"
+	"sort"
+)
+
+// Those occurring earlier in the list get installed before those occurring later in the list.
+// Based on Helm's list, with our CRDs added in
+
+var sortOrder = []string{
+	"Namespace",
+	"NetworkPolicy",
+	"ResourceQuota",
+	"Issuer",      // added
+	"Certificate", // added
+	"LimitRange",
+	"PodSecurityPolicy",
+	"PodDisruptionBudget",
+	"ServiceAccount",
+	"Secret",
+	"SecretList",
+	"ConfigMap",
+	"StorageClass",
+	"PersistentVolume",
+	"PersistentVolumeClaim",
+	"CustomResourceDefinition",
+	"ClusterRole",
+	"ClusterRoleList",
+	"ClusterRoleBinding",
+	"ClusterRoleBindingList",
+	"Role",
+	"RoleList",
+	"RoleBinding",
+	"RoleBindingList",
+	"Service",
+	"DaemonSet",
+	"Pod",
+	"ReplicationController",
+	"ReplicaSet",
+	"StatefulSet", // moved above Deployment
+	"Deployment",
+	"HorizontalPodAutoscaler",
+	"Job",
+	"CronJob",
+	"Ingress",
+	"APIService",
+}
+
+type k8sChart struct {
+	metav1.TypeMeta `json:",inline"`
+	Content         string
+}
+
+func DependencySortingRenderFunc(charts []string) ([]string, error) {
+	sortData := make([]k8sChart, 0)
+
+	for _, o := range charts {
+		// Assume multi-document YAML
+		re := regexp.MustCompile("(^|\n)---")
+		items := re.Split(o, -1)
+
+		for _, p := range items {
+			var v k8sChart
+			err := yaml.Unmarshal([]byte(p), &v)
+			if err != nil {
+				return nil, err
+			}
+
+			v.Content = p
+			sortData = append(sortData, v)
+		}
+	}
+
+	sortMap := map[string]int{}
+	for k, v := range sortOrder {
+		sortMap[v] = k
+	}
+
+	sort.Slice(sortData, func(i, j int) bool {
+		scoreI := sortMap[sortData[i].Kind]
+		scoreJ := sortMap[sortData[j].Kind]
+
+		return scoreI < scoreJ
+	})
+
+	out := make([]string, 0)
+	for _, d := range sortData {
+		out = append(out, d.Content)
+	}
+
+	return out, nil
+}

installer/pkg/common/sorter.go

@@ -167,10 +167,6 @@ func ImportTemplate(chart *charts.Chart, templateCfg TemplateConfig, pkgConfig P
 			}
 		}
 
-		return append(templates, []string{
-			fmt.Sprintf("# %s Helm chart", settings.Config.Name),
-			rel.Manifest, // This already starts with "---" - consider stripping this out
-			fmt.Sprintf("# End of %s chart", settings.Config.Name),
-		}...), nil
+		return append(templates, rel.Manifest), nil
 	}
 }