Docs: rename clanName to just name
This commit is contained in:
@@ -4,14 +4,14 @@
|
|||||||
|
|
||||||
In the `flake.nix` file:
|
In the `flake.nix` file:
|
||||||
|
|
||||||
- [x] set a unique `clanName`.
|
- [x] set a unique `name`.
|
||||||
|
|
||||||
=== "**buildClan**"
|
=== "**buildClan**"
|
||||||
|
|
||||||
```nix title="clan-core.lib.buildClan"
|
```nix title="clan-core.lib.buildClan"
|
||||||
buildClan {
|
buildClan {
|
||||||
# Set a unique name
|
# Set a unique name
|
||||||
clanName = "Lobsters";
|
meta.name = "Lobsters";
|
||||||
# Should usually point to the directory of flake.nix
|
# Should usually point to the directory of flake.nix
|
||||||
directory = ./.;
|
directory = ./.;
|
||||||
|
|
||||||
@@ -31,7 +31,7 @@ In the `flake.nix` file:
|
|||||||
```nix title="clan-core.flakeModules.default"
|
```nix title="clan-core.flakeModules.default"
|
||||||
clan = {
|
clan = {
|
||||||
# Set a unique name
|
# Set a unique name
|
||||||
clanName = "Lobsters";
|
meta.name = "Lobsters";
|
||||||
|
|
||||||
machines = {
|
machines = {
|
||||||
jon = {
|
jon = {
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ inputs = {
|
|||||||
# New flake-parts input
|
# New flake-parts input
|
||||||
flake-parts.url = "github:hercules-ci/flake-parts";
|
flake-parts.url = "github:hercules-ci/flake-parts";
|
||||||
flake-parts.inputs.nixpkgs-lib.follows = "nixpkgs";
|
flake-parts.inputs.nixpkgs-lib.follows = "nixpkgs";
|
||||||
|
|
||||||
clan-core = {
|
clan-core = {
|
||||||
url = "git+https://git.clan.lol/clan/clan-core";
|
url = "git+https://git.clan.lol/clan/clan-core";
|
||||||
inputs.nixpkgs.follows = "nixpkgs"; # Needed if your configuration uses nixpkgs unstable.
|
inputs.nixpkgs.follows = "nixpkgs"; # Needed if your configuration uses nixpkgs unstable.
|
||||||
@@ -35,7 +35,7 @@ After updating your flake inputs, the next step is to import the `clan-core` fla
|
|||||||
inputs@{ flake-parts, ... }:
|
inputs@{ flake-parts, ... }:
|
||||||
flake-parts.lib.mkFlake { inherit inputs; } (
|
flake-parts.lib.mkFlake { inherit inputs; } (
|
||||||
{
|
{
|
||||||
#
|
#
|
||||||
imports = [
|
imports = [
|
||||||
inputs.clan-core.flakeModules.default
|
inputs.clan-core.flakeModules.default
|
||||||
];
|
];
|
||||||
@@ -63,7 +63,7 @@ Below is a guide on how to structure this in your flake.nix:
|
|||||||
# Define your clan
|
# Define your clan
|
||||||
clan = {
|
clan = {
|
||||||
# Clan wide settings. (Required)
|
# Clan wide settings. (Required)
|
||||||
clanName = ""; # Ensure to choose a unique name.
|
meta.name = ""; # Ensure to choose a unique name.
|
||||||
|
|
||||||
machines = {
|
machines = {
|
||||||
jon = {
|
jon = {
|
||||||
@@ -84,7 +84,7 @@ Below is a guide on how to structure this in your flake.nix:
|
|||||||
|
|
||||||
# There needs to be exactly one controller per clan
|
# There needs to be exactly one controller per clan
|
||||||
clan.networking.zerotier.controller.enable = true;
|
clan.networking.zerotier.controller.enable = true;
|
||||||
|
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -31,7 +31,7 @@
|
|||||||
{ ... }:
|
{ ... }:
|
||||||
{
|
{
|
||||||
clan = {
|
clan = {
|
||||||
# meta.name = "clan-core";
|
meta.name = "clan-core";
|
||||||
directory = self;
|
directory = self;
|
||||||
};
|
};
|
||||||
systems = [
|
systems = [
|
||||||
|
|||||||
@@ -10,7 +10,7 @@
|
|||||||
let
|
let
|
||||||
clan = clan-core.lib.buildClan {
|
clan = clan-core.lib.buildClan {
|
||||||
directory = self;
|
directory = self;
|
||||||
clanName = "test_flake_with_core";
|
meta.name = "test_flake_with_core";
|
||||||
machines = {
|
machines = {
|
||||||
vm1 =
|
vm1 =
|
||||||
{ lib, ... }:
|
{ lib, ... }:
|
||||||
|
|||||||
@@ -10,7 +10,7 @@
|
|||||||
let
|
let
|
||||||
clan = clan-core.lib.buildClan {
|
clan = clan-core.lib.buildClan {
|
||||||
directory = self;
|
directory = self;
|
||||||
clanName = "test_flake_with_core_and_pass";
|
meta.name = "test_flake_with_core_and_pass";
|
||||||
machines = {
|
machines = {
|
||||||
vm1 =
|
vm1 =
|
||||||
{ lib, ... }:
|
{ lib, ... }:
|
||||||
|
|||||||
@@ -10,7 +10,7 @@
|
|||||||
let
|
let
|
||||||
clan = clan-core.lib.buildClan {
|
clan = clan-core.lib.buildClan {
|
||||||
directory = self;
|
directory = self;
|
||||||
clanName = "test_flake_with_core_dynamic_machines";
|
meta.name = "test_flake_with_core_dynamic_machines";
|
||||||
machines =
|
machines =
|
||||||
let
|
let
|
||||||
machineModules = builtins.readDir (self + "/machines");
|
machineModules = builtins.readDir (self + "/machines");
|
||||||
|
|||||||
Reference in New Issue
Block a user