[CLI] New CLI tool for node operators #268

odesenfans · 2022-05-15T14:39:10Z

We now provide a CLI tool that integrates all the operations
commonly performed by node operators. Currently, this CLI
allows to:

generate private keys for the node, replacing a functionality
that was implemented in the CCN main app directly.
run migrations, replacing the config updater script.

odesenfans · 2022-05-15T14:46:06Z

After discussion with @hoh regarding the garbage collector, we decided to do garbage collection differently from what is proposed in #250. The idea is that the GC will be invoked manually for the time being. To make this easier for node operators, we decided to introduce a new CLI tool that will implement useful commands for node operators. This PR is the initial work for this, before the introduction of the GC.

To do / To discuss:

update the documentation
put the CLI in a different Python module? (requires to split the CCN in several modules)
A better name for the tool?

$ ccn_cli --help
Usage: ccn_cli [OPTIONS] COMMAND [ARGS]...

  Aleph Core Channel Node CLI for operators.

Options:
  --config PATH                   Path to the configuration file of the CCN.
                                  Defaults to <cwd>/config.yml.
  --key-dir PATH                  Path to the key directory. Defaults to
                                  <cwd>/keys/.
  --verbose / --no-verbose        Show more information.  [default: no-
                                  verbose]
  --install-completion [bash|zsh|fish|powershell|pwsh]
                                  Install completion for the specified shell.
  --show-completion [bash|zsh|fish|powershell|pwsh]
                                  Show completion for the specified shell, to
                                  copy it or customize the installation.
  --help                          Show this message and exit.

Commands:
  keys        Operations on private keys.
  migrations  Run DB migrations.

Usage: ccn_cli keys [OPTIONS] COMMAND [ARGS]...

  Operations on private keys.

Options:
  --help  Show this message and exit.

Commands:
  generate  Generates a new set of private/public keys for the Core...
  show      Prints the private key of the node.

Usage: ccn_cli migrations [OPTIONS] COMMAND [ARGS]...

  Run DB migrations.

Options:
  --help  Show this message and exit.

Commands:
  downgrade
  upgrade

Problem: web wallets do not allow signing raw messages. Instead, they require binary payloads in a specific format. Solution: support Micheline-style signatures, i.e. signatures supported by wallets like Beacon. Users can now use Micheline or raw signatures by specifying the `signature.signingType` field to "micheline" or "raw". By default, "raw" is assumed. Co-authored-by: Mike Hukiewitz <[email protected]>

We now provide a CLI tool that integrates all the operations commonly performed by node operators. Currently, this CLI allows to: * generate private keys for the node, replacing a functionality that was implemented in the CCN main app directly. * run migrations, replacing the config updater script.

hoh

A few comments, looks good overall 👍

hoh · 2022-10-13T08:25:45Z

src/aleph/ccn_cli/cli_config.py

+class CliConfig:
+    config_file_path: Path
+    key_dir: Path
+    verbose: bool


No default ?

hoh · 2022-10-13T08:29:07Z

src/aleph/ccn_cli/commands/keys.py

+from typing import cast
+from aleph.ccn_cli.services.keys import generate_keypair, save_keys
+
+keys_ns = typer.Typer()


This naming does not seem clear to me. The habit in Typer is app = typer.Typer(), so I would base the naming on that.

Suggested change

keys_ns = typer.Typer()

app = typer.Typer()

hoh · 2022-10-13T08:35:37Z

src/aleph/ccn_cli/commands/keys.py

+    The keys will be created in the key directory. You can modify the destination
+    by using the --key-dir option.
+    """
+    cli_config = cast(CliConfig, ctx.obj)


This casting is not obvious. Would it be worth adding a comment to explain it ?

hoh · 2022-10-13T08:35:49Z

src/aleph/ccn_cli/commands/keys.py

+    by using the --key-dir option.
+    """
+    cli_config = cast(CliConfig, ctx.obj)
+    print(cli_config)


Why this print ?

hoh · 2022-10-13T08:36:48Z

src/aleph/ccn_cli/commands/keys.py

+
+
+@keys_ns.command()
+def generate(ctx: typer.Context):


Replace generate with the simpler create term ?

Suggested change

def generate(ctx: typer.Context):

def create(ctx: typer.Context):

hoh · 2022-10-13T10:15:39Z

src/aleph/ccn_cli/commands/migrations/__init__.py

+    except Exception as e:
+        typer.echo(f"{command} failed: {e}.", err=True)
+        if cli_config.verbose:
+            typer.echo(format_exc())


