-
-
Notifications
You must be signed in to change notification settings - Fork 233
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
Add tutorial for deploying NixOS with Terraform #110
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,179 @@ | ||
.. _deploying-nixos-using-terraform: | ||
|
||
Deploying NixOS using Terraform | ||
=============================== | ||
|
||
Assuming you're `familiar with the basics of Terraform <https://www.terraform.io/intro/index.html>`_, | ||
by the end of tutorial you will have provisioned Amazon AWS instance with Terraform | ||
and use Nix to deploy incremental changes to NixOS running on the instance. | ||
|
||
We'll look at how to boot a NixOS machine and how to deploy the incremental changes: | ||
|
||
|
||
Booting NixOS image | ||
------------------- | ||
|
||
1. Start by providing terraform executable: | ||
|
||
.. code:: shell | ||
|
||
nix-shell -p terraform | ||
|
||
2. We are using `Terraform Cloud <https://app.terraform.io>`_ as a `state/locking backend <https://www.terraform.io/docs/state/purpose.html>`_: | ||
|
||
.. code:: shell | ||
|
||
terraform login | ||
|
||
3. Make sure to `create an organization <https://app.terraform.io/app/organizations/new>`_ like ``myorganization`` in your Terraform Cloud account. | ||
|
||
4. Inside ``myorganization`` `create a workspace <https://app.terraform.io/app/cachix/workspaces/new>`_ by chosing | ||
"CLI-driven workflow and pick name like ``myapp``. | ||
|
||
4. Inside a new directory create ``main.tf`` file with the following contents that will start an AWS instance with NixOS image using one SSH keypair and an SSH security group: | ||
|
||
.. code:: | ||
|
||
terraform { | ||
backend "remote" { | ||
organization = "myorganization" | ||
|
||
workspaces { | ||
name = "myapp" | ||
} | ||
} | ||
} | ||
|
||
provider "aws" { | ||
region = "eu-central-1" | ||
} | ||
|
||
module "nixos_image" { | ||
source = "git::https://github.com/tweag/terraform-nixos.git//aws_image_nixos?ref=5f5a0408b299874d6a29d1271e9bffeee4c9ca71" | ||
release = "20.09" | ||
} | ||
|
||
resource "aws_security_group" "ssh_and_egress" { | ||
ingress { | ||
from_port = 22 | ||
to_port = 22 | ||
protocol = "tcp" | ||
cidr_blocks = [ "0.0.0.0/0" ] | ||
} | ||
|
||
egress { | ||
from_port = 0 | ||
to_port = 0 | ||
protocol = "-1" | ||
cidr_blocks = ["0.0.0.0/0"] | ||
} | ||
} | ||
|
||
resource "tls_private_key" "state_ssh_key" { | ||
algorithm = "RSA" | ||
} | ||
|
||
resource "local_file" "machine_ssh_key" { | ||
sensitive_content = tls_private_key.state_ssh_key.private_key_pem | ||
filename = "${path.module}/id_rsa.pem" | ||
file_permission = "0600" | ||
} | ||
|
||
resource "aws_key_pair" "generated_key" { | ||
key_name = "generated-key-${sha256(tls_private_key.state_ssh_key.public_key_openssh)}" | ||
public_key = tls_private_key.state_ssh_key.public_key_openssh | ||
} | ||
|
||
resource "aws_instance" "machine" { | ||
ami = module.nixos_image.ami | ||
instance_type = "t3.micro" | ||
security_groups = [ aws_security_group.ssh_and_egress.name ] | ||
key_name = aws_key_pair.generated_key.key_name | ||
|
||
root_block_device { | ||
volume_size = 50 # GiB | ||
} | ||
} | ||
|
||
output "public_dns" { | ||
value = aws_instance.machine.public_dns | ||
} | ||
|
||
The only NixOS specific snippet is: | ||
|
||
.. code:: | ||
|
||
module "nixos_image" { | ||
source = "git::https://github.com/tweag/terraform-nixos.git/aws_image_nixos?ref=5f5a0408b299874d6a29d1271e9bffeee4c9ca71" | ||
release = "20.09" | ||
} | ||
|
||
.. note:: | ||
|
||
``aws_image_nixos`` module will return an NixOS AMI given `NixOS release number <https://status.nixos.org>`_ | ||
so that ``aws_instance`` resource can reference the AMI in `instance_type <https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/instance#instance_type>`_ argument. | ||
|
||
5. Make sure to `configure AWS credentials <https://registry.terraform.io/providers/hashicorp/aws/latest/docs#authentication>`_. | ||
|
||
6. Applying Terraform configuration should get you a running NixOS: | ||
|
||
.. code:: shell | ||
|
||
terraform init | ||
terraform apply | ||
|
||
|
||
Deploying NixOS changes | ||
----------------------- | ||
|
||
Once AWS instance is running an NixOS image via Terraform, we can teach Terraform to always build | ||
latest NixOS configuration and apply those changes to your instance. | ||
|
||
1. Create ``configuration.nix`` with the following contents: | ||
|
||
.. code:: nix | ||
|
||
{ config, lib, pkgs, ... }: { | ||
imports = [ <nixpkgs/nixos/modules/virtualisation/amazon-image.nix> ]; | ||
|
||
# Open https://search.nixos.org/options for all options | ||
} | ||
|
||
2. Append the following snippet to your ``main.tf``: | ||
|
||
.. code:: | ||
|
||
module "deploy_nixos" { | ||
source = "git::https://github.com/tweag/terraform-nixos.git//deploy_nixos?ref=5f5a0408b299874d6a29d1271e9bffeee4c9ca71" | ||
nixos_config = "${path.module}/configuration.nix" | ||
target_host = aws_instance.machine.public_ip | ||
ssh_private_key_file = local_file.machine_ssh_key.filename | ||
ssh_agent = false | ||
} | ||
|
||
3. Deploy: | ||
|
||
.. code:: shell | ||
|
||
terraform init | ||
terraform apply | ||
|
||
|
||
Caveats | ||
------- | ||
|
||
- ``deploy_nixos`` module requires NixOS to be installed on the target machine and Nix on the host machine. | ||
|
||
- ``deploy_nixos`` module doesn't work when the client and target architectures are different (unless you use `distributed builds <https://nixos.org/manual/nix/unstable/advanced-topics/distributed-builds.html>`_). | ||
|
||
- If you need to inject a value into Nix, there is no elegant solution. | ||
|
||
- Each machine is evaluated separately, so note that your memory requirements will grow linearly with the number of machine. | ||
|
||
|
||
Going Forward | ||
------------- | ||
|
||
- It's possible to `switch to use Google Compute Engine provider <https://github.com/tweag/terraform-nixos/tree/master/google_image_nixos#readme>`_. | ||
|
||
- `deploy_nixos module <https://github.com/tweag/terraform-nixos/tree/master/deploy_nixos#readme>`_ supports a number arguments, for example to upload keys, etc. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/Terraform/Terraform Cloud/
While it can probably be translated to the non cloud version this would be more correct right now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's not really correct, since it doesn't run on Cloud but it only stores the state there.