Skip to content

feat: Better default config values #226

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
gregjacobus wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

feat: Better default config values #226

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c2d7cb4
setting some more realistic default values for config params
gregjacobus Dec 23, 2025
e67c53c
updating associated documentation
gregjacobus Dec 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 24 additions & 24 deletions docs/source/install/configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,13 @@ These settings are used by FIREWHEEL's :ref:`cli`.

.. table::

+-------------+----------+----------+---------------------------------------------------------------------------------------------------+
| Setting |Value Type| Default | Description |
+=============+==========+==========+===================================================================================================+
|``cache_dir``|string |``fw_cli``|The folder name of the CLI Helper cache. |
+-------------+----------+----------+---------------------------------------------------------------------------------------------------+
|``root_dir`` |string |``""`` |The path to the ``cache_dir``. If left empty, the ``system.default_output_dir`` value will be used.|
+-------------+----------+----------+---------------------------------------------------------------------------------------------------+
+-------------+----------+------------------+---------------------------------------------------------------------------------------------------+
| Setting |Value Type| Default | Description |
+=============+==========+==================+===================================================================================================+
|``cache_dir``|string |``fw_cli`` |The folder name of the CLI Helper cache. |
+-------------+----------+------------------+---------------------------------------------------------------------------------------------------+
|``root_dir`` |string |``/tmp/firewheel``|The path to the ``cache_dir``. If left empty, the ``system.default_output_dir`` value will be used.|
Copy link
Member

@mitchnegus mitchnegus Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|``root_dir`` |string |``/tmp/firewheel``|The path to the ``cache_dir``. If left empty, the ``system.default_output_dir`` value will be used.|
|``root_dir`` |string |``/tmp/firewheel``|The path to the ``cache_dir``. If set as an empty string, the ``system.default_output_dir`` value will be used as the fallback. |

+-------------+----------+------------------+---------------------------------------------------------------------------------------------------+

.. _config-cluster:

Expand Down Expand Up @@ -100,21 +100,21 @@ These settings are used by FIREWHEEL's gRPC service.

.. table::

+-------------+----------+-----------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| Setting |Value Type| Default | Description |
+=============+==========+===========+======================================================================================================================================================+
|``cache_dir``|string |``fw_grpc``|The folder name of the gRPC database cache. |
+-------------+----------+-----------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|``db`` |string |``prod`` |The name of the database to use. We use ``prod`` for production and ``test`` for running our test suite. |
+-------------+----------+-----------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|``hostname`` |string |``""`` |The hostname or IP address of FIREWHEEL's gRPC service. This is typically the :ref:`cluster-control-node`. |
+-------------+----------+-----------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|``port`` |int |``50051`` |The port number for FIREWHEEL's gRPC service. |
+-------------+----------+-----------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|``root_dir`` |string |``""`` |The path to the ``cache_dir``. If left empty, the ``system.default_output_dir`` value will be used. |
+-------------+----------+-----------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|``threads`` |int |``2`` |The number of threads used for the gRPC service. If the cluster is larger, the number of threads should be increased to facilitate better performance.|
+-------------+----------+-----------+------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------+----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| Setting |Value Type| Default | Description |
+=============+==========+==================+======================================================================================================================================================+
|``cache_dir``|string |``fw_grpc`` |The folder name of the gRPC database cache. |
+-------------+----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|``db`` |string |``prod`` |The name of the database to use. We use ``prod`` for production and ``test`` for running our test suite. |
+-------------+----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|``hostname`` |string |``localhost`` |The hostname or IP address of FIREWHEEL's gRPC service. This is typically the :ref:`cluster-control-node`. |
+-------------+----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|``port`` |int |``50051`` |The port number for FIREWHEEL's gRPC service. |
+-------------+----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|``root_dir`` |string |``/tmp/firewheel``|The path to the ``cache_dir``. If left empty, the ``system.default_output_dir`` value will be used. |
Copy link
Member

@mitchnegus mitchnegus Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|``root_dir`` |string |``/tmp/firewheel``|The path to the ``cache_dir``. If left empty, the ``system.default_output_dir`` value will be used. |
|``root_dir`` |string |``/tmp/firewheel``|The path to the ``cache_dir``. If set as an empty string, the ``system.default_output_dir`` value will be used as the fallback. |

+-------------+----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|``threads`` |int |``2`` |The number of threads used for the gRPC service. If the cluster is larger, the number of threads should be increased to facilitate better performance.|
+-------------+----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+

.. _config-logging:

Expand All @@ -141,7 +141,7 @@ These settings are used to manage FIREWHEEL's logging capabilities.
+-------------------------+----------+--------------------+---------------------------------------------------------------------------------------------------------------------------------+
|.. _config-root_log_dir: | | | |
| | | | |
|``root_dir`` |string |``""`` |The path to the log files. If left empty, the ``system.default_output_dir`` value will be used. |
|``root_dir`` |string |``/tmp/firewheel`` |The path to the log files. If left empty, the ``system.default_output_dir`` value will be used. |
Copy link
Member

@mitchnegus mitchnegus Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|``root_dir`` |string |``/tmp/firewheel`` |The path to the log files. If left empty, the ``system.default_output_dir`` value will be used. |
|``root_dir`` |string |``/tmp/firewheel`` |The path to the log files. If set as an empty string, the ``system.default_output_dir`` value will be used as the fallback. |

+-------------------------+----------+--------------------+---------------------------------------------------------------------------------------------------------------------------------+
|.. _config-vmr_log_dir: | | | |
| | | | |
Expand All @@ -166,7 +166,7 @@ These settings are used for interaction between FIREWHEEL and `minimega <https:/
+------------------------+----------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|``degree`` |int |``1`` |The minimega degree for the cluster. This specifies the number of other nodes minimega should try to connect to and should be equal to the number of nodes in your :ref:`FIREWHEEL-cluster`. |
+------------------------+----------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|``experiment_interface``|string |``""`` |The NIC for the current host for which will be used to connect to other :ref:`cluster-nodes`. |
|``experiment_interface``|string |``lo`` |The NIC for the current host for which will be used to connect to other :ref:`cluster-nodes`. |
+------------------------+----------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|``files_dir`` |string |``/tmp/minimega/files``|minimega's ``filepath`` option, which is used in their `iomeshage capability <https://www.sandia.gov/minimega/using-minimega/>`_. |
+------------------------+----------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Expand Down
10 changes: 5 additions & 5 deletions src/firewheel/config/config-template.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ ansible: {}
attribute_defaults: {}
cli:
cache_dir: fw_cli
root_dir: ""
root_dir: /tmp/firewheel
cluster:
compute: []
control: []
Expand All @@ -13,23 +13,23 @@ discovery:
grpc:
cache_dir: fw_grpc
db: prod
hostname: ""
hostname: localhost
port: 50051
root_dir: ""
root_dir: /tmp/firewheel
threads: 2
logging:
cli_log: cli.log
discovery_log: discovery.log
firewheel_log: firewheel.log
level: DEBUG
minimega_log: minimega.log
root_dir: ""
root_dir: /tmp/firewheel
vmr_log_dir: vm_resource_logs
minimega:
base_dir: /tmp/minimega
control_bridge: mega_bridge
degree: 1
experiment_interface: ""
experiment_interface: lo
files_dir: /tmp/minimega/files
install_dir: /opt/minimega
namespace: firewheel
Expand Down
Loading