Skip to content

Commit 0befb8f

Browse files
chore: adding troubleshooting guide (#501)
Signed-off-by: Kavindu Dodanduwa <[email protected]>
1 parent 1620a08 commit 0befb8f

File tree

2 files changed

+31
-0
lines changed

2 files changed

+31
-0
lines changed

docs/quick_start.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,11 @@ The output should be the following,
177177
This response is produced from flagd feature provider sidecar deployment, controlled by the operator and shows how
178178
operator pattern works end to end.
179179

180+
If you are facing errors or if things are not working,
181+
182+
- See if our troubleshooting guide helps: [Troubleshooting](./troubleshoot.md)
183+
- Reach us with a detailed issue: [Create issue](https://github.com/open-feature/open-feature-operator/issues/new)
184+
180185
### What's next ?
181186

182187
- Learn more about core concepts behind operator: [concepts](./concepts.md)

docs/troubleshoot.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Troubleshooting
2+
3+
This section contain some common issues you can face while installing, operating the operator and possible solutions for them.
4+
5+
## Service account and custom resource access errors
6+
7+
When using `kubernetes` flag sync method, operator rely on K8s RBAC to grant injected flagd access to custom resources.
8+
If your K8s cluster has permission restrictions or if you have cluster configurations as code which can override `ClusterRoleBinding` with a new rollout, then there can be operator errors.
9+
10+
For example, if you see error such as,
11+
12+
```sh
13+
Error creating: admission webhook <WEBHOOK_NAME> denied the request: ServiceAccount <NAME> not found
14+
```
15+
16+
```sh
17+
User <SERVICE_ACCOUNT> cannot get resource <FLAG_CONFIGURATION_CR> in API group "core.openfeature.dev" in the namespace <NAMESPACE>
18+
```
19+
20+
then, please check if you have correct `ClusterRoleBinding` configuration under `open-feature-operator-flagd-kubernetes-sync`.
21+
22+
> kubectl describe ClusterRoleBinding open-feature-operator-flagd-kubernetes-sync
23+
24+
And you must see your workload namespace listed there,
25+
26+
>ServiceAccount default <NAMESPACE>

0 commit comments

Comments
 (0)