v5.0.0: backup/restore apps, overhaul TTS, add new node to existing cluster + 🐛 fixes

.github/smol-k8s-lab-appimage.yaml

@@ -0,0 +1,40 @@
+# This is an example for making an AppImage from a python3 smol-k8s-lab application
+# using virtualenv and pip3
+
+app: smol-k8s-lab
+
+ingredients:
+  dist: bookworm
+  sources:
+    - deb http://us.archive.ubuntu.com/ubuntu/ bookworm bookworm-updates bookworm-security main universe
+    - deb http://us.archive.ubuntu.com/ubuntu/ bookworm-updates main universe
+    - deb http://us.archive.ubuntu.com/ubuntu/ bookworm-security main universe
+  packages:
+    - python3.12-venv
+    # these are for making sound work
+    - libasound2-data
+    - libasound2-plugins
+    - libasound2
+  script:
+    -  wget -c https://raw.githubusercontent.com/small-hack/smol-k8s-lab/feat/restore-app/docs/assets/images/icons/logo.png
+    -  wget -c https://raw.githubusercontent.com/small-hack/smol-k8s-lab/feat/restore-app/smol_k8s_lab/config/smol-k8s-lab.appdata.xml
+
+script:
+  - cp smol-k8s-lab.png ./usr/share/icons/hicolor/256x256/
+  - cp smol-k8s-lab.png .
+  - mkdir -p usr/share/metainfo/ ; cp smol-k8s-lab.appdata.xml usr/share/metainfo/
+  - virtualenv --python=python3 usr
+  - ./usr/bin/pip3 install smol-k8s-lab
+  - cat > usr/share/applications/smol-k8s-lab.desktop <<\EOF
+  - [Desktop Entry]
+  - Type=Application
+  - Name=smol-k8s-lab
+  - Comment=CLI and TUI to quickly install slimmer Kubernetes distros and then manage apps declaratively using Argo CD
+  - Icon=smol-k8s-lab
+  - Exec=smol-k8s-lab
+  - Terminal=true
+  - Categories=Application;Development;
+  - Keywords=Python;Kubernetes;
+  - EOF
+  - cp usr/share/applications/smol-k8s-lab.desktop .
+  - usr/bin/pip3 freeze | grep "smol-k8s-lab" | cut -d "=" -f 3 >> ../VERSION

.github/smol_k8s_lab_config_k3d.yaml

@@ -15,7 +15,7 @@ smol_k8s_lab:
         on_focus: true
         # ring the built in terminal bell when something is wrong
         on_error: true
-      text_to_speech: 
+      text_to_speech:
         # use a specific program for text to speech - needs to be a full path
         # macOS default: say
         speech_program: say
@@ -26,16 +26,16 @@ smol_k8s_lab:
         # press f5 to read the element id and selected row of DataTables
         on_key_press: true
 
-    # enable text to speech
-    # k9s is a terminal UI dashboard and interface for interacting with Kubernetes
-    k9s:
-      # when set to true, if smol-k8s-lab is in interactive mode, it runs k9s
-      # immediately after the cluster is up and enabled apps have been installed
-      enabled: false
-      # default command to run when k9s launches. Defaults to application.argoproj.io
-      # so that you can view the status of all of your argo apps immediately. This
-      # default results in running: k9s --command applications.argoproj.io
-      command: applications.argoproj.io
+  run_command:
+    # command to run after smol-k8s-lab tui is done or immediately when running
+    command: echo 'we did it'
+    # tell me which terminal you use if you'd like to use split or tab features
+    terminal: wezterm
+    # where to run the command, options: same window, new window, new tab,
+    # split left, split right, split top, split bottom
+    # if set to "same window", we just run it in the same window after we're
+    # done the entire smol-k8s-lab cli run
+    window_behavior: same window
 
   # logging config for the smol-k8s-lab CLI
   log:
@@ -68,7 +68,7 @@ k8s_distros:
     enabled: false
     # if k8s_distro set to k3s/k3d, you can add an array of extra arguments to pass
     # to the k3s install script as a k3s.yaml file. If you enable cilium, we
-    # automatically pass in flannel-backend: none and disable-network-policy: true 
+    # automatically pass in flannel-backend: none and disable-network-policy: true
     k3s_yaml:
       # if you enable MetalLB, we automatically add servicelb to the disable list
       # enables encryption at rest for Kubernetes secrets
@@ -87,7 +87,7 @@ k8s_distros:
     enabled: true
     # if k8s_distro set to k3s/k3d, you can add an array of extra arguments to pass
     # to the k3s install script as a k3s.yaml file. if you enable cilium, we
