vars: generate docs for cli and module

This commit is contained in:
DavHau
2024-11-29 16:51:56 +07:00
parent e1d9467357
commit fbbfcc0aa5
6 changed files with 21 additions and 10 deletions

View File

@@ -293,11 +293,11 @@ For more detailed information, visit: {help_hyperlink("secrets", "https://docs.c
# like facts but with vars instead of facts
parser_vars = subparsers.add_parser(
"vars",
help="WIP: Manage vars",
description="WIP: Manage vars",
help="Manage vars",
description="Manage vars",
epilog=(
f"""
This subcommand provides an interface to vars of clan machines.
This subcommand provides an interface to `vars` of clan machines.
Vars are variables that a service can generate.
There are public and secret vars.
Public vars can be referenced by other machines directly.

View File

@@ -137,7 +137,6 @@ class Machine:
module = importlib.import_module(self.public_facts_module)
return module.FactStore(machine=self)
# WIP: Vars module is not ready yet.
@property
def secret_vars_module(self) -> str:
return self.deployment["vars"]["secretModule"]

View File

@@ -487,7 +487,7 @@ def generate_command(args: argparse.Namespace) -> None:
machines = get_all_machines(args.flake, args.option)
else:
machines = get_selected_machines(args.flake, args.option, args.machines)
generate_vars(machines, args.service, args.regenerate, args.fix)
generate_vars(machines, args.generator, args.regenerate, args.fix)
def register_generate_parser(parser: argparse.ArgumentParser) -> None:
@@ -501,15 +501,17 @@ def register_generate_parser(parser: argparse.ArgumentParser) -> None:
add_dynamic_completer(machines_parser, complete_machines)
service_parser = parser.add_argument(
"--service",
"--generator",
"-g",
type=str,
help="service to generate facts for, if empty, generate facts for every service",
help="execute only the specified generator. If unset, execute all generators",
default=None,
)
add_dynamic_completer(service_parser, complete_services_for_machine)
parser.add_argument(
"--regenerate",
"-r",
action=argparse.BooleanOptionalAction,
help="whether to regenerate facts for the specified machine",
default=None,