fix samples

docs/book/src/cronjob-tutorial/testdata/project/api/v1/cronjob_types.go

@@ -19,6 +19,7 @@ limitations under the License.
  */
 
 package v1
+
 /*
  */
 
@@ -61,7 +62,6 @@ import (
  the fields.
 */
 
-
 // CronJobSpec defines the desired state of CronJob
 type CronJobSpec struct {
 	//+kubebuilder:validation:MinLength=0
@@ -188,4 +188,5 @@ type CronJobList struct {
 func init() {
 	SchemeBuilder.Register(&CronJob{}, &CronJobList{})
 }
+
 //+kubebuilder:docs-gen:collapse=Root Object Definitions

docs/book/src/cronjob-tutorial/testdata/project/api/v1/cronjob_webhook.go

@@ -37,6 +37,7 @@ Next, we'll setup a logger for the webhooks.
 */
 
 var cronjoblog = logf.Log.WithName("cronjob-resource")
+
 /*
 Then, we set up the webhook with the manager.
 */
@@ -63,14 +64,11 @@ A webhook will automatically be served that calls this defaulting.
 The `Default` method is expected to mutate the receiver, setting the defaults.
 */
 
-
-
-
 var _ webhook.Defaulter = &CronJob{}
 
 // Default implements webhook.Defaulter so a webhook will be registered for the type
 func (r *CronJob) Default() {
-		cronjoblog.Info("default", "name", r.Name)
+	cronjoblog.Info("default", "name", r.Name)
 
 	if r.Spec.ConcurrencyPolicy == "" {
 		r.Spec.ConcurrencyPolicy = AllowConcurrent
@@ -116,24 +114,19 @@ Here, however, we just use the same shared validation for `ValidateCreate` and
 validate anything on deletion.
 */
 
-
-
-
 var _ webhook.Validator = &CronJob{}
 
 // ValidateCreate implements webhook.Validator so a webhook will be registered for the type
 func (r *CronJob) ValidateCreate() (admission.Warnings, error) {
 	cronjoblog.Info("validate create", "name", r.Name)
 
-
 	return nil, r.validateCronJob()
 }
 
 // ValidateUpdate implements webhook.Validator so a webhook will be registered for the type
 func (r *CronJob) ValidateUpdate(old runtime.Object) (admission.Warnings, error) {
 	cronjoblog.Info("validate update", "name", r.Name)
 
-
 	return nil, r.validateCronJob()
 }
 
@@ -143,6 +136,8 @@ func (r *CronJob) ValidateDelete() (admission.Warnings, error) {
 
 	// TODO(user): fill in your validation logic upon object deletion.
 	return nil, nil
+}
+
 /*
 We validate the name and the spec of the CronJob.
 */
@@ -217,4 +212,3 @@ func (r *CronJob) validateCronJobName() *field.Error {
 }
 
 // +kubebuilder:docs-gen:collapse=Validate object name
-}

docs/book/src/cronjob-tutorial/testdata/project/api/v1/groupversion_info.go

@@ -13,6 +13,15 @@ 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.
 */
+// +kubebuilder:docs-gen:collapse=Apache License
+
+/*
+First, we have some *package-level* markers that denote that there are
+Kubernetes objects in this package, and that this package represents the group
+`batch.tutorial.kubebuilder.io`. The `object` generator makes use of the
+former, while the latter is used by the CRD generator to generate the right
+metadata for the CRDs it creates from this package.
+*/
 
 // Package v1 contains API Schema definitions for the batch v1 API group
 // +kubebuilder:object:generate=true
@@ -24,6 +33,13 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/scheme"
 )
 
+/*
+Then, we have the commonly useful variables that help us set up our Scheme.
+Since we need to use all the types in this package in our controller, it's
+helpful (and the convention) to have a convenient method to add all the types to
+some other `Scheme`. SchemeBuilder makes this easy for us.
+*/
+
 var (
 	// GroupVersion is group version used to register these objects
 	GroupVersion = schema.GroupVersion{Group: "batch.tutorial.kubebuilder.io", Version: "v1"}

docs/book/src/cronjob-tutorial/testdata/project/cmd/main.go

@@ -13,6 +13,7 @@ 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.
 */
+// +kubebuilder:docs-gen:collapse=Apache License
 
 package main
 
@@ -36,6 +37,17 @@ import (
 	//+kubebuilder:scaffold:imports
 )
 
+// +kubebuilder:docs-gen:collapse=Imports
+
+/*
+The first difference to notice is that kubebuilder has added the new API
+group's package (`batchv1`) to our scheme.  This means that we can use those
+objects in our controller.
+
+If we would be using any other CRD we would have to add their scheme the same way.
+Builtin types such as Job have their scheme added by `clientgoscheme`.
+*/
+
 var (
 	scheme   = runtime.NewScheme()
 	setupLog = ctrl.Log.WithName("setup")
@@ -48,7 +60,14 @@ func init() {
 	//+kubebuilder:scaffold:scheme
 }
 
+/*
+The other thing that's changed is that kubebuilder has added a block calling our
+CronJob controller's `SetupWithManager` method.
+*/
+
 func main() {
+	/*
+	 */
 	var metricsAddr string
 	var enableLeaderElection bool
 	var probeAddr string
@@ -89,16 +108,29 @@ func main() {
 		os.Exit(1)
 	}
 
+	// +kubebuilder:docs-gen:collapse=old stuff
+
 	if err = (&controller.CronJobReconciler{
 		Client: mgr.GetClient(),
 		Scheme: mgr.GetScheme(),
 	}).SetupWithManager(mgr); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "CronJob")
 		os.Exit(1)
 	}
-	if err = (&batchv1.CronJob{}).SetupWebhookWithManager(mgr); err != nil {
-		setupLog.Error(err, "unable to create webhook", "webhook", "CronJob")
-		os.Exit(1)
+
+	/*
+		We'll also set up webhooks for our type, which we'll talk about next.
+		We just need to add them to the manager.  Since we might want to run
+		the webhooks separately, or not run them when testing our controller
+		locally, we'll put them behind an environment variable.
+
+		We'll just make sure to set `ENABLE_WEBHOOKS=false` when we run locally.
+	*/
+	if os.Getenv("ENABLE_WEBHOOKS") != "false" {
+		if err = (&batchv1.CronJob{}).SetupWebhookWithManager(mgr); err != nil {
+			setupLog.Error(err, "unable to create webhook", "webhook", "CronJob")
+			os.Exit(1)
+		}
 	}
 	//+kubebuilder:scaffold:builder
 
@@ -116,4 +148,5 @@ func main() {
 		setupLog.Error(err, "problem running manager")
 		os.Exit(1)
 	}
+	// +kubebuilder:docs-gen:collapse=old stuff
 }