2023-10-23 07:19:59 +00:00
|
|
|
# API Reference for ArangoLocalStorage V1Alpha
|
|
|
|
|
|
|
|
|
|
## Spec
|
|
|
|
|
|
2023-11-09 09:23:56 +00:00
|
|
|
### .spec.localPath
|
|
|
|
|
|
|
|
|
|
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/local_storage_spec.go#L36)</sup>
|
2023-10-23 07:19:59 +00:00
|
|
|
|
|
|
|
|
LocalPath setting specifies one or more local directories (on the nodes) used to create persistent volumes in.
|
|
|
|
|
|
2023-11-09 09:23:56 +00:00
|
|
|
***
|
|
|
|
|
|
|
|
|
|
### .spec.nodeSelector
|
2023-10-23 07:19:59 +00:00
|
|
|
|
2023-11-09 09:23:56 +00:00
|
|
|
Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/local_storage_spec.go#L43)</sup>
|
2023-10-23 07:19:59 +00:00
|
|
|
|
|
|
|
|
NodeSelector setting specifies which nodes the operator will provision persistent volumes on.
|
|
|
|
|
|
2023-11-09 09:23:56 +00:00
|
|
|
***
|
|
|
|
|
|
|
|
|
|
### .spec.podCustomization.priority
|
2023-10-23 07:19:59 +00:00
|
|
|
|
2023-11-09 09:23:56 +00:00
|
|
|
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/local_storage_pod_customization.go#L25)</sup>
|
2023-10-23 07:19:59 +00:00
|
|
|
|
|
|
|
|
Priority if defined, sets the priority for pods of storage provisioner
|
|
|
|
|
|
2023-11-09 09:23:56 +00:00
|
|
|
***
|
2023-10-23 07:19:59 +00:00
|
|
|
|
2023-11-09 09:23:56 +00:00
|
|
|
### .spec.privileged
|
|
|
|
|
|
|
|
|
|
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/local_storage_spec.go#L45)</sup>
|
2023-10-23 07:19:59 +00:00
|
|
|
|
|
|
|
|
Privileged if set, passes Privileged flag to SecurityContext for pods of storage provisioner
|
|
|
|
|
|
2023-11-09 09:23:56 +00:00
|
|
|
***
|
|
|
|
|
|
|
|
|
|
### .spec.storageClass.isDefault
|
2023-10-23 07:19:59 +00:00
|
|
|
|
2023-11-09 09:23:56 +00:00
|
|
|
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/storage_class_spec.go#L42)</sup>
|
2023-10-23 07:19:59 +00:00
|
|
|
|
|
|
|
|
IsDefault setting specifies if the created `StorageClass` will
|
|
|
|
|
be marked as default storage class.
|
|
|
|
|
|
2023-11-07 18:50:23 +00:00
|
|
|
Default Value: `false`
|
2023-10-23 07:19:59 +00:00
|
|
|
|
2023-11-09 09:23:56 +00:00
|
|
|
***
|
2023-10-23 07:19:59 +00:00
|
|
|
|
2023-11-09 09:23:56 +00:00
|
|
|
### .spec.storageClass.name
|
|
|
|
|
|
|
|
|
|
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/storage_class_spec.go#L38)</sup>
|
2023-10-23 07:19:59 +00:00
|
|
|
|
|
|
|
|
Name setting specifies the name of the storage class that
|
|
|
|
|
created `PersistentVolume` will use.
|
|
|
|
|
If empty, this field defaults to the name of the `ArangoLocalStorage` object.
|
|
|
|
|
If a `StorageClass` with given name does not yet exist, it will be created.
|
|
|
|
|
|
2023-11-07 18:50:23 +00:00
|
|
|
Default Value: `""`
|
2023-10-23 07:19:59 +00:00
|
|
|
|
2023-11-09 09:23:56 +00:00
|
|
|
***
|
|
|
|
|
|
|
|
|
|
### .spec.storageClass.reclaimPolicy
|
2023-10-23 07:19:59 +00:00
|
|
|
|
2023-11-09 09:23:56 +00:00
|
|
|
Type: `core.PersistentVolumeReclaimPolicy` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/storage_class_spec.go#L46)</sup>
|
2023-10-23 07:19:59 +00:00
|
|
|
|
|
|
|
|
ReclaimPolicy defines what happens to a persistent volume when released from its claim.
|
|
|
|
|
|
|
|
|
|
Links:
|
|
|
|
|
* [Documentation of core.PersistentVolumeReclaimPolicy](https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming)
|
|
|
|
|
|
2023-11-09 09:23:56 +00:00
|
|
|
***
|
2023-10-23 07:19:59 +00:00
|
|
|
|
2023-11-09 09:23:56 +00:00
|
|
|
### .spec.tolerations
|
|
|
|
|
|
|
|
|
|
Type: `[]core.Toleration` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/local_storage_spec.go#L41)</sup>
|
2023-10-23 07:19:59 +00:00
|
|
|
|
|
|
|
|
Tolerations specifies the tolerations added to pods of storage provisioner
|
|
|
|
|
|
|
|
|
|
Links:
|
|
|
|
|
* [Documentation of core.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#toleration-v1-core)
|
|
|
|
|
|
