feature: switching to XDG_CACHE_DIR and XDG_CONFIG_DIR everywhere (#28)

* switching to XDG_CACHE_DIR and XDG_CONFIG_DIR everywhere

* fix colors

* update docs and fix colors for console logging

* fix help txt width

Author: jessebot

docs/quickstart.md

@@ -42,7 +42,7 @@ The help should return this:
 
 [<img src="https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/screenshots/help_text.svg" alt="Output of smol-k8s-lab --help after cloning the directory and installing the prerequisites.">](https://raw.githubusercontent.com/jessebot/smol-k8s-lab/main/docs/screenshots/help_text.svg)
 
-🔔 Then you *have to edit* the `~/.config/smol-k8s-lab/config.yaml` to be your own values (for _right now_).
+🔔 Then you *have to edit* your `$XDG_CONFIG_DIR` (usually `~/.config/smol-k8s-lab/config.yaml`) to be your own values. Better cli options and Interactive config setup coming soon!
 
 Here's an example file already filled out with comments:
 
@@ -73,8 +73,8 @@ external_secrets:
 log:
   # logging level, Options: debug, info, warn, error
   level: "info"
-  # path of file to log to
-  file: "./smol-k8s-log.log"
+  # path of file to log to, disabled by default
+  # file: "./smol-k8s-log.log"
 ```
 
 ## Install a distro of k8s with smol-k8s-lab

docs/screenshots/help_text.svg

@@ -1,6 +1,6 @@
 [tool.poetry]
 name          = "smol_k8s_lab"
-version       = "0.10.1"
+version       = "0.10.2"
 description   = "bootstrap simple projects on kubernetes with kind and k3s"
 authors       = ["Jesse Hitch <[email protected]>"]
 readme        = "README.md"
@@ -28,6 +28,7 @@ click    = "^8.1.3"
 bcrypt   = "^4.0.1"
 requests = "^2.28.1"
 pyyaml   = "^6.0"
+xdg = "^5.1.1"
 
 [[tool.poetry.source]]
 name = "testpypi"

poetry.lock

@@ -14,22 +14,23 @@
 from rich.logging import RichHandler
 from sys import exit
 
-from .console_logging import header, sub_header
-from .env_config import check_os_support, USR_CONFIG_FILE, VERSION, HOME_DIR
-from .env_config import CONSOLE
+# custom libs and constants
+from .console_logging import CONSOLE, header, sub_header
+from .env_config import check_os_support, HOME_DIR, USR_CONFIG_FILE, VERSION
+from .env_config import XDG_CACHE_DIR
 from .help_text import RichCommand, options_help
 
 
-SUPPORTED_DISTROS = ['k0s', 'k3s', 'kind']
-
 HELP = options_help()
 HELP_SETTINGS = dict(help_option_names=['-h', '--help'])
+SUPPORTED_DISTROS = ['k0s', 'k3s', 'kind']
 
 
 def setup_logger(level="", log_file=""):
     """
-    Sets up rich logger and stores the values for it in a db for future import
-    in other files. Returns logging.getLogger("rich")
+    Sets up rich logger for the entire project.
+    ꒰ᐢ.   ̫ .ᐢ꒱ <---- who is he? :3
+    Returns logging.getLogger("rich")
     """
     # determine logging level
     if not level:
@@ -76,8 +77,10 @@ def setup_logger(level="", log_file=""):
 
 def install_k8s_distro(k8s_distro=""):
     """
-    install a specific distro of k8s
-    options: k0s, k3s, kind
+    Install a specific distro of k8s
+    Takes one variable:
+        k8s_distro - string. options: 'k0s', 'k3s', or 'kind'
+    Returns True
     """
     if k8s_distro == "kind":
         from .k8s_distros.kind import install_kind_cluster
@@ -88,6 +91,7 @@ def install_k8s_distro(k8s_distro=""):
     elif k8s_distro == "k0s":
         from .k8s_distros.k0s import install_k0s_cluster
         install_k0s_cluster()
+    return True
 
 
 def delete_cluster(k8s_distro="k3s"):
@@ -102,8 +106,8 @@ def delete_cluster(k8s_distro="k3s"):
         uninstall_k3s()
 
     elif k8s_distro == 'kind':
-        from .k8s_distros.kind import uninstall_kind
-        uninstall_kind()
+        from .k8s_distros.kind import delete_kind_cluster
+        delete_kind_cluster()
 
     elif k8s_distro == 'k0s':
         from .k8s_distros.k0s import uninstall_k0s
@@ -112,7 +116,7 @@ def delete_cluster(k8s_distro="k3s"):
     else:
         header("┌（・o・）┘≡З  Whoops. {k8s_distro} not YET supported.")
 
-    sub_header("[green]◝(ᵔᵕᵔ)◜ Success!")
+    sub_header("[grn]◝(ᵔᵕᵔ)◜ Success![/grn]")
     exit()
 
 
@@ -149,36 +153,35 @@ def main(k8s: str = "",
     Quickly install a k8s distro for a homelab setup. Installs k3s
     with metallb, ingess-nginx, cert-manager, and argocd
     """
-    # setup logging immediately
-    log = setup_logger(log_level, log_file)
-    log.info("Logging configured")
-
     # only return the version if --version was passed in
     if version:
         print(f'\n🎉 v{VERSION}\n')
         return True
 
+    # setup logging immediately
+    log = setup_logger(log_level, log_file)
+    log.info("Logging configured")
+
     # make sure we got a valid k8s distro
     if k8s not in SUPPORTED_DISTROS:
         CONSOLE.print(f'\n☹ Sorry, "[b]{k8s}[/]" is not a currently supported '
                       'k8s distro. Please try again with any of '
                       f'{SUPPORTED_DISTROS}.\n')
         exit()
 
-    # before we do anything, we need to make sure this OS is supported
+    # make sure this OS is supported
     check_os_support()
 
     if delete:
-        # this exist the script after deleting the cluster
+        # exits the script after deleting the cluster
         delete_cluster(k8s)
 
-    # TODO: make this follow XDG base directory spec
-    # make sure the cache directory exists, to store stuff
-    Path(f"{HOME_DIR}/.cache/smol-k8s-lab").mkdir(exist_ok=True)
+    # make sure the cache directory exists (typically ~/.cache/smol-k8s-lab)
+    Path(XDG_CACHE_DIR).mkdir(exist_ok=True)
 
     # install the actual KIND or k3s cluster
     header(f'Installing [green]{k8s}[/] cluster.')
-    sub_header('This could take a min ʕ•́ᴥ•̀ʔっ♡ ', False)
+    sub_header('This could take a min ʕ•́  ̫•̀ʔっ♡ ', False)
     install_k8s_distro(k8s)
 
     # make sure helm is installed and the repos are up to date
@@ -190,27 +193,28 @@ def main(k8s: str = "",
     from .k8s_apps.metallb import configure_metallb
     configure_metallb(USR_CONFIG_FILE['metallb_address_pool'])
 
-    # this is so we can accept traffic from outside the cluster
+    # ingress controller: so we can accept traffic from outside the cluster
     header("Installing [b]ingress-nginx-controller[/b]...")
     from .k8s_apps.nginx_ingress_controller import configure_ingress_nginx
     configure_ingress_nginx(k8s)
 
-    # this is for manager SSL/TLS certificates via lets-encrypt
+    # manager SSL/TLS certificates via lets-encrypt
     header("Installing [b]cert-manager[/b] for TLS certificates...")
     from .k8s_apps.certmanager import configure_cert_manager
     configure_cert_manager(USR_CONFIG_FILE['email'])
 
-    # this is for external secrets, currently only supports gitlab
+    # external secrets provider: currently only supports gitlab
     if external_secret_operator:
-        external_secrets = USR_CONFIG_FILE['external_secrets']['gitlab']
         from .k8s_apps.external_secrets import configure_external_secrets
+        external_secrets = USR_CONFIG_FILE['external_secrets']['gitlab']
         configure_external_secrets(external_secrets)
 
+    # kyverno: kubernetes native policy manager
     if kyverno:
         from .k8s_apps.kyverno import install_kyverno
         install_kyverno()
 
-    # then install argo CD ꒰ᐢ.   ̫ .ᐢ꒱ <---- who is he? :3
+    # 🦑 Install Argo CD: continuous deployment app for k8s
     if argo:
         argocd_fqdn = ".".join([USR_CONFIG_FILE['domain']['argo_cd'],
                                 USR_CONFIG_FILE['domain']['base']])

pyproject.toml

@@ -7,14 +7,17 @@
 from rich import print
 from rich.console import Console
 from rich.panel import Panel
-from rich.table import Table
+# from rich.table import Table
 from rich.theme import Theme
 
 
-# for console logging only
-CONSOLE = Console(theme=Theme({"warn": "bold yellow",
-                               "grn": "medium_spring_green",
-                               "ohno": "magenta"}))
+# this is for rich text, to pretty print things
+soft_theme = Theme({"info": "dim cornflower_blue",
+                    "grn": "medium_spring_green",
+                    "warn": "yellow on black",
+                    "danger": "bold magenta",
+                    "ohno": "pale_violet_red1"})
+CONSOLE = Console(theme=soft_theme)
 
 
 def header(text):

smol_k8s_lab/__init__.py

@@ -1,4 +1,8 @@
 #!/usr/bin/env python3.11
+"""
+NAME: env_config.py
+DESC: everything to do with initial configuration of a new environment
+"""
 
 from importlib.metadata import version as get_version
 from getpass import getuser
@@ -12,22 +16,17 @@
 from sys import exit
 import yaml
 from .console_logging import print_panel
+from xdg import xdg_cache_home, xdg_config_home
 
 
 HOME_DIR = getenv("HOME")
-USER = getuser()
-
-# this is for rich text, to pretty print things
-soft_theme = Theme({"info": "dim cornflower_blue",
-                    "warn": "yellow on black",
-                    "danger": "bold magenta"})
-CONSOLE = Console(theme=soft_theme)
-
 PWD = path.dirname(__file__)
+USER = getuser()
+XDG_CACHE_DIR = path.join(xdg_cache_home(), 'smol-k8s-lab')
+XDG_CONFIG_DIR = path.join(xdg_config_home(), 'smol-k8s-lab/config.yaml')
 
 
-def load_yaml(yaml_config_file=path.join(HOME_DIR,
-                                         ".config/smol-k8s-lab/config.yaml")):
+def load_yaml(yaml_config_file=XDG_CONFIG_DIR):
     """
     load config yaml files for smol-k8s-lab and return as dicts
     """

smol_k8s_lab/console_logging.py

@@ -1,5 +1,7 @@
-# file for rich printing
-
+"""
+Name: help_text
+Desc: the help text for smol-k8s-lab
+"""
 import click
 from rich.console import Console
 from rich.highlighter import RegexHighlighter
@@ -8,7 +10,7 @@
 from rich.text import Text
 from rich.theme import Theme
 
-from .env_config import VERSION
+from .env_config import VERSION, XDG_CONFIG_DIR
 
 
 def pretty_choices(default_list):
@@ -34,8 +36,7 @@ def options_help():
         'Install Argo CD as part of this script. Default: False',
 
         'config':
-        'Full path and name of yml to parse. '
-        'Default: ~/.config/smol-k8s-lab/config.yaml\n'
+        f'Full path and name of yml to parse. Default: {XDG_CONFIG_DIR}\n'
         'Example: smol-k8s-lab -f [light_steel_blue]/tmp/config.yaml[/]',
 
         'delete':

smol_k8s_lab/env_config.py

@@ -6,10 +6,12 @@
     LICENSE: GNU AFFERO GENERAL PUBLIC LICENSE Version 3
 """
 import bcrypt
+from os import path
+from yaml import dump
 from ..bw_cli import BwCLI
 from ..console_logging import header, sub_header
+from ..env_config import XDG_CACHE_DIR
 from ..k8s_tools.homelabHelm import helm
-from yaml import dump
 
 
 def configure_argocd(argo_cd_domain="", password_manager=False):
@@ -60,7 +62,7 @@ def configure_argocd(argo_cd_domain="", password_manager=False):
         val['configs']['secret']['argocdServerAdminPassword'] = admin_pass
 
     # this creates a values.yaml from from the val dict above
-    values_file_name = '/tmp/smol-k8s-lab/argocd_values.yaml'
+    values_file_name = path.join(XDG_CACHE_DIR, 'argocd_values.yaml')
     with open(values_file_name, 'w') as values_file:
         dump(val, values_file)
 

smol_k8s_lab/help_text.py

@@ -1,35 +1,40 @@
 #!/usr/bin/env python3.11
 """
        Name: kind
-DESCRIPTION: install or uninstall kind cluster
-     AUTHOR: @jessebot
+DESCRIPTION: create or delete a kind cluster
+     AUTHOR: github.com/jessebot/smol-k8s-lab
     LICENSE: GNU AFFERO GENERAL PUBLIC LICENSE Version 3
 """
 from os import path
 from shutil import which
-from ..env_config import PWD, CONSOLE
+from ..console_logging import sub_header
+from ..env_config import PWD
 from ..subproc import subproc
 
 
 def install_kind_cluster():
     """
-    python installation process for kind
+    Run installation process for kind and create cluster
+    returns True
     """
     # make sure kind is installed first, and if not, install it
     if not which("kind"):
         msg = ("ʕ•́ᴥ•̀ʔ [b]kind[/b] is [warn]not installed[/warn]. "
                "[i]We'll install it for you.[/i] ʕᵔᴥᵔʔ")
-        CONSOLE.print(msg, justify='center')
+        sub_header(msg)
         subproc(['brew install kind'], spinner=True)
 
     # then use our pre-configured kind file to install a small cluster
     full_path = path.join(PWD, 'distros/kind/kind_cluster_config.yaml')
     subproc([f"kind create cluster --config={full_path}"], spinner=True)
-    return
 
+    return True
 
-def uninstall_kind_cluster():
+
+def delete_kind_cluster():
     """
-    uninstall kind cluster
+    delete kind cluster
+    returns True
     """
     subproc(['kind delete cluster'])
+    return True