-
Notifications
You must be signed in to change notification settings - Fork 78
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adds object dependency sorting and tests
- Loading branch information
Showing
4 changed files
with
916 additions
and
81 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,136 @@ | ||
| // Copyright 2021 The Kubernetes Authors. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| // This package provides a object sorting functionality | ||
| // based on the explicit "depends-on" annotation, and | ||
| // implicit object dependencies like namespaces and CRD's. | ||
| package graph | ||
|
|
||
| import ( | ||
| "k8s.io/apimachinery/pkg/apis/meta/v1/unstructured" | ||
| "k8s.io/klog/v2" | ||
| "sigs.k8s.io/cli-utils/pkg/object" | ||
| ) | ||
|
|
||
| // SortObjs returns a slice of the sets of objects to apply (in order). | ||
| // Each of the objects in an apply set is applied together. The order of | ||
| // the returned applied sets is a topological ordering of the sets to apply. | ||
| // Returns an single empty apply set if there are no objects to apply. | ||
| func SortObjs(objs []*unstructured.Unstructured) [][]*unstructured.Unstructured { | ||
| if len(objs) == 0 { | ||
| return [][]*unstructured.Unstructured{} | ||
| } | ||
| // Create the graph, and build a map of object metadata to the object (Unstructured). | ||
| g := New() | ||
| objToUnstructured := map[object.ObjMetadata]*unstructured.Unstructured{} | ||
| for _, obj := range objs { | ||
| id := object.UnstructuredToObjMeta(obj) | ||
| objToUnstructured[id] = obj | ||
| } | ||
| // Add object vertices and dependency edges to graph. | ||
| addExplicitEdges(g, objs) | ||
| addNamespaceEdges(g, objs) | ||
| addCRDEdges(g, objs) | ||
| // Run topological sort on the graph. | ||
| objSets := [][]*unstructured.Unstructured{} | ||
| sortedObjSets, err := g.Sort() | ||
| if err != nil { | ||
| return objSets | ||
| } | ||
| // Map the object metadata back to the sorted sets of unstructured objects. | ||
| for _, objSet := range sortedObjSets { | ||
| currentSet := []*unstructured.Unstructured{} | ||
| for _, id := range objSet { | ||
| var found bool | ||
| var obj *unstructured.Unstructured | ||
| if obj, found = objToUnstructured[id]; found { | ||
| currentSet = append(currentSet, obj) | ||
| } | ||
| } | ||
| objSets = append(objSets, currentSet) | ||
| } | ||
| return objSets | ||
| } | ||
|
|
||
| // ReverseSortObjs is the same as SortObjs but using reverse ordering. | ||
| func ReverseSortObjs(objs []*unstructured.Unstructured) [][]*unstructured.Unstructured { | ||
| // Sorted objects using normal ordering. | ||
| s := SortObjs(objs) | ||
| // Reverse the ordering of the object sets using swaps. | ||
| for i, j := 0, len(s)-1; i < j; i, j = i+1, j-1 { | ||
| s[i], s[j] = s[j], s[i] | ||
| } | ||
| return s | ||
| } | ||
|
|
||
| // addExplicitEdges updates the graph with edges from objects | ||
| // with an explicit "depends-on" annotation. | ||
| func addExplicitEdges(g *Graph, objs []*unstructured.Unstructured) { | ||
| for _, obj := range objs { | ||
| id := object.UnstructuredToObjMeta(obj) | ||
| klog.V(3).Infof("adding vertex: %s", id) | ||
| g.AddVertex(id) | ||
| deps, err := object.DependsOnObjs(obj) | ||
| if err == nil { | ||
| for _, dep := range deps { | ||
| klog.V(3).Infof("adding edge from: %s, to: %s", id, dep) | ||
| g.AddEdge(id, dep) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // addCRDEdges adds edges to the dependency graph from custom | ||
| // resources to their definitions to ensure the CRD's exist | ||
| // before applying the custom resources created with the definition. | ||
| func addCRDEdges(g *Graph, objs []*unstructured.Unstructured) { | ||
| crds := map[string]object.ObjMetadata{} | ||
| // First create a map of all the CRD's. | ||
| for _, u := range objs { | ||
| if object.IsCRD(u) { | ||
| groupKind, found := object.GetCRDGroupKind(u) | ||
| if found { | ||
| obj := object.UnstructuredToObjMeta(u) | ||
| crds[groupKind.String()] = obj | ||
| } | ||
| } | ||
| } | ||
| // Iterate through all resources to see if we are applying any | ||
| // custom resources defined by previously recorded CRD's. | ||
| for _, u := range objs { | ||
| gvk := u.GroupVersionKind() | ||
| groupKind := gvk.GroupKind() | ||
| if to, found := crds[groupKind.String()]; found { | ||
| from := object.UnstructuredToObjMeta(u) | ||
| klog.V(3).Infof("adding edge from: custom resource %s, to CRD: %s", from, to) | ||
| g.AddEdge(from, to) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // addNamespaceEdges adds edges to the dependency graph from namespaced | ||
| // objects to the namespace objects. Ensures the namespaces exist | ||
| // before the resources in those namespaces are applied. | ||
| func addNamespaceEdges(g *Graph, objs []*unstructured.Unstructured) { | ||
| namespaces := map[string]object.ObjMetadata{} | ||
| // First create a map of all the namespaces objects live in. | ||
| for _, obj := range objs { | ||
| if object.IsKindNamespace(obj) { | ||
| id := object.UnstructuredToObjMeta(obj) | ||
| namespace := obj.GetName() | ||
| namespaces[namespace] = id | ||
| } | ||
| } | ||
| // Next, if the namespace of a namespaced object is being applied, | ||
| // then create an edge from the namespaced object to its namespace. | ||
| for _, obj := range objs { | ||
| if object.IsNamespaced(obj) { | ||
| objNamespace := obj.GetNamespace() | ||
| if namespace, found := namespaces[objNamespace]; found { | ||
| id := object.UnstructuredToObjMeta(obj) | ||
| klog.V(3).Infof("adding edge from: %s to namespace: %s", id, namespace) | ||
| g.AddEdge(id, namespace) | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.