You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+58-2
Original file line number
Diff line number
Diff line change
@@ -416,7 +416,63 @@ Byron vote submission:
416
416
Development
417
417
****
418
418
419
-
Development tooling
419
+
Overview
420
+
====
421
+
422
+
The ``cardano-node`` development is primarily based on the Nix infrastructure (https://nixos.org/ ), which enables packaging, CI, development environments and deployments.
423
+
424
+
On how to set up Nix for ``cardano-node`` development, please see `Building Cardano Node with nix <https://github.com/input-output-hk/cardano-node/tree/master/doc/getting-started/building-the-node-using-nix.md>`_.
425
+
426
+
Workbench: a local cluster playground
427
+
====
428
+
429
+
You can quickly spin up a local cluster, based on any of a wide variety of configurations, and put it under a transaction generation workload -- using the ``workbench`` environment:
430
+
431
+
1. Optional: choose a workbench profile:
432
+
- ``default`` stands for a light-state, 6-node cluster, under saturation workload, indefinite runtime
433
+
- ``ci-test`` is the profile run in the node CI -- very light, just two nodes and short runtime
434
+
- ``devops`` is an unloaded profile (no transaction generation) with short slots -- ``0.2`` s.
435
+
- ..and many more -- which can be either:
436
+
- listed, by ``make ps``
437
+
- observed at their point of definition: `nix/workbench/profiles/prof1-variants.jq <https://github.com/input-output-hk/cardano-node/tree/master/nix/workbench/profiles/prof1-variants.jq#L333-L526>`_.
438
+
2. Optional: select mode of operation, by optionally providing a suffix:
439
+
- default -- no suffix -- just enter the workbench shell, allowing you to run ``start-cluster`` at any time. Binaries will be built locally, by ``cabal``.
440
+
- ``autostay`` suffix -- enter the workbench shell, start the cluster, and stay in the shell afterwards. Binaries will be built locally, by ``cabal``.
441
+
- ``autonix`` suffix -- enter the workbench shell, start the cluster. All binaries will be provided by the Nix CI.
442
+
- ..there are other modes, as per `lib.mk <https://github.com/input-output-hk/cardano-node/tree/master/lib.mk>`_.
443
+
3. Enter the workbench shell for the chosen profile & mode:
444
+
``make <PROFILE-NAME>`` or ``make <PROFILE-NAME>-<SUFFIX>`` (when there is a suffix).
445
+
4. Optional: start cluster:
446
+
Depending on the chosen mode, your cluster might already start, or you are expected to start it yourself, using ``start-cluster``.
447
+
448
+
The workbench services are available only inside the workbench shell.
449
+
450
+
Using Cabal
451
+
----
452
+
453
+
By default, all binaries originating in the ``cardano-node`` repository are available to ``cabal build`` and ``cabal run``, unless the workbench was entered using one of the pure ``*nix`` modes. Note that in all cases, the dependencies for the workbench are supplied though Nix and have been built/tested on CI.
454
+
455
+
Hoogle
456
+
----
457
+
458
+
The workbench shell provides ``hoogle``, with a local database for the full set of dependencies:
0 commit comments