Do we really want to only display the exception in verbose mode ? I am wondering if it would not make it easier that any user can copy paste the traceback of an error without running the command again 🤔

hoh · 2022-10-13T12:12:00Z

src/aleph/ccn_cli/commands/migrations/migration_runner.py

+    return config
+
+
+def import_module_from_path(path: str) -> ModuleType:


Suggested change

def import_module_from_path(path: str) -> ModuleType:

def import_module_from_path(path: Path) -> ModuleType:

hoh · 2022-10-13T12:19:43Z

src/aleph/ccn_cli/main.py

+import typer
+
+from .cli_config import CliConfig
+from .commands.keys import keys_ns


If using the app naming convention in the module, this could become:

Suggested change

from .commands.keys import keys_ns

import .commands.keys.app as keys_app

else:

Suggested change

from .commands.keys import keys_ns

import . import commands.keys

...

app.add_typer(commands.keys.app, name="keys", help="Operations on private keys.")

hoh · 2022-10-13T13:30:18Z

src/aleph/ccn_cli/services/keys.py

+    return key_pair
+
+
+def save_keys(key_pair: KeyPair, key_dir: str) -> None:


Use pathlib.Path ?

hoh · 2022-10-13T13:31:18Z

src/aleph/ccn_cli/services/keys.py

+def generate_keypair() -> KeyPair:
+    """
+    Generates a new key pair for the node.
+    """
+    key_pair = create_new_key_pair()
+    return key_pair


Why this proxy function ?

Suggested change

def generate_keypair() -> KeyPair:

"""

Generates a new key pair for the node.

"""

key_pair = create_new_key_pair()

return key_pair

generate_keypair = create_new_key_pair

odesenfans force-pushed the od-node-operator-cli branch from f08a6c0 to 50744dd Compare May 15, 2022 14:47

odesenfans mentioned this pull request May 15, 2022

Feature: garbage collector CLI command #269

Draft

odesenfans marked this pull request as ready for review May 17, 2022 08:37

odesenfans requested a review from hoh May 17, 2022 08:37

odesenfans assigned hoh May 17, 2022

odesenfans force-pushed the od-node-operator-cli branch from 50744dd to fdf844f Compare June 14, 2022 13:18

odesenfans changed the base branch from dev to master July 2, 2022 16:09

odesenfans and others added 2 commits September 26, 2022 14:20

odesenfans force-pushed the od-node-operator-cli branch from fdf844f to 50798e3 Compare October 2, 2022 23:19

odesenfans changed the base branch from master to dev October 2, 2022 23:19

hoh reviewed Oct 13, 2022

View reviewed changes

odesenfans force-pushed the dev branch from f887c6f to 172f796 Compare October 17, 2022 09:13

odesenfans force-pushed the dev branch from 8abefc9 to aa38b38 Compare October 27, 2022 11:53

odesenfans force-pushed the dev branch from aa38b38 to 1e4d83c Compare January 9, 2023 22:19

odesenfans force-pushed the dev branch 2 times, most recently from d9f920c to 3d016e0 Compare March 21, 2023 13:43

odesenfans force-pushed the dev branch from e74460f to 5cd4496 Compare April 24, 2023 14:47

odesenfans force-pushed the dev branch 2 times, most recently from 48b3f90 to 11bf24a Compare October 27, 2023 17:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CLI] New CLI tool for node operators #268

[CLI] New CLI tool for node operators #268

odesenfans commented May 15, 2022

odesenfans commented May 15, 2022

hoh left a comment

hoh Oct 13, 2022

hoh Oct 13, 2022

hoh Oct 13, 2022

hoh Oct 13, 2022

hoh Oct 13, 2022

hoh Oct 13, 2022

hoh Oct 13, 2022

hoh Oct 13, 2022

hoh Oct 13, 2022

hoh Oct 13, 2022

	def generate(ctx: typer.Context):
	def create(ctx: typer.Context):

		return config


		def import_module_from_path(path: str) -> ModuleType:

	def import_module_from_path(path: str) -> ModuleType:
	def import_module_from_path(path: Path) -> ModuleType:

	from .commands.keys import keys_ns
	import .commands.keys.app as keys_app

-from .commands.keys import keys_ns
+import . import commands.keys
+...
+app.add_typer(commands.keys.app, name="keys", help="Operations on private keys.")

		return key_pair


		def save_keys(key_pair: KeyPair, key_dir: str) -> None:

[CLI] New CLI tool for node operators #268

Are you sure you want to change the base?

[CLI] New CLI tool for node operators #268

Conversation

odesenfans commented May 15, 2022

odesenfans commented May 15, 2022

hoh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment