k8s.io/kubernetes@v1.29.3/pkg/registry/core/resourcequota/storage/storage.go (about)

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