Skip to main content
Zylon troubleshooting is mostly done through the zylon-cli command line tool.

Zylon Doctor

zylon-cli comes with a built in diagnosis tool. Run:
to get all the relevant information for debugging. The output of the command will guide your further in case you need more detailed information in case some part of the system is failing.

Change Server IP after Zylon has been installed

In case you need to move the server where Zylon is installed to a different IP address, there is a change that needs to be done.
  1. Stop the K0s cluster: sudo k0s stop
  2. Edit the file /var/lib/k0s/kubelet.conf and replace the old IP for the new IP
  3. Reboot the machine
  4. Run sudo zylon-cli sync-kube-config

Debugging tools

In addition to the doctor command, additional debugging tools can be enabled in zylon-conf.yaml. Be aware that these tools tap directly into Zylon internals and you can break the system if you modify any critical resource.

Background task debugging

Enable the background task debug tool by adding these lines to the configuration:
After the update, a new endpoint will be available under /gpt-worker/tasks that contains information about the running operations. The technology powering the dashboard is flower. Username is flower and default password is zylon-flower

Kubernetes dashboard

Enable kubernetes admin dashboard for advanced Zylon control by adding these lines to the configuration:
After the update, a new endpoint will be available under /kube-dashboard. The technology powering dashboard is kubernetes dashboard. In order to connect to the dashboard you must generate a token by running the following command in your instance
This token gives FULL ACCESS to all Zylon resources, configuration, secrets, and so on.
As a general rule, once you are doing using the dashboard you should disable it due to security risks.

Improve indexing for versions before 1.13.0

If you are installing a Zylon version greater than 1.13.0 (Release on Jan 27th 2025) skip this section, it only applies to previous versions. With the release v1.13.0 and support for bigger files indexing is required for better performance. This is a one time operation that will create the index in the vector database for your existing and new documents. Simply run the script in the machine where Zylon is installed. Running the script multiple times has no negative effect. Indexing time might vary depending on the number of documents, but should be faster than a minute.
  • Indexing script

OpenEBS is not working, making PODs be Pending

In certain situations, while Zylon is being installed, it may cause OpenEBS to not install correctly. To remedy this, you can do the following: