Add yaml output to lb commands (#321)

GokceGK · web-flow · commit 0768e513c6b0 · 2024-05-15T15:35:40.000+02:00
* update docs

* add yaml output
diff --git a/docs/stackit_load-balancer.md b/docs/stackit_load-balancer.md
@@ -21,7 +21,7 @@ stackit load-balancer [flags]
 ```
   -y, --assume-yes             If set, skips all confirmation prompts
       --async                  If set, runs the command asynchronously
-  -o, --output-format string   Output format, one of ["json" "pretty" "none"]
+  -o, --output-format string   Output format, one of ["json" "pretty" "none" "yaml"]
   -p, --project-id string      Project ID
       --verbosity string       Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
 ```
diff --git a/docs/stackit_load-balancer_create.md b/docs/stackit_load-balancer_create.md
@@ -39,7 +39,7 @@ stackit load-balancer create [flags]
 ```
   -y, --assume-yes             If set, skips all confirmation prompts
       --async                  If set, runs the command asynchronously
-  -o, --output-format string   Output format, one of ["json" "pretty" "none"]
+  -o, --output-format string   Output format, one of ["json" "pretty" "none" "yaml"]
   -p, --project-id string      Project ID
       --verbosity string       Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
 ```
diff --git a/docs/stackit_load-balancer_delete.md b/docs/stackit_load-balancer_delete.md
@@ -28,7 +28,7 @@ stackit load-balancer delete LOAD_BALANCER_NAME [flags]
 ```
   -y, --assume-yes             If set, skips all confirmation prompts
       --async                  If set, runs the command asynchronously
-  -o, --output-format string   Output format, one of ["json" "pretty" "none"]
+  -o, --output-format string   Output format, one of ["json" "pretty" "none" "yaml"]
   -p, --project-id string      Project ID
       --verbosity string       Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
 ```
diff --git a/docs/stackit_load-balancer_describe.md b/docs/stackit_load-balancer_describe.md
@@ -31,7 +31,7 @@ stackit load-balancer describe LOAD_BALANCER_NAME [flags]
 ```
   -y, --assume-yes             If set, skips all confirmation prompts
       --async                  If set, runs the command asynchronously
-  -o, --output-format string   Output format, one of ["json" "pretty" "none"]
+  -o, --output-format string   Output format, one of ["json" "pretty" "none" "yaml"]
   -p, --project-id string      Project ID
       --verbosity string       Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
 ```
diff --git a/docs/stackit_load-balancer_generate-payload.md b/docs/stackit_load-balancer_generate-payload.md
@@ -37,7 +37,7 @@ stackit load-balancer generate-payload [flags]
 ```
   -y, --assume-yes             If set, skips all confirmation prompts
       --async                  If set, runs the command asynchronously
-  -o, --output-format string   Output format, one of ["json" "pretty" "none"]
+  -o, --output-format string   Output format, one of ["json" "pretty" "none" "yaml"]
   -p, --project-id string      Project ID
       --verbosity string       Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
 ```
diff --git a/docs/stackit_load-balancer_list.md b/docs/stackit_load-balancer_list.md
@@ -35,7 +35,7 @@ stackit load-balancer list [flags]
 ```
   -y, --assume-yes             If set, skips all confirmation prompts
       --async                  If set, runs the command asynchronously
-  -o, --output-format string   Output format, one of ["json" "pretty" "none"]
+  -o, --output-format string   Output format, one of ["json" "pretty" "none" "yaml"]
   -p, --project-id string      Project ID
       --verbosity string       Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
 ```
diff --git a/docs/stackit_load-balancer_observability-credentials.md b/docs/stackit_load-balancer_observability-credentials.md
@@ -21,7 +21,7 @@ stackit load-balancer observability-credentials [flags]
 ```
   -y, --assume-yes             If set, skips all confirmation prompts
       --async                  If set, runs the command asynchronously
-  -o, --output-format string   Output format, one of ["json" "pretty" "none"]
+  -o, --output-format string   Output format, one of ["json" "pretty" "none" "yaml"]
   -p, --project-id string      Project ID
       --verbosity string       Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
 ```
diff --git a/docs/stackit_load-balancer_observability-credentials_add.md b/docs/stackit_load-balancer_observability-credentials_add.md
@@ -34,7 +34,7 @@ stackit load-balancer observability-credentials add [flags]
 ```
   -y, --assume-yes             If set, skips all confirmation prompts
       --async                  If set, runs the command asynchronously
-  -o, --output-format string   Output format, one of ["json" "pretty" "none"]
+  -o, --output-format string   Output format, one of ["json" "pretty" "none" "yaml"]
   -p, --project-id string      Project ID
       --verbosity string       Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
 ```
diff --git a/docs/stackit_load-balancer_observability-credentials_cleanup.md b/docs/stackit_load-balancer_observability-credentials_cleanup.md
@@ -28,7 +28,7 @@ stackit load-balancer observability-credentials cleanup [flags]
 ```
   -y, --assume-yes             If set, skips all confirmation prompts
       --async                  If set, runs the command asynchronously
-  -o, --output-format string   Output format, one of ["json" "pretty" "none"]
+  -o, --output-format string   Output format, one of ["json" "pretty" "none" "yaml"]
   -p, --project-id string      Project ID
       --verbosity string       Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
 ```
diff --git a/docs/stackit_load-balancer_observability-credentials_delete.md b/docs/stackit_load-balancer_observability-credentials_delete.md
@@ -28,7 +28,7 @@ stackit load-balancer observability-credentials delete CREDENTIALS_REF [flags]
 ```
   -y, --assume-yes             If set, skips all confirmation prompts
       --async                  If set, runs the command asynchronously
-  -o, --output-format string   Output format, one of ["json" "pretty" "none"]
+  -o, --output-format string   Output format, one of ["json" "pretty" "none" "yaml"]
   -p, --project-id string      Project ID
       --verbosity string       Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
 ```
diff --git a/docs/stackit_load-balancer_observability-credentials_describe.md b/docs/stackit_load-balancer_observability-credentials_describe.md
@@ -28,7 +28,7 @@ stackit load-balancer observability-credentials describe CREDENTIALS_REF [flags]
 ```
   -y, --assume-yes             If set, skips all confirmation prompts
       --async                  If set, runs the command asynchronously
-  -o, --output-format string   Output format, one of ["json" "pretty" "none"]
+  -o, --output-format string   Output format, one of ["json" "pretty" "none" "yaml"]
   -p, --project-id string      Project ID
       --verbosity string       Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
 ```
diff --git a/docs/stackit_load-balancer_observability-credentials_list.md b/docs/stackit_load-balancer_observability-credentials_list.md
@@ -43,7 +43,7 @@ stackit load-balancer observability-credentials list [flags]
 ```
   -y, --assume-yes             If set, skips all confirmation prompts
       --async                  If set, runs the command asynchronously
-  -o, --output-format string   Output format, one of ["json" "pretty" "none"]
+  -o, --output-format string   Output format, one of ["json" "pretty" "none" "yaml"]
   -p, --project-id string      Project ID
       --verbosity string       Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
 ```
diff --git a/docs/stackit_load-balancer_observability-credentials_update.md b/docs/stackit_load-balancer_observability-credentials_update.md
@@ -34,7 +34,7 @@ stackit load-balancer observability-credentials update [flags]
 ```
   -y, --assume-yes             If set, skips all confirmation prompts
       --async                  If set, runs the command asynchronously
-  -o, --output-format string   Output format, one of ["json" "pretty" "none"]
+  -o, --output-format string   Output format, one of ["json" "pretty" "none" "yaml"]
   -p, --project-id string      Project ID
       --verbosity string       Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
 ```
diff --git a/docs/stackit_load-balancer_quota.md b/docs/stackit_load-balancer_quota.md
@@ -28,7 +28,7 @@ stackit load-balancer quota [flags]
 ```
   -y, --assume-yes             If set, skips all confirmation prompts
       --async                  If set, runs the command asynchronously
-  -o, --output-format string   Output format, one of ["json" "pretty" "none"]
+  -o, --output-format string   Output format, one of ["json" "pretty" "none" "yaml"]
   -p, --project-id string      Project ID
       --verbosity string       Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
 ```
diff --git a/docs/stackit_load-balancer_target-pool.md b/docs/stackit_load-balancer_target-pool.md
@@ -21,7 +21,7 @@ stackit load-balancer target-pool [flags]
 ```
   -y, --assume-yes             If set, skips all confirmation prompts
       --async                  If set, runs the command asynchronously
-  -o, --output-format string   Output format, one of ["json" "pretty" "none"]
+  -o, --output-format string   Output format, one of ["json" "pretty" "none" "yaml"]
   -p, --project-id string      Project ID
       --verbosity string       Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
 ```
diff --git a/docs/stackit_load-balancer_target-pool_add-target.md b/docs/stackit_load-balancer_target-pool_add-target.md
@@ -32,7 +32,7 @@ stackit load-balancer target-pool add-target TARGET_IP [flags]
 ```
   -y, --assume-yes             If set, skips all confirmation prompts
       --async                  If set, runs the command asynchronously
-  -o, --output-format string   Output format, one of ["json" "pretty" "none"]
+  -o, --output-format string   Output format, one of ["json" "pretty" "none" "yaml"]
   -p, --project-id string      Project ID
       --verbosity string       Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
 ```
diff --git a/docs/stackit_load-balancer_target-pool_describe.md b/docs/stackit_load-balancer_target-pool_describe.md
@@ -32,7 +32,7 @@ stackit load-balancer target-pool describe TARGET_POOL_NAME [flags]
 ```
   -y, --assume-yes             If set, skips all confirmation prompts
       --async                  If set, runs the command asynchronously
-  -o, --output-format string   Output format, one of ["json" "pretty" "none"]
+  -o, --output-format string   Output format, one of ["json" "pretty" "none" "yaml"]
   -p, --project-id string      Project ID
       --verbosity string       Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
 ```
diff --git a/docs/stackit_load-balancer_target-pool_remove-target.md b/docs/stackit_load-balancer_target-pool_remove-target.md
@@ -30,7 +30,7 @@ stackit load-balancer target-pool remove-target TARGET_IP [flags]
 ```
   -y, --assume-yes             If set, skips all confirmation prompts
       --async                  If set, runs the command asynchronously
-  -o, --output-format string   Output format, one of ["json" "pretty" "none"]
+  -o, --output-format string   Output format, one of ["json" "pretty" "none" "yaml"]
   -p, --project-id string      Project ID
       --verbosity string       Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
 ```
diff --git a/docs/stackit_load-balancer_update.md b/docs/stackit_load-balancer_update.md
@@ -39,7 +39,7 @@ stackit load-balancer update LOAD_BALANCER_NAME [flags]
 ```
   -y, --assume-yes             If set, skips all confirmation prompts
       --async                  If set, runs the command asynchronously
-  -o, --output-format string   Output format, one of ["json" "pretty" "none"]
+  -o, --output-format string   Output format, one of ["json" "pretty" "none" "yaml"]
   -p, --project-id string      Project ID
       --verbosity string       Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
 ```
diff --git a/internal/cmd/load-balancer/describe/describe.go b/internal/cmd/load-balancer/describe/describe.go
@@ -6,6 +6,7 @@ import (
 	"fmt"
 	"strings"
 
+	"github.com/goccy/go-yaml"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/args"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/errors"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/examples"
@@ -105,6 +106,14 @@ func outputResult(p *print.Printer, outputFormat string, loadBalancer *loadbalan
 		}
 		p.Outputln(string(details))
 
+		return nil
+	case print.YAMLOutputFormat:
+		details, err := yaml.Marshal(loadBalancer)
+		if err != nil {
+			return fmt.Errorf("marshal load balancer: %w", err)
+		}
+		p.Outputln(string(details))
+
 		return nil
 	default:
 		return outputResultAsTable(p, loadBalancer)
diff --git a/internal/cmd/load-balancer/list/list.go b/internal/cmd/load-balancer/list/list.go
@@ -5,6 +5,7 @@ import (
 	"encoding/json"
 	"fmt"
 
+	"github.com/goccy/go-yaml"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/args"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/errors"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/examples"
@@ -138,6 +139,14 @@ func outputResult(p *print.Printer, outputFormat string, loadBalancers []loadbal
 		}
 		p.Outputln(string(details))
 
+		return nil
+	case print.YAMLOutputFormat:
+		details, err := yaml.Marshal(loadBalancers)
+		if err != nil {
+			return fmt.Errorf("marshal load balancer list: %w", err)
+		}
+		p.Outputln(string(details))
+
 		return nil
 	default:
 		table := tables.NewTable()
diff --git a/internal/cmd/load-balancer/observability-credentials/add/add.go b/internal/cmd/load-balancer/observability-credentials/add/add.go
@@ -5,6 +5,7 @@ import (
 	"encoding/json"
 	"fmt"
 
+	"github.com/goccy/go-yaml"
 	"github.com/google/uuid"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/args"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/errors"
@@ -156,6 +157,14 @@ func outputResult(p *print.Printer, model *inputModel, projectLabel string, resp
 		}
 		p.Outputln(string(details))
 
+		return nil
+	case print.YAMLOutputFormat:
+		details, err := yaml.Marshal(resp)
+		if err != nil {
+			return fmt.Errorf("marshal Load Balancer observability credentials: %w", err)
+		}
+		p.Outputln(string(details))
+
 		return nil
 	default:
 		p.Outputf("Added Load Balancer observability credentials on project %q. Credentials reference: %q\n", projectLabel, *resp.Credential.CredentialsRef)
diff --git a/internal/cmd/load-balancer/observability-credentials/describe/describe.go b/internal/cmd/load-balancer/observability-credentials/describe/describe.go
@@ -5,6 +5,7 @@ import (
 	"encoding/json"
 	"fmt"
 
+	"github.com/goccy/go-yaml"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/args"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/errors"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/examples"
@@ -102,6 +103,14 @@ func outputResult(p *print.Printer, outputFormat string, credentials *loadbalanc
 		}
 		p.Outputln(string(details))
 
+		return nil
+	case print.YAMLOutputFormat:
+		details, err := yaml.Marshal(credentials)
+		if err != nil {
+			return fmt.Errorf("marshal Load Balancer observability credentials: %w", err)
+		}
+		p.Outputln(string(details))
+
 		return nil
 	default:
 		table := tables.NewTable()
diff --git a/internal/cmd/load-balancer/observability-credentials/list/list.go b/internal/cmd/load-balancer/observability-credentials/list/list.go
@@ -5,6 +5,7 @@ import (
 	"encoding/json"
 	"fmt"
 
+	"github.com/goccy/go-yaml"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/args"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/errors"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/examples"
@@ -174,6 +175,14 @@ func outputResult(p *print.Printer, outputFormat string, credentials []loadbalan
 		}
 		p.Outputln(string(details))
 
+		return nil
+	case print.YAMLOutputFormat:
+		details, err := yaml.Marshal(credentials)
+		if err != nil {
+			return fmt.Errorf("marshal Load Balancer observability credentials list: %w", err)
+		}
+		p.Outputln(string(details))
+
 		return nil
 	default:
 		table := tables.NewTable()
diff --git a/internal/cmd/load-balancer/quota/quota.go b/internal/cmd/load-balancer/quota/quota.go
@@ -6,6 +6,7 @@ import (
 	"fmt"
 	"strconv"
 
+	"github.com/goccy/go-yaml"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/args"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/errors"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/examples"
@@ -95,6 +96,14 @@ func outputResult(p *print.Printer, outputFormat string, quota *loadbalancer.Get
 
 		p.Outputf("Maximum number of load balancers allowed: %s\n", maxLoadBalancers)
 
+		return nil
+	case print.YAMLOutputFormat:
+		details, err := yaml.Marshal(quota)
+		if err != nil {
+			return fmt.Errorf("marshal quota: %w", err)
+		}
+		p.Outputln(string(details))
+
 		return nil
 	default:
 		details, err := json.MarshalIndent(quota, "", "  ")
diff --git a/internal/cmd/load-balancer/target-pool/describe/describe.go b/internal/cmd/load-balancer/target-pool/describe/describe.go
@@ -7,6 +7,7 @@ import (
 	"strconv"
 	"strings"
 
+	"github.com/goccy/go-yaml"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/args"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/errors"
 	"github.com/stackitcloud/stackit-cli/internal/pkg/examples"
@@ -119,21 +120,30 @@ func buildRequest(ctx context.Context, model *inputModel, apiClient *loadbalance
 }
 
 func outputResult(p *print.Printer, outputFormat string, targetPool loadbalancer.TargetPool, listener *loadbalancer.Listener) error {
+	output := struct {
+		*loadbalancer.TargetPool
+		Listener *loadbalancer.Listener `json:"attached_listener"`
+	}{
+		&targetPool,
+		listener,
+	}
+
 	switch outputFormat {
 	case print.JSONOutputFormat:
-		output := struct {
-			*loadbalancer.TargetPool
-			Listener *loadbalancer.Listener `json:"attached_listener"`
-		}{
-			&targetPool,
-			listener,
-		}
 		details, err := json.MarshalIndent(output, "", "  ")
 		if err != nil {
 			return fmt.Errorf("marshal load balancer: %w", err)
 		}
 		p.Outputln(string(details))
 
+		return nil
+	case print.YAMLOutputFormat:
+		details, err := yaml.Marshal(output)
+		if err != nil {
+			return fmt.Errorf("marshal load balancer: %w", err)
+		}
+		p.Outputln(string(details))
+
 		return nil
 	default:
 		return outputResultAsTable(p, targetPool, listener)
