Skip to content
This repository was archived by the owner on Jan 22, 2026. It is now read-only.

Commit fb45164

Browse files
authored
doc: update diff section (#32)
* chore: update operators name * chore: add operator name in README * chore: update operator-v2-with-tests dependency to match other operators dependencies * chore: go mod tidy * doc: update diff
1 parent 6bed3b5 commit fb45164

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+158
-150
lines changed

README.md

Lines changed: 49 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -44,21 +44,23 @@ diff --color -r operator-v1/README.md operator-v2/README.md
4444
---
4545
> # operator-v2
4646
diff --color -r operator-v1/api/v1/foo_types.go operator-v2/api/v1/foo_types.go
47-
32a33,35
47+
33a34,36
4848
>
49-
> // Foo's favorite colour
50-
> Colour string `json:"colour,omitempty"`
51-
Only in operator-v2: color
49+
> // Foo's favorite colour
50+
> Colour string `json:"colour,omitempty"`
51+
Binary files operator-v1/bin/kustomize and operator-v2/bin/kustomize differ
52+
Binary files operator-v1/bin/setup-envtest and operator-v2/bin/setup-envtest differ
5253
diff --color -r operator-v1/config/crd/bases/tutorial.my.domain_foos.yaml operator-v2/config/crd/bases/tutorial.my.domain_foos.yaml
53-
46a47,49
54+
45a46,48
5455
> colour:
5556
> description: Foo's favorite colour
5657
> type: string
57-
diff --color -r operator-v1/controllers/foo_controller.go operator-v2/controllers/foo_controller.go
58-
32a33
59-
> color "my.domain/tutorial/color"
60-
77a79
61-
> foo.Status.Colour = color.ConvertStrToColor(foo.Name + foo.Namespace)
58+
Only in operator-v2/internal: color
59+
diff --color -r operator-v1/internal/controller/foo_controller.go operator-v2/internal/controller/foo_controller.go
60+
31a32
61+
> "my.domain/tutorial/internal/color"
62+
75a77
63+
> foo.Status.Colour = color.ConvertStrToColor(foo.Name + foo.Namespace)
6264
```
6365

6466
### `v2` <> `v2-with-tests`
@@ -70,46 +72,52 @@ diff --color -r operator-v2/README.md operator-v2-with-tests/README.md
7072
< # operator-v2
7173
---
7274
> # operator-v2-with-tests
73-
Only in operator-v2-with-tests/color: color_test.go
74-
Only in operator-v2-with-tests/controllers: foo_controller_test.go
75-
diff --color -r operator-v2/controllers/suite_test.go operator-v2-with-tests/controllers/suite_test.go
75+
Only in operator-v2-with-tests/bin: manager
76+
diff --color -r operator-v2/go.mod operator-v2-with-tests/go.mod
77+
7a8
78+
> k8s.io/api v0.28.0
79+
64d64
80+
< k8s.io/api v0.28.0 // indirect
81+
Only in operator-v2-with-tests/internal/color: color_test.go
82+
Only in operator-v2-with-tests/internal/controller: foo_controller_test.go
83+
diff --color -r operator-v2/internal/controller/suite_test.go operator-v2-with-tests/internal/controller/suite_test.go
7684
19a20
77-
> "context"
78-
22a24,25
79-
> ctrl "sigs.k8s.io/controller-runtime"
85+
> "context"
86+
24a26,27
87+
> ctrl "sigs.k8s.io/controller-runtime"
8088
>
81-
40,42c43,49
89+
42,44c45,51
8290
< var cfg *rest.Config
8391
< var k8sClient client.Client
8492
< var testEnv *envtest.Environment
8593
---
8694
> var (
87-
> cfg *rest.Config
88-
> k8sClient client.Client
89-
> testEnv *envtest.Environment
90-
> ctx context.Context
91-
> cancel context.CancelFunc
95+
> cfg *rest.Config
96+
> k8sClient client.Client
97+
> testEnv *envtest.Environment
98+
> ctx context.Context
99+
> cancel context.CancelFunc
92100
> )
93101
53a61
94-
> ctx, cancel = context.WithCancel(context.TODO())
95-
75a84,100
96-
> // Register and start the Foo controller
97-
> k8sManager, err := ctrl.NewManager(cfg, ctrl.Options{
98-
> Scheme: scheme.Scheme,
99-
> })
100-
> Expect(err).ToNot(HaveOccurred())
102+
> ctx, cancel = context.WithCancel(context.TODO())
103+
83a92,108
104+
> // Register and start the Foo controller
105+
> k8sManager, err := ctrl.NewManager(cfg, ctrl.Options{
106+
> Scheme: scheme.Scheme,
107+
> })
108+
> Expect(err).ToNot(HaveOccurred())
101109
>
102-
> err = (&FooReconciler{
103-
> Client: k8sManager.GetClient(),
104-
> Scheme: k8sManager.GetScheme(),
105-
> }).SetupWithManager(k8sManager)
106-
> Expect(err).ToNot(HaveOccurred())
110+
> err = (&FooReconciler{
111+
> Client: k8sManager.GetClient(),
112+
> Scheme: k8sManager.GetScheme(),
113+
> }).SetupWithManager(k8sManager)
114+
> Expect(err).ToNot(HaveOccurred())
107115
>
108-
> go func() {
109-
> defer GinkgoRecover()
110-
> err = k8sManager.Start(ctx)
111-
> Expect(err).ToNot(HaveOccurred(), "failed to run manager")
112-
> }()
113-
78a104
114-
> cancel()
116+
> go func() {
117+
> defer GinkgoRecover()
118+
> err = k8sManager.Start(ctx)
119+
> Expect(err).ToNot(HaveOccurred(), "failed to run manager")
120+
> }()
121+
86a112
122+
> cancel()
115123
```

operator-v1/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ kubectl apply -k config/samples/
1818
2. Build and push your image to the location specified by `IMG`:
1919

2020
```sh
21-
make docker-build docker-push IMG=<some-registry>/operator-v1:tag
21+
make docker-build docker-push IMG=<some-registry>/operator:tag
2222
```
2323

2424
3. Deploy the controller to the cluster with the image specified by `IMG`:
2525

2626
```sh
27-
make deploy IMG=<some-registry>/operator-v1:tag
27+
make deploy IMG=<some-registry>/operator:tag
2828
```
2929

3030
### Uninstall CRDs

operator-v1/config/default/kustomization.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Adds namespace to all resources.
2-
namespace: operator-v1-system
2+
namespace: operator-system
33

44
# Value of this field is prepended to the
55
# names of all resources, e.g. a deployment named
66
# "wordpress" becomes "alices-wordpress".
77
# Note that it should also match with the prefix (text before '-') of the namespace
88
# field above.
9-
namePrefix: operator-v1-
9+
namePrefix: operator-
1010

1111
# Labels to add to all resources and selectors.
1212
#labels:

operator-v1/config/manager/manager.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ metadata:
66
app.kubernetes.io/name: namespace
77
app.kubernetes.io/instance: system
88
app.kubernetes.io/component: manager
9-
app.kubernetes.io/created-by: operator-v1
10-
app.kubernetes.io/part-of: operator-v1
9+
app.kubernetes.io/created-by: operator
10+
app.kubernetes.io/part-of: operator
1111
app.kubernetes.io/managed-by: kustomize
1212
name: system
1313
---
@@ -21,8 +21,8 @@ metadata:
2121
app.kubernetes.io/name: deployment
2222
app.kubernetes.io/instance: controller-manager
2323
app.kubernetes.io/component: manager
24-
app.kubernetes.io/created-by: operator-v1
25-
app.kubernetes.io/part-of: operator-v1
24+
app.kubernetes.io/created-by: operator
25+
app.kubernetes.io/part-of: operator
2626
app.kubernetes.io/managed-by: kustomize
2727
spec:
2828
selector:

operator-v1/config/prometheus/monitor.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ metadata:
88
app.kubernetes.io/name: servicemonitor
99
app.kubernetes.io/instance: controller-manager-metrics-monitor
1010
app.kubernetes.io/component: metrics
11-
app.kubernetes.io/created-by: operator-v1
12-
app.kubernetes.io/part-of: operator-v1
11+
app.kubernetes.io/created-by: operator
12+
app.kubernetes.io/part-of: operator
1313
app.kubernetes.io/managed-by: kustomize
1414
name: controller-manager-metrics-monitor
1515
namespace: system

operator-v1/config/rbac/auth_proxy_client_clusterrole.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ metadata:
55
app.kubernetes.io/name: clusterrole
66
app.kubernetes.io/instance: metrics-reader
77
app.kubernetes.io/component: kube-rbac-proxy
8-
app.kubernetes.io/created-by: operator-v1
9-
app.kubernetes.io/part-of: operator-v1
8+
app.kubernetes.io/created-by: operator
9+
app.kubernetes.io/part-of: operator
1010
app.kubernetes.io/managed-by: kustomize
1111
name: metrics-reader
1212
rules:

operator-v1/config/rbac/auth_proxy_role.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ metadata:
55
app.kubernetes.io/name: clusterrole
66
app.kubernetes.io/instance: proxy-role
77
app.kubernetes.io/component: kube-rbac-proxy
8-
app.kubernetes.io/created-by: operator-v1
9-
app.kubernetes.io/part-of: operator-v1
8+
app.kubernetes.io/created-by: operator
9+
app.kubernetes.io/part-of: operator
1010
app.kubernetes.io/managed-by: kustomize
1111
name: proxy-role
1212
rules:

operator-v1/config/rbac/auth_proxy_role_binding.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ metadata:
55
app.kubernetes.io/name: clusterrolebinding
66
app.kubernetes.io/instance: proxy-rolebinding
77
app.kubernetes.io/component: kube-rbac-proxy
8-
app.kubernetes.io/created-by: operator-v1
9-
app.kubernetes.io/part-of: operator-v1
8+
app.kubernetes.io/created-by: operator
9+
app.kubernetes.io/part-of: operator
1010
app.kubernetes.io/managed-by: kustomize
1111
name: proxy-rolebinding
1212
roleRef:

operator-v1/config/rbac/auth_proxy_service.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ metadata:
66
app.kubernetes.io/name: service
77
app.kubernetes.io/instance: controller-manager-metrics-service
88
app.kubernetes.io/component: kube-rbac-proxy
9-
app.kubernetes.io/created-by: operator-v1
10-
app.kubernetes.io/part-of: operator-v1
9+
app.kubernetes.io/created-by: operator
10+
app.kubernetes.io/part-of: operator
1111
app.kubernetes.io/managed-by: kustomize
1212
name: controller-manager-metrics-service
1313
namespace: system

operator-v1/config/rbac/foo_editor_role.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ metadata:
66
app.kubernetes.io/name: clusterrole
77
app.kubernetes.io/instance: foo-editor-role
88
app.kubernetes.io/component: rbac
9-
app.kubernetes.io/created-by: operator-v1
10-
app.kubernetes.io/part-of: operator-v1
9+
app.kubernetes.io/created-by: operator
10+
app.kubernetes.io/part-of: operator
1111
app.kubernetes.io/managed-by: kustomize
1212
name: foo-editor-role
1313
rules:

0 commit comments

Comments
 (0)