From 651e3f7f5498355e9658d5484815699d70199cc4 Mon Sep 17 00:00:00 2001 From: Alexander Dejanovski Date: Wed, 24 Jan 2024 09:13:30 +0100 Subject: [PATCH] Upgrade CRD reference (#1186) --- .../k8ssandra-operator-crds-latest/_index.md | 401 ++++++++++++++++++ 1 file changed, 401 insertions(+) diff --git a/docs/content/en/reference/crd/k8ssandra-operator-crds-latest/_index.md b/docs/content/en/reference/crd/k8ssandra-operator-crds-latest/_index.md index 5815f3455..7787dbe90 100644 --- a/docs/content/en/reference/crd/k8ssandra-operator-crds-latest/_index.md +++ b/docs/content/en/reference/crd/k8ssandra-operator-crds-latest/_index.md @@ -53030,6 +53030,8 @@ Resource Types: - [MedusaBackupSchedule](#medusabackupschedule) +- [MedusaConfiguration](#medusaconfiguration) + - [MedusaRestoreJob](#medusarestorejob) - [Medusa](#medusa) @@ -71796,6 +71798,405 @@ MedusaBackupScheduleStatus defines the observed state of MedusaBackupSchedule +### MedusaConfiguration +[↩ Parent](#medusak8ssandraiov1alpha1 ) + + + + + + +MedusaConfiguration is the Schema for the medusaconfigurations API + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
apiVersionstringmedusa.k8ssandra.io/v1alpha1true
kindstringMedusaConfigurationtrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the `metadata` field.true
specobject + MedusaConfigurationSpec defines the desired state of MedusaConfiguration
+ 		false
statusobject + MedusaConfigurationStatus defines the observed state of MedusaConfiguration
+ 		false
+ + +#### MedusaConfiguration.spec +[↩ Parent](#medusaconfiguration) + + + +MedusaConfigurationSpec defines the desired state of MedusaConfiguration + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
storagePropertiesobject + StorageProperties defines the storage backend settings to use for the backups.
+ 		false
+ + +#### MedusaConfiguration.spec.storageProperties +[↩ Parent](#medusaconfigurationspec) + + + +StorageProperties defines the storage backend settings to use for the backups. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
apiProfilestring + AWS Profile to use for authentication.
+ 		false
backupGracePeriodInDaysinteger + Age after which orphan sstables can be deleted from the storage backend. Protects from race conditions between purge and ongoing backups. Defaults to 10 days.
+ 		false
bucketNamestring + The name of the bucket to use for the backups.
+ 		false
concurrentTransfersinteger + Number of concurrent uploads. Helps maximizing the speed of uploads but puts more pressure on the network. Defaults to 1.
+
+ Default: 1
+ 		false
hoststring + Host to connect to for the storage backend.
+ 		false
maxBackupAgeinteger + Maximum backup age that the purge process should observe.
+
+ Default: 0
+ 		false
maxBackupCountinteger + Maximum number of backups to keep (used by the purge process). Default is unlimited.
+
+ Default: 0
+ 		false
multiPartUploadThresholdinteger + File size over which cloud specific cli tools are used for transfer. Defaults to 100 MB.
+
+ Default: 104857600
+ 		false
podStorageobject + Pod storage settings for the local storage provider
+ 		false
portinteger + Port to connect to for the storage backend.
+ 		false
prefixstring + Name of the top level folder in the backup bucket. If empty, the cluster name will be used.
+ 		false
regionstring + Region of the storage bucket. Defaults to "default".
+ 		false
secureboolean + Whether to use SSL for the storage backend.
+ 		false
sslVerifyboolean + When using SSL, whether to also verify the certificate.
+ 		false
storageProviderenum + The storage backend to use for the backups.
+
+ Enum: google_storage, azure_blobs, s3, s3_compatible, s3_rgw, ibm_storage
+ 		false
storageSecretRefobject + Kubernetes Secret that stores the key file for the storage provider's API. If using 'local' storage, this value is ignored.
+ 		false
transferMaxBandwidthstring + Max upload bandwidth in MB/s. Defaults to 50 MB/s.
+
+ Default: 50MB/s
+ 		false
+ + +#### MedusaConfiguration.spec.storageProperties.podStorage +[↩ Parent](#medusaconfigurationspecstorageproperties) + + + +Pod storage settings for the local storage provider + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
accessModes[]string + Pod local storage access modes
+ 		false
sizeint or string + Size of the pod's storage in bytes. Defaults to 10 GB.
+
+ Default: 10Gi
+ 		false
storageClassNamestring + Storage class name to use for the pod's storage.
+ 		false
+ + +#### MedusaConfiguration.spec.storageProperties.storageSecretRef +[↩ Parent](#medusaconfigurationspecstorageproperties) + + + +Kubernetes Secret that stores the key file for the storage provider's API. If using 'local' storage, this value is ignored. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
+ 		false
+ + +#### MedusaConfiguration.status +[↩ Parent](#medusaconfiguration) + + + +MedusaConfigurationStatus defines the observed state of MedusaConfiguration + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
conditions[]object +
+ 		false
+ + +#### MedusaConfiguration.status.conditions[index] +[↩ Parent](#medusaconfigurationstatus) + + + +Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, + type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` + // other fields } + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
lastTransitionTimestring + lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
+
+ Format: date-time
+ 		true
messagestring + message is a human readable message indicating details about the transition. This may be an empty string.
+ 		true
reasonstring + reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
+ 		true
statusenum + status of the condition, one of True, False, Unknown.
+
+ Enum: True, False, Unknown
+ 		true
typestring + type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
+ 		true
observedGenerationinteger + observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
+
+ Format: int64
+ Minimum: 0
+ 		false
+ ### MedusaRestoreJob [↩ Parent](#medusak8ssandraiov1alpha1 )