Command or script to generate documentation?

TrueNAS General
1

Hello,

Is it possible to somehow generate documentation of a system in a human eadable format like a file you generate to prepare for a support call?

Thanks.

2

It sounds like you want something similar to Solaris Explorer, the more generic Config2HTML or RHEL’s SOS Report. But, easily readable. Those generate server state files that allow a remote support engineer to examine the server and help diagnose problems.

I doubt that TrueNAS supports a user type readable support information. The GUI’s debug file probably could be parsed and some information extracted. Just like a configuration backup could probably be deconstructed.

What is your goal?

Did you want to have a clear TrueNAS server configuration for use in duplicating?

3

Thanks. I would like to discuss my setup with someone without the need to give access to the box.

A file in a structured format with dumps of all the content in the GUI would be great. The ability to convert the json file into a readable would be the cherry on the cake.

I hoped this existed for Enterprise customers and could trickle down to the freeloaders. :slight_smile:

4

Only a few features are restricted to Enterprise customers and they all make sense:

  1. HA / High Availability support
  2. Unlimited TrueCommand, (we can use TC, but it’s limited to fewer disks)
  3. And if I remember correctly, their used to be Enterprise support for Fibre Channel. But, don’t quote me.

As for your question, sounds like a reasonable feature request. Go to the Feature Requests Category and open one.

Be specific and perhaps allow 2 modes. Full description of a TrueNAS server, including IPs and users, (but not passwords). And maybe a more anonymous mode that removes IPs and user names, putting in generic replacements. Plus, either text readable or JSON mode output.

Keep in mind that making a feature request does require other people to be interested in it, enough to “vote” for it. So, you need to be an advocate for the feature request. And, if it can apply to Enterprise users, that may make the difference.

For example, creating a text readable configuration layout of a TrueNAS SCALE server that can be used during a capacity planning meeting, might make the difference. Being able to clearly see the ZFS pool(s) layout, size of existing disks, perhaps another section in how they are wired to the server. Etc…

I am no expert in such software tools. But when I use someone else’s tool that works well, it is noticeable.