terraform-provider-nixos

README

Terraform Provider NixOS

NixOps has too many responsibilities and not a big enough community. The goal is to reduce NixOps' realm of control by moving all provisioning steps in to Terraform. This combines NixOp's deep support for NixOS with Terraform's nearly universal support for hardware and software providers.

Maintainers

This provider plugin is an experiment.

Requirements

• Terraform 0.10.x
• Go 1.8 (to build the provider plugin)

Building The Provider

Clone repository to: $GOPATH/src/github.com/tweag/terraform-provider-nixos

$ mkdir -p $GOPATH/src/github.com/tweag; cd $GOPATH/src/github.com/tweag
$ git clone git@github.com:tweag/terraform-provider-nixos

Enter the provider directory and build the provider

$ cd $GOPATH/src/github.com/tweag/terraform-provider-nixos
$ make build

Using the provider

provider "nixos" {
  root = "./nixos-machines/"
}

resource "nixos_node" "my-server" {
  node_name = "my-server-name"
  ip = "10.5.3.1"
  nix = <<NIX
    environment.systemPackages = with pkgs; [
      file
    ];
  NIX
}

This will create a file at ./nixos-machines/my-server.nix containing:

{
  terraform.ip = "10.5.3.1";
  terraform.name = "my-server-name";
  environment.systemPackages = with pkgs; [
    file
  ];
}

In your Nix configuration, add a file called terraform.nix containing:

{ config, lib, pkgs, ... }:
let
  inherit (lib) mkIf mkOption types;
  cfg = config.terraform;
in {
  options = {
    terraform = {
      name = mkOption {
        type = types.string;
      };

      ip = mkOption {
        type = types.string;
      };
    };
  };
}

and add it to the configuration.nix via:

{
  imports = [ ./terraform.nix ];
}

If you're using the provider with NixOps, you may want to add this to your configuration.nix:

{
  deployment.targetHost = terraform.ip;
}

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (version 1.8+ is required). You'll also need to correctly setup a GOPATH, as well as adding $GOPATH/bin to your $PATH.

To compile the provider, run make build. This will build the provider and put the provider binary in the $GOPATH/bin directory.

$ make bin
...
$ $GOPATH/bin/terraform-provider-tweag
...

In order to test the provider, you can simply run make test.

$ make test

In order to run the full suite of Acceptance tests, run make testacc.

Note: Acceptance tests create real resources, and often cost money to run.

$ make testacc