a12d7e1115
Nixpkgs now includes Colmena starting with 21.11 and is now the preferred method to obtain Colmena. The `stable` branch will continue to be updated for each stable release. Fixes #41.
2.6 KiB
Usage with Flakes
Installation
colmena is included in Nixpkgs beginning with 21.11.
For this tutorial, use the following command to enter an ephemeral environment with the colmena command:
nix shell nixpkgs#colmena
If you are interested in trying out the bleeding-edge version of Colmena, Read the unstable version of the Manual for instructions.
To quickly try Colmena out, use the following command to enter an ephemeral environment with the latest development version of colmena:
nix shell github:zhaofengli/colmena
To install Colmena to the user profile, use the following command:
nix-env -if https://github.com/zhaofengli/colmena/tarball/main
You can also add github:zhaofengli/colmena as an input in your Flake and add the colmena package to your devShell.
Unstable Binary Cache
A public binary cache is available at https://colmena.cachix.org, courtesy of Cachix. This binary cache contains unstable versions of Colmena built by GitHub Actions.
Basic Configuration
Colmena reads the colmena output in your Flake.
Here is a short example:
{
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
};
outputs = { nixpkgs, ... }: {
colmena = {
meta = {
nixpkgs = import nixpkgs {
system = "x86_64-linux";
};
};
host-a = { name, nodes, pkgs, ... }: {
boot.isContainer = true;
time.timeZone = nodes.host-b.config.time.timeZone;
};
host-b = {
deployment = {
targetHost = "somehost.tld";
targetPort = 1234;
targetUser = "luser";
};
boot.isContainer = true;
time.timeZone = "America/Los_Angeles";
};
};
};
}
The full set of deployment options can be found here.
You can also check out the example in the main tutorial for some inspiration.
Now you are ready to use Colmena! To build the configuration:
colmena build
To build and deploy to all nodes:
colmena apply