put builtin and crd example under examples

Author: Mengqi Yu

crdexample/logutil/log.go

@@ -36,7 +36,7 @@ type podAnnotator struct {
 func (a *podAnnotator) Handle(ctx context.Context, req admission.Request) admission.Response {
 	pod := &corev1.Pod{}
 
-	err := a.decoder.Decode(req.Object, pod)
+	err := a.decoder.Decode(req, pod)
 	if err != nil {
 		return admission.Errored(http.StatusBadRequest, err)
 	}

example/controller.go renamed to examples/builtins/controller.go

@@ -36,7 +36,7 @@ type podValidator struct {
 func (v *podValidator) Handle(ctx context.Context, req admission.Request) admission.Response {
 	pod := &corev1.Pod{}
 
-	err := v.decoder.Decode(req.Object, pod)
+	err := v.decoder.Decode(req, pod)
 	if err != nil {
 		return admission.Errored(http.StatusBadRequest, err)
 	}

example/main.go renamed to examples/builtins/main.go

@@ -0,0 +1,7 @@
+apiVersion: v1
+kind: Namespace
+metadata:
+  labels:
+    control-plane: controller-manager
+    controller-tools.k8s.io: "1.0"
+  name: crew-system

example/mutatingwebhook.go renamed to examples/builtins/mutatingwebhook.go

@@ -0,0 +1,27 @@
+apiVersion: apiextensions.k8s.io/v1beta1
+kind: CustomResourceDefinition
+metadata:
+  # name must match the spec fields below, and be in the form: <plural>.<group>
+  name: firstmates.crew.example.com
+spec:
+  # group name to use for REST API: /apis/<group>/<version>
+  group: crew.example.com
+  # list of versions supported by this CustomResourceDefinition
+  versions:
+  - name: v1
+    # Each version can be enabled/disabled by Served flag.
+    served: true
+    # One and only one version must be marked as the storage version.
+    storage: true
+  # either Namespaced or Cluster
+  scope: Namespaced
+  names:
+    # plural name to be used in the URL: /apis/<group>/<version>/<plural>
+    plural: firstmates
+    # singular name to be used as an alias on the CLI and for display
+    singular: firstmate
+    # kind is normally the CamelCased singular type. Your resource manifests use this.
+    kind: FirstMate
+    # shortNames allow shorter string to match your resource on the CLI
+    shortNames:
+      - fm

example/validatingwebhook.go renamed to examples/builtins/validatingwebhook.go

@@ -0,0 +1,21 @@
+# Requires: kubectl create clusterrolebinding cluster-admin-binding --clusterrole cluster-admin --user USER
+apiVersion: v1beta1
+kind: Kustomization
+
+# Adds namespace to all resources.
+namespace: crew-system
+
+bases:
+- ../../base
+
+resources:
+- firstmate_crd.yaml
+- manager_rbac.yaml
+- crew_namespace.yaml
+
+patchesStrategicMerge:
+- manager_image_patch.yaml
+
+imageTags:
+  - name: pwittrock/controller-manager
+    newTag: v1

crdexample/Dockerfile renamed to examples/crd/Dockerfile

@@ -0,0 +1,11 @@
+apiVersion: apps/v1
+kind: StatefulSet
+metadata:
+  name: controller-manager
+  namespace: system
+spec:
+  template:
+    spec:
+      containers:
+      - image: pwittrock/controller-manager
+        name: manager

crdexample/README.md renamed to examples/crd/README.md

@@ -0,0 +1,33 @@
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRole
+metadata:
+  name: manager-role
+rules:
+  - apiGroups:
+      - apps
+      - crew.example.com
+    resources:
+      - deployments
+      - deployments/status
+      - firstmates
+      - firstmates/status
+    verbs:
+      - get
+      - list
+      - watch
+      - create
+      - update
+      - patch
+      - delete
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRoleBinding
+metadata:
+  name: manager-rolebinding
+roleRef:
+  apiGroup: rbac.authorization.k8s.io
+  kind: ClusterRole
+  name: manager-role
+subjects:
+  - kind: ServiceAccount
+    name: default

examples/crd/config/crew_namespace.yaml

@@ -26,29 +26,30 @@ import (
 	"k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
-	"sigs.k8s.io/controller-runtime/crdexample/logutil"
-	"sigs.k8s.io/controller-runtime/crdexample/pkg"
+	"sigs.k8s.io/controller-runtime/examples/crd/pkg"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
 )
 
-var fmLog = logutil.Log.WithName("firstmate-reconciler")
+var fmLog = log.WithName("firstmate-reconciler")
 
 // FirstMateController reconciles ReplicaSets
 type FirstMateController struct {
 	// client can be used to retrieve objects from the APIServer.
 	client client.Client
 }
 
-func (i *FirstMateController) InjectClient(c client.Client) error {
-	i.client = c
+// InjectClient implements inject.Client interface.
+func (r *FirstMateController) InjectClient(c client.Client) error {
+	r.client = c
 	return nil
 }
 
 // Implement reconcile.Reconciler so the controller can reconcile objects
 var _ reconcile.Reconciler = &FirstMateController{}
 
+// Reconcile drives current state to desired state.
 func (r *FirstMateController) Reconcile(request reconcile.Request) (reconcile.Result, error) {
 	// set up a entryLog object so we don't have to type request over and over again
 	log := fmLog.WithValues("request", request)

examples/crd/config/firstmate_crd.yaml

@@ -22,17 +22,19 @@ import (
 
 	appsv1 "k8s.io/api/apps/v1"
 	_ "k8s.io/client-go/plugin/pkg/client/auth/gcp"
-	"sigs.k8s.io/controller-runtime/crdexample/logutil"
-	"sigs.k8s.io/controller-runtime/crdexample/pkg"
+	"sigs.k8s.io/controller-runtime/examples/crd/pkg"
 	"sigs.k8s.io/controller-runtime/pkg/builder"
 	"sigs.k8s.io/controller-runtime/pkg/client/config"
 	"sigs.k8s.io/controller-runtime/pkg/manager"
+	logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
 	"sigs.k8s.io/controller-runtime/pkg/runtime/signals"
 )
 
+var log = logf.Log.WithName("example-controller")
+
 func main() {
 	flag.Parse()
-	entryLog := logutil.Log.WithName("entrypoint")
+	entryLog := log.WithName("entrypoint")
 
 	entryLog.Info("setting up manager")
 	mgr, err := manager.New(config.GetConfigOrDie(), manager.Options{})

examples/crd/config/kustomization.yaml

@@ -14,10 +14,16 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-// Package v1 contains API Schema definitions for the crew v1 API group
+// Package pkg contains API Schema definitions for the crew v1 API group
 // +k8s:openapi-gen=true
 // +k8s:deepcopy-gen=package,register
 // +k8s:conversion-gen=sigs.k8s.io/kubebuilder/test/project/pkg/apis/crew
 // +k8s:defaulter-gen=TypeMeta
 // +groupName=crew.example.com
 package pkg
+
+import (
+	logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
+)
+
+var log = logf.Log.WithName("firstmate-resource")

examples/crd/config/manager_image_patch.yaml

@@ -22,17 +22,14 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/runtime/schema"
-	"sigs.k8s.io/controller-runtime/crdexample/logutil"
 	"sigs.k8s.io/controller-runtime/pkg/scheme"
-	"sigs.k8s.io/controller-runtime/pkg/webhook"
+	"sigs.k8s.io/controller-runtime/pkg/webhook/admission"
 )
 
 // +genclient
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 
-var log = logutil.Log.WithName("firstmate-resource")
-
-// firstMate is the Schema for the firstmates API
+// FirstMate is the Schema for the firstmates API
 // +k8s:openapi-gen=true
 type FirstMate struct {
 	metav1.TypeMeta   `json:",inline"`
@@ -54,7 +51,7 @@ type FirstMateStatus struct {
 	Location string
 }
 
-var _ webhook.Validator = &FirstMate{}
+var _ admission.Validator = &FirstMate{}
 
 // ValidateCreate implements webhookutil.validator so a webhook will be registered for the type
 func (f *FirstMate) ValidateCreate() error {
@@ -84,7 +81,7 @@ func (f *FirstMate) ValidateUpdate(old runtime.Object) error {
 	return nil
 }
 
-var _ webhook.Defaulter = &FirstMate{}
+var _ admission.Defaulter = &FirstMate{}
 
 // Default implements webhookutil.defaulter so a webhook will be registered for the type
 func (f *FirstMate) Default() {
@@ -119,8 +116,3 @@ var (
 	// AddToScheme is required by pkg/client/...
 	AddToScheme = SchemeBuilder.AddToScheme
 )
-
-// Resource is required by pkg/client/listers/...
-func Resource(resource string) schema.GroupResource {
-	return SchemeGroupVersion.WithResource(resource).GroupResource()
-}