-    # automatically pass in flannel-backend: none and disable-network-policy: true 
+    # automatically pass in flannel-backend: none and disable-network-policy: true
     k3s_yaml:
       # if you enable MetalLB, we automatically add servicelb to the disable list
       # enables encryption at rest for Kubernetes secrets
@@ -157,6 +157,8 @@ apps:
         hostname: "argocd.test.com"
         # which oidc provider to use for Argo CD: defaults to Zitadel
         oidc_provider: "zitadel"
+      # kubernetes cluster to install the k8s app into, defaults to Argo CD default
+      cluster: https://kubernetes.default.svc
       # git repo to install the Argo CD app from
       repo: "https://github.com/small-hack/argocd-apps"
       # path in the argo repo to point to. Trailing slash very important!
@@ -170,6 +172,7 @@ apps:
       directory_recursion: true
       # source repos for Argo CD argo-cd Project (in addition to argo_cd.argo.repo)
       project:
+        name: argo-cd
         source_repos:
           - https://argoproj.github.io/argo-helm
           - https://small-hack.github.io/appset-secret-plugin
@@ -482,7 +485,7 @@ apps:
   kubevirt:
     description: |
       [link=https://kubevirt.io/]kubevirt[/link] lets you manage virtual machines via Kubernetes.
-  
+
     # default disabled while a helm chart is being actively developed
     enabled: false
     argo:
@@ -500,7 +503,7 @@ apps:
       directory_recursion: false
       # source repos for Argo CD App Project (in addition to argo.repo)
       project:
-        source_repos: 
+        source_repos:
           - "https://github.com/small-hack/argocd-apps"
         destination:
           # automatically includes the app's namespace and argocd's namespace
@@ -567,7 +570,7 @@ apps:
         admin_user: tootadmin
         # hostname that users go to in the browser
         hostname: ""
-        # set the local s3 provider for mastodon's public data in one bucket 
+        # set the local s3 provider for mastodon's public data in one bucket
         # and private database backups in another. can be minio or seaweedfs
         s3_provider: seaweedfs
         # how large the backing pvc's capacity should be for minio or seaweedfs
@@ -609,7 +612,7 @@ apps:
       This deploys a matrix synapse server, element (web frontend), and turn server (voice)
 
       smol-k8s-lab supports initialization by creating initial secrets for your:
-        - matrix, element, and federation hostnames, 
+        - matrix, element, and federation hostnames,
         - credentials for: postgresql, admin user, S3 storage, and SMTP
 
       smol-k8s-lab also sets up an OIDC application via Zitadel.

.github/smol_k8s_lab_config_k3s.yaml

@@ -15,7 +15,7 @@ smol_k8s_lab:
         on_focus: true
         # ring the built in terminal bell when something is wrong
         on_error: true
-      text_to_speech: 
+      text_to_speech:
         # use a specific program for text to speech - needs to be a full path
         # macOS default: say
         speech_program: say
@@ -26,16 +26,16 @@ smol_k8s_lab:
         # press f5 to read the element id and selected row of DataTables
         on_key_press: true
 
-    # enable text to speech
-    # k9s is a terminal UI dashboard and interface for interacting with Kubernetes
-    k9s:
-      # when set to true, if smol-k8s-lab is in interactive mode, it runs k9s
-      # immediately after the cluster is up and enabled apps have been installed
-      enabled: false
-      # default command to run when k9s launches. Defaults to application.argoproj.io
-      # so that you can view the status of all of your argo apps immediately. This
-      # default results in running: k9s --command applications.argoproj.io
-      command: applications.argoproj.io
+  run_command:
+    # command to run after smol-k8s-lab tui is done or immediately when running
+    command: echo 'we did it'
+    # tell me which terminal you use if you'd like to use split or tab features
+    terminal: wezterm
+    # where to run the command, options: same window, new window, new tab,
+    # split left, split right, split top, split bottom
+    # if set to "same window", we just run it in the same window after we're
+    # done the entire smol-k8s-lab cli run
+    window_behavior: same window
 
   # logging config for the smol-k8s-lab CLI
   log:
@@ -68,7 +68,7 @@ k8s_distros:
     enabled: true
     # if k8s_distro set to k3s/k3d, you can add an array of extra arguments to pass
     # to the k3s install script as a k3s.yaml file. If you enable cilium, we
-    # automatically pass in flannel-backend: none and disable-network-policy: true 
+    # automatically pass in flannel-backend: none and disable-network-policy: true
     k3s_yaml:
       # if you enable MetalLB, we automatically add servicelb to the disable list
       # enables encryption at rest for Kubernetes secrets
@@ -87,7 +87,7 @@ k8s_distros:
     enabled: false
     # if k8s_distro set to k3s/k3d, you can add an array of extra arguments to pass
     # to the k3s install script as a k3s.yaml file. if you enable cilium, we
-    # automatically pass in flannel-backend: none and disable-network-policy: true 
+    # automatically pass in flannel-backend: none and disable-network-policy: true
     k3s_yaml:
       # if you enable MetalLB, we automatically add servicelb to the disable list
       # enables encryption at rest for Kubernetes secrets
@@ -157,6 +157,8 @@ apps:
         hostname: "argocd.test.com"
         # which oidc provider to use for Argo CD: defaults to Zitadel
         oidc_provider: "zitadel"
+      # kubernetes cluster to install the k8s app into, defaults to Argo CD default
+      cluster: https://kubernetes.default.svc
       # git repo to install the Argo CD app from
       repo: "https://github.com/small-hack/argocd-apps"
       # path in the argo repo to point to. Trailing slash very important!
@@ -170,6 +172,7 @@ apps:
       directory_recursion: true
       # source repos for Argo CD argo-cd Project (in addition to argo_cd.argo.repo)
       project:
+        name: argo-cd
         source_repos:
           - https://argoproj.github.io/argo-helm
           - https://small-hack.github.io/appset-secret-plugin
@@ -482,7 +485,7 @@ apps:
   kubevirt:
     description: |
       [link=https://kubevirt.io/]kubevirt[/link] lets you manage virtual machines via Kubernetes.
-  
+
     # default disabled while a helm chart is being actively developed
     enabled: false
     argo:
@@ -500,7 +503,7 @@ apps:
       directory_recursion: false
       # source repos for Argo CD App Project (in addition to argo.repo)
       project:
-        source_repos: 
+        source_repos:
           - "https://github.com/small-hack/argocd-apps"
         destination:
           # automatically includes the app's namespace and argocd's namespace
@@ -567,7 +570,7 @@ apps:
         admin_user: tootadmin
         # hostname that users go to in the browser
         hostname: ""
-        # set the local s3 provider for mastodon's public data in one bucket 
+        # set the local s3 provider for mastodon's public data in one bucket
         # and private database backups in another. can be minio or seaweedfs
         s3_provider: seaweedfs
         # how large the backing pvc's capacity should be for minio or seaweedfs
@@ -609,7 +612,7 @@ apps:
       This deploys a matrix synapse server, element (web frontend), and turn server (voice)
 
       smol-k8s-lab supports initialization by creating initial secrets for your:
-        - matrix, element, and federation hostnames, 
+        - matrix, element, and federation hostnames,
         - credentials for: postgresql, admin user, S3 storage, and SMTP
 
       smol-k8s-lab also sets up an OIDC application via Zitadel.

.github/smol_k8s_lab_config_kind.yaml

@@ -15,7 +15,7 @@ smol_k8s_lab:
         on_focus: true
         # ring the built in terminal bell when something is wrong
         on_error: true
-      text_to_speech: 
+      text_to_speech:
         # use a specific program for text to speech - needs to be a full path
         # macOS default: say
         speech_program: say
@@ -26,16 +26,17 @@ smol_k8s_lab:
         # press f5 to read the element id and selected row of DataTables
         on_key_press: true
 
-    # enable text to speech
-    # k9s is a terminal UI dashboard and interface for interacting with Kubernetes
-    k9s:
-      # when set to true, if smol-k8s-lab is in interactive mode, it runs k9s
-      # immediately after the cluster is up and enabled apps have been installed
-      enabled: false
-      # default command to run when k9s launches. Defaults to application.argoproj.io
-      # so that you can view the status of all of your argo apps immediately. This
-      # default results in running: k9s --command applications.argoproj.io
-      command: applications.argoproj.io
+  run_command:
+    # command to run after smol-k8s-lab tui is done or immediately when running
+    command: echo 'we did it'
+    # tell me which terminal you use if you'd like to use split or tab features
+    terminal: wezterm
+    # where to run the command, options: same window, new window, new tab,
+    # split left, split right, split top, split bottom
+    # if set to "same window", we just run it in the same window after we're
+    # done the entire smol-k8s-lab cli run
+    window_behavior: same window
+
 
   # logging config for the smol-k8s-lab CLI
   log:
@@ -68,7 +69,7 @@ k8s_distros:
     enabled: false
     # if k8s_distro set to k3s/k3d, you can add an array of extra arguments to pass
     # to the k3s install script as a k3s.yaml file. If you enable cilium, we
-    # automatically pass in flannel-backend: none and disable-network-policy: true 
+    # automatically pass in flannel-backend: none and disable-network-policy: true
     k3s_yaml:
       # if you enable MetalLB, we automatically add servicelb to the disable list
       # enables encryption at rest for Kubernetes secrets
@@ -90,7 +91,7 @@ k8s_distros:
     enabled: false
     # if k8s_distro set to k3s/k3d, you can add an array of extra arguments to pass
     # to the k3s install script as a k3s.yaml file. if you enable cilium, we
-    # automatically pass in flannel-backend: none and disable-network-policy: true 
+    # automatically pass in flannel-backend: none and disable-network-policy: true
     k3s_yaml:
       # if you enable MetalLB, we automatically add servicelb to the disable list
       # enables encryption at rest for Kubernetes secrets
@@ -160,6 +161,8 @@ apps:
         hostname: "argocd.test.com"
         # which oidc provider to use for Argo CD: defaults to Zitadel
         oidc_provider: "zitadel"
+      # kubernetes cluster to install the k8s app into, defaults to Argo CD default
+      cluster: https://kubernetes.default.svc
       # git repo to install the Argo CD app from
       repo: "https://github.com/small-hack/argocd-apps"
       # path in the argo repo to point to. Trailing slash very important!
@@ -173,6 +176,7 @@ apps:
       directory_recursion: true
       # source repos for Argo CD argo-cd Project (in addition to argo_cd.argo.repo)
       project:
+        name: argo-cd
         source_repos:
           - https://argoproj.github.io/argo-helm
           - https://small-hack.github.io/appset-secret-plugin
@@ -485,7 +489,7 @@ apps:
   kubevirt:
     description: |
       [link=https://kubevirt.io/]kubevirt[/link] lets you manage virtual machines via Kubernetes.
-  
+
     # default disabled while a helm chart is being actively developed
     enabled: false
     argo:
@@ -503,7 +507,7 @@ apps:
       directory_recursion: false
       # source repos for Argo CD App Project (in addition to argo.repo)
       project:
-        source_repos: 
+        source_repos:
           - "https://github.com/small-hack/argocd-apps"
         destination:
           # automatically includes the app's namespace and argocd's namespace
@@ -570,7 +574,7 @@ apps:
         admin_user: tootadmin
         # hostname that users go to in the browser
         hostname: ""
-        # set the local s3 provider for mastodon's public data in one bucket 
+        # set the local s3 provider for mastodon's public data in one bucket
         # and private database backups in another. can be minio or seaweedfs
         s3_provider: seaweedfs
         # how large the backing pvc's capacity should be for minio or seaweedfs
@@ -612,7 +616,7 @@ apps:
       This deploys a matrix synapse server, element (web frontend), and turn server (voice)
 
       smol-k8s-lab supports initialization by creating initial secrets for your:
-        - matrix, element, and federation hostnames, 
+        - matrix, element, and federation hostnames,
         - credentials for: postgresql, admin user, S3 storage, and SMTP
 
       smol-k8s-lab also sets up an OIDC application via Zitadel.

.github/workflows/python-publish.yml

@@ -16,8 +16,23 @@ jobs:
           python_version: "3.12.0"
           pypi_token: ${{ secrets.DEPLOY_FROM_GITHUB_SMOL_K8S_LAB }}
 
+      # not ready to do this until we have self-hosted runners
+      # - name: Generate Sound Files
+      #   run: |
+      #       poetry run smol-tts -l en --tar
+      #       poetry run smol-tts -l nl --tar
+
+      - name: Create an appimage for smol-k8s-lab for use with brew
+        # see https://github.com/AppImageCommunity/pkg2appimage for more info
+        run: |
+            wget -c $(wget -q https://api.github.com/repos/AppImageCommunity/pkg2appimage/releases -O - | grep "pkg2appimage-.*-x86_64.AppImage" | grep browser_download_url | head -n 1 | cut -d '"' -f 4)
+            chmod +x ./pkg2appimage-*.AppImage
+            ./pkg2appimage-*.AppImage .github/smol-k8s-lab-appimage.yaml
+
       - name: Create a Release on GitHub
         uses: softprops/action-gh-release@v2
         if: startsWith(github.ref, 'refs/tags/')
         with:
           generate_release_notes: true
+          files: |
+              smol-k8s-lab.AppImage