Skip to content

Commit

Permalink
Add Cloud connectivity troubleshooting guide (#116)
Browse files Browse the repository at this point in the history
Co-authored-by: Uri Sarid <[email protected]>
  • Loading branch information
orishoshan and usarid authored Aug 22, 2023
1 parent f043acf commit a6f1ade
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 4 deletions.
24 changes: 20 additions & 4 deletions docs/troubleshooting/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,26 @@ 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>
### Problem: components remain in 'Not integrated' status or become 'Disconnected'

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

</details>
#### Steps to try:

##### 1. Check that all your Otterize pods are in 'Running' state: `kubectl get pods -n otterize-system`

Check whether the intents operator, network mapper, or credentials operator are running. Use `kubectl describe pod -n otterize-system <pod name>` to check the status and events and see why those pods may not be starting.

##### 2. 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 Cloud 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)

##### 3. Check the disconnected 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.

One possible problem is an egress default-deny network policy, which blocks all outgoing traffic. To solve this, make sure you exclude `otterize-system` from the namespaces to which the policy applies.
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 a6f1ade

Please sign in to comment.