nixpkgs/nixos/tests/ceph-single-node.nix

import ./make-test-python.nix (
  { pkgs, lib, ... }:

  let
    cfg = {
      clusterId = "066ae264-2a5d-4729-8001-6ad265f50b03";
      monA = {
        name = "a";
        ip = "192.168.1.1";
      };
      osd0 = {
        name = "0";
        key = "AQBCEJNa3s8nHRAANvdsr93KqzBznuIWm2gOGg==";
        uuid = "55ba2294-3e24-478f-bee0-9dca4c231dd9";
      };
      osd1 = {
        name = "1";
        key = "AQBEEJNac00kExAAXEgy943BGyOpVH1LLlHafQ==";
        uuid = "5e97a838-85b6-43b0-8950-cb56d554d1e5";
      };
      osd2 = {
        name = "2";
        key = "AQAdyhZeIaUlARAAGRoidDAmS6Vkp546UFEf5w==";
        uuid = "ea999274-13d0-4dd5-9af9-ad25a324f72f";
      };
    };
    generateCephConfig =
      { daemonConfig }:
      {
        enable = true;
        global = {
          fsid = cfg.clusterId;
          monHost = cfg.monA.ip;
          monInitialMembers = cfg.monA.name;
        };
      }
      // daemonConfig;

    generateHost =
      {
        pkgs,
        cephConfig,
        networkConfig,
        ...
      }:
      {
        virtualisation = {
          emptyDiskImages = [
            20480
            20480
            20480
          ];
          vlans = [ 1 ];
        };

        networking = networkConfig;

        environment.systemPackages = with pkgs; [
          bash
          sudo
          ceph
          xfsprogs
        ];

        boot.kernelModules = [ "xfs" ];

        services.ceph = cephConfig;
      };

    networkMonA = {
      dhcpcd.enable = false;
      interfaces.eth1.ipv4.addresses = pkgs.lib.mkOverride 0 [
        {
          address = cfg.monA.ip;
          prefixLength = 24;
        }
      ];
    };
    cephConfigMonA = generateCephConfig {
      daemonConfig = {
        mon = {
          enable = true;
          daemons = [ cfg.monA.name ];
        };
        mgr = {
          enable = true;
          daemons = [ cfg.monA.name ];
        };
        osd = {
          enable = true;
          daemons = [
            cfg.osd0.name
            cfg.osd1.name
            cfg.osd2.name
          ];
        };
      };
    };

    # Following deployment is based on the manual deployment described here:
    # https://docs.ceph.com/docs/master/install/manual-deployment/
    # For other ways to deploy a ceph cluster, look at the documentation at
    # https://docs.ceph.com/docs/master/
    testscript =
      { ... }:
      ''
        start_all()

        monA.wait_for_unit("network.target")

        # Bootstrap ceph-mon daemon
        monA.succeed(
            "sudo -u ceph ceph-authtool --create-keyring /tmp/ceph.mon.keyring --gen-key -n mon. --cap mon 'allow *'",
            "sudo -u ceph ceph-authtool --create-keyring /etc/ceph/ceph.client.admin.keyring --gen-key -n client.admin --cap mon 'allow *' --cap osd 'allow *' --cap mds 'allow *' --cap mgr 'allow *'",
            "sudo -u ceph ceph-authtool /tmp/ceph.mon.keyring --import-keyring /etc/ceph/ceph.client.admin.keyring",
            "monmaptool --create --add ${cfg.monA.name} ${cfg.monA.ip} --fsid ${cfg.clusterId} /tmp/monmap",
            "sudo -u ceph ceph-mon --mkfs -i ${cfg.monA.name} --monmap /tmp/monmap --keyring /tmp/ceph.mon.keyring",
            "sudo -u ceph touch /var/lib/ceph/mon/ceph-${cfg.monA.name}/done",
            "systemctl start ceph-mon-${cfg.monA.name}",
        )
        monA.wait_for_unit("ceph-mon-${cfg.monA.name}")
        monA.succeed("ceph mon enable-msgr2")
        monA.succeed("ceph config set mon auth_allow_insecure_global_id_reclaim false")

        # Can't check ceph status until a mon is up
        monA.succeed("ceph -s | grep 'mon: 1 daemons'")

        # Start the ceph-mgr daemon, after copying in the keyring
        monA.succeed(
            "sudo -u ceph mkdir -p /var/lib/ceph/mgr/ceph-${cfg.monA.name}/",
            "ceph auth get-or-create mgr.${cfg.monA.name} mon 'allow profile mgr' osd 'allow *' mds 'allow *' > /var/lib/ceph/mgr/ceph-${cfg.monA.name}/keyring",
            "systemctl start ceph-mgr-${cfg.monA.name}",
        )
        monA.wait_for_unit("ceph-mgr-a")
        monA.wait_until_succeeds("ceph -s | grep 'quorum ${cfg.monA.name}'")
        monA.wait_until_succeeds("ceph -s | grep 'mgr: ${cfg.monA.name}(active,'")

        # Bootstrap OSDs
        monA.succeed(
            "mkfs.xfs /dev/vdb",
            "mkfs.xfs /dev/vdc",
            "mkfs.xfs /dev/vdd",
            "mkdir -p /var/lib/ceph/osd/ceph-${cfg.osd0.name}",
            "mount /dev/vdb /var/lib/ceph/osd/ceph-${cfg.osd0.name}",
            "mkdir -p /var/lib/ceph/osd/ceph-${cfg.osd1.name}",
            "mount /dev/vdc /var/lib/ceph/osd/ceph-${cfg.osd1.name}",
            "mkdir -p /var/lib/ceph/osd/ceph-${cfg.osd2.name}",
            "mount /dev/vdd /var/lib/ceph/osd/ceph-${cfg.osd2.name}",
            "ceph-authtool --create-keyring /var/lib/ceph/osd/ceph-${cfg.osd0.name}/keyring --name osd.${cfg.osd0.name} --add-key ${cfg.osd0.key}",
            "ceph-authtool --create-keyring /var/lib/ceph/osd/ceph-${cfg.osd1.name}/keyring --name osd.${cfg.osd1.name} --add-key ${cfg.osd1.key}",
            "ceph-authtool --create-keyring /var/lib/ceph/osd/ceph-${cfg.osd2.name}/keyring --name osd.${cfg.osd2.name} --add-key ${cfg.osd2.key}",
            'echo \'{"cephx_secret": "${cfg.osd0.key}"}\' | ceph osd new ${cfg.osd0.uuid} -i -',
            'echo \'{"cephx_secret": "${cfg.osd1.key}"}\' | ceph osd new ${cfg.osd1.uuid} -i -',
            'echo \'{"cephx_secret": "${cfg.osd2.key}"}\' | ceph osd new ${cfg.osd2.uuid} -i -',
        )

        # Initialize the OSDs with regular filestore
        monA.succeed(
            "ceph-osd -i ${cfg.osd0.name} --mkfs --osd-uuid ${cfg.osd0.uuid}",
            "ceph-osd -i ${cfg.osd1.name} --mkfs --osd-uuid ${cfg.osd1.uuid}",
            "ceph-osd -i ${cfg.osd2.name} --mkfs --osd-uuid ${cfg.osd2.uuid}",
            "chown -R ceph:ceph /var/lib/ceph/osd",
            "systemctl start ceph-osd-${cfg.osd0.name}",
            "systemctl start ceph-osd-${cfg.osd1.name}",
            "systemctl start ceph-osd-${cfg.osd2.name}",
        )
        monA.wait_until_succeeds("ceph osd stat | grep -e '3 osds: 3 up[^,]*, 3 in'")
        monA.wait_until_succeeds("ceph -s | grep 'mgr: ${cfg.monA.name}(active,'")
        monA.wait_until_succeeds("ceph -s | grep 'HEALTH_OK'")

        monA.succeed(
            "ceph osd pool create single-node-test 32 32",
            "ceph osd pool ls | grep 'single-node-test'",

            # We need to enable an application on the pool, otherwise it will
            # stay unhealthy in state POOL_APP_NOT_ENABLED.
            # Creating a CephFS would do this automatically, but we haven't done that here.
            # See: https://docs.ceph.com/en/reef/rados/operations/pools/#associating-a-pool-with-an-application
            # We use the custom application name "nixos-test" for this.
            "ceph osd pool application enable single-node-test nixos-test",

            "ceph osd pool rename single-node-test single-node-other-test",
            "ceph osd pool ls | grep 'single-node-other-test'",
        )
        monA.wait_until_succeeds("ceph -s | grep '2 pools, 33 pgs'")
        monA.succeed(
            "ceph osd getcrushmap -o crush",
            "crushtool -d crush -o decrushed",
            "sed 's/step chooseleaf firstn 0 type host/step chooseleaf firstn 0 type osd/' decrushed > modcrush",
            "crushtool -c modcrush -o recrushed",
            "ceph osd setcrushmap -i recrushed",
            "ceph osd pool set single-node-other-test size 2",
        )
        monA.wait_until_succeeds("ceph -s | grep 'HEALTH_OK'")
        monA.wait_until_succeeds("ceph -s | grep '33 active+clean'")
        monA.fail(
            "ceph osd pool ls | grep 'multi-node-test'",
            "ceph osd pool delete single-node-other-test single-node-other-test --yes-i-really-really-mean-it",
        )

        # Shut down ceph by stopping ceph.target.
        monA.succeed("systemctl stop ceph.target")

        # Start it up
        monA.succeed("systemctl start ceph.target")
        monA.wait_for_unit("ceph-mon-${cfg.monA.name}")
        monA.wait_for_unit("ceph-mgr-${cfg.monA.name}")
        monA.wait_for_unit("ceph-osd-${cfg.osd0.name}")
        monA.wait_for_unit("ceph-osd-${cfg.osd1.name}")
        monA.wait_for_unit("ceph-osd-${cfg.osd2.name}")

        # Ensure the cluster comes back up again
        monA.succeed("ceph -s | grep 'mon: 1 daemons'")
        monA.wait_until_succeeds("ceph -s | grep 'quorum ${cfg.monA.name}'")
        monA.wait_until_succeeds("ceph osd stat | grep -e '3 osds: 3 up[^,]*, 3 in'")
        monA.wait_until_succeeds("ceph -s | grep 'mgr: ${cfg.monA.name}(active,'")
        monA.wait_until_succeeds("ceph -s | grep 'HEALTH_OK'")

        # Enable the dashboard and recheck health
        monA.succeed(
            "ceph mgr module enable dashboard",
            "ceph config set mgr mgr/dashboard/ssl false",
            # default is 8080 but it's better to be explicit
            "ceph config set mgr mgr/dashboard/server_port 8080",
        )
        monA.wait_for_open_port(8080)
        monA.wait_until_succeeds("curl -q --fail http://localhost:8080")
        monA.wait_until_succeeds("ceph -s | grep 'HEALTH_OK'")
      '';
  in
  {
    name = "basic-single-node-ceph-cluster";
    meta = with pkgs.lib.maintainers; {
      maintainers = [
        lejonet
        johanot
      ];
    };

    nodes = {
      monA = generateHost {
        pkgs = pkgs;
        cephConfig = cephConfigMonA;
        networkConfig = networkMonA;
      };
    };

    testScript = testscript;
  }
)