Skip to content

nixos/nix: add option to preface remote machines with a comment #374360

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversation

bryanhonof
Copy link
Member

@bryanhonof bryanhonof commented Jan 16, 2025

I recently ran into an issue where I wasn't able to use the DNS hostname of a machine inside the /etc/nix/machines file. Nothing to do with NixOS or Nix itself, just a weird networking setup I was in. This meant I had to use the plain IPv4 and IPv6 addresses of those machines in these files.

I still like to have some reference to what these machines are, so I've always put a comment above the remote machine line with the DNS name of the machine, and then use the hostName option for the IP address.

This adds the nix.buildMachines.*.comment option. Allows us to do the following.

{
  nix.buildMachines = [
    {
      protocol = "ssh-ng";
      sshUser = "nixbld";
      hostName = "192.168.0.222";
      comment = "Some very powerful machine in Belgium";
    }
  ];
}

Which would result in the following /etc/nix/machines entry.

# Some very powerful machine in Belgium
ssh-ng://nixbld@192.168.0.222 - - 1 1 - - -

I also went ahead and formatted this module with nix run nixpkgs#nixfmt, not sure if that's allowed.

Things done

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
    • sandbox = relaxed
    • sandbox = true
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 25.05 Release Notes (or backporting 24.11 and 25.05 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md.

Add a 👍 reaction to pull requests you find important.

@github-actions github-actions bot added 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: module (update) This PR changes an existing module in `nixos/` labels Jan 16, 2025
I recently ran into an issue where I wasn't able to use the DNS hostname of a
machine inside the /etc/nix/machines file. Nothing to do with NixOS or Nix
itself, just a weird networking setup I was in. This meant I had to use the
plain IPv4 and IPv6 addresses of those machines in these files.

I still like to have some reference to what these machines are, so I've always
put a comment above the remote machine line with the DNS name of the machine,
and then use the hostName option for the IP address.

This adds the nix.buildMachines.*.comment option. Allows us to do the following.

    {
      nix.buildMachines = [
        {
          protocol = "ssh-ng";
          sshUser = "nixbld";
          hostName = "192.168.0.222";
          comment = "Some very powerful machine in Belgium";
        }
      ];
    }

Which would result in the following /etc/nix/machines entry.

    # Some very powerful machine in Belgium
    ssh-ng://nixbld@192.168.0.222 - - 1 1 - - -
@bryanhonof bryanhonof changed the title nix: add option to preface remote machines with a comment nixos/nix: add option to preface remote machines with a comment Jan 16, 2025
@bryanhonof bryanhonof force-pushed the bryanhonof.add-comments-to-etc-nix-machines branch from 853d8db to 9ca8622 Compare January 16, 2025 18:59
@bryanhonof bryanhonof force-pushed the bryanhonof.add-comments-to-etc-nix-machines branch from 7d74966 to f5b3048 Compare January 16, 2025 23:45
@github-actions github-actions bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux. labels Jan 16, 2025
@illdefined
Copy link
Contributor

I recently ran into an issue where I wasn't able to use the DNS hostname of a machine inside the /etc/nix/machines file. Nothing to do with NixOS or Nix itself, just a weird networking setup I was in. This meant I had to use the plain IPv4 and IPv6 addresses of those machines in these files.

I still like to have some reference to what these machines are, so I've always put a comment above the remote machine line with the DNS name of the machine, and then use the hostName option for the IP address.

I had a comparable problem that I solved by defining a host in the SSH client configuration:

nix.buildMachines = [
  {
    hostName = "belgium.powerfulmachines.mydomain.tld";
   # …
  }
];

programs.ssh.extraConfig = ''
  Host belgium.powerfulmachines.mydomain.tld
    Hostname 192.168.0.222
'';

Also works if the SSH service listens on a non‐standard port.

@nixpkgs-ci nixpkgs-ci bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Aug 15, 2025
@bryanhonof
Copy link
Member Author

Closing since I've been using the fix suggested above, and have been satisfied with is.

@bryanhonof bryanhonof closed this Aug 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: module (update) This PR changes an existing module in `nixos/` 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants