framework.go 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250
  1. /*
  2. Copyright 2018 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 converter
  14. import (
  15. "fmt"
  16. "io/ioutil"
  17. "net/http"
  18. "strings"
  19. "github.com/munnerz/goautoneg"
  20. "k8s.io/klog"
  21. "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
  22. "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1beta1"
  23. metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  24. "k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
  25. "k8s.io/apimachinery/pkg/runtime"
  26. "k8s.io/apimachinery/pkg/runtime/serializer/json"
  27. utilruntime "k8s.io/apimachinery/pkg/util/runtime"
  28. )
  29. // convertFunc is the user defined function for any conversion. The code in this file is a
  30. // template that can be use for any CR conversion given this function.
  31. type convertFunc func(Object *unstructured.Unstructured, version string) (*unstructured.Unstructured, metav1.Status)
  32. func statusErrorWithMessage(msg string, params ...interface{}) metav1.Status {
  33. return metav1.Status{
  34. Message: fmt.Sprintf(msg, params...),
  35. Status: metav1.StatusFailure,
  36. }
  37. }
  38. func statusSucceed() metav1.Status {
  39. return metav1.Status{
  40. Status: metav1.StatusSuccess,
  41. }
  42. }
  43. // doConversionV1beta1 converts the requested objects in the v1beta1 ConversionRequest using the given conversion function and
  44. // returns a conversion response. Failures are reported with the Reason in the conversion response.
  45. func doConversionV1beta1(convertRequest *v1beta1.ConversionRequest, convert convertFunc) *v1beta1.ConversionResponse {
  46. var convertedObjects []runtime.RawExtension
  47. for _, obj := range convertRequest.Objects {
  48. cr := unstructured.Unstructured{}
  49. if err := cr.UnmarshalJSON(obj.Raw); err != nil {
  50. klog.Error(err)
  51. return &v1beta1.ConversionResponse{
  52. Result: metav1.Status{
  53. Message: fmt.Sprintf("failed to unmarshall object (%v) with error: %v", string(obj.Raw), err),
  54. Status: metav1.StatusFailure,
  55. },
  56. }
  57. }
  58. convertedCR, status := convert(&cr, convertRequest.DesiredAPIVersion)
  59. if status.Status != metav1.StatusSuccess {
  60. klog.Error(status.String())
  61. return &v1beta1.ConversionResponse{
  62. Result: status,
  63. }
  64. }
  65. convertedCR.SetAPIVersion(convertRequest.DesiredAPIVersion)
  66. convertedObjects = append(convertedObjects, runtime.RawExtension{Object: convertedCR})
  67. }
  68. return &v1beta1.ConversionResponse{
  69. ConvertedObjects: convertedObjects,
  70. Result: statusSucceed(),
  71. }
  72. }
  73. // doConversionV1 converts the requested objects in the v1 ConversionRequest using the given conversion function and
  74. // returns a conversion response. Failures are reported with the Reason in the conversion response.
  75. func doConversionV1(convertRequest *v1.ConversionRequest, convert convertFunc) *v1.ConversionResponse {
  76. var convertedObjects []runtime.RawExtension
  77. for _, obj := range convertRequest.Objects {
  78. cr := unstructured.Unstructured{}
  79. if err := cr.UnmarshalJSON(obj.Raw); err != nil {
  80. klog.Error(err)
  81. return &v1.ConversionResponse{
  82. Result: metav1.Status{
  83. Message: fmt.Sprintf("failed to unmarshall object (%v) with error: %v", string(obj.Raw), err),
  84. Status: metav1.StatusFailure,
  85. },
  86. }
  87. }
  88. convertedCR, status := convert(&cr, convertRequest.DesiredAPIVersion)
  89. if status.Status != metav1.StatusSuccess {
  90. klog.Error(status.String())
  91. return &v1.ConversionResponse{
  92. Result: status,
  93. }
  94. }
  95. convertedCR.SetAPIVersion(convertRequest.DesiredAPIVersion)
  96. convertedObjects = append(convertedObjects, runtime.RawExtension{Object: convertedCR})
  97. }
  98. return &v1.ConversionResponse{
  99. ConvertedObjects: convertedObjects,
  100. Result: statusSucceed(),
  101. }
  102. }
  103. func serve(w http.ResponseWriter, r *http.Request, convert convertFunc) {
  104. var body []byte
  105. if r.Body != nil {
  106. if data, err := ioutil.ReadAll(r.Body); err == nil {
  107. body = data
  108. }
  109. }
  110. contentType := r.Header.Get("Content-Type")
  111. serializer := getInputSerializer(contentType)
  112. if serializer == nil {
  113. msg := fmt.Sprintf("invalid Content-Type header `%s`", contentType)
  114. klog.Errorf(msg)
  115. http.Error(w, msg, http.StatusBadRequest)
  116. return
  117. }
  118. klog.V(2).Infof("handling request: %v", body)
  119. obj, gvk, err := serializer.Decode(body, nil, nil)
  120. if err != nil {
  121. msg := fmt.Sprintf("failed to deserialize body (%v) with error %v", string(body), err)
  122. klog.Error(err)
  123. http.Error(w, msg, http.StatusBadRequest)
  124. return
  125. }
  126. var responseObj runtime.Object
  127. switch *gvk {
  128. case v1beta1.SchemeGroupVersion.WithKind("ConversionReview"):
  129. convertReview, ok := obj.(*v1beta1.ConversionReview)
  130. if !ok {
  131. msg := fmt.Sprintf("Expected v1beta1.ConversionReview but got: %T", obj)
  132. klog.Errorf(msg)
  133. http.Error(w, msg, http.StatusBadRequest)
  134. return
  135. }
  136. convertReview.Response = doConversionV1beta1(convertReview.Request, convert)
  137. convertReview.Response.UID = convertReview.Request.UID
  138. klog.V(2).Info(fmt.Sprintf("sending response: %v", convertReview.Response))
  139. // reset the request, it is not needed in a response.
  140. convertReview.Request = &v1beta1.ConversionRequest{}
  141. responseObj = convertReview
  142. case v1.SchemeGroupVersion.WithKind("ConversionReview"):
  143. convertReview, ok := obj.(*v1.ConversionReview)
  144. if !ok {
  145. msg := fmt.Sprintf("Expected v1.ConversionReview but got: %T", obj)
  146. klog.Errorf(msg)
  147. http.Error(w, msg, http.StatusBadRequest)
  148. return
  149. }
  150. convertReview.Response = doConversionV1(convertReview.Request, convert)
  151. convertReview.Response.UID = convertReview.Request.UID
  152. klog.V(2).Info(fmt.Sprintf("sending response: %v", convertReview.Response))
  153. // reset the request, it is not needed in a response.
  154. convertReview.Request = &v1.ConversionRequest{}
  155. responseObj = convertReview
  156. default:
  157. msg := fmt.Sprintf("Unsupported group version kind: %v", gvk)
  158. klog.Error(err)
  159. http.Error(w, msg, http.StatusBadRequest)
  160. return
  161. }
  162. accept := r.Header.Get("Accept")
  163. outSerializer := getOutputSerializer(accept)
  164. if outSerializer == nil {
  165. msg := fmt.Sprintf("invalid accept header `%s`", accept)
  166. klog.Errorf(msg)
  167. http.Error(w, msg, http.StatusBadRequest)
  168. return
  169. }
  170. err = outSerializer.Encode(responseObj, w)
  171. if err != nil {
  172. klog.Error(err)
  173. http.Error(w, err.Error(), http.StatusInternalServerError)
  174. return
  175. }
  176. }
  177. // ServeExampleConvert servers endpoint for the example converter defined as convertExampleCRD function.
  178. func ServeExampleConvert(w http.ResponseWriter, r *http.Request) {
  179. serve(w, r, convertExampleCRD)
  180. }
  181. type mediaType struct {
  182. Type, SubType string
  183. }
  184. var scheme = runtime.NewScheme()
  185. func init() {
  186. addToScheme(scheme)
  187. }
  188. func addToScheme(scheme *runtime.Scheme) {
  189. utilruntime.Must(v1.AddToScheme(scheme))
  190. utilruntime.Must(v1beta1.AddToScheme(scheme))
  191. }
  192. var serializers = map[mediaType]runtime.Serializer{
  193. {"application", "json"}: json.NewSerializer(json.DefaultMetaFactory, scheme, scheme, false),
  194. {"application", "yaml"}: json.NewYAMLSerializer(json.DefaultMetaFactory, scheme, scheme),
  195. }
  196. func getInputSerializer(contentType string) runtime.Serializer {
  197. parts := strings.SplitN(contentType, "/", 2)
  198. if len(parts) != 2 {
  199. return nil
  200. }
  201. return serializers[mediaType{parts[0], parts[1]}]
  202. }
  203. func getOutputSerializer(accept string) runtime.Serializer {
  204. if len(accept) == 0 {
  205. return serializers[mediaType{"application", "json"}]
  206. }
  207. clauses := goautoneg.ParseAccept(accept)
  208. for _, clause := range clauses {
  209. for k, v := range serializers {
  210. switch {
  211. case clause.Type == k.Type && clause.SubType == k.SubType,
  212. clause.Type == k.Type && clause.SubType == "*",
  213. clause.Type == "*" && clause.SubType == "*":
  214. return v
  215. }
  216. }
  217. }
  218. return nil
  219. }