Skip to content

Commit

Permalink
chore: adding troubleshooting guide (#501)
Browse files Browse the repository at this point in the history
Signed-off-by: Kavindu Dodanduwa <[email protected]>
  • Loading branch information
Kavindu-Dodan authored Jul 27, 2023
1 parent 1620a08 commit 0befb8f
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,11 @@ The output should be the following,
This response is produced from flagd feature provider sidecar deployment, controlled by the operator and shows how
operator pattern works end to end.

If you are facing errors or if things are not working,

- See if our troubleshooting guide helps: [Troubleshooting](./troubleshoot.md)
- Reach us with a detailed issue: [Create issue](https://github.com/open-feature/open-feature-operator/issues/new)

### What's next ?

- Learn more about core concepts behind operator: [concepts](./concepts.md)
Expand Down
26 changes: 26 additions & 0 deletions docs/troubleshoot.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Troubleshooting

This section contain some common issues you can face while installing, operating the operator and possible solutions for them.

## Service account and custom resource access errors

When using `kubernetes` flag sync method, operator rely on K8s RBAC to grant injected flagd access to custom resources.
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.

For example, if you see error such as,

```sh
Error creating: admission webhook <WEBHOOK_NAME> denied the request: ServiceAccount <NAME> not found
```

```sh
User <SERVICE_ACCOUNT> cannot get resource <FLAG_CONFIGURATION_CR> in API group "core.openfeature.dev" in the namespace <NAMESPACE>
```

then, please check if you have correct `ClusterRoleBinding` configuration under `open-feature-operator-flagd-kubernetes-sync`.

> kubectl describe ClusterRoleBinding open-feature-operator-flagd-kubernetes-sync
And you must see your workload namespace listed there,

>ServiceAccount default <NAMESPACE>

0 comments on commit 0befb8f

Please sign in to comment.