fieldmanager.go

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

     1  /*
     2  Copyright 2018 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 managedfields
    18  
    19  import (
    20  	"fmt"
    21  
    22  	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
    23  	"k8s.io/apimachinery/pkg/runtime"
    24  	"k8s.io/apimachinery/pkg/runtime/schema"
    25  	"k8s.io/apimachinery/pkg/util/managedfields/internal"
    26  	"sigs.k8s.io/structured-merge-diff/v4/fieldpath"
    27  )
    28  
    29  // FieldManager updates the managed fields and merges applied
    30  // configurations.
    31  type FieldManager = internal.FieldManager
    32  
    33  // NewDefaultFieldManager creates a new FieldManager that merges apply requests
    34  // and update managed fields for other types of requests.
    35  func NewDefaultFieldManager(typeConverter TypeConverter, objectConverter runtime.ObjectConvertor, objectDefaulter runtime.ObjectDefaulter, objectCreater runtime.ObjectCreater, kind schema.GroupVersionKind, hub schema.GroupVersion, subresource string, resetFields map[fieldpath.APIVersion]*fieldpath.Set) (*FieldManager, error) {
    36  	f, err := internal.NewStructuredMergeManager(typeConverter, objectConverter, objectDefaulter, kind.GroupVersion(), hub, resetFields)
    37  	if err != nil {
    38  		return nil, fmt.Errorf("failed to create field manager: %v", err)
    39  	}
    40  	return internal.NewDefaultFieldManager(f, typeConverter, objectConverter, objectCreater, kind, subresource), nil
    41  }
    42  
    43  // NewDefaultCRDFieldManager creates a new FieldManager specifically for
    44  // CRDs. This allows for the possibility of fields which are not defined
    45  // in models, as well as having no models defined at all.
    46  func NewDefaultCRDFieldManager(typeConverter TypeConverter, objectConverter runtime.ObjectConvertor, objectDefaulter runtime.ObjectDefaulter, objectCreater runtime.ObjectCreater, kind schema.GroupVersionKind, hub schema.GroupVersion, subresource string, resetFields map[fieldpath.APIVersion]*fieldpath.Set) (_ *FieldManager, err error) {
    47  	f, err := internal.NewCRDStructuredMergeManager(typeConverter, objectConverter, objectDefaulter, kind.GroupVersion(), hub, resetFields)
    48  	if err != nil {
    49  		return nil, fmt.Errorf("failed to create field manager: %v", err)
    50  	}
    51  	return internal.NewDefaultFieldManager(f, typeConverter, objectConverter, objectCreater, kind, subresource), nil
    52  }
    53  
    54  func ValidateManagedFields(encodedManagedFields []metav1.ManagedFieldsEntry) error {
    55  	_, err := internal.DecodeManagedFields(encodedManagedFields)
    56  	return err
    57  }
    58
View as plain text