[Feature] Add DebugPackage to the OPS Binary (#1771)

Author: ajanikow

CHANGELOG.md

@@ -24,6 +24,7 @@
 - (Feature) (Scheduler) Deployment Scale Functionality
 - (Feature) (Platform) Chart Integration
 - (Maintenance) Switch to google.golang.org/protobuf
+- (Feature) Add DebugPackage to the OPS Binary
 
 ## [1.2.43](https://github.com/arangodb/kube-arangodb/tree/1.2.43) (2024-10-14)
 - (Feature) ArangoRoute CRD

cmd/debug.go

@@ -34,6 +34,9 @@ func init() {
 	cmdMain.AddCommand(debugPackage)
 	cmdMain.AddCommand(debugPackageV2)
 
+	cmdOps.AddCommand(debugPackage)
+	cmdOps.AddCommand(debugPackageV2)
+
 	debugPackage.Flags().StringVarP(&debugPackageInput.Output, "output", "o", "out.tar.gz", "Output of the result gz file. If set to `-` then stdout is used")
 	debugPackageV2.Flags().StringVarP(&debugPackageInput.Output, "output", "o", "out.tar.gz", "Output of the result gz file. If set to `-` then stdout is used")
 

docs/cli/arangodb_operator.md

@@ -15,14 +15,14 @@ Usage:
 Available Commands:
   admin           Administration operations
   completion      Generate the autocompletion script for the specified shell
-  crd         CRD operations
-  debug-package   Generate debug package for debugging
+  crd           CRD operations
+  debug-package Generate debug package for debugging
   exporter        
   features        Describe all operator features
   help            Help about any command
   integration     
   storage         
-  task        
+  task          
   version         
 
 Flags:

docs/cli/arangodb_operator_ops.md

@@ -13,10 +13,11 @@ Usage:
   arangodb_operator_ops [command]
 
 Available Commands:
-  completion  Generate the autocompletion script for the specified shell
-  crd         CRD operations
-  help        Help about any command
-  task        
+  completion    Generate the autocompletion script for the specified shell
+  crd           CRD operations
+  debug-package Generate debug package for debugging
+  help          Help about any command
+  task          
 
 Flags:
   -h, --help   help for arangodb_operator_ops
@@ -86,3 +87,33 @@ Global Flags:
       --crd.validation-schema stringArray         Controls which CRD should have validation schema <crd-name>=<true/false>.
 ```
 [END_INJECT]: # (arangodb_operator_ops_cmd_crd_generate)
+
+# ArangoDB Operator Ops CRD Install Subcommand
+
+[START_INJECT]: # (arangodb_operator_ops_cmd_debug_package)
+```
+Generate debug package for debugging
+
+Usage:
+  arangodb_operator_ops debug-package [flags]
+
+Flags:
+      --generator.agency-dump           Define if generator agency-dump is enabled (default true)
+      --generator.analytics             Define if generator analytics is enabled (default true)
+      --generator.backupBackup          Define if generator backupBackup is enabled (default true)
+      --generator.deployments           Define if generator deployments is enabled (default true)
+      --generator.kubernetes-events     Define if generator kubernetes-events is enabled (default true)
+      --generator.kubernetes-pods       Define if generator kubernetes-pods is enabled (default true)
+      --generator.kubernetes-secrets    Define if generator kubernetes-secrets is enabled (default true)
+      --generator.kubernetes-services   Define if generator kubernetes-services is enabled (default true)
+      --generator.ml                    Define if generator ml is enabled (default true)
+      --generator.networking            Define if generator networking is enabled (default true)
+      --generator.platform              Define if generator platform is enabled (default true)
+      --generator.scheduler             Define if generator scheduler is enabled (default true)
+  -h, --help                            help for debug-package
+      --hide-sensitive-data             Hide sensitive data (default true)
+  -n, --namespace string                Kubernetes namespace (default "default")
+  -o, --output -                        Output of the result gz file. If set to - then stdout is used (default "out.tar.gz")
+      --pod-logs                        Collect pod logs (default true)
+```
+[END_INJECT]: # (arangodb_operator_ops_cmd_debug_package)

internal/readme_cli.go

@@ -71,6 +71,12 @@ func GenerateCLIArangoDBOperatorOpsReadme(root string) error {
 		readmeSections["arangodb_operator_ops_cmd_crd_generate"] = section
 	}
 
+	if section, err := GenerateHelpQuoted(cmd.CommandOps(), "debug-package"); err != nil {
+		return err
+	} else {
+		readmeSections["arangodb_operator_ops_cmd_debug_package"] = section
+	}
+
 	if err := md.ReplaceSectionsInFile(path.Join(root, "docs", "cli", "arangodb_operator_ops.md"), readmeSections); err != nil {
 		return err
 	}