Update repo structure as part of nixification

README.md

@@ -1,159 +1,27 @@
-# dots
+# Dots
 
-[![Ansible Lint](https://github.com/genebean/dots/actions/workflows/ansible-lint.yml/badge.svg)](https://github.com/genebean/dots/actions/workflows/ansible-lint.yml)
+This repo historically contained my dot files and is now transitioning to being a Nix flake that manages my dot files and the things that consume them. Things are changing a lot right now, but historically symlinked files are still in `link/`. Most all the other old stuff is now tucked away under `legacy/` to get it out of the way until I decide what is and isn't needed.
-[![Ruby](https://github.com/genebean/dots/actions/workflows/ruby.yml/badge.svg)](https://github.com/genebean/dots/actions/workflows/ruby.yml)
 
-> **NOTICE:** this repo is undergoing a transformation. Historically it has been centered around using Puppet and r10k as ruby gems. I love Puppet for managing servers, but running it unprivledged as a gem has proven more than a little challenging in this specific use case. As a result, I am transitioning to using Ansible for the adhoc work that is needed here. Also, the `dots` tool and associated rake tasks will almost certainly be moved to Python 3 as it is universally available without some of the hastles of a bundler based setup.
+The new Nix bits are driven by `flake.nix` which pulls in things under `modules/`. Initial support is for both x86 macOS and NixOS. New stuff is structured like so, at least for now:
-
-This repo contains my dot files and a tool to deploy them, and the programs that use them, to various OS's. Some additional tools that I consider part of my baseline setup are also installed and, if possible, configured by dots.
-
-Dots is written in ruby and utilizes bundler to keep all its dependancies
-as self-contained as possible. Installation of programs and management of git
-repositories is handled by way of the
-[Puppet gem](https://rubygems.org/gems/puppet).
-
-Everything about dots macOS assumes you are running it as a normal user,
-not as root. Strange and unexpected things could well happen if you run any part
-of it as root or via sudo while on macOS. That said, sudo is required on Debian
-due to there not being an equivalent to homebrew as you need sudo to use apt.
-
-
-## Currently Supported OS's
-
-* macOS
-* Linux Mint 18.2
-
-
-## Initial Setup
 
 ```bash
-git clone git@github.com:genebean/dots.git ~/.dotfiles
+$ tree . -I legacy* -I link*
-cd ~/.dotfiles
+.
-bin/bootstrap.sh
+├── flake.lock
-This script takes care of getting dots ready to use
+├── flake.nix
-Enter the number of the task you want to perform:
+├── LICENSE
-1) Mac setup
+├── modules
-2) EL setup
+│   ├── darwin
-3) Mint setup
+│   │   └── default.nix
-4) Quit
+│   ├── home-manager
-Task:
+│   │   └── default.nix
+│   ├── linux
+│   └── nixos
+│       ├── dconf.nix
+│       ├── default.nix
+│       └── hardware-configuration.nix
+├── README.md
+└── Vagrantfile
+
+6 directories, 10 files
 ```
-
-After you run the setup for your OS you will want to make sure that
-[puppet/production/hieradata/nodes/](puppet/production/hieradata/nodes/)
-contains a file matching the hostname of your machine. That file needs to
-contain at least the following:
-
-```yaml
----
-homedir: '/Users/johndoe'
-```
-
-Naturally, you will want to adjust the entry to match the real path to your
-home directory. On a Mac this is generally in `/Users/` or `/home/` on Linux.
-
-
-## Running dots
-
-The primary way to interact with dots is via `bundle exec rake dots`.
-This will run an interactive cli program like so:
-
-```
-$ bundle exec rake dots
-/usr/local/Cellar/ruby/2.4.1_1/bin/ruby bin/dots.rb
-It seems you are on macOS 10.12.5
-What would you like to do? (Use arrow keys, press Enter to select)
-‣ copy
-  link
-  install
-```
-
-If not on macOS then you will need to use sudo for the install step:
-
-```
-$ sudo bundle exec rake dots
-```
-
-Additional tasks are available in the
-dots namespace. You can see all the available tasks via
-`bundle exec rake -T`.
-
-
-## Notes
-
-#### Running Puppet
-
-```bash
-# Any of these will work:
-bundle exec rake dots:run_puppet
-bundle exec rake dots:run_puppet_noop
-bundle exec puppet apply --environmentpath ~/.dotfiles/puppet ~/.dotfiles/puppet/production/manifests/site.pp
-```
-
-As mentioned above, when not on macOS you will need to prefix bundle with sudo.
-
-
-#### Installed Homebrew packages
-
-To see what has been installed (not the deps) run `brew leaves`
-
-
-## Project structure
-
-* `bin/`: this is where the "application" bits live
-* `bin/bootstrap`: platform specific helpers called by `bin/bootstrap.sh`
-* `copy/`: files directly in this directory are copied to all hosts
-* `copy/mac/`: files in here get copied to Macs
-* `copy/nix/`: files in here get copied to all Posix systems
-* `link/`: files directly in this directory are symlinked on all hosts.
-  * all symlinks are prefixed with a dot. Ex: `link/gemrc` becomes `~/.gemrc`
-* `link/linux/`: files in here get symlinked on all Linux distros
-* `link/mac/`: files in here get symlinked on all Macs
-* `link/nix/`: files in here get symlinked on all Posix systems
-* `link/ssh/`: these files get symlinked under `~/.ssh/` on all Posix systems
-* `puppet/`: this is basically a control repo modified to suit this setup
-* `puppet/production/`: items from an environment's branch in a control repo
-  * this setup assumes Puppet 4 and Hiera 5. Hiera's config is parsed as part of
-    the environment rather than from a global config file.
-* `spec/`: unit tests go here
-
-
-## Adding Packages
-
-To add additional pacakages to be installed and managed by dots you will need to
-edit the associated Puppet manifest. Currently, this consists of the following:
-
-```bash
-puppet/production/site/profile/manifests/
-├── base.pp
-├── linux
-│   └── debian.pp
-├── linux.pp
-└── mac.pp
-```
-
-On macOS you can easily install packages and casks from homebrew or Python
-modules from pip. On Linux Mint you can easily use any package provider
-that supports Debian or Ubuntu since all installs are done via sudo. On both
-platforms you can also use custom exec's to to work around limitations. For
-example, an exec is used on Mint to set the shell to zsh and on both platforms
-to install or update the powerline fonts.
-
-
-## Puppet Customizations
-
-This repo also contains some custom facts and functions under
-`puppet/production/site/custom_libs`:
-
-### Facts
-
-* `os_release`: this creates a structured fact out of the contents of
-  /etc/os-release on Linux systems. This info is needed on Mint to determine
-  what version of Ubuntu it is based on.
-
-### Functions
-
-* `find_group`: returns the owning group's GID as a string for the file or
-  folder at a given path
-* `find_owner`: returns the owning user's UID as a string for the file or
-  folder at a given path

legacy/README.md

@@ -0,0 +1,159 @@
+# dots
+
+[![Ansible Lint](https://github.com/genebean/dots/actions/workflows/ansible-lint.yml/badge.svg)](https://github.com/genebean/dots/actions/workflows/ansible-lint.yml)
+[![Ruby](https://github.com/genebean/dots/actions/workflows/ruby.yml/badge.svg)](https://github.com/genebean/dots/actions/workflows/ruby.yml)
+
+> **NOTICE:** this repo is undergoing a transformation. Historically it has been centered around using Puppet and r10k as ruby gems. I love Puppet for managing servers, but running it unprivledged as a gem has proven more than a little challenging in this specific use case. As a result, I am transitioning to using Ansible for the adhoc work that is needed here. Also, the `dots` tool and associated rake tasks will almost certainly be moved to Python 3 as it is universally available without some of the hastles of a bundler based setup.
+
+This repo contains my dot files and a tool to deploy them, and the programs that use them, to various OS's. Some additional tools that I consider part of my baseline setup are also installed and, if possible, configured by dots.
+
+Dots is written in ruby and utilizes bundler to keep all its dependancies
+as self-contained as possible. Installation of programs and management of git
+repositories is handled by way of the
+[Puppet gem](https://rubygems.org/gems/puppet).
+
+Everything about dots macOS assumes you are running it as a normal user,
+not as root. Strange and unexpected things could well happen if you run any part
+of it as root or via sudo while on macOS. That said, sudo is required on Debian
+due to there not being an equivalent to homebrew as you need sudo to use apt.
+
+
+## Currently Supported OS's
+
+* macOS
+* Linux Mint 18.2
+
+
+## Initial Setup
+
+```bash
+git clone git@github.com:genebean/dots.git ~/.dotfiles
+cd ~/.dotfiles
+bin/bootstrap.sh
+This script takes care of getting dots ready to use
+Enter the number of the task you want to perform:
+1) Mac setup
+2) EL setup
+3) Mint setup
+4) Quit
+Task:
+```
+
+After you run the setup for your OS you will want to make sure that
+[puppet/production/hieradata/nodes/](puppet/production/hieradata/nodes/)
+contains a file matching the hostname of your machine. That file needs to
+contain at least the following:
+
+```yaml
+---
+homedir: '/Users/johndoe'
+```
+
+Naturally, you will want to adjust the entry to match the real path to your
+home directory. On a Mac this is generally in `/Users/` or `/home/` on Linux.
+
+
+## Running dots
+
+The primary way to interact with dots is via `bundle exec rake dots`.
+This will run an interactive cli program like so:
+
+```
+$ bundle exec rake dots
+/usr/local/Cellar/ruby/2.4.1_1/bin/ruby bin/dots.rb
+It seems you are on macOS 10.12.5
+What would you like to do? (Use arrow keys, press Enter to select)
+‣ copy
+  link
+  install
+```
+
+If not on macOS then you will need to use sudo for the install step:
+
+```
+$ sudo bundle exec rake dots
+```
+
+Additional tasks are available in the
+dots namespace. You can see all the available tasks via
+`bundle exec rake -T`.
+
+
+## Notes
+
+#### Running Puppet
+
+```bash
+# Any of these will work:
+bundle exec rake dots:run_puppet
+bundle exec rake dots:run_puppet_noop
+bundle exec puppet apply --environmentpath ~/.dotfiles/puppet ~/.dotfiles/puppet/production/manifests/site.pp
+```
+
+As mentioned above, when not on macOS you will need to prefix bundle with sudo.
+
+
+#### Installed Homebrew packages
+
+To see what has been installed (not the deps) run `brew leaves`
+
+
+## Project structure
+
+* `bin/`: this is where the "application" bits live
+* `bin/bootstrap`: platform specific helpers called by `bin/bootstrap.sh`
+* `copy/`: files directly in this directory are copied to all hosts
+* `copy/mac/`: files in here get copied to Macs
+* `copy/nix/`: files in here get copied to all Posix systems
+* `link/`: files directly in this directory are symlinked on all hosts.
+  * all symlinks are prefixed with a dot. Ex: `link/gemrc` becomes `~/.gemrc`
+* `link/linux/`: files in here get symlinked on all Linux distros
+* `link/mac/`: files in here get symlinked on all Macs
+* `link/nix/`: files in here get symlinked on all Posix systems
+* `link/ssh/`: these files get symlinked under `~/.ssh/` on all Posix systems
+* `puppet/`: this is basically a control repo modified to suit this setup
+* `puppet/production/`: items from an environment's branch in a control repo
+  * this setup assumes Puppet 4 and Hiera 5. Hiera's config is parsed as part of
+    the environment rather than from a global config file.
+* `spec/`: unit tests go here
+
+
+## Adding Packages
+
+To add additional pacakages to be installed and managed by dots you will need to
+edit the associated Puppet manifest. Currently, this consists of the following:
+
+```bash
+puppet/production/site/profile/manifests/
+├── base.pp
+├── linux
+│   └── debian.pp
+├── linux.pp
+└── mac.pp
+```
+
+On macOS you can easily install packages and casks from homebrew or Python
+modules from pip. On Linux Mint you can easily use any package provider
+that supports Debian or Ubuntu since all installs are done via sudo. On both
+platforms you can also use custom exec's to to work around limitations. For
+example, an exec is used on Mint to set the shell to zsh and on both platforms
+to install or update the powerline fonts.
+
+
+## Puppet Customizations
+
+This repo also contains some custom facts and functions under
+`puppet/production/site/custom_libs`:
+
+### Facts
+
+* `os_release`: this creates a structured fact out of the contents of
+  /etc/os-release on Linux systems. This info is needed on Mint to determine
+  what version of Ubuntu it is based on.
+
+### Functions
+
+* `find_group`: returns the owning group's GID as a string for the file or
+  folder at a given path
+* `find_owner`: returns the owning user's UID as a string for the file or
+  folder at a given path