From b546e03e37c9816eb6ae55a674adf5d2db668db1 Mon Sep 17 00:00:00 2001 From: strNophix Date: Fri, 8 Apr 2022 22:32:30 +0200 Subject: [PATCH] Added more comments --- cli.py | 6 +++++- service.py | 2 ++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/cli.py b/cli.py index 46e8a8e..d030366 100755 --- a/cli.py +++ b/cli.py @@ -193,6 +193,10 @@ def recover_env(args: argparse.Namespace): def create_env(args: argparse.Namespace): + """ + Managing environments works in a declarative way and thus it can + also be used for updating. + """ if (args.num_nginx_web + args.num_nginx_lb + args.num_postgres) == 0: raise Exception("At least one item should be deployed") @@ -306,7 +310,7 @@ def main() -> int: # CLI definition for positional arg "create" cenv_parser = sub_parser.add_parser("create", - help="create a new environment") + help="create/update an environment") cenv_parser.add_argument("customer_name", type=str, help="name of the customer") diff --git a/service.py b/service.py index acc86de..ae077b8 100644 --- a/service.py +++ b/service.py @@ -80,6 +80,8 @@ def main() -> int: lambda x: bool(RE_TEXT.match(x))) """ Ensures the necessary customer setup. + + NOTE: The customer and the `envs` directory inside of it never get removed. """ envs_dir = path.join("customers", customer_name, "envs") Path(envs_dir).mkdir(parents=True, exist_ok=True)