diff --git a/docs/api/ArangoMLStorage.V1Alpha1.md b/docs/api/ArangoMLStorage.V1Alpha1.md
index 7422f8110..edf0b8c59 100644
--- a/docs/api/ArangoMLStorage.V1Alpha1.md
+++ b/docs/api/ArangoMLStorage.V1Alpha1.md
@@ -4,7 +4,7 @@
### .spec.backend.s3.allowInsecure
-Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/ml/v1alpha1/storage_spec_backend_s3.go#L41)
+Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/ml/v1alpha1/storage_spec_backend_s3.go#L42)
AllowInsecure if set to true, the Endpoint certificates won't be checked
@@ -14,7 +14,7 @@ Default Value: `false`
### .spec.backend.s3.bucketName
-Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/ml/v1alpha1/storage_spec_backend_s3.go#L35)
+Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/ml/v1alpha1/storage_spec_backend_s3.go#L36)
BucketName specifies the name of the bucket
Required
@@ -23,7 +23,7 @@ Required
### .spec.backend.s3.caSecretName
-Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/ml/v1alpha1/storage_spec_backend_s3.go#L47)
+Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/ml/v1alpha1/storage_spec_backend_s3.go#L48)
CASecretName if not empty, the given secret will be used to check the authenticity of Endpoint
The specified `Secret`, must contain the following data fields:
@@ -36,7 +36,7 @@ Default Value: `""`
### .spec.backend.s3.credentialsSecretName
-Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/ml/v1alpha1/storage_spec_backend_s3.go#L38)
+Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/ml/v1alpha1/storage_spec_backend_s3.go#L39)
CredentialsSecretName specifies the name of the secret containing AccessKey and SecretKey for S3 API authorization
Required
@@ -45,7 +45,7 @@ Required
### .spec.backend.s3.endpoint
-Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/ml/v1alpha1/storage_spec_backend_s3.go#L32)
+Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/ml/v1alpha1/storage_spec_backend_s3.go#L33)
Endpoint specifies the S3 API-compatible endpoint which implements storage
Required
@@ -54,7 +54,7 @@ Required
### .spec.backend.s3.region
-Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/ml/v1alpha1/storage_spec_backend_s3.go#L50)
+Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/ml/v1alpha1/storage_spec_backend_s3.go#L51)
Region defines the availability zone name. If empty, defaults to 'us-east-1'
@@ -64,7 +64,7 @@ Default Value: `""`
### .spec.mode.sidecar.listenPort
-Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/ml/v1alpha1/storage_spec_mode_sidecar.go#L33)
+Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/ml/v1alpha1/storage_spec_mode_sidecar.go#L40)
ListenPort defines on which port the sidecar container will be listening for connections
@@ -74,7 +74,7 @@ Default Value: `9201`
### .spec.mode.sidecar.resources
-Type: `core.ResourceRequirements` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/ml/v1alpha1/storage_spec_mode_sidecar.go#L38)
+Type: `core.ResourceRequirements` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/ml/v1alpha1/storage_spec_mode_sidecar.go#L45)
Resources holds resource requests & limits for container running the S3 proxy
diff --git a/pkg/apis/ml/v1alpha1/storage_spec.go b/pkg/apis/ml/v1alpha1/storage_spec.go
index 4d70176db..37e86e2ba 100644
--- a/pkg/apis/ml/v1alpha1/storage_spec.go
+++ b/pkg/apis/ml/v1alpha1/storage_spec.go
@@ -27,7 +27,7 @@ import (
type ArangoMLStorageSpec struct {
// Mode defines how storage implementation should be deployed
Mode *ArangoMLStorageSpecMode `json:"mode,omitempty"`
- // Backed defines how storage is implemented
+ // Backend defines how storage is implemented
Backend *ArangoMLStorageSpecBackend `json:"backend,omitempty"`
}
diff --git a/pkg/crd/crds/ml-storage.schema.generated.yaml b/pkg/crd/crds/ml-storage.schema.generated.yaml
index 7564d8d4a..f97a4e26b 100644
--- a/pkg/crd/crds/ml-storage.schema.generated.yaml
+++ b/pkg/crd/crds/ml-storage.schema.generated.yaml
@@ -4,8 +4,10 @@ v1alpha1:
spec:
properties:
backend:
+ description: Backend defines how storage is implemented
properties:
s3:
+ description: S3 backend implements storage as a proxy to the provided S3 API endpoint
properties:
allowInsecure:
description: AllowInsecure if set to true, the Endpoint certificates won't be checked
@@ -38,8 +40,10 @@ v1alpha1:
type: object
type: object
mode:
+ description: Mode defines how storage implementation should be deployed
properties:
sidecar:
+ description: Sidecar mode runs the storage implementation as a sidecar
properties:
listenPort:
description: ListenPort defines on which port the sidecar container will be listening for connections