Generate schema for CRD v1

examples/Cargo.toml

@@ -31,6 +31,7 @@ snafu = { version = "0.6.8", features = ["futures"] }
 either = "1.6.0"
 # Some configuration tweaking require reqwest atm
 reqwest = { version = "0.10.8", default-features = false, features = ["json", "gzip", "stream"] }
+schemars = "0.8.0"
 
 [[example]]
 name = "configmapgen_controller"
@@ -56,6 +57,10 @@ path = "crd_apply.rs"
 name = "crd_derive"
 path = "crd_derive.rs"
 
+[[example]]
+name = "crd_derive_schema"
+path = "crd_derive_schema.rs"
+
 [[example]]
 name = "crd_reflector"
 path = "crd_reflector.rs"

examples/configmapgen_controller.rs

@@ -10,6 +10,7 @@ use kube::{
     Api, Client, CustomResource,
 };
 use kube_runtime::controller::{Context, Controller, ReconcilerAction};
+use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 use snafu::{Backtrace, OptionExt, ResultExt, Snafu};
 use std::collections::BTreeMap;
@@ -32,7 +33,7 @@ enum Error {
     },
 }
 
-#[derive(CustomResource, Debug, Clone, Deserialize, Serialize)]
+#[derive(CustomResource, Debug, Clone, Deserialize, Serialize, JsonSchema)]
 #[kube(group = "nullable.se", version = "v1", kind = "ConfigMapGenerator")]
 #[kube(shortname = "cmg", namespaced)]
 struct ConfigMapGeneratorSpec {

examples/crd_api.rs

@@ -1,5 +1,6 @@
 #[macro_use] extern crate log;
 use either::Either::{Left, Right};
+use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 use serde_json::json;
 use std::time::Duration;
@@ -14,7 +15,7 @@ use kube::{
 };
 
 // Own custom resource
-#[derive(CustomResource, Deserialize, Serialize, Clone, Debug)]
+#[derive(CustomResource, Deserialize, Serialize, Clone, Debug, JsonSchema)]
 #[kube(group = "clux.dev", version = "v1", kind = "Foo", namespaced)]
 #[kube(apiextensions = "v1beta1")]
 #[kube(status = "FooStatus")]
@@ -26,7 +27,7 @@ pub struct FooSpec {
     replicas: i32,
 }
 
-#[derive(Deserialize, Serialize, Clone, Debug, Default)]
+#[derive(Deserialize, Serialize, Clone, Debug, Default, JsonSchema)]
 pub struct FooStatus {
     is_bad: bool,
     replicas: i32,

examples/crd_apply.rs

@@ -1,5 +1,6 @@
 #[macro_use] extern crate log;
 use futures::{StreamExt, TryStreamExt};
+use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
 use apiexts::CustomResourceDefinition;
@@ -14,7 +15,7 @@ use kube::{
 // Please test against Kubernetes 1.16.X!
 
 // Own custom resource
-#[derive(CustomResource, Deserialize, Serialize, Clone, Debug)]
+#[derive(CustomResource, Deserialize, Serialize, Clone, Debug, JsonSchema)]
 #[kube(group = "clux.dev", version = "v1", kind = "Foo", namespaced)]
 #[kube(status = "FooStatus")]
 #[kube(apiextensions = "v1beta1")] // remove this if using Kubernetes >= 1.17
@@ -25,7 +26,7 @@ pub struct FooSpec {
     replicas: i32,
 }
 
-#[derive(Deserialize, Serialize, Clone, Debug, Default)]
+#[derive(Deserialize, Serialize, Clone, Debug, Default, JsonSchema)]
 pub struct FooStatus {
     is_bad: bool,
     replicas: i32,

examples/crd_derive.rs

@@ -1,11 +1,12 @@
 use k8s_openapi::Resource;
 use kube::CustomResource;
+use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
 /// Our spec for Foo
 ///
 /// A struct with our chosen Kind will be created for us, using the following kube attrs
-#[derive(CustomResource, Serialize, Deserialize, Default, Debug, PartialEq, Clone)]
+#[derive(CustomResource, Serialize, Deserialize, Default, Debug, PartialEq, Clone, JsonSchema)]
 #[kube(
     group = "clux.dev",
     version = "v1",
@@ -18,14 +19,14 @@ use serde::{Deserialize, Serialize};
     scale = r#"{"specReplicasPath":".spec.replicas", "statusReplicasPath":".status.replicas"}"#,
     printcolumn = r#"{"name":"Spec", "type":"string", "description":"name of foo", "jsonPath":".spec.name"}"#
 )]
-#[kube(apiextensions = "v1beta1")] // kubernetes <= 1.16
+#[kube(apiextensions = "v1")]
 pub struct MyFoo {
     name: String,
     #[serde(skip_serializing_if = "Option::is_none")]
     info: Option<String>,
 }
 
-#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
+#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, JsonSchema)]
 pub struct FooStatus {
     is_bad: bool,
 }
@@ -49,7 +50,7 @@ fn verify_crd() {
     use serde_json::{self, json};
     let crd = Foo::crd();
     let output = json!({
-      "apiVersion": "apiextensions.k8s.io/v1beta1",
+      "apiVersion": "apiextensions.k8s.io/v1",
       "kind": "CustomResourceDefinition",
       "metadata": {
         "name": "foos.clux.dev"
@@ -62,26 +63,69 @@ fn verify_crd() {
           "shortNames": ["f"],
           "singular": "foo"
         },
-        "additionalPrinterColumns": [
-          {
-            "description": "name of foo",
-            "JSONPath": ".spec.name",
-            "name": "Spec",
-            "type": "string"
-          }
-        ],
         "scope": "Namespaced",
         "versions": [
           {
             "name": "v1",
             "served": true,
-            "storage": true
+            "storage": true,
+            "additionalPrinterColumns": [
+              {
+                "description": "name of foo",
+                "jsonPath": ".spec.name",
+                "name": "Spec",
+                "type": "string"
+              }
+            ],
+            "schema": {
+              "openAPIV3Schema": {
+                "description": "Auto-generated derived type for MyFoo via `CustomResource`",
+                "properties": {
+                  "spec": {
+                    "description": "Our spec for Foo\n\nA struct with our chosen Kind will be created for us, using the following kube attrs",
+                    "properties": {
+                      "info": {
+                        "nullable": true,
+                        "type": "string"
+                      },
+                      "name": {
+                        "type": "string"
+                      }
+                    },
+                    "required": [
+                      "name"
+                    ],
+                    "type": "object"
+                  },
+                  "status": {
+                    "nullable": true,
+                    "properties": {
+                      "is_bad": {
+                        "type": "boolean"
+                      }
+                    },
+                    "required": [
+                      "is_bad"
+                    ],
+                    "type": "object"
+                  }
+                },
+                "required": [
+                  "spec"
+                ],
+                "title": "Foo",
+                "type": "object"
+              }
+            },
+            "subresources": {
+              "scale": {
+                "specReplicasPath": ".spec.replicas",
+                "statusReplicasPath": ".status.replicas"
+              },
+              "status": {}
+            },
           }
-        ],
-        "subresources": {
-          "scale": {"specReplicasPath":".spec.replicas", "statusReplicasPath":".status.replicas"},
-          "status": {}
-        }
+        ]
       }
     });
     let outputcrd = serde_json::from_value(output).expect("expected output is valid");