1588970ec4
If a client says they want the name to be generated, a 409 is not appropriate (since they didn't specify a name). Instead, we should return the next most appropriate error, which is a 5xx error indicating the request failed but the client *should* try again. Since there is no 5xx error that exactly fits this purpose, use 500 with StatusReasonTryAgainLater set. This commit does not implement client retry on TryAgainLater, but clients should retry up to a certain number of times.
101 lines
3.4 KiB
Go
101 lines
3.4 KiB
Go
/*
|
|
Copyright 2014 Google Inc. All rights reserved.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package rest
|
|
|
|
import (
|
|
"github.com/GoogleCloudPlatform/kubernetes/pkg/api"
|
|
"github.com/GoogleCloudPlatform/kubernetes/pkg/api/errors"
|
|
"github.com/GoogleCloudPlatform/kubernetes/pkg/runtime"
|
|
)
|
|
|
|
// RESTCreateStrategy defines the minimum validation, accepted input, and
|
|
// name generation behavior to create an object that follows Kubernetes
|
|
// API conventions.
|
|
type RESTCreateStrategy interface {
|
|
runtime.ObjectTyper
|
|
// The name generate is used when the standard GenerateName field is set.
|
|
// The NameGenerator will be invoked prior to validation.
|
|
api.NameGenerator
|
|
|
|
// NamespaceScoped returns true if the object must be within a namespace.
|
|
NamespaceScoped() bool
|
|
// ResetBeforeCreate is invoked on create before validation to remove any fields
|
|
// that may not be persisted.
|
|
ResetBeforeCreate(obj runtime.Object)
|
|
// Validate is invoked after default fields in the object have been filled in before
|
|
// the object is persisted.
|
|
Validate(obj runtime.Object) errors.ValidationErrorList
|
|
}
|
|
|
|
// BeforeCreate ensures that common operations for all resources are performed on creation. It only returns
|
|
// errors that can be converted to api.Status. It invokes ResetBeforeCreate, then GenerateName, then Validate.
|
|
// It returns nil if the object should be created.
|
|
func BeforeCreate(strategy RESTCreateStrategy, ctx api.Context, obj runtime.Object) error {
|
|
objectMeta, kind, kerr := objectMetaAndKind(strategy, obj)
|
|
if kerr != nil {
|
|
return kerr
|
|
}
|
|
|
|
if strategy.NamespaceScoped() {
|
|
if !api.ValidNamespace(ctx, objectMeta) {
|
|
return errors.NewBadRequest("the namespace of the provided object does not match the namespace sent on the request")
|
|
}
|
|
} else {
|
|
objectMeta.Namespace = api.NamespaceNone
|
|
}
|
|
strategy.ResetBeforeCreate(obj)
|
|
api.FillObjectMetaSystemFields(ctx, objectMeta)
|
|
api.GenerateName(strategy, objectMeta)
|
|
|
|
if errs := strategy.Validate(obj); len(errs) > 0 {
|
|
return errors.NewInvalid(kind, objectMeta.Name, errs)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// CheckGeneratedNameError checks whether an error that occured creating a resource is due
|
|
// to generation being unable to pick a valid name.
|
|
func CheckGeneratedNameError(strategy RESTCreateStrategy, err error, obj runtime.Object) error {
|
|
if !errors.IsAlreadyExists(err) {
|
|
return err
|
|
}
|
|
|
|
objectMeta, kind, kerr := objectMetaAndKind(strategy, obj)
|
|
if kerr != nil {
|
|
return kerr
|
|
}
|
|
|
|
if len(objectMeta.GenerateName) == 0 {
|
|
return err
|
|
}
|
|
|
|
return errors.NewTryAgainLater(kind, "POST")
|
|
}
|
|
|
|
// objectMetaAndKind retrieves kind and ObjectMeta from a runtime object, or returns an error.
|
|
func objectMetaAndKind(strategy RESTCreateStrategy, obj runtime.Object) (*api.ObjectMeta, string, error) {
|
|
objectMeta, err := api.ObjectMetaFor(obj)
|
|
if err != nil {
|
|
return nil, "", errors.NewInternalError(err)
|
|
}
|
|
_, kind, err := strategy.ObjectVersionAndKind(obj)
|
|
if err != nil {
|
|
return nil, "", errors.NewInternalError(err)
|
|
}
|
|
return objectMeta, kind, nil
|
|
}
|