yadunut/clan-core
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

templates: consistent templates, remove deprecated things

Browse Source
This commit is contained in:
Johannes Kirschbauer
2025-07-02 11:57:30 +02:00
parent a27321a826
commit f0c5a8c84a
13 changed files with 129 additions and 165 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
pkgs/clan-cli/clan_cli/tests/test_clan_nix_attrset.py
View File

@@ -93,7 +93,7 @@ def test_clan_core_templates(
]
clan_core_template_keys = list(clan_core_templates.keys())
expected_templates = ["classic", "default", "minimal"]
expected_templates = ["default", "minimal", "flake-parts"]
assert clan_core_template_keys == expected_templates
vlist_temps = list_templates("clan", clan_dir)

80
templates/clan/classic/flake.nix
View File

@@ -1,80 +0,0 @@
{
inputs.clan-core.url = "https://git.clan.lol/clan/clan-core/archive/main.tar.gz";
inputs.nixpkgs.follows = "clan-core/nixpkgs";
outputs =
{ self, clan-core, ... }:
let
# Usage see: https://docs.clan.lol
clan = clan-core.clanLib.buildClan {
inherit self;
# Ensure this is unique among all clans you want to use.
meta.name = "__CHANGE_ME__";
# Information about your machines. Machines under ./machines will be auto-imported.
inventory.machines = {
somemachine.tags = [ "desktop" ];
somemachine.deploy.targetHost = "root@somemachine";
};
# Clan services to use. See https://docs.clan.lol/reference/clanServices
inventory.instances = {
admin = {
module = {
name = "admin";
input = "clan";
};
roles.default.tags.all = { };
};
zerotier = {
module = {
name = "zerotier";
input = "clan";
};
roles.peer.tags.all = { };
};
};
# A mapping of machine names to their nixos configuration. Allows specifying
# additional configuration.
machines = {
somemachine =
{ pkgs, ... }:
{
environment.systemPackages = with pkgs; [ asciinema ];
};
};
};
in
{
# Expose clan structures as flake outputs. clanInternals is needed for
# the clan-cli. Exposing nixosConfigurations allows using `nixos-rebuild` as before.
inherit (clan)
nixosConfigurations
nixosModules
clanInternals
darwinConfigurations
darwinModules
;
# Add the Clan cli tool to the dev shell.
# Use "nix develop" to enter the dev shell.
devShells =
clan-core.inputs.nixpkgs.lib.genAttrs
[
"x86_64-linux"
"aarch64-linux"
"aarch64-darwin"
"x86_64-darwin"
]
(system: {
default = clan-core.inputs.nixpkgs.legacyPackages.${system}.mkShell {
packages = [ clan-core.packages.${system}.clan-cli ];
};
});
};
}

0
templates/clan/classic/machines/.gitkeep
View File

2
templates/clan/default/.gitignore vendored Normal file
View File

@@ -0,0 +1,2 @@
result*
.direnv/

82
templates/clan/default/flake.nix
View File

