[Feature] [LM] Inventory CLI (#1974)

Author: ajanikow

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## [master](https://github.com/arangodb/kube-arangodb/tree/master) (N/A)
 - (Bugfix) (Platform) Increase memory limit for Inventory
+- (Feature) (LM) Inventory Generator
 
 ## [1.3.1](https://github.com/arangodb/kube-arangodb/tree/1.3.1) (2025-10-07)
 - (Documentation) Add ArangoPlatformStorage Docs & Examples

docs/cli/arangodb_operator_platform.md

@@ -4,6 +4,28 @@ parent: Binaries
 title: arangodb_operator_platform
 ---
 
+# ArangoDB Operator Platform Command
+
+[START_INJECT]: # (arangodb_operator_platform_cmd)
+```
+Usage:
+  arangodb_operator_platform [command]
+
+Available Commands:
+  completion  Generate the autocompletion script for the specified shell
+  help        Help about any command
+  license     License Package related operations
+  package     Release Package related operations
+
+Flags:
+  -h, --help                help for arangodb_operator_platform
+      --kubeconfig string   Kubernetes Config File
+  -n, --namespace string    Kubernetes Namespace (default "default")
+
+Use "arangodb_operator_platform [command] --help" for more information about a command.
+```
+[END_INJECT]: # (arangodb_operator_platform_cmd)
+
 # ArangoDB Operator Platform Package Command
 
 [START_INJECT]: # (arangodb_operator_platform_package_cmd)
@@ -70,3 +92,49 @@ Global Flags:
 ```
 [END_INJECT]: # (arangodb_operator_platform_package_install_cmd)
 
+# ArangoDB Operator Platform License Command
+
+[START_INJECT]: # (arangodb_operator_platform_license_cmd)
+```
+License Package related operations
+
+Usage:
+  arangodb_operator_platform license [command]
+
+Available Commands:
+  inventory   Inventory Generator
+
+Flags:
+  -h, --help   help for license
+
+Global Flags:
+      --kubeconfig string   Kubernetes Config File
+  -n, --namespace string    Kubernetes Namespace (default "default")
+
+Use "arangodb_operator_platform license [command] --help" for more information about a command.
+```
+[END_INJECT]: # (arangodb_operator_platform_license_cmd)
+
+# ArangoDB Operator Platform License Inventory Command
+
+[START_INJECT]: # (arangodb_operator_platform_license_inventory_cmd)
+```
+Inventory Generator
+
+Usage:
+  arangodb_operator_platform license inventory [flags] output
+
+Flags:
+      --arango.authentication string   Arango Endpoint Auth Method. One of: Disabled, Basic, Token (default "Disabled")
+      --arango.basic.password string   Arango Password for Basic Authentication
+      --arango.basic.username string   Arango Username for Basic Authentication
+      --arango.endpoint strings        Arango Endpoint
+      --arango.insecure                Arango Endpoint Insecure
+      --arango.token string            Arango JWT Token for Authentication
+  -h, --help                           help for inventory
+
+Global Flags:
+      --kubeconfig string   Kubernetes Config File
+  -n, --namespace string    Kubernetes Namespace (default "default")
+```
+[END_INJECT]: # (arangodb_operator_platform_license_inventory_cmd)

internal/readme_cli.go

@@ -139,6 +139,18 @@ func GenerateCLIArangoDBOperatorPlatformReadme(root string) error {
 		readmeSections["arangodb_operator_platform_package_install_cmd"] = section
 	}
 
+	if section, err := GenerateHelpQuoted(cmd, "license"); err != nil {
+		return err
+	} else {
+		readmeSections["arangodb_operator_platform_license_cmd"] = section
+	}
+
+	if section, err := GenerateHelpQuoted(cmd, "license", "inventory"); err != nil {
+		return err
+	} else {
+		readmeSections["arangodb_operator_platform_license_inventory_cmd"] = section
+	}
+
 	if err := pretty.ReplaceSectionsInFile(path.Join(root, "docs", "cli", "arangodb_operator_platform.md"), readmeSections); err != nil {
 		return err
 	}

pkg/apis/shared/validate.go

@@ -200,6 +200,11 @@ func ValidateRequiredNotEmptyPath[T any](path string, in *T) error {
 	return PrefixResourceError(path, ValidateRequiredNotEmpty(in))
 }
 
+// ValidatePath Validates object
+func ValidatePath[T any](path string, in T, validator func(T) error) error {
+	return PrefixResourceErrors(path, validator(in))
+}
+
 // ValidateRequiredPath Validates object and required not nil value
 func ValidateRequiredPath[T any](path string, in *T, validator func(T) error) error {
 	return PrefixResourceErrors(path, ValidateRequired(in, validator))

pkg/deployment/client/client.go

@@ -59,6 +59,8 @@ type Client interface {
 	Compact(ctx context.Context, request *CompactRequest) error
 
 	Inventory(ctx context.Context) (*Inventory, error)
+
+	DeploymentID(ctx context.Context) (DeploymentID, error)
 }
 
 type client struct {

pkg/deployment/client/id.go

@@ -0,0 +1,35 @@
+//
+// DISCLAIMER
+//
+// Copyright 2025 ArangoDB GmbH, Cologne, Germany
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// Copyright holder is ArangoDB GmbH, Cologne, Germany
+//
+
+package client
+
+import (
+	"context"
+
+	"github.com/arangodb/kube-arangodb/pkg/util/arangod"
+)
+
+type DeploymentID struct {
+	Id string `json:"id"`
+}
+
+func (c *client) DeploymentID(ctx context.Context) (DeploymentID, error) {
+	return arangod.GetRequest[DeploymentID](ctx, c.c, "_admin", "deployment", "id").AcceptCode(200).Response()
+}

pkg/platform/flags.go

@@ -100,6 +100,8 @@ var (
 		},
 	}
 
+	flagDeployment = cli.NewDeployment("arango")
+
 	flagValues = cli.Flag[[]string]{
 		Name:        "values",
 		Short:       "f",

pkg/platform/installer.go

@@ -44,6 +44,7 @@ func installer() (*cobra.Command, error) {
 
 	if err := withRegisterCommand(&cmd,
 		pkg,
+		license,
 	); err != nil {
 		return nil, err
 	}

pkg/platform/inventory/aql.go

@@ -0,0 +1,103 @@
+//
+// DISCLAIMER
+//
+// Copyright 2025 ArangoDB GmbH, Cologne, Germany
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// Copyright holder is ArangoDB GmbH, Cologne, Germany
+//
+
+package inventory
+
+import (
+	"context"
+	"time"
+
+	"github.com/arangodb/go-driver"
+	"github.com/arangodb/go-driver/util/connection/wrappers/async"
+
+	"github.com/arangodb/kube-arangodb/pkg/logging"
+	"github.com/arangodb/kube-arangodb/pkg/util/errors"
+	"github.com/arangodb/kube-arangodb/pkg/util/executor"
+	ugrpc "github.com/arangodb/kube-arangodb/pkg/util/grpc"
+)
+
+func ExecuteAQL(db string, aql string, bind map[string]any) Executor {
+	return func(conn driver.Connection, out chan<- *Item) executor.RunFunc {
+		return func(ctx context.Context, log logging.Logger, t executor.Thread, h executor.Handler) error {
+			c, err := driver.NewClient(driver.ClientConfig{Connection: async.NewConnectionAsyncWrapper(conn)})
+			if err != nil {
+				return err
+			}
+
+			d, err := c.Database(ctx, db)
+			if err != nil {
+				return err
+			}
+
+			nctx := driver.WithAsync(ctx)
+
+			_, err = d.Query(nctx, aql, bind)
+			if err == nil {
+				return errors.Errorf("Async execution of the query should be prepared")
+			}
+
+			jobId, ok := async.IsAsyncJobInProgress(err)
+			if !ok {
+				return errors.Wrapf(err, "Async execution of the query should be prepared")
+			}
+
+			var cursor driver.Cursor
+
+			for {
+				zctx := driver.WithAsyncID(ctx, jobId)
+
+				query, err := d.Query(zctx, aql, bind)
+				if err != nil {
+					_, ok := async.IsAsyncJobInProgress(err)
+					if !ok {
+						return errors.Wrapf(err, "Async execution of the query should be prepared")
+					}
+
+					t.Wait(125 * time.Millisecond)
+
+					continue
+				}
+
+				cursor = query
+				break
+			}
+
+			for {
+				var ret ugrpc.Object[*Item]
+
+				if _, err := cursor.ReadDocument(ctx, &ret); err != nil {
+					if driver.IsNoMoreDocuments(err) {
+						break
+					}
+
+					return err
+				}
+
+				if err := ret.Object.Validate(); err != nil {
+					return err
+				}
+
+				out <- ret.Object
+			}
+
+			return nil
+		}
+	}
+}

pkg/platform/inventory/fetcher.aql.timestamp.go

@@ -0,0 +1,30 @@
+//
+// DISCLAIMER
+//
+// Copyright 2025 ArangoDB GmbH, Cologne, Germany
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// Copyright holder is ArangoDB GmbH, Cologne, Germany
+//
+
+package inventory
+
+import _ "embed"
+
+//go:embed queries/timestamp.aql
+var queryTimestampAQL string
+
+func init() {
+	global.MustRegister("aql.timestamp", ExecuteAQL("_system", queryTimestampAQL, nil))
+}