You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The secret sync controller runs on managed clusters and syncs the `policy-encryption-key``Secret` from the Hub to the
10
-
managed cluster. This controller requires access to get, create, update, and delete `Secret` objects in
11
-
the managed cluster namespace. Since the managed cluster namespace is not known at build time, the
12
-
configuration in `deploy/operator.yaml` grants this access cluster wide. In a production
13
-
environment, limit this to just the managed cluster namespace.
10
+
managed cluster. This controller requires access to get, create, update, and delete `Secret` objects in the managed
11
+
cluster namespace. Since the managed cluster namespace is not known at build time, the configuration in
12
+
`deploy/operator.yaml` grants this access cluster wide. In a production environment, limit this to just the managed
13
+
cluster namespace.
14
14
15
15
### Spec Sync Controller
16
16
17
-
The spec sync controller runs on managed clusters, updating local `Policy` specs to match `Policies` in the cluster's namespace on the hub cluster.
17
+
The spec sync controller runs on managed clusters, updating local `Policy` specs to match `Policies` in the cluster's
18
+
namespace on the hub cluster.
18
19
19
-
The controller watches for changes to Policies in the cluster's namespace on the hub cluster to trigger a reconcile. Every reconcile creates/updates/deletes replicated policies on the managed cluster to match the spec from the hub cluster.
20
+
The controller watches for changes to Policies in the cluster's namespace on the hub cluster to trigger a reconcile.
21
+
Every reconcile creates/updates/deletes replicated policies on the managed cluster to match the spec from the hub
22
+
cluster.
20
23
21
24
### Status Sync Controller
22
25
23
-
The status sync controller runs on managed clusters, updating `Policy` statuses on both the hub and (local) managed clusters, based on events and changes in the managed cluster.
26
+
The status sync controller runs on managed clusters, updating `Policy` statuses on both the hub and (local) managed
27
+
clusters, based on events and changes in the managed cluster.
24
28
25
29
This controller watches for the following changes to trigger a reconcile:
26
30
@@ -33,9 +37,12 @@ Every reconcile does the following things:
33
37
34
38
### Template Sync Controller
35
39
36
-
The template sync controller runs on managed clusters and updates objects defined in the templates of `Policies` in the cluster namespace.
40
+
The template sync controller runs on managed clusters and updates objects defined in the templates of `Policies` in the
41
+
cluster namespace.
37
42
38
-
This controller watches for changes on `Policies` in the cluster namespace on the managed cluster to trigger a reconcile. On each reconcile, it creates/updates/deletes objects defined in the `spec.policy-templates` of those `Policies`.
43
+
This controller watches for changes on `Policies` in the cluster namespace on the managed cluster to trigger a
44
+
reconcile. On each reconcile, it creates/updates/deletes objects defined in the `spec.policy-templates` of those
45
+
`Policies`.
39
46
40
47
## Getting started
41
48
@@ -46,14 +53,17 @@ to learn how to get involved.
46
53
Check the [Security guide](SECURITY.md) if you need to report a security issue.
47
54
48
55
### Build and deploy locally
56
+
49
57
You will need [kind](https://kind.sigs.k8s.io/docs/user/quick-start/) installed.
50
58
51
59
```bash
52
60
make kind-bootstrap-cluster-dev
53
61
make build-images
54
62
make kind-deploy-controller-dev
55
63
```
64
+
56
65
### Running tests
66
+
57
67
```
58
68
make test-dependencies
59
69
make test
@@ -63,21 +73,22 @@ make e2e-test
63
73
```
64
74
65
75
### Clean up
76
+
66
77
```
67
78
make kind-delete-cluster
68
79
```
69
80
70
81
### deploy/operator.yaml
71
82
72
-
The `deploy/operator.yaml` file is generated via Kustomize. The `deploy/rbac` directory of
73
-
Kustomize files is managed by the operator-sdk and Kubebuilder using
74
-
[markers](https://book.kubebuilder.io/reference/markers.html). After updating the markers or
75
-
any of the Kustomize files, you may regenerate `deploy/operator.yaml` by running
83
+
The `deploy/operator.yaml` file is generated via Kustomize. The `deploy/rbac` directory of Kustomize files is managed by
84
+
the operator-sdk and Kubebuilder using [markers](https://book.kubebuilder.io/reference/markers.html). After updating the
85
+
markers or any of the Kustomize files, you may regenerate `deploy/operator.yaml` by running
76
86
`make generate-operator-yaml`.
77
87
78
88
## References
79
89
80
-
- The `governance-policy-framework-addon` is part of the `open-cluster-management` community. For more information, visit: [open-cluster-management.io](https://open-cluster-management.io).
90
+
- The `governance-policy-framework-addon` is part of the `open-cluster-management` community. For more information,
0 commit comments