Merge pull request #7 from KubeDeckio/add-helm-storage-backend-backup

PixelRobots · web-flow · commit b9bd656b8701 · 2024-12-10T15:34:19.000Z
Add helm storage backend backup
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
-snapshots/
+snapshots/
+helm_snapshots/
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,21 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.0.12] - 2024-12-08
+
+### Added:
+- **Helm Backend Storage**: `$SnapshotHelm` now includes a backup of Helm backend storage (Secrets or ConfigMaps), ensuring that all metadata for Helm releases is captured in snapshots.
+- **Verbose Backend Logging**: Detailed logging of backend type (Secrets or ConfigMaps) and operations is now included when running in verbose mode.
+- **Helm Restore with History**: Added support for restoring Helm releases, including their full history and backend configuration (Secrets or ConfigMaps). This ensures a complete recovery of release state.
+- **Dynamic Resource Discovery**: Replaced hardcoded lists of resource kinds with dynamic discovery using `kubectl api-resources`. This ensures all available Kubernetes resource types, including CRDs and their objects, are automatically included in snapshots.
+- **Automatic CRD Object Backup**: CRD objects are now seamlessly backed up alongside other resources without requiring separate logic.
+
+### Fixed:
+- **Empty Release Handling**: Improved handling of namespaces with no Helm releases, avoiding unnecessary warnings and providing clear messages instead.
+- **Error Messages**: Enhanced error messages for missing tools (`helm` or `kubectl`) to include actionable instructions for installation.
+
+- **Changed**: Replaced `$AllNamespaces` with `$ClusterResources` for snapshotting cluster-scoped resources. `$AllNamespaces` remains available for Helm snapshotting purposes. 
+
 ## [0.0.11] - 2024-12-06
 
 ### Fixed:
