clan-core/pkgs/clan-cli/clan_cli/vars/cli.py

# !/usr/bin/env python3
import argparse

from clan_cli.hyperlink import help_hyperlink

from .check import register_check_parser
from .fix import register_fix_parser
from .generate import register_generate_parser
from .get import register_get_parser
from .keygen import register_keygen_parser
from .list import register_list_parser
from .set import register_set_parser
from .upload import register_upload_parser


# takes a (sub)parser and configures it
def register_parser(parser: argparse.ArgumentParser) -> None:
    subparser = parser.add_subparsers(
        title="command",
        description="the command to run",
        help="the command to run",
        required=True,
    )

    keygen_parser = subparser.add_parser(
        "keygen",
        help="initialize sops keys for vars",
        epilog=(
            """
This subcommand allows initializing sops keys for vars.
This creates the file ~/.config/sops/age/keys.txt

             """
        ),
        formatter_class=argparse.RawTextHelpFormatter,
    )
    register_keygen_parser(keygen_parser)

    check_parser = subparser.add_parser(
        "check",
        help="check if vars are up to date",
        epilog=(
            """
This subcommand allows checking if all vars are up to date.

Examples:

  $ clan vars check [MACHINE]
  Will check vars for the specified machine.
        """
        ),
        formatter_class=argparse.RawTextHelpFormatter,
    )
    register_check_parser(check_parser)

    fix_parser = subparser.add_parser(
        "fix",
        help="fix inconsistencies in the vars store",
        epilog=(
            """
This subcommand allows fixing of inconsistencies in the vars store.

Examples:

  $ clan vars fix [MACHINE]
  Will fix vars for the specified machine.
        """
        ),
        formatter_class=argparse.RawTextHelpFormatter,
    )
    register_fix_parser(fix_parser)

    list_parser = subparser.add_parser(
        "list",
        help="list all vars",
        epilog=(
            f"""
This subcommand allows listing all non-secret vars for a specific machine.

The resulting list will be strings terminated by newlines as key-value pairs separated by a space.

This is how an example output might look like:
```
[GENERATOR_NAME/VAR_1] [VALUE_1]
[GENERATOR_NAME/VAR_2] [VALUE_2]
```

Examples:

  $ clan vars list [MACHINE]
  Will list vars for the specified machine.
  Secret vars will be masked by ******** and can be queried directly.

  $ clan vars get [MACHINE] [GENERATOR_NAME/VAR]
  This will print secret as well as public vars directly.


For more detailed information, visit: {help_hyperlink("secrets", "https://docs.clan.lol/getting-started/secrets")}
        """
        ),
        formatter_class=argparse.RawTextHelpFormatter,
    )
    register_list_parser(list_parser)

    get_parser = subparser.add_parser(
        "get",
        help="get a specific var",
        epilog=(
            f"""
This subcommand allows getting a specific var for a specific machine.

Examples:

    $ clan vars get my-server zerotier/vpn-ip
    Will get the var for the specified machine.

For more detailed information, visit: {help_hyperlink("secrets", "https://docs.clan.lol/getting-started/secrets")}
        """
        ),
        formatter_class=argparse.RawTextHelpFormatter,
    )
    register_get_parser(get_parser)

    set_parser = subparser.add_parser(
        "set",
        help="set a specific var",
        epilog=(
            f"""
This subcommand allows setting a specific var for a specific machine.

Examples:

    $ clan vars set my-server zerotier/vpn-ip
    Will set the var for the specified machine.

For more detailed information, visit: {help_hyperlink("secrets", "https://docs.clan.lol/getting-started/secrets")}
        """
        ),
        formatter_class=argparse.RawTextHelpFormatter,
    )
    register_set_parser(set_parser)

    parser_generate = subparser.add_parser(
        "generate",
        help="(re-)generate vars for specific or all machines",
        epilog=(
            f"""
This subcommand allows control of the generation of vars.
Often this function will be invoked automatically on deploying machines,
but there are situations the user may want to have more granular control,
especially for the regeneration of certain services.

A service is an included clan-module that implements vars generation functionality.
For example the zerotier module will generate secret and public vars.
In this case the public vars will be the resulting zerotier-ip of the machine.
The secret variable will be the zerotier-identity-secret, which is used by zerotier
to prove the machine has control of the zerotier-ip.


Examples:

  $ clan vars generate
  Will generate vars for all machines.

  $ clan vars generate [MACHINE]
  Will generate vars for the specified machine.

  $ clan vars generate [MACHINE] --generator [SERVICE]
  Will generate vars for the specified machine for the specified service.

  $ clan vars generate --generator [SERVICE] --regenerate
  Will regenerate vars, if they are already generated for a specific service.
  This is especially useful for resetting certain passwords while leaving the rest
  of the vars for a machine in place.

For more detailed information, visit: {help_hyperlink("secrets", "https://docs.clan.lol/getting-started/secrets")}
        """
        ),
        formatter_class=argparse.RawTextHelpFormatter,
    )
    register_generate_parser(parser_generate)

    parser_upload = subparser.add_parser(
        "upload",
        help="upload secrets for machines",
        epilog=(
            f"""
This subcommand allows uploading secrets to remote machines.

If using sops as a secret backend it will upload the private key to the machine.
If using password store it uploads all the secrets you manage to the machine.

The default backend is sops.

Examples:

  $ clan vars upload [MACHINE]
  Will upload secrets to a specific machine.

For more detailed information, visit: {help_hyperlink("secrets", "https://docs.clan.lol/getting-started/secrets")}
        """
        ),
        formatter_class=argparse.RawTextHelpFormatter,
    )
    register_upload_parser(parser_upload)