chore: update differences (#34)

* chore: update differences

* chore: update readme titles

* chore: update diffs

* chore: add a pull request template to avoid multiple PRs next time the project gets updated

* chore: prevent changes to PR template to trigger CI

.github/workflows/ci.yml

@@ -5,6 +5,7 @@ on:
     branches: [main]
   pull_request:
     paths-ignore:
+      - '.github/workflows/pull_request_template.md'
       - 'doc/**'
       - 'README.md'
 

.github/workflows/pull_request_template.md

@@ -0,0 +1,12 @@
+## Description
+
+TODO: Describe your changes.
+
+## Checklist
+
+- [ ] ✨ A brand new operator has been created using the new [kubebuilder](https://github.com/kubernetes-sigs/kubebuilder) version.
+- [ ] 🧪 The operator was tested agaisnt a local kubernetes cluster.
+- [ ] ✏️ The main `README.md` has been updated (especially the `diff` section).
+- [ ] ✏️ The [Medium articles](https://medium.com/@leovct/list/kubernetes-operators-101-dcfcc4cb52f6) have been updated.
+- [ ] ✏️ The [personal website articles](https://github.com/leovct/leovct.github.io/tree/main/content/posts/kubernetes) have been updated.
+- [ ] 🌟 A new release will be created, following [kubebuilder](https://github.com/kubernetes-sigs/kubebuilder)'s versions.

README.md

@@ -48,19 +48,27 @@ diff --color -r operator-v1/api/v1/foo_types.go operator-v2/api/v1/foo_types.go
 >
 > 	// Foo's favorite colour
 > 	Colour string `json:"colour,omitempty"`
-Binary files operator-v1/bin/kustomize and operator-v2/bin/kustomize differ
-Binary files operator-v1/bin/setup-envtest and operator-v2/bin/setup-envtest differ
+Only in operator-v2/bin: k8s
+Only in operator-v1/bin: kustomize
+Binary files operator-v1/bin/manager and operator-v2/bin/manager differ
+Only in operator-v2/bin: setup-envtest
 diff --color -r operator-v1/config/crd/bases/tutorial.my.domain_foos.yaml operator-v2/config/crd/bases/tutorial.my.domain_foos.yaml
 45a46,48
 >               colour:
 >                 description: Foo's favorite colour
 >                 type: string
+Only in operator-v2: cover.out
 Only in operator-v2/internal: color
 diff --color -r operator-v1/internal/controller/foo_controller.go operator-v2/internal/controller/foo_controller.go
 31a32
 > 	"my.domain/tutorial/internal/color"
-75a77
+76a78
 > 	foo.Status.Colour = color.ConvertStrToColor(foo.Name + foo.Namespace)
+diff --color -r operator-v1/internal/controller/suite_test.go operator-v2/internal/controller/suite_test.go
+66c66
+< 			fmt.Sprintf("1.28.3-%s-%s", runtime.GOOS, runtime.GOARCH)),
+---
+> 			fmt.Sprintf("1.28.0-%s-%s", runtime.GOOS, runtime.GOARCH)),
 ```
 
 ### `v2` <> `v2-with-tests`
@@ -72,12 +80,7 @@ diff --color -r operator-v2/README.md operator-v2-with-tests/README.md
 < # operator-v2
 ---
 > # operator-v2-with-tests
-Only in operator-v2-with-tests/bin: manager
-diff --color -r operator-v2/go.mod operator-v2-with-tests/go.mod
-7a8
-> 	k8s.io/api v0.28.0
-64d64
-< 	k8s.io/api v0.28.0 // indirect
+Binary files operator-v2/bin/manager and operator-v2-with-tests/bin/manager differ
 Only in operator-v2-with-tests/internal/color: color_test.go
 Only in operator-v2-with-tests/internal/controller: foo_controller_test.go
 diff --color -r operator-v2/internal/controller/suite_test.go operator-v2-with-tests/internal/controller/suite_test.go
@@ -100,6 +103,10 @@ diff --color -r operator-v2/internal/controller/suite_test.go operator-v2-with-t
 > )
 53a61
 > 	ctx, cancel = context.WithCancel(context.TODO())
+66c74
+< 			fmt.Sprintf("1.28.0-%s-%s", runtime.GOOS, runtime.GOARCH)),
+---
+> 			fmt.Sprintf("1.28.3-%s-%s", runtime.GOOS, runtime.GOARCH)),
 83a92,108
 > 	// Register and start the Foo controller
 > 	k8sManager, err := ctrl.NewManager(cfg, ctrl.Options{

operator-v1/PROJECT

@@ -5,7 +5,7 @@
 domain: my.domain
 layout:
 - go.kubebuilder.io/v4
-projectName: operator-v1
+projectName: operator
 repo: my.domain/tutorial
 resources:
 - api:

operator-v1/README.md

@@ -16,7 +16,7 @@
 **Build and push your image to the location specified by `IMG`:**
 
 ```sh
-make docker-build docker-push IMG=<some-registry>/operator-v1:tag
+make docker-build docker-push IMG=<some-registry>/operator:tag
 ```
 
 **NOTE:** This image ought to be published in the personal registry you specified.
@@ -32,7 +32,7 @@ make install
 **Deploy the Manager to the cluster with the image specified by `IMG`:**
 
 ```sh
-make deploy IMG=<some-registry>/operator-v1:tag
+make deploy IMG=<some-registry>/operator:tag
 ```
 
 > **NOTE**: If you encounter RBAC errors, you may need to grant yourself cluster-admin

operator-v1/config/default/kustomization.yaml

@@ -1,12 +1,12 @@
 # Adds namespace to all resources.
-namespace: operator-v1-system
+namespace: operator-system
 
 # Value of this field is prepended to the
 # names of all resources, e.g. a deployment named
 # "wordpress" becomes "alices-wordpress".
 # Note that it should also match with the prefix (text before '-') of the namespace
 # field above.
-namePrefix: operator-v1-
+namePrefix: operator-
 
 # Labels to add to all resources and selectors.
 #labels:

operator-v1/config/manager/manager.yaml

@@ -6,8 +6,8 @@ metadata:
     app.kubernetes.io/name: namespace
     app.kubernetes.io/instance: system
     app.kubernetes.io/component: manager
-    app.kubernetes.io/created-by: operator-v1
-    app.kubernetes.io/part-of: operator-v1
+    app.kubernetes.io/created-by: operator
+    app.kubernetes.io/part-of: operator
     app.kubernetes.io/managed-by: kustomize
   name: system
 ---
@@ -21,8 +21,8 @@ metadata:
     app.kubernetes.io/name: deployment
     app.kubernetes.io/instance: controller-manager
     app.kubernetes.io/component: manager
-    app.kubernetes.io/created-by: operator-v1
-    app.kubernetes.io/part-of: operator-v1
+    app.kubernetes.io/created-by: operator
+    app.kubernetes.io/part-of: operator
     app.kubernetes.io/managed-by: kustomize
 spec:
   selector:

operator-v1/config/prometheus/monitor.yaml

@@ -7,8 +7,8 @@ metadata:
     app.kubernetes.io/name: servicemonitor
     app.kubernetes.io/instance: controller-manager-metrics-monitor
     app.kubernetes.io/component: metrics
-    app.kubernetes.io/created-by: operator-v1
-    app.kubernetes.io/part-of: operator-v1
+    app.kubernetes.io/created-by: operator
+    app.kubernetes.io/part-of: operator
     app.kubernetes.io/managed-by: kustomize
   name: controller-manager-metrics-monitor
   namespace: system

operator-v1/config/rbac/auth_proxy_client_clusterrole.yaml

@@ -5,8 +5,8 @@ metadata:
     app.kubernetes.io/name: clusterrole
     app.kubernetes.io/instance: metrics-reader
     app.kubernetes.io/component: kube-rbac-proxy
-    app.kubernetes.io/created-by: operator-v1
-    app.kubernetes.io/part-of: operator-v1
+    app.kubernetes.io/created-by: operator
+    app.kubernetes.io/part-of: operator
     app.kubernetes.io/managed-by: kustomize
   name: metrics-reader
 rules:

operator-v1/config/rbac/auth_proxy_role.yaml

@@ -5,8 +5,8 @@ metadata:
     app.kubernetes.io/name: clusterrole
     app.kubernetes.io/instance: proxy-role
     app.kubernetes.io/component: kube-rbac-proxy
-    app.kubernetes.io/created-by: operator-v1
-    app.kubernetes.io/part-of: operator-v1
+    app.kubernetes.io/created-by: operator
+    app.kubernetes.io/part-of: operator
     app.kubernetes.io/managed-by: kustomize
   name: proxy-role
 rules:

operator-v1/config/rbac/auth_proxy_role_binding.yaml

@@ -5,8 +5,8 @@ metadata:
     app.kubernetes.io/name: clusterrolebinding
     app.kubernetes.io/instance: proxy-rolebinding
     app.kubernetes.io/component: kube-rbac-proxy
-    app.kubernetes.io/created-by: operator-v1
-    app.kubernetes.io/part-of: operator-v1
+    app.kubernetes.io/created-by: operator
+    app.kubernetes.io/part-of: operator
     app.kubernetes.io/managed-by: kustomize
   name: proxy-rolebinding
 roleRef:

operator-v1/config/rbac/auth_proxy_service.yaml

@@ -6,8 +6,8 @@ metadata:
     app.kubernetes.io/name: service
     app.kubernetes.io/instance: controller-manager-metrics-service
     app.kubernetes.io/component: kube-rbac-proxy
-    app.kubernetes.io/created-by: operator-v1
-    app.kubernetes.io/part-of: operator-v1
+    app.kubernetes.io/created-by: operator
+    app.kubernetes.io/part-of: operator
     app.kubernetes.io/managed-by: kustomize
   name: controller-manager-metrics-service
   namespace: system

operator-v1/config/rbac/foo_editor_role.yaml

@@ -6,8 +6,8 @@ metadata:
     app.kubernetes.io/name: clusterrole
     app.kubernetes.io/instance: foo-editor-role
     app.kubernetes.io/component: rbac
-    app.kubernetes.io/created-by: operator-v1
-    app.kubernetes.io/part-of: operator-v1
+    app.kubernetes.io/created-by: operator
+    app.kubernetes.io/part-of: operator
     app.kubernetes.io/managed-by: kustomize
   name: foo-editor-role
 rules:

operator-v1/config/rbac/foo_viewer_role.yaml

@@ -6,8 +6,8 @@ metadata:
     app.kubernetes.io/name: clusterrole
     app.kubernetes.io/instance: foo-viewer-role
     app.kubernetes.io/component: rbac
-    app.kubernetes.io/created-by: operator-v1
-    app.kubernetes.io/part-of: operator-v1
+    app.kubernetes.io/created-by: operator
+    app.kubernetes.io/part-of: operator
     app.kubernetes.io/managed-by: kustomize
   name: foo-viewer-role
 rules:

operator-v1/config/rbac/leader_election_role.yaml

@@ -6,8 +6,8 @@ metadata:
     app.kubernetes.io/name: role
     app.kubernetes.io/instance: leader-election-role
     app.kubernetes.io/component: rbac
-    app.kubernetes.io/created-by: operator-v1
-    app.kubernetes.io/part-of: operator-v1
+    app.kubernetes.io/created-by: operator
+    app.kubernetes.io/part-of: operator
     app.kubernetes.io/managed-by: kustomize
   name: leader-election-role
 rules:

operator-v1/config/rbac/leader_election_role_binding.yaml

@@ -5,8 +5,8 @@ metadata:
     app.kubernetes.io/name: rolebinding
     app.kubernetes.io/instance: leader-election-rolebinding
     app.kubernetes.io/component: rbac
-    app.kubernetes.io/created-by: operator-v1
-    app.kubernetes.io/part-of: operator-v1
+    app.kubernetes.io/created-by: operator
+    app.kubernetes.io/part-of: operator
     app.kubernetes.io/managed-by: kustomize
   name: leader-election-rolebinding
 roleRef:

operator-v1/config/rbac/role_binding.yaml

@@ -5,8 +5,8 @@ metadata:
     app.kubernetes.io/name: clusterrolebinding
     app.kubernetes.io/instance: manager-rolebinding
     app.kubernetes.io/component: rbac
-    app.kubernetes.io/created-by: operator-v1
-    app.kubernetes.io/part-of: operator-v1
+    app.kubernetes.io/created-by: operator
+    app.kubernetes.io/part-of: operator
     app.kubernetes.io/managed-by: kustomize
   name: manager-rolebinding
 roleRef:

operator-v1/config/rbac/service_account.yaml

@@ -5,8 +5,8 @@ metadata:
     app.kubernetes.io/name: serviceaccount
     app.kubernetes.io/instance: controller-manager-sa
     app.kubernetes.io/component: rbac
-    app.kubernetes.io/created-by: operator-v1
-    app.kubernetes.io/part-of: operator-v1
+    app.kubernetes.io/created-by: operator
+    app.kubernetes.io/part-of: operator
     app.kubernetes.io/managed-by: kustomize
   name: controller-manager
   namespace: system

operator-v1/config/samples/tutorial_v1_foo.yaml

@@ -4,9 +4,9 @@ metadata:
   labels:
     app.kubernetes.io/name: foo
     app.kubernetes.io/instance: foo-sample
-    app.kubernetes.io/part-of: operator-v1
+    app.kubernetes.io/part-of: operator
     app.kubernetes.io/managed-by: kustomize
-    app.kubernetes.io/created-by: operator-v1
+    app.kubernetes.io/created-by: operator
   name: foo-01
 spec:
   name: jack
@@ -18,9 +18,9 @@ metadata:
   labels:
     app.kubernetes.io/name: foo
     app.kubernetes.io/instance: foo-sample
-    app.kubernetes.io/part-of: operator-v1
+    app.kubernetes.io/part-of: operator
     app.kubernetes.io/managed-by: kustomize
-    app.kubernetes.io/created-by: operator-v1
+    app.kubernetes.io/created-by: operator
   name: foo-02
 spec:
   name: joe

operator-v2-with-tests/PROJECT

@@ -5,7 +5,7 @@
 domain: my.domain
 layout:
 - go.kubebuilder.io/v4
-projectName: operator-v2
+projectName: operator
 repo: my.domain/tutorial
 resources:
 - api:

operator-v2-with-tests/README.md

@@ -1,4 +1,4 @@
-# operator-v2
+# operator-v2-with-tests
 // TODO(user): Add simple overview of use/purpose
 
 ## Description
@@ -16,7 +16,7 @@
 **Build and push your image to the location specified by `IMG`:**
 
 ```sh
-make docker-build docker-push IMG=<some-registry>/operator-v2:tag
+make docker-build docker-push IMG=<some-registry>/operator:tag
 ```
 
 **NOTE:** This image ought to be published in the personal registry you specified.
@@ -32,7 +32,7 @@ make install
 **Deploy the Manager to the cluster with the image specified by `IMG`:**
 
 ```sh
-make deploy IMG=<some-registry>/operator-v2:tag
+make deploy IMG=<some-registry>/operator:tag
 ```
 
 > **NOTE**: If you encounter RBAC errors, you may need to grant yourself cluster-admin

operator-v2-with-tests/config/default/kustomization.yaml

@@ -1,12 +1,12 @@
 # Adds namespace to all resources.
-namespace: operator-v2-system
+namespace: operator-system
 
 # Value of this field is prepended to the
 # names of all resources, e.g. a deployment named
 # "wordpress" becomes "alices-wordpress".
 # Note that it should also match with the prefix (text before '-') of the namespace
 # field above.
-namePrefix: operator-v2-
+namePrefix: operator-
 
 # Labels to add to all resources and selectors.
 #labels:

operator-v2-with-tests/config/manager/manager.yaml

@@ -6,8 +6,8 @@ metadata:
     app.kubernetes.io/name: namespace
     app.kubernetes.io/instance: system
     app.kubernetes.io/component: manager
-    app.kubernetes.io/created-by: operator-v2
-    app.kubernetes.io/part-of: operator-v2
+    app.kubernetes.io/created-by: operator
+    app.kubernetes.io/part-of: operator
     app.kubernetes.io/managed-by: kustomize
   name: system
 ---
@@ -21,8 +21,8 @@ metadata:
     app.kubernetes.io/name: deployment
     app.kubernetes.io/instance: controller-manager
     app.kubernetes.io/component: manager
-    app.kubernetes.io/created-by: operator-v2
-    app.kubernetes.io/part-of: operator-v2
+    app.kubernetes.io/created-by: operator
+    app.kubernetes.io/part-of: operator
     app.kubernetes.io/managed-by: kustomize
 spec:
   selector:

operator-v2-with-tests/config/prometheus/monitor.yaml

@@ -7,8 +7,8 @@ metadata:
     app.kubernetes.io/name: servicemonitor
     app.kubernetes.io/instance: controller-manager-metrics-monitor
     app.kubernetes.io/component: metrics
-    app.kubernetes.io/created-by: operator-v2
-    app.kubernetes.io/part-of: operator-v2
+    app.kubernetes.io/created-by: operator
+    app.kubernetes.io/part-of: operator
     app.kubernetes.io/managed-by: kustomize
   name: controller-manager-metrics-monitor
   namespace: system

operator-v2-with-tests/config/rbac/auth_proxy_client_clusterrole.yaml

@@ -5,8 +5,8 @@ metadata:
     app.kubernetes.io/name: clusterrole
     app.kubernetes.io/instance: metrics-reader
     app.kubernetes.io/component: kube-rbac-proxy
-    app.kubernetes.io/created-by: operator-v2
-    app.kubernetes.io/part-of: operator-v2
+    app.kubernetes.io/created-by: operator
+    app.kubernetes.io/part-of: operator
     app.kubernetes.io/managed-by: kustomize
   name: metrics-reader
 rules:

operator-v2-with-tests/config/rbac/auth_proxy_role.yaml

@@ -5,8 +5,8 @@ metadata:
     app.kubernetes.io/name: clusterrole
     app.kubernetes.io/instance: proxy-role
     app.kubernetes.io/component: kube-rbac-proxy
-    app.kubernetes.io/created-by: operator-v2
-    app.kubernetes.io/part-of: operator-v2
+    app.kubernetes.io/created-by: operator
+    app.kubernetes.io/part-of: operator
     app.kubernetes.io/managed-by: kustomize
   name: proxy-role
 rules:

operator-v2-with-tests/config/rbac/auth_proxy_role_binding.yaml

@@ -5,8 +5,8 @@ metadata:
     app.kubernetes.io/name: clusterrolebinding
     app.kubernetes.io/instance: proxy-rolebinding
     app.kubernetes.io/component: kube-rbac-proxy
-    app.kubernetes.io/created-by: operator-v2
-    app.kubernetes.io/part-of: operator-v2
+    app.kubernetes.io/created-by: operator
+    app.kubernetes.io/part-of: operator
     app.kubernetes.io/managed-by: kustomize
   name: proxy-rolebinding
 roleRef: