storage.go 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370
  1. /*
  2. Copyright 2015 The Kubernetes Authors.
  3. Licensed under the Apache License, Version 2.0 (the "License");
  4. you may not use this file except in compliance with the License.
  5. You may obtain a copy of the License at
  6. http://www.apache.org/licenses/LICENSE-2.0
  7. Unless required by applicable law or agreed to in writing, software
  8. distributed under the License is distributed on an "AS IS" BASIS,
  9. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. See the License for the specific language governing permissions and
  11. limitations under the License.
  12. */
  13. package storage
  14. import (
  15. "context"
  16. "fmt"
  17. "net/http"
  18. "k8s.io/apimachinery/pkg/api/errors"
  19. metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  20. "k8s.io/apimachinery/pkg/runtime"
  21. "k8s.io/apimachinery/pkg/runtime/schema"
  22. "k8s.io/apiserver/pkg/registry/generic"
  23. genericregistry "k8s.io/apiserver/pkg/registry/generic/registry"
  24. "k8s.io/apiserver/pkg/registry/rest"
  25. "k8s.io/apiserver/pkg/storage"
  26. storeerr "k8s.io/apiserver/pkg/storage/errors"
  27. "k8s.io/apiserver/pkg/util/dryrun"
  28. "k8s.io/kubernetes/pkg/apis/apps"
  29. appsv1beta1 "k8s.io/kubernetes/pkg/apis/apps/v1beta1"
  30. appsv1beta2 "k8s.io/kubernetes/pkg/apis/apps/v1beta2"
  31. appsvalidation "k8s.io/kubernetes/pkg/apis/apps/validation"
  32. "k8s.io/kubernetes/pkg/apis/autoscaling"
  33. autoscalingv1 "k8s.io/kubernetes/pkg/apis/autoscaling/v1"
  34. autoscalingvalidation "k8s.io/kubernetes/pkg/apis/autoscaling/validation"
  35. extensionsv1beta1 "k8s.io/kubernetes/pkg/apis/extensions/v1beta1"
  36. "k8s.io/kubernetes/pkg/printers"
  37. printersinternal "k8s.io/kubernetes/pkg/printers/internalversion"
  38. printerstorage "k8s.io/kubernetes/pkg/printers/storage"
  39. "k8s.io/kubernetes/pkg/registry/apps/deployment"
  40. )
  41. // DeploymentStorage includes dummy storage for Deployments and for Scale subresource.
  42. type DeploymentStorage struct {
  43. Deployment *REST
  44. Status *StatusREST
  45. Scale *ScaleREST
  46. Rollback *RollbackREST
  47. }
  48. func NewStorage(optsGetter generic.RESTOptionsGetter) (DeploymentStorage, error) {
  49. deploymentRest, deploymentStatusRest, deploymentRollbackRest, err := NewREST(optsGetter)
  50. if err != nil {
  51. return DeploymentStorage{}, err
  52. }
  53. return DeploymentStorage{
  54. Deployment: deploymentRest,
  55. Status: deploymentStatusRest,
  56. Scale: &ScaleREST{store: deploymentRest.Store},
  57. Rollback: deploymentRollbackRest,
  58. }, nil
  59. }
  60. type REST struct {
  61. *genericregistry.Store
  62. categories []string
  63. }
  64. // NewREST returns a RESTStorage object that will work against deployments.
  65. func NewREST(optsGetter generic.RESTOptionsGetter) (*REST, *StatusREST, *RollbackREST, error) {
  66. store := &genericregistry.Store{
  67. NewFunc: func() runtime.Object { return &apps.Deployment{} },
  68. NewListFunc: func() runtime.Object { return &apps.DeploymentList{} },
  69. DefaultQualifiedResource: apps.Resource("deployments"),
  70. CreateStrategy: deployment.Strategy,
  71. UpdateStrategy: deployment.Strategy,
  72. DeleteStrategy: deployment.Strategy,
  73. TableConvertor: printerstorage.TableConvertor{TableGenerator: printers.NewTableGenerator().With(printersinternal.AddHandlers)},
  74. }
  75. options := &generic.StoreOptions{RESTOptions: optsGetter}
  76. if err := store.CompleteWithOptions(options); err != nil {
  77. return nil, nil, nil, err
  78. }
  79. statusStore := *store
  80. statusStore.UpdateStrategy = deployment.StatusStrategy
  81. return &REST{store, []string{"all"}}, &StatusREST{store: &statusStore}, &RollbackREST{store: store}, nil
  82. }
  83. // Implement ShortNamesProvider
  84. var _ rest.ShortNamesProvider = &REST{}
  85. // ShortNames implements the ShortNamesProvider interface. Returns a list of short names for a resource.
  86. func (r *REST) ShortNames() []string {
  87. return []string{"deploy"}
  88. }
  89. // Implement CategoriesProvider
  90. var _ rest.CategoriesProvider = &REST{}
  91. // Categories implements the CategoriesProvider interface. Returns a list of categories a resource is part of.
  92. func (r *REST) Categories() []string {
  93. return r.categories
  94. }
  95. func (r *REST) WithCategories(categories []string) *REST {
  96. r.categories = categories
  97. return r
  98. }
  99. // StatusREST implements the REST endpoint for changing the status of a deployment
  100. type StatusREST struct {
  101. store *genericregistry.Store
  102. }
  103. func (r *StatusREST) New() runtime.Object {
  104. return &apps.Deployment{}
  105. }
  106. // Get retrieves the object from the storage. It is required to support Patch.
  107. func (r *StatusREST) Get(ctx context.Context, name string, options *metav1.GetOptions) (runtime.Object, error) {
  108. return r.store.Get(ctx, name, options)
  109. }
  110. // Update alters the status subset of an object.
  111. 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) {
  112. // We are explicitly setting forceAllowCreate to false in the call to the underlying storage because
  113. // subresources should never allow create on update.
  114. return r.store.Update(ctx, name, objInfo, createValidation, updateValidation, false, options)
  115. }
  116. // RollbackREST implements the REST endpoint for initiating the rollback of a deployment
  117. type RollbackREST struct {
  118. store *genericregistry.Store
  119. }
  120. // ProducesMIMETypes returns a list of the MIME types the specified HTTP verb (GET, POST, DELETE,
  121. // PATCH) can respond with.
  122. func (r *RollbackREST) ProducesMIMETypes(verb string) []string {
  123. return nil
  124. }
  125. // ProducesObject returns an object the specified HTTP verb respond with. It will overwrite storage object if
  126. // it is not nil. Only the type of the return object matters, the value will be ignored.
  127. func (r *RollbackREST) ProducesObject(verb string) interface{} {
  128. return metav1.Status{}
  129. }
  130. var _ = rest.StorageMetadata(&RollbackREST{})
  131. // New creates a rollback
  132. func (r *RollbackREST) New() runtime.Object {
  133. return &apps.DeploymentRollback{}
  134. }
  135. var _ = rest.NamedCreater(&RollbackREST{})
  136. func (r *RollbackREST) Create(ctx context.Context, name string, obj runtime.Object, createValidation rest.ValidateObjectFunc, options *metav1.CreateOptions) (runtime.Object, error) {
  137. rollback, ok := obj.(*apps.DeploymentRollback)
  138. if !ok {
  139. return nil, errors.NewBadRequest(fmt.Sprintf("not a DeploymentRollback: %#v", obj))
  140. }
  141. if errs := appsvalidation.ValidateDeploymentRollback(rollback); len(errs) != 0 {
  142. return nil, errors.NewInvalid(apps.Kind("DeploymentRollback"), rollback.Name, errs)
  143. }
  144. if name != rollback.Name {
  145. return nil, errors.NewBadRequest("name in URL does not match name in DeploymentRollback object")
  146. }
  147. if createValidation != nil {
  148. if err := createValidation(ctx, obj.DeepCopyObject()); err != nil {
  149. return nil, err
  150. }
  151. }
  152. // Update the Deployment with information in DeploymentRollback to trigger rollback
  153. err := r.rollbackDeployment(ctx, rollback.Name, &rollback.RollbackTo, rollback.UpdatedAnnotations, dryrun.IsDryRun(options.DryRun))
  154. if err != nil {
  155. return nil, err
  156. }
  157. return &metav1.Status{
  158. Status: metav1.StatusSuccess,
  159. Message: fmt.Sprintf("rollback request for deployment %q succeeded", rollback.Name),
  160. Code: http.StatusOK,
  161. }, nil
  162. }
  163. func (r *RollbackREST) rollbackDeployment(ctx context.Context, deploymentID string, config *apps.RollbackConfig, annotations map[string]string, dryRun bool) error {
  164. if _, err := r.setDeploymentRollback(ctx, deploymentID, config, annotations, dryRun); err != nil {
  165. err = storeerr.InterpretGetError(err, apps.Resource("deployments"), deploymentID)
  166. err = storeerr.InterpretUpdateError(err, apps.Resource("deployments"), deploymentID)
  167. if _, ok := err.(*errors.StatusError); !ok {
  168. err = errors.NewInternalError(err)
  169. }
  170. return err
  171. }
  172. return nil
  173. }
  174. func (r *RollbackREST) setDeploymentRollback(ctx context.Context, deploymentID string, config *apps.RollbackConfig, annotations map[string]string, dryRun bool) (*apps.Deployment, error) {
  175. dKey, err := r.store.KeyFunc(ctx, deploymentID)
  176. if err != nil {
  177. return nil, err
  178. }
  179. var finalDeployment *apps.Deployment
  180. err = r.store.Storage.GuaranteedUpdate(ctx, dKey, &apps.Deployment{}, false, nil, storage.SimpleUpdate(func(obj runtime.Object) (runtime.Object, error) {
  181. d, ok := obj.(*apps.Deployment)
  182. if !ok {
  183. return nil, fmt.Errorf("unexpected object: %#v", obj)
  184. }
  185. if d.Annotations == nil {
  186. d.Annotations = make(map[string]string)
  187. }
  188. for k, v := range annotations {
  189. d.Annotations[k] = v
  190. }
  191. d.Spec.RollbackTo = config
  192. finalDeployment = d
  193. return d, nil
  194. }), dryRun)
  195. return finalDeployment, err
  196. }
  197. type ScaleREST struct {
  198. store *genericregistry.Store
  199. }
  200. // ScaleREST implements Patcher
  201. var _ = rest.Patcher(&ScaleREST{})
  202. var _ = rest.GroupVersionKindProvider(&ScaleREST{})
  203. func (r *ScaleREST) GroupVersionKind(containingGV schema.GroupVersion) schema.GroupVersionKind {
  204. switch containingGV {
  205. case extensionsv1beta1.SchemeGroupVersion:
  206. return extensionsv1beta1.SchemeGroupVersion.WithKind("Scale")
  207. case appsv1beta1.SchemeGroupVersion:
  208. return appsv1beta1.SchemeGroupVersion.WithKind("Scale")
  209. case appsv1beta2.SchemeGroupVersion:
  210. return appsv1beta2.SchemeGroupVersion.WithKind("Scale")
  211. default:
  212. return autoscalingv1.SchemeGroupVersion.WithKind("Scale")
  213. }
  214. }
  215. // New creates a new Scale object
  216. func (r *ScaleREST) New() runtime.Object {
  217. return &autoscaling.Scale{}
  218. }
  219. func (r *ScaleREST) Get(ctx context.Context, name string, options *metav1.GetOptions) (runtime.Object, error) {
  220. obj, err := r.store.Get(ctx, name, options)
  221. if err != nil {
  222. return nil, errors.NewNotFound(apps.Resource("deployments/scale"), name)
  223. }
  224. deployment := obj.(*apps.Deployment)
  225. scale, err := scaleFromDeployment(deployment)
  226. if err != nil {
  227. return nil, errors.NewBadRequest(fmt.Sprintf("%v", err))
  228. }
  229. return scale, nil
  230. }
  231. func (r *ScaleREST) Update(ctx context.Context, name string, objInfo rest.UpdatedObjectInfo, createValidation rest.ValidateObjectFunc, updateValidation rest.ValidateObjectUpdateFunc, forceAllowCreate bool, options *metav1.UpdateOptions) (runtime.Object, bool, error) {
  232. obj, err := r.store.Get(ctx, name, &metav1.GetOptions{})
  233. if err != nil {
  234. return nil, false, errors.NewNotFound(apps.Resource("deployments/scale"), name)
  235. }
  236. deployment := obj.(*apps.Deployment)
  237. oldScale, err := scaleFromDeployment(deployment)
  238. if err != nil {
  239. return nil, false, err
  240. }
  241. obj, err = objInfo.UpdatedObject(ctx, oldScale)
  242. if err != nil {
  243. return nil, false, err
  244. }
  245. if obj == nil {
  246. return nil, false, errors.NewBadRequest(fmt.Sprintf("nil update passed to Scale"))
  247. }
  248. scale, ok := obj.(*autoscaling.Scale)
  249. if !ok {
  250. return nil, false, errors.NewBadRequest(fmt.Sprintf("expected input object type to be Scale, but %T", obj))
  251. }
  252. if errs := autoscalingvalidation.ValidateScale(scale); len(errs) > 0 {
  253. return nil, false, errors.NewInvalid(autoscaling.Kind("Scale"), name, errs)
  254. }
  255. deployment.Spec.Replicas = scale.Spec.Replicas
  256. deployment.ResourceVersion = scale.ResourceVersion
  257. obj, _, err = r.store.Update(
  258. ctx,
  259. deployment.Name,
  260. rest.DefaultUpdatedObjectInfo(deployment),
  261. toScaleCreateValidation(createValidation),
  262. toScaleUpdateValidation(updateValidation),
  263. false,
  264. options,
  265. )
  266. if err != nil {
  267. return nil, false, err
  268. }
  269. deployment = obj.(*apps.Deployment)
  270. newScale, err := scaleFromDeployment(deployment)
  271. if err != nil {
  272. return nil, false, errors.NewBadRequest(fmt.Sprintf("%v", err))
  273. }
  274. return newScale, false, nil
  275. }
  276. func toScaleCreateValidation(f rest.ValidateObjectFunc) rest.ValidateObjectFunc {
  277. return func(ctx context.Context, obj runtime.Object) error {
  278. scale, err := scaleFromDeployment(obj.(*apps.Deployment))
  279. if err != nil {
  280. return err
  281. }
  282. return f(ctx, scale)
  283. }
  284. }
  285. func toScaleUpdateValidation(f rest.ValidateObjectUpdateFunc) rest.ValidateObjectUpdateFunc {
  286. return func(ctx context.Context, obj, old runtime.Object) error {
  287. newScale, err := scaleFromDeployment(obj.(*apps.Deployment))
  288. if err != nil {
  289. return err
  290. }
  291. oldScale, err := scaleFromDeployment(old.(*apps.Deployment))
  292. if err != nil {
  293. return err
  294. }
  295. return f(ctx, newScale, oldScale)
  296. }
  297. }
  298. // scaleFromDeployment returns a scale subresource for a deployment.
  299. func scaleFromDeployment(deployment *apps.Deployment) (*autoscaling.Scale, error) {
  300. selector, err := metav1.LabelSelectorAsSelector(deployment.Spec.Selector)
  301. if err != nil {
  302. return nil, err
  303. }
  304. return &autoscaling.Scale{
  305. // TODO: Create a variant of ObjectMeta type that only contains the fields below.
  306. ObjectMeta: metav1.ObjectMeta{
  307. Name: deployment.Name,
  308. Namespace: deployment.Namespace,
  309. UID: deployment.UID,
  310. ResourceVersion: deployment.ResourceVersion,
  311. CreationTimestamp: deployment.CreationTimestamp,
  312. },
  313. Spec: autoscaling.ScaleSpec{
  314. Replicas: deployment.Spec.Replicas,
  315. },
  316. Status: autoscaling.ScaleStatus{
  317. Replicas: deployment.Status.Replicas,
  318. Selector: selector.String(),
  319. },
  320. }, nil
  321. }