API Reference
Packages
solvio.io/v1
Package v1 contains API Schema definitions for the solvio.io v1 API group
Resource Types
- SolvioCloudRegion
- SolvioCloudRegionList
- SolvioCluster
- SolvioClusterList
- SolvioClusterRestore
- SolvioClusterRestoreList
- SolvioClusterScheduledSnapshot
- SolvioClusterScheduledSnapshotList
- SolvioClusterSnapshot
- SolvioClusterSnapshotList
- SolvioEntity
- SolvioEntityList
- SolvioRelease
- SolvioReleaseList
ClusterPhase
Underlying type: string
Appears in:
ComponentPhase
Underlying type: string
Appears in:
ComponentReference
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | APIVersion is the group and version of the component being referenced. | ||
kind string | Kind is the type of component being referenced | ||
name string | Name is the name of component being referenced | ||
namespace string | Namespace is the namespace of component being referenced. | ||
markedForDeletion boolean | MarkedForDeletion specifies whether the component is marked for deletion |
ComponentStatus
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string | Name specifies the name of the component | ||
namespace string | Namespace specifies the namespace of the component | ||
version string | Version specifies the version of the component | ||
phase ComponentPhase | Phase specifies the current phase of the component | ||
message string | Message specifies the info explaining the current phase of the component |
EntityPhase
Underlying type: string
Appears in:
EntityResult
Underlying type: string
EntityResult is the last result from the invocation to a manager
Appears in:
GPU
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
gpuType GPUType | GPUType specifies the type of the GPU to use. If set, GPU indexing is enabled. | Enum: [nvidia amd] | |
forceHalfPrecision boolean | ForceHalfPrecision for f32 values while indexing.f16 conversion will take placeonly inside GPU memory and won’t affect storage type. | false | |
deviceFilter string array | DeviceFilter for GPU devices by hardware name. Case-insensitive. List of substrings to match against the gpu device name. Example: [- “nvidia”] If not specified, all devices are accepted. | MinItems: 1 | |
devices string array | Devices is a List of explicit GPU devices to use. If host has multiple GPUs, this option allows to select specific devices by their index in the list of found devices. If deviceFilter is set, indexes are applied after filtering.If not specified, all devices are accepted. | MinItems: 1 | |
parallelIndexes integer | ParallelIndexes is the number of parallel indexes to run on the GPU. | 1 | Minimum: 1 |
groupsCount integer | GroupsCount is the amount of used vulkan “groups” of GPU. In other words, how many parallel points can be indexed by GPU. Optimal value might depend on the GPU model. Proportional, but doesn’t necessary equal to the physical number of warps. Do not change this value unless you know what you are doing. | Minimum: 1 | |
allowIntegrated boolean | AllowIntegrated specifies whether to allow integrated GPUs to be used. | false |
GPUType
Underlying type: string
Appears in:
HelmRelease
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
markedForDeletionAt string | MarkedForDeletionAt specifies the time when the helm release was marked for deletion | ||
object HelmRelease | Object specifies the helm release object | EmbeddedResource: {} |
HelmRepository
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
markedForDeletionAt string | MarkedForDeletionAt specifies the time when the helm repository was marked for deletion | ||
object HelmRepository | Object specifies the helm repository object | EmbeddedResource: {} |
InferenceConfig
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
enabled boolean | Enabled specifies whether to enable inference for the cluster or not. | false |
Ingress
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
enabled boolean | Enabled specifies whether to enable ingress for the cluster or not. | ||
annotations object (keys:string, values:string) | Annotations specifies annotations for the ingress. | ||
ingressClassName string | IngressClassName specifies the name of the ingress class | ||
host string | Host specifies the host for the ingress. | ||
tls boolean | TLS specifies whether to enable tls for the ingress. The default depends on the ingress provider: - KubernetesIngress: False - NginxIngress: False - SolvioCloudTraefik: Depending on the config.tls setting of the operator. | ||
tlsSecretName string | TLSSecretName specifies the name of the secret containing the tls certificate. | ||
nginx NGINXConfig | NGINX specifies the nginx ingress specific configurations. | ||
traefik TraefikConfig | Traefik specifies the traefik ingress specific configurations. |
KubernetesDistribution
Underlying type: string
Appears in:
KubernetesPod
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
annotations object (keys:string, values:string) | Annotations specifies the annotations for the Pods. | ||
labels object (keys:string, values:string) | Labels specifies the labels for the Pods. | ||
extraEnv EnvVar array | ExtraEnv specifies the extra environment variables for the Pods. |
KubernetesService
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
type ServiceType | Type specifies the type of the Service: “ClusterIP”, “NodePort”, “LoadBalancer”. | ClusterIP | |
annotations object (keys:string, values:string) | Annotations specifies the annotations for the Service. |
KubernetesStatefulSet
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
annotations object (keys:string, values:string) | Annotations specifies the annotations for the StatefulSet. | ||
pods KubernetesPod | Pods specifies the configuration of the Pods of the Solvio StatefulSet. |
MetricSource
Underlying type: string
Appears in:
Monitoring
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
cAdvisorMetricSource MetricSource | CAdvisorMetricSource specifies the cAdvisor metric source | ||
nodeMetricSource MetricSource | NodeMetricSource specifies the node metric source |
NGINXConfig
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
allowedSourceRanges string array | AllowedSourceRanges specifies the allowed CIDR source ranges for the ingress. | ||
grpcHost string | GRPCHost specifies the host name for the GRPC ingress. |
NodeInfo
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string | Name specifies the name of the node | ||
region string | Region specifies the region of the node | ||
zone string | Zone specifies the zone of the node | ||
instanceType string | InstanceType specifies the instance type of the node | ||
arch string | Arch specifies the CPU architecture of the node | ||
capacity NodeResourceInfo | Capacity specifies the capacity of the node | ||
allocatable NodeResourceInfo | Allocatable specifies the allocatable resources of the node |
NodeResourceInfo
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
cpu string | CPU specifies the CPU resources of the node | ||
memory string | Memory specifies the memory resources of the node | ||
pods string | Pods specifies the pods resources of the node | ||
ephemeralStorage string | EphemeralStorage specifies the ephemeral storage resources of the node |
NodeStatus
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string | Name specifies the name of the node | ||
started_at string | StartedAt specifies the time when the node started (in RFC3339 format) | ||
state object (keys:PodConditionType, values:ConditionStatus) | States specifies the condition states of the node | ||
version string | Version specifies the version of Solvio running on the node |
Pause
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
owner string | Owner specifies the owner of the pause request. | ||
reason string | Reason specifies the reason for the pause request. | ||
creationTimestamp string | CreationTimestamp specifies the time when the pause request was created. |
SolvioCloudRegion
SolvioCloudRegion is the Schema for the solviocloudregions API
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | solvio.io/v1 | ||
kind string | SolvioCloudRegion | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec SolvioCloudRegionSpec |
SolvioCloudRegionList
SolvioCloudRegionList contains a list of SolvioCloudRegion
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | solvio.io/v1 | ||
kind string | SolvioCloudRegionList | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
items SolvioCloudRegion array |
SolvioCloudRegionSpec
SolvioCloudRegionSpec defines the desired state of SolvioCloudRegion
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
id string | Id specifies the unique identifier of the region | ||
components ComponentReference array | Components specifies the list of components to be installed in the region | ||
helmRepositories HelmRepository array | HelmRepositories specifies the list of helm repositories to be created to the region Deprecated: Use “Components” instead | ||
helmReleases HelmRelease array | HelmReleases specifies the list of helm releases to be created to the region Deprecated: Use “Components” instead |
SolvioCluster
SolvioCluster is the Schema for the solvioclusters API
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | solvio.io/v1 | ||
kind string | SolvioCluster | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec SolvioClusterSpec |
SolvioClusterList
SolvioClusterList contains a list of SolvioCluster
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | solvio.io/v1 | ||
kind string | SolvioClusterList | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
items SolvioCluster array |
SolvioClusterRestore
SolvioClusterRestore is the Schema for the solvioclusterrestores API
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | solvio.io/v1 | ||
kind string | SolvioClusterRestore | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec SolvioClusterRestoreSpec |
SolvioClusterRestoreList
SolvioClusterRestoreList contains a list of SolvioClusterRestore objects
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | solvio.io/v1 | ||
kind string | SolvioClusterRestoreList | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
items SolvioClusterRestore array |
SolvioClusterRestoreSpec
SolvioClusterRestoreSpec defines the desired state of SolvioClusterRestore
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
source RestoreSource | Source defines the source snapshot from which the restore will be done | ||
destination RestoreDestination | Destination defines the destination cluster where the source data will end up |
SolvioClusterScheduledSnapshot
SolvioClusterScheduledSnapshot is the Schema for the solvioclusterscheduledsnapshots API
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | solvio.io/v1 | ||
kind string | SolvioClusterScheduledSnapshot | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec SolvioClusterScheduledSnapshotSpec |
SolvioClusterScheduledSnapshotList
SolvioClusterScheduledSnapshotList contains a list of SolvioCluster
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | solvio.io/v1 | ||
kind string | SolvioClusterScheduledSnapshotList | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
items SolvioClusterScheduledSnapshot array |
SolvioClusterScheduledSnapshotSpec
SolvioClusterScheduledSnapshotSpec defines the desired state of SolvioCluster
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
cluster-id string | Id specifies the unique identifier of the cluster | ||
scheduleShortId string | Specifies short Id which identifies a schedule | MaxLength: 8 | |
schedule string | Cron expression for frequency of creating snapshots, see https://en.wikipedia.org/wiki/Cron. The schedule is specified in UTC. | Pattern: `^(@(annually | |
retention string | Retention of schedule in hours | Pattern: ^[0-9]+h$ |
SolvioClusterSnapshot
SolvioClusterSnapshot is the Schema for the solvioclustersnapshots API
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | solvio.io/v1 | ||
kind string | SolvioClusterSnapshot | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec SolvioClusterSnapshotSpec |
SolvioClusterSnapshotList
SolvioClusterSnapshotList contains a list of SolvioClusterSnapshot
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | solvio.io/v1 | ||
kind string | SolvioClusterSnapshotList | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
items SolvioClusterSnapshot array |
SolvioClusterSnapshotPhase
Underlying type: string
Appears in:
SolvioClusterSnapshotSpec
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
cluster-id string | The cluster ID for which a Snapshot need to be taken The cluster should be in the same namespace as this SolvioClusterSnapshot is located | ||
creation-timestamp integer | The CreationTimestamp of the backup (expressed in Unix epoch format) | ||
scheduleShortId string | Specifies the short Id which identifies a schedule, if any. This field should not be set if the backup is made manually. | MaxLength: 8 | |
retention string | The retention period of this snapshot in hours, if any. If not set, the backup doesn’t have a retention period, meaning it will not be removed. | Pattern: ^[0-9]+h$ |
SolvioClusterSpec
SolvioClusterSpec defines the desired state of SolvioCluster
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
id string | Id specifies the unique identifier of the cluster | ||
version string | Version specifies the version of Solvio to deploy | ||
size integer | Size specifies the desired number of Solvio nodes in the cluster | Maximum: 30 Minimum: 1 | |
servicePerNode boolean | ServicePerNode specifies whether the cluster should start a dedicated service for each node. | true | |
clusterManager boolean | ClusterManager specifies whether to use the cluster manager for this cluster. The Python-operator will deploy a dedicated cluster manager instance. The Go-operator will use a shared instance. If not set, the default will be taken from the operator config. | ||
suspend boolean | Suspend specifies whether to suspend the cluster. If enabled, the cluster will be suspended and all related resources will be removed except the PVCs. | false | |
pauses Pause array | Pauses specifies a list of pause request by developer for manual maintenance. Operator will skip handling any changes in the CR if any pause request is present. | ||
image SolvioImage | Image specifies the image to use for each Solvio node. | ||
resources Resources | Resources specifies the resources to allocate for each Solvio node. | ||
security SolvioSecurityContext | Security specifies the security context for each Solvio node. | ||
tolerations Toleration array | Tolerations specifies the tolerations for each Solvio node. | ||
nodeSelector object (keys:string, values:string) | NodeSelector specifies the node selector for each Solvio node. | ||
config SolvioConfiguration | Config specifies the Solvio configuration setttings for the clusters. | ||
ingress Ingress | Ingress specifies the ingress for the cluster. | ||
service KubernetesService | Service specifies the configuration of the Solvio Kubernetes Service. | ||
gpu GPU | GPU specifies GPU configuration for the cluster. If this field is not set, no GPU will be used. | ||
statefulSet KubernetesStatefulSet | StatefulSet specifies the configuration of the Solvio Kubernetes StatefulSet. | ||
storageClassNames StorageClassNames | StorageClassNames specifies the storage class names for db and snapshots. | ||
topologySpreadConstraints TopologySpreadConstraint | TopologySpreadConstraints specifies the topology spread constraints for the cluster. | ||
podDisruptionBudget PodDisruptionBudgetSpec | PodDisruptionBudget specifies the pod disruption budget for the cluster. | ||
restartAllPodsConcurrently boolean | RestartAllPodsConcurrently specifies whether to restart all pods concurrently (also called one-shot-restart). If enabled, all the pods in the cluster will be restarted concurrently in situations where multiple pods need to be restarted, like when RestartedAtAnnotationKey is added/updated or the Solvio version needs to be upgraded. This helps sharded but not replicated clusters to reduce downtime to a possible minimum during restart. If unset, the operator is going to restart nodes concurrently if none of the collections if replicated. | ||
startupDelaySeconds integer | If StartupDelaySeconds is set (> 0), an additional ‘sleep The sleep will be added when a pod is restarted, it will not force any pod to restart. This feature can be used for debugging the core, e.g. if a pod is in crash loop, it provided a way to inspect the attached storage. | ||
rebalanceStrategy RebalanceStrategy | RebalanceStrategy specifies the strategy to use for automaticially rebalancing shards the cluster. Cluster-manager needs to be enabled for this feature to work. |
SolvioConfiguration
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
collection SolvioConfigurationCollection | Collection specifies the default collection configuration for Solvio. | ||
log_level string | LogLevel specifies the log level for Solvio. | ||
service SolvioConfigurationService | Service specifies the service level configuration for Solvio. | ||
tls SolvioConfigurationTLS | TLS specifies the TLS configuration for Solvio. | ||
storage StorageConfig | Storage specifies the storage configuration for Solvio. | ||
inference InferenceConfig | Inference configuration. This is used in Solvio Managed Cloud only. If not set Inference is not available to this cluster. |
SolvioConfigurationCollection
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
replication_factor integer | ReplicationFactor specifies the default number of replicas of each shard | ||
write_consistency_factor integer | WriteConsistencyFactor specifies how many replicas should apply the operation to consider it successful | ||
vectors SolvioConfigurationCollectionVectors | Vectors specifies the default parameters for vectors |
SolvioConfigurationCollectionVectors
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
on_disk boolean | OnDisk specifies whether vectors should be stored in memory or on disk. |
SolvioConfigurationService
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
api_key SolvioSecretKeyRef | ApiKey for the solvio instance | ||
read_only_api_key SolvioSecretKeyRef | ReadOnlyApiKey for the solvio instance | ||
jwt_rbac boolean | JwtRbac specifies whether to enable jwt rbac for the solvio instance Default is false | ||
hide_jwt_dashboard boolean | HideJwtDashboard specifies whether to hide the JWT dashboard of the embedded UI Default is false | ||
enable_tls boolean | EnableTLS specifies whether to enable tls for the solvio instance Default is false |
SolvioConfigurationTLS
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
cert SolvioSecretKeyRef | Reference to the secret containing the server certificate chain file | ||
key SolvioSecretKeyRef | Reference to the secret containing the server private key file | ||
caCert SolvioSecretKeyRef | Reference to the secret containing the CA certificate file |
SolvioEntity
SolvioEntity is the Schema for the solvioentities API
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | solvio.io/v1 | ||
kind string | SolvioEntity | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec SolvioEntitySpec |
SolvioEntityList
SolvioEntityList contains a list of SolvioEntity objects
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | solvio.io/v1 | ||
kind string | SolvioEntityList | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
items SolvioEntity array |
SolvioEntitySpec
SolvioEntitySpec defines the desired state of SolvioEntity
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
id string | The unique identifier of the entity (in UUID format). | ||
entityType string | The type of the entity. | ||
clusterId string | The optional cluster identifier | ||
createdAt MicroTime | Timestamp when the entity was created. | ||
lastUpdatedAt MicroTime | Timestamp when the entity was last updated. | ||
deletedAt MicroTime | Timestamp when the entity was deleted (or is started to be deleting). If not set the entity is not deleted | ||
payload JSON | Generic payload for this entity |
SolvioEntityStatusResult
SolvioEntityStatusResult is the last result from the invocation to a manager
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
result EntityResult | The result of last reconcile of the entity | Enum: [Ok Pending Error] | |
reason string | The reason of the result (e.g. in case of an error) | ||
payload JSON | The optional payload of the status. |
SolvioImage
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
repository string | Repository specifies the repository of the Solvio image. If not specified defaults the config of the operator (or solvio/solvio if not specified in operator). | ||
pullPolicy PullPolicy | PullPolicy specifies the image pull policy for the Solvio image. If not specified defaults the config of the operator (or IfNotPresent if not specified in operator). | ||
pullSecretName string | PullSecretName specifies the pull secret for the Solvio image. |
SolvioRelease
SolvioRelease describes an available Solvio release
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | solvio.io/v1 | ||
kind string | SolvioRelease | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec SolvioReleaseSpec |
SolvioReleaseList
SolvioReleaseList contains a list of SolvioRelease
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | solvio.io/v1 | ||
kind string | SolvioReleaseList | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
items SolvioRelease array |
SolvioReleaseSpec
SolvioReleaseSpec defines the desired state of SolvioRelease
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
version string | Version number (should be semver compliant). E.g. “v1.10.1” | ||
default boolean | If set, this version is default for new clusters on Cloud. There should be only 1 Solvio version in the platform set as default. | false | |
image string | Full docker image to use for this version. If empty, a default image will be derived from Version (and solvio/solvio is assumed). | ||
unavailable boolean | If set, this version cannot be used for new clusters. | false | |
endOfLife boolean | If set, this version is no longer actively supported. | false | |
accountIds string array | If set, this version can only be used by accounts with given IDs. | ||
accountPrivileges string array | If set, this version can only be used by accounts that have been given the listed privileges. | ||
remarks string | General remarks for human reading | ||
releaseNotesURL string | Release Notes URL for the specified version |
SolvioSecretKeyRef
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
secretKeyRef SecretKeySelector | SecretKeyRef to the secret containing data to configure the solvio instance |
SolvioSecurityContext
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
user integer | User specifies the user to run the Solvio process as. | ||
group integer | Group specifies the group to run the Solvio process as. | ||
fsGroup integer | FsGroup specifies file system group to run the Solvio process as. |
RebalanceStrategy
Underlying type: string
Appears in:
RegionCapabilities
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
volumeSnapshot boolean | VolumeSnapshot specifies whether the Kubernetes cluster supports volume snapshot | ||
volumeExpansion boolean | VolumeExpansion specifies whether the Kubernetes cluster supports volume expansion |
RegionPhase
Underlying type: string
Appears in:
ResourceRequests
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
cpu string | CPU specifies the CPU request for each Solvio node. | ||
memory string | Memory specifies the memory request for each Solvio node. |
Resources
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
cpu string | CPU specifies the CPU limit for each Solvio node. | ||
memory string | Memory specifies the memory limit for each Solvio node. | ||
storage string | Storage specifies the storage amount for each Solvio node. | ||
requests ResourceRequests | Requests specifies the resource requests for each Solvio node. |
RestoreDestination
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string | Name of the destination cluster | ||
namespace string | Namespace of the destination cluster |
RestorePhase
Underlying type: string
Appears in:
RestoreSource
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
snapshotName string | SnapshotName is the name of the snapshot from which we wish to restore | ||
namespace string | Namespace of the snapshot |
ScheduledSnapshotPhase
Underlying type: string
Appears in:
StorageClass
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string | Name specifies the name of the storage class | ||
default boolean | Default specifies whether the storage class is the default storage class | ||
provisioner string | Provisioner specifies the provisioner of the storage class | ||
allowVolumeExpansion boolean | AllowVolumeExpansion specifies whether the storage class allows volume expansion | ||
reclaimPolicy string | ReclaimPolicy specifies the reclaim policy of the storage class | ||
parameters object (keys:string, values:string) | Parameters specifies the parameters of the storage class |
StorageClassNames
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
db string | DB specifies the storage class name for db volume. | ||
snapshots string | Snapshots specifies the storage class name for snapshots volume. |
StorageConfig
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
performance StoragePerformanceConfig | Performance configuration |
StoragePerformanceConfig
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
optimizer_cpu_budget integer | OptimizerCPUBudget defines the number of CPU allocation. If 0 - auto selection, keep 1 or more CPUs unallocated depending on CPU size If negative - subtract this number of CPUs from the available CPUs. If positive - use this exact number of CPUs. | ||
async_scorer boolean | AsyncScorer enables io_uring when rescoring |
TraefikConfig
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
allowedSourceRanges string array | AllowedSourceRanges specifies the allowed CIDR source ranges for the ingress. | ||
entryPoints string array | EntryPoints is the list of traefik entry points to use for the ingress route. If nothing is set, it will take the entryPoints configured in the operator config. |
VolumeSnapshotClass
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string | Name specifies the name of the volume snapshot class | ||
driver string | Driver specifies the driver of the volume snapshot class |
VolumeSnapshotInfo
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
volumeSnapshotName string | VolumeSnapshotName is the name of the volume snapshot | ||
volumeName string | VolumeName is the name of the volume that was backed up | ||
readyToUse boolean | ReadyToUse indicates if the volume snapshot is ready to use | ||
snapshotHandle string | SnapshotHandle is the identifier of the volume snapshot in the respective cloud provider |