mirror of
https://github.com/k3s-io/kubernetes.git
synced 2025-10-11 17:55:42 +00:00
4f88b778a6
Contains breaking API change on api.Status#Details (type change) Turn Details from string -> StatusDetails - a general bucket for keyed error behavior. Define an open enumeration ReasonType exposed as Reason on the status object to provide machine readable subcategorization beyond HTTP Status Code. Define a human readable field Message which is common convention (previously this was joined into Details). Precedence order: HTTP Status Code, Reason, Details. apiserver would impose restraints on the ReasonTypes defined by the main apiobject, and ensure their use is consistent. There are four long term scenarios this change supports: 1. Allow a client access to a machine readable field that can be easily switched on for improving or translating the generic server Message. 2. Return a 404 when a composite operation on multiple resources fails with enough data so that a client can distinguish which item does not exist. E.g. resource Parent and resource Child, POST /parents/1/children to create a new Child, but /parents/1 is deleted. POST returns 404, ReasonTypeNotFound, and Details.ID = "1", Details.Kind = "parent" 3. Allow a client to receive validation data that is keyed by attribute for building user facing UIs around field submission. Validation is usually expressed as map[string][]string, but that type is less appropriate for many other uses. 4. Allow specific API errors to return more granular failure status for specific operations. An example might be a minion proxy, where the operation that failed may be both proxying OR the minion itself. In this case a reason may be defined "proxy_failed" corresponding to 502, where the Details field may be extended to contain a nested error object. At this time only ID and Kind are exposed
60 lines
1.8 KiB
Go
60 lines
1.8 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 apiserver
|
|
|
|
import (
|
|
"net/http"
|
|
|
|
"github.com/GoogleCloudPlatform/kubernetes/pkg/api"
|
|
"github.com/GoogleCloudPlatform/kubernetes/pkg/tools"
|
|
"github.com/GoogleCloudPlatform/kubernetes/pkg/util"
|
|
)
|
|
|
|
// WorkFunc is used to perform any time consuming work for an api call, after
|
|
// the input has been validated. Pass one of these to MakeAsync to create an
|
|
// appropriate return value for the Update, Delete, and Create methods.
|
|
type WorkFunc func() (result interface{}, err error)
|
|
|
|
// MakeAsync takes a function and executes it, delivering the result in the way required
|
|
// by RESTStorage's Update, Delete, and Create methods.
|
|
func MakeAsync(fn WorkFunc) <-chan interface{} {
|
|
channel := make(chan interface{})
|
|
go func() {
|
|
defer util.HandleCrash()
|
|
obj, err := fn()
|
|
if err != nil {
|
|
status := http.StatusInternalServerError
|
|
switch {
|
|
case tools.IsEtcdTestFailed(err):
|
|
status = http.StatusConflict
|
|
}
|
|
channel <- &api.Status{
|
|
Status: api.StatusFailure,
|
|
Message: err.Error(),
|
|
Code: status,
|
|
}
|
|
} else {
|
|
channel <- obj
|
|
}
|
|
// 'close' is used to signal that no further values will
|
|
// be written to the channel. Not strictly necessary, but
|
|
// also won't hurt.
|
|
close(channel)
|
|
}()
|
|
return channel
|
|
}
|