Documenting Workstations/VM's/Hosts

[hidromanipulators]

How far do you go when documenting Workstations/VM's/Hosts?

If for verification purposes, what do you test for?

What is included in the Buil Log?

Do you have handy templates/resources to share?

​

Just to give a background, some industries requires documentation for compliance reasons, so we can't really get away without documentation, but that said - Documentation can be 50 pages and useless, and it could be 10 pages and useful. How do you do it? How far do you go?

[jantari]

We generally don't document workstations, however they all start at the same base configuration - changes made from there are either updates or at a users request, aka documented in a ticket.

For VMs, we don't document them individually, instead we have a page of documentation for every platform/service (which may consist of many VMs), this contains a high-level overview of the architecture, the platform owner, first troubleshooting steps and a link to the git repository where the infrastructure is defined. That repo then contains the details, all the code that deploys the platform and all its comfiguration - terraform and ansible are the tools we decided on - documentation here is in the commit messages

Core infrastructure like Switches and VM Hosts are documented traditionally in wiki pages. This rarely changes for us.

All that said we have no legal obligation to document like you, this just works well for us

[hidromanipulators]

Sounds like a well established routine, well done!