Skip to content

Commit

Permalink
Merge pull request #460 from LF-Decentralized-Trust-labs/Troubleshooting
Browse files Browse the repository at this point in the history
Adding a troubleshooting guid
  • Loading branch information
dwertent authored Dec 4, 2024
2 parents 1dc8287 + 617c361 commit d3148b7
Show file tree
Hide file tree
Showing 3 changed files with 55 additions and 8 deletions.
10 changes: 8 additions & 2 deletions doc-site/docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Pre-requisites

* Access to a running Kubernetes cluster
* [helm](https://helm.sh/) installed
* [helm](https://helm.sh/) `v3` installed
* [kubectl](https://kubernetes.io/docs/reference/kubectl/) installed

## Quick Start with kind
Expand Down Expand Up @@ -173,6 +173,12 @@ Each Paladin node runs an instance of the Paladin UI at the path `/ui`. If you u

Learn about interacting with the [UI](./user-interface.md), and try out the [Tutorials](./../tutorials/index.md).

## Troubleshooting

If you encounter any issues during installation, please refer to the [Troubleshooting Guide](./troubleshooting.md).

If your issue is not listed or remains unresolved, please report it by [opening an issue on the Paladin GitHub page](https://github.com/LF-Decentralized-Trust-labs/paladin/issues).

## Uninstall

To remove the Paladin operator and related resources, run the following commands:
Expand All @@ -183,4 +189,4 @@ kubectl delete namespace paladin
helm uninstall cert-manager -n cert-manager
kubectl delete -f https://github.com/cert-manager/cert-manager/releases/download/v1.16.1/cert-manager.crds.yaml
kubectl delete namespace cert-manager
```
```
40 changes: 40 additions & 0 deletions doc-site/docs/getting-started/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Troubleshooting

## Issue: Page Not Loaded in UI

If you navigate to `http://localhost:31548/ui` and the page does not load, there may be several potential issues. Follow these steps to troubleshoot:

1. **Check Pod Status**:
Ensure all relevant pods are running. You can do this by executing:
```bash
kubectl -n paladin get pods
```
Look for any pods that are not in a `Running` state.

2. **Verify Service Health**:
Confirm that the services are healthy and accessible. Run:
```bash
kubectl -n paladin get services
```
Ensure the service associated with the UI is exposed and reachable.

3. **Test Network Connectivity**:
Verify that the issue is not isolated to your local machine's connection to the pod. Use the following steps:
- `exec` into another pod in the cluster and test connectivity between pods:
```bash
kubectl -n paladin -it exec paladin-node2-0 -- curl http://paladin-node2:8548/ui
```
- If pods fail to communicate with each other, there may be a networking issue.

4. **Check Cluster and Docker Versions**:
If network issues exist, you might be using an outdated version of your cluster or Docker. Ensure the following minimum versions are installed:
- **Docker**: Version `27.0.0` or newer
- **Kind**: Version `0.24.0` or newer

You can check the versions by running:
```bash
docker --version
kind --version
```

If you identify an outdated version, upgrade your tools and retry.
13 changes: 7 additions & 6 deletions doc-site/docs/getting-started/user-interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,22 @@ Each Paladin node runs an instance of the Paladin UI at the path `/ui`. If you u

### Indexer

The indexer panel displays recent transactions and events.

<img src="../../images/ui-indexer.png" alt="Indexer" style=" box-shadow: 0px 0px 15px 0px rgba(0,0,0,0.57">

The indexer panel displays recent transactions and events. Clicking on `View Details` brings up detailed information on a transaction or event:
Clicking on `View Details` brings up detailed information on a transaction or event:

<img src="../../images/ui-transaction.png" alt="Transaction" style=" box-shadow: 0px 0px 15px 0px rgba(0,0,0,0.57">

### Submissions

<img src="../../images/ui-submissions.png" alt="Submissions" style=" box-shadow: 0px 0px 15px 0px rgba(0,0,0,0.57">


The submissions panel displays recent transactions that have been submitted with an option to display only those in pending state.

<img src="../../images/ui-submissions.png" alt="Submissions" style=" box-shadow: 0px 0px 15px 0px rgba(0,0,0,0.57">

### Registry

<img src="../../images/ui-registry.png" alt="Registry" style=" box-shadow: 0px 0px 15px 0px rgba(0,0,0,0.57">
The registry panel displays the list of Paladin nodes.

The registry panel displays the list of Paladin nodes.
<img src="../../images/ui-registry.png" alt="Registry" style=" box-shadow: 0px 0px 15px 0px rgba(0,0,0,0.57">

0 comments on commit d3148b7

Please sign in to comment.