Skip to content

Commit ee2ffbf

Browse files
versioning in docs, title fix
Signed-off-by: James Milligan <[email protected]>
1 parent ed7c3b4 commit ee2ffbf

File tree

3 files changed

+22
-17
lines changed

3 files changed

+22
-17
lines changed

docs/installation.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,6 @@ kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/
1212
kubectl wait --for=condition=Available=True deploy --all -n 'cert-manager'
1313
```
1414

15-
## kubectl
16-
Apply the release yaml directly via kubectl
17-
```
18-
kubectl create namespace open-feature-operator-system
19-
kubectl apply -f https://github.com/open-feature/open-feature-operator/releases/download/v0.2.20/release.yaml
20-
```
21-
### Uninstall
22-
```
23-
kubectl delete -f https://github.com/open-feature/open-feature-operator/releases/download/v0.2.20/release.yaml
24-
kubectl delete namespace open-feature-operator-system
25-
```
26-
2715
## Helm
2816

2917
Add the chart repository to helm:
@@ -39,6 +27,22 @@ helm install ofo openfeature/ofo
3927
helm uninstall ofo
4028
```
4129

30+
## kubectl
31+
Apply the release yaml directly via kubectl
32+
<!---x-release-please-start-version-->
33+
```
34+
kubectl create namespace open-feature-operator-system
35+
kubectl apply -f https://github.com/open-feature/open-feature-operator/releases/download/v0.2.20/release.yaml
36+
```
37+
<!---x-release-please-end-->
38+
### Uninstall
39+
<!---x-release-please-start-version-->
40+
```
41+
kubectl delete -f https://github.com/open-feature/open-feature-operator/releases/download/v0.2.20/release.yaml
42+
kubectl delete namespace open-feature-operator-system
43+
```
44+
<!---x-release-please-end-->
45+
4246
## Release contents
4347
- `FeatureFlagConfiguration` `CustomResourceDefinition` (custom type that holds the configured state of feature flags).
4448
- Standard kubernetes primitives (e.g. namespace, accounts, roles, bindings, configmaps).

docs/permissions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The open feature operator uses the `open-feature-operator-controller-manager` se
66
- `open-feature-operator-proxy-role` (role name: `proxy-role`)
77
- `open-feature-operator-flagd-kubernetes-sync` (role name: `flagd-kubernetes-sync`)
88

9-
### leader-election-role
9+
### Leader Election Role
1010

1111
The `leader-election-role` provides the operator with the required permissions to perform leader election.
1212
The definition of this role can be found [here](../config/rbac//leader_election_role.yaml)
@@ -18,7 +18,7 @@ The definition of this role can be found [here](../config/rbac//leader_election_
1818
| `coordination.k8s.io` | `Lease` | create, delete, get, list, patch, update, watch |
1919

2020

21-
### manager-role
21+
### Manager Role
2222

2323
The `manager-role` applies the rules described below, its definition can be found [here](../config/rbac/role.yaml). It provides the operator with sufficient permissions over the `core.openfeature.dev` resources, and the required permissions for injecting the `flagd` sidecar into appropriate pods. The `ConfigMap` permissions are needed to allow the mounting of `FeatureFlagConfiguration` resources for filepath syncs.
2424

@@ -32,7 +32,7 @@ The `manager-role` applies the rules described below, its definition can be foun
3232
| `core.openfeature.dev` | `FeatureFlagConfiguration Status` | get, patch, update |
3333
| `rbac.authorization.k8s.io` | `*` | * |
3434

35-
### proxy-role
35+
### Proxy Role
3636

3737
The `proxy-role` definition can be found [here](../config/rbac/auth_proxy_role.yaml)
3838

@@ -41,7 +41,7 @@ The `proxy-role` definition can be found [here](../config/rbac/auth_proxy_role.y
4141
| `authentication.k8s.io` | `Token Review` | create |
4242
| `authentication.k8s.io` | `Subject Access Review` | create |
4343

44-
### flagd-kubernetes-sync
44+
### Flagd Kubernetes Sync
4545

4646
The `flagd-kubernetes-sync` role providers the permission to get, watch and list all `core.openfeature.dev` resources, permitting the kubernetes sync feature in injected `flagd` containers.
4747
Its definition can be found [here](../config/rbac/flagd_kubernetes_sync_clusterrole.yaml)

release-please-config.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@
1010
"README.md",
1111
"chart/Chart.yaml",
1212
"chart/values.yaml",
13-
"Makefile"
13+
"Makefile",
14+
"docs/installation.md"
1415
]
1516
}
1617
}

0 commit comments

Comments
 (0)