stripmeta.go

Documentation: k8s.io/apimachinery/pkg/util/managedfields/internal

     1  /*
     2  Copyright 2019 The Kubernetes Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package internal
    18  
    19  import (
    20  	"fmt"
    21  
    22  	"k8s.io/apimachinery/pkg/runtime"
    23  	"sigs.k8s.io/structured-merge-diff/v4/fieldpath"
    24  )
    25  
    26  type stripMetaManager struct {
    27  	fieldManager Manager
    28  
    29  	// stripSet is the list of fields that should never be part of a mangedFields.
    30  	stripSet *fieldpath.Set
    31  }
    32  
    33  var _ Manager = &stripMetaManager{}
    34  
    35  // NewStripMetaManager creates a new Manager that strips metadata and typemeta fields from the manager's fieldset.
    36  func NewStripMetaManager(fieldManager Manager) Manager {
    37  	return &stripMetaManager{
    38  		fieldManager: fieldManager,
    39  		stripSet: fieldpath.NewSet(
    40  			fieldpath.MakePathOrDie("apiVersion"),
    41  			fieldpath.MakePathOrDie("kind"),
    42  			fieldpath.MakePathOrDie("metadata"),
    43  			fieldpath.MakePathOrDie("metadata", "name"),
    44  			fieldpath.MakePathOrDie("metadata", "namespace"),
    45  			fieldpath.MakePathOrDie("metadata", "creationTimestamp"),
    46  			fieldpath.MakePathOrDie("metadata", "selfLink"),
    47  			fieldpath.MakePathOrDie("metadata", "uid"),
    48  			fieldpath.MakePathOrDie("metadata", "clusterName"),
    49  			fieldpath.MakePathOrDie("metadata", "generation"),
    50  			fieldpath.MakePathOrDie("metadata", "managedFields"),
    51  			fieldpath.MakePathOrDie("metadata", "resourceVersion"),
    52  		),
    53  	}
    54  }
    55  
    56  // Update implements Manager.
    57  func (f *stripMetaManager) Update(liveObj, newObj runtime.Object, managed Managed, manager string) (runtime.Object, Managed, error) {
    58  	newObj, managed, err := f.fieldManager.Update(liveObj, newObj, managed, manager)
    59  	if err != nil {
    60  		return nil, nil, err
    61  	}
    62  	f.stripFields(managed.Fields(), manager)
    63  	return newObj, managed, nil
    64  }
    65  
    66  // Apply implements Manager.
    67  func (f *stripMetaManager) Apply(liveObj, appliedObj runtime.Object, managed Managed, manager string, force bool) (runtime.Object, Managed, error) {
    68  	newObj, managed, err := f.fieldManager.Apply(liveObj, appliedObj, managed, manager, force)
    69  	if err != nil {
    70  		return nil, nil, err
    71  	}
    72  	f.stripFields(managed.Fields(), manager)
    73  	return newObj, managed, nil
    74  }
    75  
    76  // stripFields removes a predefined set of paths found in typed from managed
    77  func (f *stripMetaManager) stripFields(managed fieldpath.ManagedFields, manager string) {
    78  	vs, ok := managed[manager]
    79  	if ok {
    80  		if vs == nil {
    81  			panic(fmt.Sprintf("Found unexpected nil manager which should never happen: %s", manager))
    82  		}
    83  		newSet := vs.Set().Difference(f.stripSet)
    84  		if newSet.Empty() {
    85  			delete(managed, manager)
    86  		} else {
    87  			managed[manager] = fieldpath.NewVersionedSet(newSet, vs.APIVersion(), vs.Applied())
    88  		}
    89  	}
    90  }
    91
View as plain text