[Feature] [ML] Allow to use PlatformStorage (#1798)

Author: ajanikow

CHANGELOG.md

@@ -48,6 +48,7 @@
 - (Feature) (Platform) Expose Route Name via Header
 - (Feature) (Platform) Route Upstream Timeout
 - (Maintenance) Fix CRD Generation and golangci version
+- (Feature) (ML) Allow to use PlatformStorage
 
 ## [1.2.43](https://github.com/arangodb/kube-arangodb/tree/1.2.43) (2024-10-14)
 - (Feature) ArangoRoute CRD

docs/api/ArangoMLExtension.V1Beta1.md

@@ -3188,6 +3188,18 @@ Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2
 
 UID keeps the information about object UID
 
+***
+
+### .spec.storageType
+
+Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.43/pkg/apis/ml/v1beta1/extension_spec.go#L52)</sup>
+
+ArangoMLExtensionSpecStorageType defines storage used for extension
+
+Possible Values: 
+* `"extension"` (default) - Uses AragoMLStorage
+* `"platform"` - Uses AragoPlatformStorage
+
 ## Status
 
 ### .status.arangoDB.secret.checksum

docs/platform.md

@@ -3,4 +3,26 @@ layout: page
 has_children: true
 title: ArangoDBPlatform
 has_toc: false
----
+---
+
+# Platform
+
+
+#### Community & Enterprise Edition
+
+[Full CustomResourceDefinition reference ->](./api/ArangoPlatformStorage.V1Alpha1.md)
+
+This instruction covers only the steps to enable ArangoPlatform in Kubernetes cluster with already running ArangoDeployment.
+If you don't have one yet, consider checking [kube-arangodb installation guide](./using-the-operator.md) and [ArangoDeployment CR description](./deployment-resource-reference.md).
+
+### To enable Platform on your cluster, follow next steps:
+
+1) Install [CertManager](https://github.com/cert-manager/cert-manager) on your cluster.
+ 
+2) Enable Gateway Feature. Add `--deployment.feature.gateway=true` option to the Operator arguments.
+
+3) Enable Webhooks. e.g. if you are using Helm package, add `--set "webhooks.enabled=true"` option to the Helm command.
+
+4) Enable Managed Certificates. e.g. if you are using Helm package, add `--set "certificate.enabled=true"` option to the Helm command.
+
+5) Enable Gateways in the ArangoDeployment. Set `.spec.gateway.enabled` and `.spec.gateway.dynamic` to True

pkg/apis/ml/v1beta1/extension_spec.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2024 ArangoDB GmbH, Cologne, Germany
+// Copyright 2024-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.
@@ -31,7 +31,7 @@ type ArangoMLExtensionSpec struct {
 	// +doc/immutable: This setting cannot be changed after the MetadataService has been created.
 	MetadataService *ArangoMLExtensionSpecMetadataService `json:"metadataService,omitempty"`
 
-	// Storage specifies the ArangoMLStorage used within Extension
+	// Storage specifies the ArangoMLStorage used within Extension, if extension storage is used
 	Storage *sharedApi.Object `json:"storage,omitempty"`
 
 	// ArangoMLExtensionTemplate define Init job specification
@@ -45,6 +45,11 @@ type ArangoMLExtensionSpec struct {
 
 	// IntegrationSidecar define the integration sidecar spec
 	IntegrationSidecar *schedulerIntegrationApi.Sidecar `json:"integrationSidecar,omitempty"`
+
+	// ArangoMLExtensionSpecStorageType defines storage used for extension
+	// +doc/enum: extension|Uses AragoMLStorage
+	// +doc/enum: platform|Uses AragoPlatformStorage
+	StorageType *ArangoMLExtensionSpecStorageType `json:"storageType,omitempty"`
 }
 
 func (a *ArangoMLExtensionSpec) GetMetadataService() *ArangoMLExtensionSpecMetadataService {
@@ -71,6 +76,14 @@ func (a *ArangoMLExtensionSpec) GetStorage() *sharedApi.Object {
 	return a.Storage
 }
 
+func (a *ArangoMLExtensionSpec) GetStorageType() ArangoMLExtensionSpecStorageType {
+	if a == nil {
+		return ArangoMLExtensionSpecStorageTypeDefault
+	}
+
+	return a.StorageType.Get()
+}
+
 func (a *ArangoMLExtensionSpec) GetDeployment() *ArangoMLExtensionSpecDeployment {
 	if a == nil || a.Deployment == nil {
 		return nil
@@ -99,7 +112,7 @@ func (a *ArangoMLExtensionSpec) Validate() error {
 
 	return shared.WithErrors(shared.PrefixResourceErrors("spec",
 		shared.PrefixResourceErrors("metadataService", a.GetMetadataService().Validate()),
-		shared.PrefixResourceErrors("storage", shared.ValidateRequired(a.GetStorage(), func(obj sharedApi.Object) error { return obj.Validate() })),
+		shared.PrefixResourceErrors("storage", shared.ValidateOptionalInterface(a.GetStorage())),
 		shared.PrefixResourceErrors("init", a.GetInit().Validate()),
 		shared.PrefixResourceErrors("deployment", a.GetDeployment().Validate()),
 		shared.PrefixResourceErrors("jobsTemplates", a.GetJobsTemplates().Validate()),

pkg/apis/ml/v1beta1/extension_spec_storage_type.go

@@ -0,0 +1,48 @@
+//
+// 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 v1beta1
+
+import "github.com/arangodb/kube-arangodb/pkg/util/errors"
+
+type ArangoMLExtensionSpecStorageType string
+
+const (
+	ArangoMLExtensionSpecStorageTypeDefault                                    = ArangoMLExtensionSpecStorageTypeExtension
+	ArangoMLExtensionSpecStorageTypeExtension ArangoMLExtensionSpecStorageType = "extension"
+	ArangoMLExtensionSpecStorageTypePlatform  ArangoMLExtensionSpecStorageType = "platform"
+)
+
+func (a *ArangoMLExtensionSpecStorageType) Get() ArangoMLExtensionSpecStorageType {
+	if a == nil {
+		return ArangoMLExtensionSpecStorageTypeDefault
+	}
+
+	return *a
+}
+
+func (a *ArangoMLExtensionSpecStorageType) Validate() error {
+	switch t := a.Get(); t {
+	case ArangoMLExtensionSpecStorageTypeExtension, ArangoMLExtensionSpecStorageTypePlatform:
+		return nil
+	default:
+		return errors.Errorf("Invalid Storage Type: %s", t)
+	}
+}

pkg/apis/ml/v1beta1/zz_generated.deepcopy.go

@@ -26986,7 +26986,7 @@ v1beta1:
                 type: object
             type: object
           storage:
-            description: Storage specifies the ArangoMLStorage used within Extension
+            description: Storage specifies the ArangoMLStorage used within Extension, if extension storage is used
             properties:
               checksum:
                 description: UID keeps the information about object Checksum
@@ -27001,6 +27001,12 @@ v1beta1:
                 description: UID keeps the information about object UID
                 type: string
             type: object
+          storageType:
+            description: ArangoMLExtensionSpecStorageType defines storage used for extension
+            enum:
+              - extension
+              - platform
+            type: string
         type: object
       status:
         description: Object with preserved fields for backward compatibility