Skip to content

Commit 9448e79

Browse files
dhaiducekopenshift-merge-robot
authored andcommitted
Reflow the README
Signed-off-by: Dale Haiducek <[email protected]>
1 parent e1d13ad commit 9448e79

File tree

1 file changed

+26
-15
lines changed

1 file changed

+26
-15
lines changed

README.md

Lines changed: 26 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[comment]: # ( Copyright Contributors to the Open Cluster Management project )
1+
[comment]: # " Copyright Contributors to the Open Cluster Management project "
22

33
# Governance Policy Framework Addon [![KinD tests](https://github.com/open-cluster-management-io/governance-policy-framework-addon/actions/workflows/kind.yml/badge.svg?branch=main&event=push)](https://github.com/open-cluster-management-io/governance-policy-framework-addon/actions/workflows/kind.yml)[![License](https://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
44

@@ -7,20 +7,24 @@
77
### Secret Sync Controller
88

99
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.
1414

1515
### Spec Sync Controller
1616

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.
1819

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.
2023

2124
### Status Sync Controller
2225

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.
2428

2529
This controller watches for the following changes to trigger a reconcile:
2630

@@ -33,9 +37,12 @@ Every reconcile does the following things:
3337

3438
### Template Sync Controller
3539

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.
3742

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`.
3946

4047
## Getting started
4148

@@ -46,14 +53,17 @@ to learn how to get involved.
4653
Check the [Security guide](SECURITY.md) if you need to report a security issue.
4754

4855
### Build and deploy locally
56+
4957
You will need [kind](https://kind.sigs.k8s.io/docs/user/quick-start/) installed.
5058

5159
```bash
5260
make kind-bootstrap-cluster-dev
5361
make build-images
5462
make kind-deploy-controller-dev
5563
```
64+
5665
### Running tests
66+
5767
```
5868
make test-dependencies
5969
make test
@@ -63,21 +73,22 @@ make e2e-test
6373
```
6474

6575
### Clean up
76+
6677
```
6778
make kind-delete-cluster
6879
```
6980

7081
### deploy/operator.yaml
7182

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
7686
`make generate-operator-yaml`.
7787

7888
## References
7989

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,
91+
visit: [open-cluster-management.io](https://open-cluster-management.io).
8192

8293
<!---
8394
Date: 2022-11-28

0 commit comments

Comments
 (0)