diff --git a/KubeSnapIt.psm1 b/KubeSnapIt.psm1
@@ -75,6 +75,7 @@ function Invoke-KubeSnapIt {
         [string]$OutputPath = "./snapshots",
         [string]$InputPath = "", 
         [string]$ComparePath = "",
+        [switch]$ClusterResources,
         [switch]$AllNamespaces,
         [switch]$AllNonSystemNamespaces,
         [string]$Labels = "",
@@ -87,6 +88,7 @@ function Invoke-KubeSnapIt {
         [switch]$UI,
         [switch]$SnapshotHelm,
         [switch]$SnapshotHelmUsedValues,
+        [switch]$RestoreHelmSnapshot,
         [Alias("h")] [switch]$Help
     )
     # END PARAM BLOCK
@@ -99,6 +101,7 @@ function Invoke-KubeSnapIt {
         Write-Host "  -OutputPath          Path to save the snapshot files."
         Write-Host "  -InputPath           Path to restore snapshots from or the first snapshot for comparison."
         Write-Host "  -ComparePath         Path to the second snapshot for comparison (optional)."
+        Write-Host "  -ClusterResources    Capture cluster-wide resources (e.g., crd's, namespaces)."
         Write-Host "  -AllNamespaces       Capture all namespaces. If this is provided, -Namespace will be ignored."
         Write-Host "  -AllNonSystemNamespaces Capture all non-system namespaces. If this is provided, -Namespace and -AllNamespaces will be ignored."
         Write-Host "  -Labels              Specify labels to filter Kubernetes objects (e.g., app=nginx)."
@@ -110,6 +113,7 @@ function Invoke-KubeSnapIt {
         Write-Host "  -Force               Force the action without prompting for confirmation."
         Write-Host "  -SnapshotHelm        Backup Helm releases and their values."
         Write-Host "  -SnapshotHelmUsedValues  Backup Helm release values."
+        write-Host "  -RestoreHelmSnapshot Restore Helm release from a snapshot."
         Write-Host "  -Help                Display this help message."
         return
     }
@@ -262,7 +266,16 @@ function Invoke-KubeSnapIt {
             return
         }
 
-        { $Namespace -or $AllNamespaces -or $AllNonSystemNamespaces } {
+        { $RestoreHelmSnapshot } {
+            if (-not $InputPath) {
+                Write-Host "Error: Input path required for restore." -ForegroundColor Red
+                return
+            }
+            Restore-HelmBackup -ManifestFilePath:$InputPath -Namespace:$Namespace -DryRun:$DryRun -Verbose:$Verbose
+            return
+        }
+
+        { $Namespace -or $ClusterResources -or $AllNonSystemNamespaces } {
             if (-not (Test-Path -Path $OutputPath)) {
                 New-Item -Path $OutputPath -ItemType Directory -Force | Out-Null
                 Write-Verbose "Output directory created: $OutputPath"
@@ -272,7 +285,7 @@ function Invoke-KubeSnapIt {
 
             # Snapshot function call
             try {
-                Save-KubeSnapshot -Namespace $Namespace -AllNamespaces:$AllNamespaces -AllNonSystemNamespaces:$AllNonSystemNamespaces -Labels $Labels -Objects $Objects -OutputPath $OutputPath -DryRun:$DryRun -Verbose:$Verbose
+                Save-KubeSnapshot -Namespace $Namespace -ClusterResources:$ClusterResources -AllNonSystemNamespaces:$AllNonSystemNamespaces -Labels $Labels -Objects $Objects -OutputPath $OutputPath -DryRun:$DryRun -Verbose:$Verbose
             }
             catch {
                 Write-Host "Error during snapshot: $_" -ForegroundColor Red
@@ -281,7 +294,7 @@ function Invoke-KubeSnapIt {
         }
 
         default {
-            Write-Host "Error: Specify -Restore, -CompareWithCluster, -CompareSnapshots, or -SnapshotHelm with necessary parameters." -ForegroundColor Red
+            Write-Host "Error: Specify -Restore, -CompareWithCluster, -CompareSnapshots, or -SnapshotHelm, or -ClusterResources with necessary parameters." -ForegroundColor Red
             return
         }
     }
diff --git a/Private/Restore-HelmBackup.ps1 b/Private/Restore-HelmBackup.ps1
@@ -0,0 +1,86 @@
+function Restore-HelmBackup {
+    param (
+        [string]$ManifestFilePath, # Path to the manifest file to restore
+        [string]$Namespace,        # Target namespace for the release
+        [switch]$Verbose,          # Enable verbose output
+        [switch]$DryRun            # Simulate the restore process without applying changes
+    )
+
+    # Set verbose preference
+    if ($Verbose) {
+        $VerbosePreference = "Continue"
+    }
+
+    # Check if kubectl is installed
+    if (!(Get-Command "kubectl")) {
+        Write-Host "'kubectl' is not installed or not found in your system's PATH." -ForegroundColor Red
+        Write-Host "Please install 'kubectl' before running Restore-HelmBackup." -ForegroundColor Red
+        Write-Host "You can install 'kubectl' from: https://kubernetes.io/docs/tasks/tools/install/" -ForegroundColor Yellow
+        return
+    }
+
+    # Validate the manifest file path
+    if (-not (Test-Path $ManifestFilePath)) {
+        Write-Host "Manifest file not found at path '$ManifestFilePath'." -ForegroundColor Red
+        return
+    }
+
+    # Extract release name and timestamp from manifest file name
+    $manifestFileName = [System.IO.Path]::GetFileNameWithoutExtension($ManifestFilePath)
+    if ($manifestFileName -notmatch "^(?<releaseName>.+)_manifest_(?<timestamp>\d{4}-\d{2}-\d{2}_\d{2}-\d{2}-\d{2})$") {
+        Write-Host "Invalid manifest file naming convention: '$manifestFileName'." -ForegroundColor Red
+        return
+    }
+    $releaseName = $matches['releaseName']
+    $timestamp = $matches['timestamp']
+
+    # Locate corresponding backend files based on timestamp
+    $backupDir = [System.IO.Path]::GetDirectoryName($ManifestFilePath)
+    $backendFile = Get-ChildItem -Path $backupDir -Filter "${releaseName}_backend_${timestamp}.yaml" | Select-Object -First 1
+
+    # Log the files being used for restoration
+    Write-Host "Using manifest file: $ManifestFilePath" -ForegroundColor Green
+    if ($backendFile) {
+        Write-Host "Using backend file: $($backendFile.FullName)" -ForegroundColor Green
+    } else {
+        Write-Host "No matching backend file found for release '$releaseName'." -ForegroundColor Yellow
+    }
+
+    # Check for namespace and create if needed
+    if (-not $DryRun) {
+        $namespaceCheck = kubectl get namespace $Namespace -o name
+        if (-not $namespaceCheck) {
+            Write-Verbose "Creating namespace '$Namespace'."
+            kubectl create namespace $Namespace
+            Write-Host "Namespace '$Namespace' created." -ForegroundColor Green
+        } else {
+            Write-Host "Namespace '$Namespace' exists." -ForegroundColor Green
+        }
+    }
+
+    # Restore the manifest
+    Write-Host "Restoring manifest for Helm release '$releaseName'..." -ForegroundColor Green
+    if ($DryRun) {
+        Write-Host "Dry run: Would apply manifest from file $ManifestFilePath." -ForegroundColor Yellow
+    } else {
+        $kubectlApplyCmd = "apply -f $ManifestFilePath"
+        Write-Verbose "Running command: kubectl $kubectlApplyCmd"
+        kubectl apply -f $ManifestFilePath
+        Write-Host "Manifest for release '$releaseName' applied." -ForegroundColor Green
+    }
+
+    # Restore backend storage (if available)
+    if ($backendFile) {
+        Write-Host "Restoring backend storage for Helm release '$releaseName'..." -ForegroundColor Green
+        if ($DryRun) {
+            Write-Host "Dry run: Would apply backend storage from file $($backendFile.FullName)." -ForegroundColor Yellow
+        } else {
+            $kubectlApplyCmd = "apply -f $($backendFile.FullName)"
+            Write-Verbose "Running command: kubectl $kubectlApplyCmd"
+            kubectl apply -f $backendFile.FullName
+            Write-Host "Backend storage for release '$releaseName' applied." -ForegroundColor Green
+        }
+    }
+
+    Write-Host "Restore process for release '$releaseName' completed." -ForegroundColor Green
+}
diff --git a/Private/Save-HelmBackup.ps1 b/Private/Save-HelmBackup.ps1
@@ -6,7 +6,7 @@ function Save-HelmBackup {
         [switch]$Verbose,
         [switch]$AllNamespaces,
         [switch]$AllNonSystemNamespaces,
-        [switch]$SnapshotHelm,           # Perform a full Helm snapshot
+        [switch]$SnapshotHelm, # Perform a full Helm snapshot (includes backend storage)
         [switch]$SnapshotHelmUsedValues # Perform only Helm used values snapshot
     )
 
@@ -75,12 +75,48 @@ function Save-HelmBackup {
 
         if ($usedValuesOutput) {
             return $usedValuesOutput
-        } else {
+        }
+        else {
             Write-Host "No used values found for release '$ReleaseName'." -ForegroundColor Yellow
             return $null
         }
     }
 
+    # Function to backup backend storage
+    function Backup-HelmBackend {
+        param (
+            [string]$Namespace
+        )
+        Write-Verbose "Backing up Helm storage backend for namespace: $Namespace"
+        $secrets = kubectl get secrets -n $Namespace -o json | ConvertFrom-Json
+        $backendType = $secrets.items | Where-Object { $_.type -eq 'helm.sh/release.v1' -and $_.metadata.name -like '*sh.helm.release.v1*' } | Select-Object -First 1
+
+        if ($backendType -match "helm.sh/release.v1") {
+            Write-Verbose "Detected backend: Secrets"
+            $releases = kubectl get secrets -n $Namespace -l "owner=helm" -o json | ConvertFrom-Json
+        }
+        else {
+            Write-Verbose "Detected backend: ConfigMaps"
+            $releases = kubectl get configmaps -n $Namespace -l "owner=helm" -o json | ConvertFrom-Json
+        }
+
+        # Prepare YAML output file
+
+        $releaseName = $release.metadata.labels.name
+        $safeName = $releaseName -replace "[:\\/]", "_"
+        $timestamp = Get-Date -Format "yyyy-MM-dd_HH-mm-ss"
+        $filePath = Join-Path -Path $OutputPath -ChildPath "${safeName}_backend_$timestamp.yaml"
+        New-Item -Path $filePath -ItemType File -Force | Out-Null
+
+        # Convert and append each release to the YAML file
+        foreach ($release in $releases.items) {
+            $yamlContent = ConvertTo-Yaml -Data $release
+            Add-Content -Path $filePath -Value $yamlContent
+            Add-Content -Path $filePath -Value "---"
+        }
+        Write-Host "Helm release '$releaseName' backend saved: $filePath" -ForegroundColor Green
+    }
+
     # Function to process a namespace
     function Backup-HelmNamespace {
         param (
@@ -92,6 +128,11 @@ function Save-HelmBackup {
             $namespaceOption = "-n $Namespace"
         }
 
+        # Back up backend storage if SnapshotHelm is enabled
+        if ($SnapshotHelm) {
+            Backup-HelmBackend -Namespace $Namespace
+        }
+
         $helmListCmd = "list $namespaceOption --output json"
         Write-Verbose "Running command: helm $helmListCmd"
         $releasesOutput = Invoke-HelmCommand $helmListCmd
@@ -111,8 +152,9 @@ function Save-HelmBackup {
 
                 if ($DryRun) {
                     Write-Host "Dry run: Found Helm release '$releaseName' in namespace '$releaseNamespace'."
-                } else {
-                    # Full Helm snapshot (values, manifest, and history)
+                }
+                else {
+                    # Full Helm snapshot (values, and manifest)
                     if ($SnapshotHelm) {
                         # Fetch values
                         $helmGetValuesCmd = "get values $releaseName $namespaceOption -o yaml"
@@ -134,16 +176,6 @@ function Save-HelmBackup {
                             $manifestOutput | Out-File -FilePath $manifestFile -Force
                             Write-Host "Helm release '$releaseName' manifest saved: $manifestFile" -ForegroundColor Green
                         }
-
-                        # Fetch history
-                        $helmHistoryCmd = "history $releaseName $namespaceOption --output yaml"
-                        Write-Verbose "Running command: helm $helmHistoryCmd"
-                        $historyOutput = Invoke-HelmCommand $helmHistoryCmd
-                        if ($historyOutput) {
-                            $historyFile = Join-Path -Path $OutputPath -ChildPath "${safeReleaseName}_history_$timestamp.yaml"
-                            $historyOutput | Out-File -FilePath $historyFile -Force
-                            Write-Host "Helm release '$releaseName' history saved: $historyFile" -ForegroundColor Green
-                        }
                     }
 
                     # Only Helm used values snapshot
@@ -158,7 +190,8 @@ function Save-HelmBackup {
                     }
                 }
             }
-        } else {
+        }
+        else {
             Write-Host "No Helm releases found in the namespace '$Namespace'." -ForegroundColor Yellow
         }
     }
@@ -168,12 +201,15 @@ function Save-HelmBackup {
         if ($AllNamespaces) {
             $namespaces = kubectl get namespaces -o json | ConvertFrom-Json
             $allClusterNamespaces = $namespaces.items | ForEach-Object { $_.metadata.name }
-        } elseif ($AllNonSystemNamespaces) {
+        }
+        elseif ($AllNonSystemNamespaces) {
             $namespaces = kubectl get namespaces -o json | ConvertFrom-Json
             $allClusterNamespaces = $namespaces.items | Where-Object { $_.metadata.name -notmatch "^(kube-system|kube-public|kube-node-lease|default)$" } | ForEach-Object { $_.metadata.name }
-        } elseif ($Namespace) {
+        }
+        elseif ($Namespace) {
             $allClusterNamespaces = @($Namespace)
-        } else {
+        }
+        else {
             Write-Host "No namespace specified." -ForegroundColor Red
             return
         }
@@ -187,4 +223,4 @@ function Save-HelmBackup {
     catch {
         Write-Host "Error occurred while backing up Helm releases: $_" -ForegroundColor Red
     }
-}
+}
diff --git a/Private/Save-KubeSnapshot.ps1 b/Private/Save-KubeSnapshot.ps1

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`		`-snapshots/`
	`1`	`+snapshots/`
	`2`	`+helm_snapshots/`