Skip to content

Commit

Permalink
Add troubleshooting guide
Browse files Browse the repository at this point in the history
  • Loading branch information
orishoshan committed Aug 20, 2023
1 parent d7f842e commit 1e3e2b6
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 4 deletions.
23 changes: 19 additions & 4 deletions docs/troubleshooting/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,25 @@ import TabItem from '@theme/TabItem';

The following areas provide tips for troubleshooting specific areas of Otterize usage.

<details>
## Connecting Otterize OSS in a Kubernetes cluster to Otterize Cloud

<summary>Connecting Otterize OSS in a Kubernetes cluster to Otterize Cloud</summary>
### Components remain in 'Not integrated' status or become 'Disconnected'

Coming soon...
![Components not integrated](/img/troubleshooting/not-integrated.png)

</details>
#### Check that all your Otterize pods are in 'Running' state: `kubectl get pods -n otterize-system`
If the intents-operator, network-mapper, or credentials-operator are not running, that is why. Run `kubectl describe pod -n otterize-system <pod name>` and check the status and events to see why the pod is not starting.

#### Verify that the client ID and client secret you specified on the command line is correct
The pod may be having trouble connecting to Otterize Cloud because the credentials are incorrect.
Make sure that the credentials specified as values to the Helm chart are correct.

The Otterize Cloud connection guide provides you with a Helm command that has the correct values.

![Components not integrated](/img/troubleshooting/connection-guide-cloud-instructions.png)

#### Check the not connected component's logs: `kubectl logs -n otterize-system <pod name>`
The component may not be able to connect to Otterize Cloud due to connectivity issues.
Check for connectivity errors in the relevant component's logs. All errors related to Otterize Cloud will mention Otterize Cloud explicitly.

Common problems may include an egress default-deny network policy, which blocks all outgoing traffic. To solve this, make sure you exclude `otterize-system` from the namespaces the policy applies to.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/troubleshooting/not-integrated.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1e3e2b6

Please sign in to comment.