nomad icon indicating copy to clipboard operation
nomad copied to clipboard

DOCS: Nomad Deployment Guide is outdated, misleading, and incorrect

Open shoenig opened this issue 2 years ago • 1 comments

https://developer.hashicorp.com/nomad/tutorials/enterprise/production-deployment-guide-vm-with-consul

This "Nomad Deployment Guide" is all kinds of incorrect.

Download Nomad

Should link to package based installation guide

Should not have tabs per Nomad version

If it does have tabs, the latest version should not be v1.1 which is years out of support

Install Nomad

Should link to package based installation guide

Should not reference Linux specific instructions (like useradd, etc.)

Configure Systemd

The systemd unit file path /etc/systemd/system/nomad.service does not match the path used by the package based installation guide, which is /etc/systemd/system/nomad.service

The example systemd file references /usr/local/bin/nomad but the package based Nomad is installed at /usr/bin/nomad

The example systemd file is missing things like EnvironmentFile=-/etc/nomad.d/nomad.env

Common configuration

Does not chown config files to the correct user (nomad for servers, root for clients)

Start Nomad

Does not mention systemctl daemon-reload is needed to make systemd aware of the unit files and changes.

Notes

I would also note just finding a guide (even one as bad as this) for configuring a 'proper' cluster (i.e. with systemd, etc.) was difficult. The "Installing Nomad / Overview" page does not link anywhere, and the Production drop down makes you click on a sub menu to get to the "good" stuff.

I would also note the diagram at the top of the page plasters Consul all over the place which is irrelevant to the guide at hand.

shoenig avatar Nov 03 '23 13:11 shoenig

I moved the corresponding Jira ticket to the Runtime Education project and let Jeff know. We hope to address the installation guides this year.

aimeeu avatar Aug 15 '24 18:08 aimeeu