@@ -1,53 +1,42 @@
{
inputs.clan-core.url = "https://git.clan.lol/clan/clan-core/archive/main.tar.gz";
inputs.nixpkgs.follows = "clan-core/nixpkgs";
inputs.flake-parts.follows = "clan-core/flake-parts";
inputs.flake-parts.inputs.nixpkgs-lib.follows = "clan-core/nixpkgs";
outputs =
inputs@{ flake-parts, ... }:
flake-parts.lib.mkFlake { inherit inputs; } {
systems = [
"x86_64-linux"
"aarch64-linux"
"x86_64-darwin"
"aarch64-darwin"
];
imports = [ inputs.clan-core.flakeModules.default ];
# https://docs.clan.lol/guides/getting-started/flake-parts/
clan = {
{ self, clan-core, ... }:
let
# Usage see: https://docs.clan.lol
clan = clan-core.clanLib.buildClan {
inherit self;
# Ensure this is unique among all clans you want to use.
meta.name = "__CHANGE_ME__";
# Information about your machines. Machines under ./machines will be auto-imported.
inventory.machines = {
somemachine.tags = [ "desktop" ];
somemachine.deploy.targetHost = "root@somemachine";
};
# Clan services to use. See https://docs.clan.lol/reference/clanServices
inventory.instances = {
admin = {
module = {
name = "admin";
input = "clan";
};
roles.default.tags.all = { };
roles.default.settings.allowedKeys = {
# Insert the public key of all your admin machines
# All these 'admin machines' will have ssh access to "tags.all" (all machines)
# Alternatively set 'users.users.root.openssh.authorizedKeys.keys' in each machine
"admin-machine-1" = "__YOUR_PUBLIC_KEY__";
};
};
zerotier = {
module = {
name = "zerotier";
input = "clan";
};
# Replace with the name of your machine that you will use as zerotier-controller
# See: https://docs.zerotier.com/controller/
# Deploy this machine first to create the network secrets
roles.controller.machines."__YOUR_CONTROLLER__" = { };
# Peers of the network
# tags.all means 'all machines' will joined
roles.peer.tags.all = { };
};
};
# A mapping of machine names to their nixos configuration. Allows specifying
# additional configuration.
# A mapping of machine names to their nixos configuration.
# Allows specifying additional nixos configuration.
machines = {
somemachine =
{ pkgs, ... }:
@@ -56,10 +45,33 @@
};
};
};
perSystem =
{ pkgs, inputs', ... }:
{
devShells.default = pkgs.mkShell { packages = [ inputs'.clan-core.packages.clan-cli ]; };
};
in
{
# Expose clan structures as flake outputs. clanInternals is needed for
# the clan-cli. Exposing nixosConfigurations allows using `nixos-rebuild` as before.
inherit (clan)
nixosConfigurations
nixosModules
clanInternals
darwinConfigurations
darwinModules
;
# Add the Clan cli tool to the dev shell.
# Use "nix develop" to enter the dev shell.
devShells =
clan-core.inputs.nixpkgs.lib.genAttrs
[
"x86_64-linux"
"aarch64-linux"
"aarch64-darwin"
"x86_64-darwin"
]
(system: {
default = clan-core.inputs.nixpkgs.legacyPackages.${system}.mkShell {
packages = [ clan-core.packages.${system}.clan-cli ];
};
});
};
}

0
templates/clan/default/machines/.gitkeep
View File

0
templates/clan/classic/.envrc → templates/clan/flake-parts/.envrc
View File

2
templates/clan/flake-parts/.gitignore vendored Normal file
View File

@@ -0,0 +1,2 @@
result*
.direnv/

61
templates/clan/flake-parts/flake.nix Normal file
View File

@@ -0,0 +1,61 @@
{
inputs.clan-core.url = "https://git.clan.lol/clan/clan-core/archive/main.tar.gz";
inputs.nixpkgs.follows = "clan-core/nixpkgs";
inputs.flake-parts.follows = "clan-core/flake-parts";
inputs.flake-parts.inputs.nixpkgs-lib.follows = "clan-core/nixpkgs";
outputs =
inputs@{ flake-parts, ... }:
flake-parts.lib.mkFlake { inherit inputs; } {
systems = [
"x86_64-linux"
"aarch64-linux"
"x86_64-darwin"
"aarch64-darwin"
];
imports = [ inputs.clan-core.flakeModules.default ];
# https://docs.clan.lol/guides/flake-parts/
clan = {
# Ensure this is unique among all clans you want to use.
meta.name = "__CHANGE_ME__";
# Clan services to use. See https://docs.clan.lol/reference/clanServices
inventory.instances = {
admin = {
roles.default.tags.all = { };
roles.default.settings.allowedKeys = {
# Insert the public key of all your admin machines
# All these 'admin machines' will have ssh access to "tags.all" (all machines)
# Alternatively set 'users.users.root.openssh.authorizedKeys.keys' in each machine
"admin-machine-1" = "__YOUR_PUBLIC_KEY__";
};
};
zerotier = {
# Replace with the name of your machine that you will use as zerotier-controller
# See: https://docs.zerotier.com/controller/
# Deploy this machine first to create the network secrets
roles.controller.machines."__YOUR_CONTROLLER__" = { };
# Peers of the network
# tags.all means 'all machines' will joined
roles.peer.tags.all = { };
};
};
# A mapping of machine names to their nixos configuration.
# Allows specifying additional nixos configuration.
machines = {
somemachine =
{ pkgs, ... }:
{
environment.systemPackages = with pkgs; [ asciinema ];
};
};
};
perSystem =
{ pkgs, inputs', ... }:
{
devShells.default = pkgs.mkShell { packages = [ inputs'.clan-core.packages.clan-cli ]; };
};
};
}

2
templates/clan/minimal/.gitignore vendored
View File

@@ -1,2 +1,2 @@
result
result*
.direnv/

15
templates/clan/minimal/flake.nix
View File

@@ -2,16 +2,21 @@
inputs = {
clan-core.url = "https://git.clan.lol/clan/clan-core/archive/main.tar.gz";
nixpkgs.follows = "clan-core/nixpkgs";
flake-parts.follows = "clan-core/flake-parts";
flake-parts.inputs.nixpkgs-lib.follows = "clan-core/nixpkgs";
};
outputs =
{ self, clan-core, ... }:
{
self,
clan-core,
nixpkgs,
...
}:
let
# Usage see: https://docs.clan.lol
clan = clan-core.lib.clan { inherit self; };
clan = clan-core.lib.clan {
inherit self;
meta.name = nixpkgs.lib.mkDefault "new-clan";
};
in
{
# all machines managed by Clan

38
templates/clan/new-clan/modules/shared.nix
View File

@@ -1,38 +0,0 @@
{
config,
clan-core,
# Optional, if you want to access other flakes:
# self,
...
}:
{
imports = [
# Enables the OpenSSH server for remote access
clan-core.clanModules.sshd
# Set a root password
clan-core.clanModules.root-password
clan-core.clanModules.user-password
clan-core.clanModules.state-version
# You can access other flakes imported in your flake via `self` like this:
# self.inputs.nix-index-database.nixosModules.nix-index
];
# Locale service discovery and mDNS
services.avahi.enable = true;
# generate a random password for our user below
# can be read using `clan secrets get <machine-name>-user-password` command
clan.user-password.user = "user";
users.users.user = {
isNormalUser = true;
extraGroups = [
"wheel"
"networkmanager"
"video"
"input"
];
uid = 1000;
openssh.authorizedKeys.keys = config.users.users.root.openssh.authorizedKeys.keys;
};
}

10
templates/flake.nix
View File

@@ -24,17 +24,17 @@
clan = {
default = {
description = "Initialize a new clan flake";
description = "Initialize a new clan";
path = ./clan/default;
};
classic = {
description = "Initialize a new clan flake (no flake-parts)";
path = ./clan/classic;
flake-parts = {
description = "Initialize a new clan (flake-parts)";
path = ./clan/flake-parts;
};
minimal = {
description = "for clans managed via (G)UI";
description = "Minimal Clan";
path = ./clan/minimal;
};
};