Design Doc, describe.go, and logs.go

cmd/non-admin/backup/backup.go

@@ -32,6 +32,8 @@ func NewBackupCommand(f client.Factory) *cobra.Command {
 
 	c.AddCommand(
 		NewCreateCommand(f, "create"),
+		NewLogsCommand(f, "logs"),
+		NewDescribeCommand(f, "describe"),
 		NewDeleteCommand(f, "delete"),
 	)
 

cmd/non-admin/backup/describe.go

@@ -0,0 +1,325 @@
+package backup
+
+import (
+	"compress/gzip"
+	"context"
+	"fmt"
+	"io"
+	"net/http"
+	"sort"
+	"strings"
+	"time"
+
+	nacv1alpha1 "github.com/migtools/oadp-non-admin/api/v1alpha1"
+	"github.com/spf13/cobra"
+	velerov1 "github.com/vmware-tanzu/velero/pkg/apis/velero/v1"
+	"github.com/vmware-tanzu/velero/pkg/client"
+	"github.com/vmware-tanzu/velero/pkg/cmd/util/output"
+	"gopkg.in/yaml.v2"
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/runtime"
+	kbclient "sigs.k8s.io/controller-runtime/pkg/client"
+)
+
+func NewDescribeCommand(f client.Factory, use string) *cobra.Command {
+	c := &cobra.Command{
+		Use:   use + " NAME",
+		Short: "Describe a non-admin backup",
+		Args:  cobra.ExactArgs(1),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			backupName := args[0]
+			userNamespace := f.Namespace()
+
+			// Setup scheme and client for NonAdminBackup resources
+			scheme := runtime.NewScheme()
+			if err := nacv1alpha1.AddToScheme(scheme); err != nil {
+				return fmt.Errorf("failed to add OADP non-admin types to scheme: %w", err)
+			}
+			if err := velerov1.AddToScheme(scheme); err != nil {
+				return fmt.Errorf("failed to add Velero types to scheme: %w", err)
+			}
+
+			restConfig, err := f.ClientConfig()
+			if err != nil {
+				return fmt.Errorf("failed to get rest config: %w", err)
+			}
+
+			kbClient, err := kbclient.New(restConfig, kbclient.Options{Scheme: scheme})
+			if err != nil {
+				return fmt.Errorf("failed to create controller-runtime client: %w", err)
+			}
+
+			// Shows NonAdminBackup resources
+			var nabList nacv1alpha1.NonAdminBackupList
+			if err := kbClient.List(context.TODO(), &nabList, kbclient.InNamespace(userNamespace)); err != nil {
+				return fmt.Errorf("failed to list NonAdminBackup resources: %w", err)
+			}
+
+			// Finds the backup
+			var foundNAB *nacv1alpha1.NonAdminBackup
+			for i := range nabList.Items {
+				if nabList.Items[i].Name == backupName {
+					foundNAB = &nabList.Items[i]
+					break
+				}
+			}
+
+			if foundNAB == nil {
+				return fmt.Errorf("NonAdminBackup %q not found in namespace %q", backupName, userNamespace)
+			}
+
+			return NonAdminDescribeBackup(cmd, kbClient, foundNAB, userNamespace)
+		},
+		Example: `  # Describe a non-admin backup with detailed information
+  kubectl oadp nonadmin backup describe my-backup`,
+	}
+	output.BindFlags(c.Flags())
+	output.ClearOutputFlagDefault(c)
+
+	return c
+}
+
+// NonAdminDescribeBackup mirrors Velero's output.DescribeBackup functionality
+// but works within non-admin RBAC boundaries using NonAdminDownloadRequest
+func NonAdminDescribeBackup(cmd *cobra.Command, kbClient kbclient.Client, nab *nacv1alpha1.NonAdminBackup, userNamespace string) error {
+	ctx, cancel := context.WithTimeout(context.Background(), 120*time.Second)
+	defer cancel()
+
+	// Print basic backup information
+	fmt.Fprintf(cmd.OutOrStdout(), "Name:         %s\n", nab.Name)
+	fmt.Fprintf(cmd.OutOrStdout(), "Namespace:    %s\n", nab.Namespace)
+
+	// Print labels
+	fmt.Fprintf(cmd.OutOrStdout(), "Labels:\n")
+	if len(nab.Labels) == 0 {
+		fmt.Fprintf(cmd.OutOrStdout(), "  <none>\n")
+	} else {
+		labelKeys := make([]string, 0, len(nab.Labels))
+		for k := range nab.Labels {
+			labelKeys = append(labelKeys, k)
+		}
+		sort.Strings(labelKeys)
+		for _, k := range labelKeys {
+			fmt.Fprintf(cmd.OutOrStdout(), "  %s=%s\n", k, nab.Labels[k])
+		}
+	}
+
+	// Print annotations
+	fmt.Fprintf(cmd.OutOrStdout(), "Annotations:\n")
+	if len(nab.Annotations) == 0 {
+		fmt.Fprintf(cmd.OutOrStdout(), "  <none>\n")
+	} else {
+		annotationKeys := make([]string, 0, len(nab.Annotations))
+		for k := range nab.Annotations {
+			annotationKeys = append(annotationKeys, k)
+		}
+		sort.Strings(annotationKeys)
+		for _, k := range annotationKeys {
+			fmt.Fprintf(cmd.OutOrStdout(), "  %s=%s\n", k, nab.Annotations[k])
+		}
+	}
+
+	// Print timestamps and status from NonAdminBackup
+	fmt.Fprintf(cmd.OutOrStdout(), "Creation Timestamp:  %s\n", nab.CreationTimestamp.Format(time.RFC3339))
+	fmt.Fprintf(cmd.OutOrStdout(), "Phase:               %s\n", nab.Status.Phase)
+
+	// If there's a referenced Velero backup, get more details
+	if nab.Status.VeleroBackup != nil && nab.Status.VeleroBackup.Name != "" {
+		veleroBackupName := nab.Status.VeleroBackup.Name
+
+		// Get backup details using NonAdminDownloadRequest for BackupResourceList
+		if resourceList, err := downloadBackupData(ctx, kbClient, userNamespace, veleroBackupName, "BackupResourceList"); err == nil {
+			fmt.Fprintf(cmd.OutOrStdout(), "\nBackup Resource List:\n")
+			fmt.Fprintf(cmd.OutOrStdout(), "%s", indent(resourceList, "  "))
+		}
+
+		// Get backup volume info using NonAdminDownloadRequest
+		if volumeInfo, err := downloadBackupData(ctx, kbClient, userNamespace, veleroBackupName, "BackupVolumeInfos"); err == nil {
+			fmt.Fprintf(cmd.OutOrStdout(), "\nBackup Volume Info:\n")
+			fmt.Fprintf(cmd.OutOrStdout(), "%s", indent(volumeInfo, "  "))
+		}
+
+		// Get backup item operations using NonAdminDownloadRequest
+		if itemOps, err := downloadBackupData(ctx, kbClient, userNamespace, veleroBackupName, "BackupItemOperations"); err == nil {
+			fmt.Fprintf(cmd.OutOrStdout(), "\nBackup Item Operations:\n")
+			fmt.Fprintf(cmd.OutOrStdout(), "%s", indent(itemOps, "  "))
+		}
+
+		// Get backup results using NonAdminDownloadRequest
+		if results, err := downloadBackupData(ctx, kbClient, userNamespace, veleroBackupName, "BackupResults"); err == nil {
+			fmt.Fprintf(cmd.OutOrStdout(), "\nBackup Results:\n")
+			fmt.Fprintf(cmd.OutOrStdout(), "%s", indent(results, "  "))
+		}
+	}
+
+	// Print NonAdminBackup Spec (excluding sensitive information)
+	if nab.Spec.BackupSpec != nil {
+		specYaml, err := yaml.Marshal(nab.Spec.BackupSpec)
+		if err != nil {
+			fmt.Fprintf(cmd.OutOrStdout(), "\nSpec: <error marshaling spec: %v>\n", err)
+		} else {
+			lines := strings.Split(string(specYaml), "\n")
+			var filtered []string
+			skip := false
+			for i := 0; i < len(lines); i++ {
+				line := lines[i]
+				trimmed := strings.TrimSpace(line)
+				if !skip && (strings.HasPrefix(trimmed, "includedNamespaces:") || strings.HasPrefix(trimmed, "includednamespaces:")) {
+					skip = true
+					continue
+				}
+				if skip {
+					// Skip all list items or indented lines after the key
+					if strings.HasPrefix(trimmed, "- ") || strings.HasPrefix(line, " ") || strings.HasPrefix(line, "\t") || trimmed == "" {
+						continue
+					} else {
+						// Found a new top-level key, stop skipping
+						skip = false
+					}
+				}
+				if !skip {
+					filtered = append(filtered, line)
+				}
+			}
+			fmt.Fprintf(cmd.OutOrStdout(), "\nSpec:\n%s", indent(strings.Join(filtered, "\n"), "  "))
+		}
+	}
+
+	// Print NonAdminBackup Status
+	statusYaml, err := yaml.Marshal(nab.Status)
+	if err != nil {
+		fmt.Fprintf(cmd.OutOrStdout(), "\nStatus: <error marshaling status: %v>\n", err)
+	} else {
+		fmt.Fprintf(cmd.OutOrStdout(), "\nStatus:\n%s", indent(string(statusYaml), "  "))
+	}
+
+	// Print Events for NonAdminBackup
+	fmt.Fprintf(cmd.OutOrStdout(), "\nEvents:\n")
+	var eventList corev1.EventList
+	if err := kbClient.List(ctx, &eventList, kbclient.InNamespace(userNamespace)); err != nil {
+		fmt.Fprintf(cmd.OutOrStdout(), "  <error fetching events: %v>\n", err)
+	} else {
+		// Filter events related to this NonAdminBackup
+		var relatedEvents []corev1.Event
+		for _, event := range eventList.Items {
+			if event.InvolvedObject.Kind == "NonAdminBackup" && event.InvolvedObject.Name == nab.Name {
+				relatedEvents = append(relatedEvents, event)
+			}
+		}
+
+		if len(relatedEvents) == 0 {
+			fmt.Fprintf(cmd.OutOrStdout(), "  <none>\n")
+		} else {
+			for _, e := range relatedEvents {
+				fmt.Fprintf(cmd.OutOrStdout(), "  %s: %s\n", e.Reason, e.Message)
+			}
+		}
+	}
+
+	return nil
+}
+
+// downloadBackupData uses NonAdminDownloadRequest to fetch detailed backup information
+// This replaces direct access to Velero backups with RBAC-compliant requests
+func downloadBackupData(ctx context.Context, kbClient kbclient.Client, userNamespace, backupName, dataType string) (string, error) {
+	// Create NonAdminDownloadRequest for the specified data type
+	req := &nacv1alpha1.NonAdminDownloadRequest{
+		ObjectMeta: metav1.ObjectMeta{
+			GenerateName: backupName + "-" + strings.ToLower(dataType) + "-",
+			Namespace:    userNamespace,
+		},
+		Spec: nacv1alpha1.NonAdminDownloadRequestSpec{
+			Target: velerov1.DownloadTarget{
+				Kind: velerov1.DownloadTargetKind(dataType),
+				Name: backupName,
+			},
+		},
+	}
+
+	if err := kbClient.Create(ctx, req); err != nil {
+		return "", fmt.Errorf("failed to create NonAdminDownloadRequest for %s: %w", dataType, err)
+	}
+
+	// Clean up the download request when done
+	defer func() {
+		deleteCtx, cancelDelete := context.WithTimeout(context.Background(), 5*time.Second)
+		defer cancelDelete()
+		_ = kbClient.Delete(deleteCtx, req)
+	}()
+
+	// Wait for the download request to be processed
+	timeout := time.After(30 * time.Second)
+	tick := time.Tick(1 * time.Second)
+
+	for {
+		select {
+		case <-timeout:
+			return "", fmt.Errorf("timed out waiting for %s download request to be processed", dataType)
+		case <-tick:
+			var updated nacv1alpha1.NonAdminDownloadRequest
+			if err := kbClient.Get(ctx, kbclient.ObjectKey{
+				Namespace: req.Namespace,
+				Name:      req.Name,
+			}, &updated); err != nil {
+				return "", fmt.Errorf("failed to get NonAdminDownloadRequest: %w", err)
+			}
+
+			switch updated.Status.Phase {
+			case "Processed":
+				if updated.Status.VeleroDownloadRequest.Status.DownloadURL != "" {
+					// Download and return the content
+					return downloadContent(updated.Status.VeleroDownloadRequest.Status.DownloadURL)
+				}
+			case "Failed":
+				return "", fmt.Errorf("NonAdminDownloadRequest failed for %s: phase=%s", dataType, updated.Status.Phase)
+			default:
+				// Continue waiting
+			}
+		}
+	}
+}
+
+// downloadContent fetches content from a signed URL and returns it as a string
+func downloadContent(url string) (string, error) {
+	resp, err := http.Get(url)
+	if err != nil {
+		return "", fmt.Errorf("failed to download content from URL %q: %w", url, err)
+	}
+	defer resp.Body.Close()
+
+	if resp.StatusCode != http.StatusOK {
+		bodyBytes, _ := io.ReadAll(resp.Body)
+		return "", fmt.Errorf("failed to download content: status %s, body: %s", resp.Status, string(bodyBytes))
+	}
+
+	// Try to decompress if it's gzipped
+	var reader io.Reader = resp.Body
+	if strings.Contains(resp.Header.Get("Content-Encoding"), "gzip") {
+		gzr, err := gzip.NewReader(resp.Body)
+		if err != nil {
+			return "", fmt.Errorf("failed to create gzip reader: %w", err)
+		}
+		defer gzr.Close()
+		reader = gzr
+	}
+
+	// Read all content
+	content, err := io.ReadAll(reader)
+	if err != nil {
+		return "", fmt.Errorf("failed to read content: %w", err)
+	}
+
+	return string(content), nil
+}
+
+// Helper to indent YAML blocks
+func indent(s, prefix string) string {
+	lines := strings.Split(s, "\n")
+	for i, line := range lines {
+		if len(line) > 0 {
+			lines[i] = prefix + line
+		}
+	}
+	return strings.Join(lines, "\n")
+}