Merge pull request #759 from apedriza/update_docs_about_cluster_persi…

…stance

Add docs about Cluster persistance

api/k0smotron.io/v1beta1/k0smotroncluster_types.go

@@ -55,7 +55,7 @@ type ClusterSpec struct {
 	//+kubebuilder:default={"type":"ClusterIP","apiPort":30443,"konnectivityPort":30132}
 	Service ServiceSpec `json:"service,omitempty"`
 	// Persistence defines the persistence configuration. If empty k0smotron
-	// will use emptyDir as a volume.
+	// will use emptyDir as a volume. See https://docs.k0smotron.io/stable/configuration/#persistence
 	//+kubebuilder:validation:Optional
 	Persistence PersistenceSpec `json:"persistence,omitempty"`
 	// KineDataSourceURL defines the kine datasource URL.

config/clusterapi/controlplane/bases/controlplane.cluster.x-k8s.io_k0smotroncontrolplanes.yaml

@@ -3446,7 +3446,7 @@ spec:
               persistence:
                 description: |-
                   Persistence defines the persistence configuration. If empty k0smotron
-                  will use emptyDir as a volume.
+                  will use emptyDir as a volume. See https://docs.k0smotron.io/stable/configuration/#persistence
                 properties:
                   autoDeletePVCs:
                     default: false

config/clusterapi/controlplane/bases/controlplane.cluster.x-k8s.io_k0smotroncontrolplanetemplates.yaml

@@ -3504,7 +3504,7 @@ spec:
                       persistence:
                         description: |-
                           Persistence defines the persistence configuration. If empty k0smotron
-                          will use emptyDir as a volume.
+                          will use emptyDir as a volume. See https://docs.k0smotron.io/stable/configuration/#persistence
                         properties:
                           autoDeletePVCs:
                             default: false

config/clusterapi/k0smotron.io/bases/k0smotron.io_clusters.yaml

@@ -3449,7 +3449,7 @@ spec:
               persistence:
                 description: |-
                   Persistence defines the persistence configuration. If empty k0smotron
-                  will use emptyDir as a volume.
+                  will use emptyDir as a volume. See https://docs.k0smotron.io/stable/configuration/#persistence
                 properties:
                   autoDeletePVCs:
                     default: false

config/crd/bases/controlplane.cluster.x-k8s.io_k0smotroncontrolplanes.yaml

@@ -3446,7 +3446,7 @@ spec:
               persistence:
                 description: |-
                   Persistence defines the persistence configuration. If empty k0smotron
-                  will use emptyDir as a volume.
+                  will use emptyDir as a volume. See https://docs.k0smotron.io/stable/configuration/#persistence
                 properties:
                   autoDeletePVCs:
                     default: false

config/crd/bases/controlplane.cluster.x-k8s.io_k0smotroncontrolplanetemplates.yaml

@@ -3504,7 +3504,7 @@ spec:
                       persistence:
                         description: |-
                           Persistence defines the persistence configuration. If empty k0smotron
-                          will use emptyDir as a volume.
+                          will use emptyDir as a volume. See https://docs.k0smotron.io/stable/configuration/#persistence
                         properties:
                           autoDeletePVCs:
                             default: false

config/crd/bases/k0smotron.io_clusters.yaml

@@ -3449,7 +3449,7 @@ spec:
               persistence:
                 description: |-
                   Persistence defines the persistence configuration. If empty k0smotron
-                  will use emptyDir as a volume.
+                  will use emptyDir as a volume. See https://docs.k0smotron.io/stable/configuration/#persistence
                 properties:
                   autoDeletePVCs:
                     default: false

docs/configuration.md

@@ -21,6 +21,14 @@ spec:
 
 For full reference of the fields check out the [reference docs](resource-reference.md#cluster).
 
+## Persistence
+
+K0smotron persists data related to each Cluster. Specifically, it persists the `/var/lib/k0s` directory of the k0s controller which is the default data directory used by k0s. 
+
+The `/var/lib/k0s` directory contains essential data for the operation of the k0s controller, but its growth over time is primarily driven by the addition of small [manifest](https://docs.k0sproject.io/stable/manifests/) files. Since these manifests are lightweight and in text format, the directory tends to grow gradually and not excessively. Typically, 250 MB of space is sufficient to handle its growth, as the main additions are these small manifests, keeping the overall size manageable.
+
+The type of persistence used for this can be configurable via `spec.persistence`. For more information, check out the [reference docs](resource-reference.md/#clusterspecpersistence) on Cluster persistence.
+
 ## K0s configuration
 
 K0smotron allows you to configure k0s via `spec.k0sConfig` field. If empty, the default configuration will be used.

docs/resource-reference.md

@@ -2865,7 +2865,7 @@ https://kubernetes.io/docs/concepts/storage/volumes<br/>
         <td>object</td>
         <td>
           Persistence defines the persistence configuration. If empty k0smotron
-will use emptyDir as a volume.<br/>
+will use emptyDir as a volume. See https://docs.k0smotron.io/stable/configuration/#persistence<br/>
         </td>
         <td>false</td>
       </tr><tr>
@@ -10049,7 +10049,7 @@ Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.<br/>
 
 
 Persistence defines the persistence configuration. If empty k0smotron
-will use emptyDir as a volume.
+will use emptyDir as a volume. See https://docs.k0smotron.io/stable/configuration/#persistence
 
 <table>
     <thead>
@@ -11290,7 +11290,7 @@ https://kubernetes.io/docs/concepts/storage/volumes<br/>
         <td>object</td>
         <td>
           Persistence defines the persistence configuration. If empty k0smotron
-will use emptyDir as a volume.<br/>
+will use emptyDir as a volume. See https://docs.k0smotron.io/stable/configuration/#persistence<br/>
         </td>
         <td>false</td>
       </tr><tr>
@@ -18474,7 +18474,7 @@ Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.<br/>
 
 
 Persistence defines the persistence configuration. If empty k0smotron
-will use emptyDir as a volume.
+will use emptyDir as a volume. See https://docs.k0smotron.io/stable/configuration/#persistence
 
 <table>
     <thead>
@@ -35630,7 +35630,7 @@ https://kubernetes.io/docs/concepts/storage/volumes<br/>
         <td>object</td>
         <td>
           Persistence defines the persistence configuration. If empty k0smotron
-will use emptyDir as a volume.<br/>
+will use emptyDir as a volume. See https://docs.k0smotron.io/stable/configuration/#persistence<br/>
         </td>
         <td>false</td>
       </tr><tr>
@@ -42814,7 +42814,7 @@ Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.<br/>
 
 
 Persistence defines the persistence configuration. If empty k0smotron
-will use emptyDir as a volume.
+will use emptyDir as a volume. See https://docs.k0smotron.io/stable/configuration/#persistence
 
 <table>
     <thead>