k8s.io/kubernetes@v1.29.3/pkg/registry/autoscaling/horizontalpodautoscaler/storage/storage.go (about)

     1  /*
     2  Copyright 2014 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 storage
    18  
    19  import (
    20  	"context"
    21  
    22  	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
    23  	"k8s.io/apimachinery/pkg/runtime"
    24  	"k8s.io/apiserver/pkg/registry/generic"
    25  	genericregistry "k8s.io/apiserver/pkg/registry/generic/registry"
    26  	"k8s.io/apiserver/pkg/registry/rest"
    27  	"k8s.io/kubernetes/pkg/apis/autoscaling"
    28  	"k8s.io/kubernetes/pkg/printers"
    29  	printersinternal "k8s.io/kubernetes/pkg/printers/internalversion"
    30  	printerstorage "k8s.io/kubernetes/pkg/printers/storage"
    31  	"k8s.io/kubernetes/pkg/registry/autoscaling/horizontalpodautoscaler"
    32  	"sigs.k8s.io/structured-merge-diff/v4/fieldpath"
    33  )
    34  
    35  // REST implements a RESTStorage for pod disruption budgets against etcd
    36  type REST struct {
    37  	*genericregistry.Store
    38  }
    39  
    40  // NewREST returns a RESTStorage object that will work against horizontal pod autoscalers.
    41  func NewREST(optsGetter generic.RESTOptionsGetter) (*REST, *StatusREST, error) {
    42  	store := &genericregistry.Store{
    43  		NewFunc:                   func() runtime.Object { return &autoscaling.HorizontalPodAutoscaler{} },
    44  		NewListFunc:               func() runtime.Object { return &autoscaling.HorizontalPodAutoscalerList{} },
    45  		DefaultQualifiedResource:  autoscaling.Resource("horizontalpodautoscalers"),
    46  		SingularQualifiedResource: autoscaling.Resource("horizontalpodautoscaler"),
    47  
    48  		CreateStrategy:      horizontalpodautoscaler.Strategy,
    49  		UpdateStrategy:      horizontalpodautoscaler.Strategy,
    50  		DeleteStrategy:      horizontalpodautoscaler.Strategy,
    51  		ResetFieldsStrategy: horizontalpodautoscaler.Strategy,
    52  
    53  		TableConvertor: printerstorage.TableConvertor{TableGenerator: printers.NewTableGenerator().With(printersinternal.AddHandlers)},
    54  	}
    55  	options := &generic.StoreOptions{RESTOptions: optsGetter}
    56  	if err := store.CompleteWithOptions(options); err != nil {
    57  		return nil, nil, err
    58  	}
    59  
    60  	statusStore := *store
    61  	statusStore.UpdateStrategy = horizontalpodautoscaler.StatusStrategy
    62  	statusStore.ResetFieldsStrategy = horizontalpodautoscaler.StatusStrategy
    63  	return &REST{store}, &StatusREST{store: &statusStore}, nil
    64  }
    65  
    66  // Implement ShortNamesProvider
    67  var _ rest.ShortNamesProvider = &REST{}
    68  
    69  // ShortNames implements the ShortNamesProvider interface. Returns a list of short names for a resource.
    70  func (r *REST) ShortNames() []string {
    71  	return []string{"hpa"}
    72  }
    73  
    74  // Implement CategoriesProvider
    75  var _ rest.CategoriesProvider = &REST{}
    76  
    77  // Categories implements the CategoriesProvider interface. Returns a list of categories a resource is part of.
    78  func (r *REST) Categories() []string {
    79  	return []string{"all"}
    80  }
    81  
    82  // StatusREST implements the REST endpoint for changing the status of a daemonset
    83  type StatusREST struct {
    84  	store *genericregistry.Store
    85  }
    86  
    87  // New creates a new HorizontalPodAutoscaler object.
    88  func (r *StatusREST) New() runtime.Object {
    89  	return &autoscaling.HorizontalPodAutoscaler{}
    90  }
    91  
    92  // Destroy cleans up resources on shutdown.
    93  func (r *StatusREST) Destroy() {
    94  	// Given that underlying store is shared with REST,
    95  	// we don't destroy it here explicitly.
    96  }
    97  
    98  // Get retrieves the object from the storage. It is required to support Patch.
    99  func (r *StatusREST) Get(ctx context.Context, name string, options *metav1.GetOptions) (runtime.Object, error) {
   100  	return r.store.Get(ctx, name, options)
   101  }
   102  
   103  // Update alters the status subset of an object.
   104  func (r *StatusREST) Update(ctx context.Context, name string, objInfo rest.UpdatedObjectInfo, createValidation rest.ValidateObjectFunc, updateValidation rest.ValidateObjectUpdateFunc, forceAllowCreate bool, options *metav1.UpdateOptions) (runtime.Object, bool, error) {
   105  	// We are explicitly setting forceAllowCreate to false in the call to the underlying storage because
   106  	// subresources should never allow create on update.
   107  	return r.store.Update(ctx, name, objInfo, createValidation, updateValidation, false, options)
   108  }
   109  
   110  // GetResetFields implements rest.ResetFieldsStrategy
   111  func (r *StatusREST) GetResetFields() map[fieldpath.APIVersion]*fieldpath.Set {
   112  	return r.store.GetResetFields()
   113  }
   114  
   115  func (r *StatusREST) ConvertToTable(ctx context.Context, object runtime.Object, tableOptions runtime.Object) (*metav1.Table, error) {
   116  	return r.store.ConvertToTable(ctx, object, tableOptions)
   117  }