From 9fa017bc7bd8978b1d2e26a5bb3d916faa986f25 Mon Sep 17 00:00:00 2001 From: Johannes Kirschbauer Date: Mon, 12 May 2025 16:13:08 +0200 Subject: [PATCH] Docs: init empty migration guide with references --- docs/mkdocs.yml | 1 + docs/site/guides/migrate-inventory-services.md | 7 +++++++ docs/site/manual/distributed-services.md | 6 ++++-- 3 files changed, 12 insertions(+), 2 deletions(-) create mode 100644 docs/site/guides/migrate-inventory-services.md diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 95aca2095..dbf3e0cf7 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -71,6 +71,7 @@ nav: - Testing: contributing/testing.md - Repo Layout: manual/repo-layout.md - Migrate existing Flakes: manual/migration-guide.md + - Migrate inventory Services: guides/migrate-inventory-services.md - Reference: - Overview: reference/index.md - Clan Modules: diff --git a/docs/site/guides/migrate-inventory-services.md b/docs/site/guides/migrate-inventory-services.md new file mode 100644 index 000000000..f97214edc --- /dev/null +++ b/docs/site/guides/migrate-inventory-services.md @@ -0,0 +1,7 @@ +# How to migrate `Inventory.services` + +## Further reference + +- [Authoring a 'clan.service' module](../authoring/clanServices/index.md) +- [Setting up `inventory.instances`](../manual/distributed-services.md) +- [Inventory Reference](../reference/nix-api/inventory.md) \ No newline at end of file diff --git a/docs/site/manual/distributed-services.md b/docs/site/manual/distributed-services.md index 3ed755477..314490c9f 100644 --- a/docs/site/manual/distributed-services.md +++ b/docs/site/manual/distributed-services.md @@ -1,8 +1,10 @@ -# Instances +# Setting up `inventory.instances` + +In Clan *distributed services* can be declaratively deployed using the `inventory.instances` attribute First of all it might be needed to explain what we mean by the term *distributed service* -## What is considered a service? +## What is considered a distributed service? A **distributed service** is a system where multiple machines work together to provide a certain functionality, abstracting complexity and allowing for declarative configuration and management.