From 295e8698bd7cf88db5bf83146b93963fb3f73848 Mon Sep 17 00:00:00 2001 From: Robert Hensing Date: Fri, 16 Dec 2022 02:31:20 +0100 Subject: [PATCH] docs: Fix examples using asciidoc includes --- .../examples/full-nixos/arion-compose.nix | 1 + .../ROOT/examples/minimal/arion-compose.nix | 1 + .../examples/nixos-unit/arion-compose.nix | 1 + docs/modules/ROOT/pages/index.adoc | 78 ++++--------------- 4 files changed, 17 insertions(+), 64 deletions(-) create mode 120000 docs/modules/ROOT/examples/full-nixos/arion-compose.nix create mode 120000 docs/modules/ROOT/examples/minimal/arion-compose.nix create mode 120000 docs/modules/ROOT/examples/nixos-unit/arion-compose.nix diff --git a/docs/modules/ROOT/examples/full-nixos/arion-compose.nix b/docs/modules/ROOT/examples/full-nixos/arion-compose.nix new file mode 120000 index 0000000..12c44e7 --- /dev/null +++ b/docs/modules/ROOT/examples/full-nixos/arion-compose.nix @@ -0,0 +1 @@ +../../../../../examples/full-nixos/arion-compose.nix \ No newline at end of file diff --git a/docs/modules/ROOT/examples/minimal/arion-compose.nix b/docs/modules/ROOT/examples/minimal/arion-compose.nix new file mode 120000 index 0000000..7e28fd1 --- /dev/null +++ b/docs/modules/ROOT/examples/minimal/arion-compose.nix @@ -0,0 +1 @@ +../../../../../examples/minimal/arion-compose.nix \ No newline at end of file diff --git a/docs/modules/ROOT/examples/nixos-unit/arion-compose.nix b/docs/modules/ROOT/examples/nixos-unit/arion-compose.nix new file mode 120000 index 0000000..45c5b7a --- /dev/null +++ b/docs/modules/ROOT/examples/nixos-unit/arion-compose.nix @@ -0,0 +1 @@ +../../../../../examples/nixos-unit/arion-compose.nix \ No newline at end of file diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc index 471d7eb..b976641 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/ROOT/pages/index.adoc @@ -113,75 +113,20 @@ Describe containers using NixOS-style modules. There are a few options: ==== Minimal: Plain command using nixpkgs -`examples/minimal/arion-compose.nix`: - -```nix -{ pkgs, ... }: -{ - config.services = { - - webserver = { - service.useHostStore = true; - service.command = [ "sh" "-c" '' - cd "$$WEB_ROOT" - ${pkgs.python3}/bin/python -m http.server - '' ]; - service.ports = [ - "8000:8000" # host:container - ]; - service.environment.WEB_ROOT = "${pkgs.nix.doc}/share/doc/nix/manual"; - }; - }; -} -``` - -==== NixOS: run only one systemd service - -`examples/nixos-unit/arion-compose.nix`: - -```nix -{ - services.webserver = { config, pkgs, ... }: { - - nixos.configuration = {config, pkgs, ...}: { - boot.isContainer = true; - services.nginx.enable = true; - services.nginx.virtualHosts.localhost.root = "${pkgs.nix.doc}/share/doc/nix/manual"; - system.build.run-nginx = pkgs.writeScript "run-nginx" '' - #!${pkgs.bash}/bin/bash - PATH='${config.systemd.services.nginx.environment.PATH}' - echo nginx:x:${toString config.users.users.nginx.uid}:${toString config.users.groups.nginx.gid}:nginx web server user:/var/empty:/bin/sh >>/etc/passwd - echo nginx:x:${toString config.users.groups.nginx.gid}:nginx >>/etc/group - ${config.systemd.services.nginx.runner} - ''; - }; - service.command = [ config.nixos.build.run-nginx ]; - service.useHostStore = true; - service.ports = [ - "8000:80" # host:container - ]; - }; -} -``` +`examples/minimal/arion-compose.nix` +[,nix] +---- +include::example$minimal/arion-compose.nix[] +---- ==== NixOS: run full OS `examples/full-nixos/arion-compose.nix`: -```nix -{ - services.webserver = { pkgs, ... }: { - nixos.useSystemd = true; - nixos.configuration.boot.tmpOnTmpfs = true; - nixos.configuration.services.nginx.enable = true; - nixos.configuration.services.nginx.virtualHosts.localhost.root = "${pkgs.nix.doc}/share/doc/nix/manual"; - service.useHostStore = true; - service.ports = [ - "8000:80" # host:container - ]; - }; -} -``` +[,nix] +---- +include::example$full-nixos/arion-compose.nix[] +---- ==== Docker image from DockerHub @@ -195,6 +140,11 @@ Describe containers using NixOS-style modules. There are a few options: } ``` +==== NixOS: run only one systemd service + +Running individual units from NixOS is possible using an experimental script. +See `examples/nixos-unit/arion-compose.nix`. + === Run Start containers and watch their logs: