verdi profile setup: Add --broker (aiidateam#7284)

Add `--broker` option to `verdi profile setup` accepting 'rabbitmq',
'zmq', or 'none'. Deprecate the `--use-rabbitmq/--no-use-rabbitmq`
flag with a warning pointing to the new option.

Add daemon restart logic to `verdi profile configure-rabbitmq` so
broker reconfiguration takes effect immediately.

Author: agoscinski

src/aiida/cmdline/commands/cmd_presto.py

@@ -190,7 +190,6 @@ def verdi_presto(
     broker. To switch to RabbitMQ later, use `verdi profile configure-rabbitmq`.
     """
     from aiida.brokers.rabbitmq.defaults import detect_rabbitmq_config
-    from aiida.brokers.zmq.defaults import get_zmq_config
     from aiida.common import exceptions
     from aiida.manage.configuration import create_profile, load_profile
     from aiida.orm import Computer
@@ -226,14 +225,14 @@ def verdi_presto(
     if use_zmq:
         echo.echo_report('`--use-zmq` enabled: configuring the profile with ZMQ broker.')
         broker_backend = 'core.zmq'
-        broker_config = get_zmq_config()
+        broker_config = {}
     else:
         try:
             broker_config = detect_rabbitmq_config()
         except ConnectionError:
             echo.echo_report('RabbitMQ server not found: falling back to ZMQ broker.')
             broker_backend = 'core.zmq'
-            broker_config = get_zmq_config()
+            broker_config = {}
         else:
             echo.echo_report('RabbitMQ server detected: configuring the profile with RabbitMQ broker.')
             broker_backend = 'core.rabbitmq'

src/aiida/cmdline/commands/cmd_profile.py

@@ -36,7 +36,8 @@ def command_create_profile(
     first_name: str | None = None,
     last_name: str | None = None,
     institution: str | None = None,
-    use_rabbitmq: bool = True,
+    broker: str = 'rabbitmq',
+    use_rabbitmq: bool | None = None,
     **kwargs,
 ):
     """Create a new profile, initialise its storage and create a default user.
@@ -51,10 +52,17 @@ def command_create_profile(
     :param first_name: First name for the default user.
     :param last_name: Last name for the default user.
     :param institution: Institution for the default user.
-    :param use_rabbitmq: Whether to configure RabbitMQ as the broker.
+    :param broker: Message broker backend ('rabbitmq', 'zmq', or 'none').
+    :param use_rabbitmq: Deprecated. Use ``broker`` instead. If False, equivalent to ``broker='none'``.
     :param kwargs: Arguments to initialise instance of the selected storage implementation.
     """
-    from aiida.brokers.rabbitmq.defaults import detect_rabbitmq_config
+    # Handle deprecated --use-rabbitmq/--no-use-rabbitmq option
+    if use_rabbitmq is not None:
+        from aiida.common.warnings import warn_deprecation
+
+        warn_deprecation('The `--use-rabbitmq` option is deprecated. Use `--broker` instead.', version=3)
+        if not use_rabbitmq:
+            broker = 'none'
     from aiida.common import docs
     from aiida.plugins.entry_point import get_entry_point_from_class
 
@@ -70,7 +78,9 @@ def command_create_profile(
     broker_backend = None
     broker_config = None
 
-    if use_rabbitmq:
+    if broker == 'rabbitmq':
+        from aiida.brokers.rabbitmq.defaults import detect_rabbitmq_config
+
         try:
             broker_config = detect_rabbitmq_config()
         except ConnectionError as exception:
@@ -80,8 +90,15 @@ def command_create_profile(
             broker_backend = 'core.rabbitmq'
 
         echo.echo_report('RabbitMQ can be reconfigured with `verdi profile configure-rabbitmq`.')
-    else:
-        echo.echo_report('Creating profile without RabbitMQ.')
+
+    elif broker == 'zmq':
+        broker_backend = 'core.zmq'
+        broker_config = {}
+        echo.echo_success('ZMQ broker configured (no external service required).')
+        echo.echo_report('The ZMQ broker service will be started automatically with the daemon.')
+
+    else:  # broker == 'none'
+        echo.echo_report('Creating profile without a message broker.')
         echo.echo_report('It can be configured at a later point in time with `verdi profile configure-rabbitmq`.')
         echo.echo_report(f'See {docs.URL_NO_BROKER} for details on the limitations of running without a broker.')
 
@@ -124,7 +141,8 @@ def command_create_profile(
         setup.SETUP_USER_FIRST_NAME(),
         setup.SETUP_USER_LAST_NAME(),
         setup.SETUP_USER_INSTITUTION(),
-        setup.SETUP_USE_RABBITMQ(),
+        setup.SETUP_BROKER_BACKEND(),
+        setup.SETUP_USE_RABBITMQ(),  # Deprecated, for backward compatibility
     ],
 )
 def profile_setup():
@@ -161,12 +179,26 @@ def profile_configure_rabbitmq(ctx, /, profile, non_interactive, force, **kwargs
     else:
         echo.echo_success('Connected to RabbitMQ with the provided connection parameters')
 
+    from aiida.engine.daemon.client import get_daemon_client
+
+    daemon_client = get_daemon_client(profile.name)
+    daemon_running = daemon_client.is_daemon_running
+
+    if daemon_running:
+        echo.echo_warning('The daemon is currently running. It will need to be restarted for changes to take effect.')
+        click.confirm('Do you want to apply the configuration and restart the daemon?', abort=True)
+
     profile.set_process_controller(name='core.rabbitmq', config=broker_config)
     ctx.obj.config.update_profile(profile)
     ctx.obj.config.store()
 
     echo.echo_success(f'RabbitMQ configuration for `{profile.name}` updated to: {broker_config}')
 
+    if daemon_running:
+        echo.echo_report('Restarting the daemon...')
+        daemon_client.restart_daemon()
+        echo.echo_success('Daemon restarted successfully.')
+
 
 @verdi_profile.command('list')
 def profile_list():

src/aiida/cmdline/params/options/commands/setup.py

@@ -342,11 +342,20 @@ def get_quicksetup_password(ctx: click.Context, param: click.Parameter, value: s
 
 SETUP_USE_RABBITMQ = options.OverridableOption(
     '--use-rabbitmq/--no-use-rabbitmq',
-    prompt='Use RabbitMQ?',
     is_flag=True,
-    default=True,
+    default=None,
+    hidden=True,
+    help='Deprecated: use --broker instead. --no-use-rabbitmq is equivalent to --broker none.',
+)
+
+SETUP_BROKER_BACKEND = options.OverridableOption(
+    '--broker',
+    prompt='Message broker',
+    type=click.Choice(['rabbitmq', 'zmq', 'none']),
+    default='rabbitmq',
     cls=options.interactive.InteractiveOption,
-    help='Whether to configure the RabbitMQ broker. Required to enable the daemon and submitting processes.',
+    help='Message broker backend for process control. Use "rabbitmq" for RabbitMQ (requires external server), '
+    '"zmq" for ZeroMQ (built-in, no external dependencies), or "none" to disable (limited functionality).',
 )
 
 SETUP_BROKER_PROTOCOL = QUICKSETUP_BROKER_PROTOCOL.clone(