feat(trait): mount volume from storage class

Closes #2994
apache · Oct 13, 2024 · 3ec5298 · 3ec5298
1 parent c10db08
commit 3ec5298
Show file tree

Hide file tree

Showing 13 changed files with 305 additions and 45 deletions.
diff --git a/docs/modules/ROOT/partials/apis/camel-k-crds.adoc b/docs/modules/ROOT/partials/apis/camel-k-crds.adoc
@@ -8008,7 +8008,9 @@ Syntax: [configmap{vbar}secret]:name[/key][@path], where name represents the res
 |
 
 
-A list of Persistent Volume Claims to be mounted. Syntax: [pvcname:/container/path]
+A list of Persistent Volume Claims to be mounted. Syntax: [pvcname:/container/path]. If the PVC is not found, the Integration fails.
+You can use the syntax [pvcname:/container/path:size:accessMode<:storageClass>] to create a dynamic PVC based on the Storage Class provided
+or the default cluster Storage Class. However, if the PVC exists, the operator would mount it.
 
 |`emptyDirs` +
 []string

diff --git a/docs/modules/traits/pages/mount.adoc b/docs/modules/traits/pages/mount.adoc
@@ -45,7 +45,9 @@ Syntax: [configmap\|secret]:name[/key][@path], where name represents the resourc
 
 | mount.volumes
 | []string
-| A list of Persistent Volume Claims to be mounted. Syntax: [pvcname:/container/path]
+| A list of Persistent Volume Claims to be mounted. Syntax: [pvcname:/container/path]. If the PVC is not found, the Integration fails.
+You can use the syntax [pvcname:/container/path:size:accessMode<:storageClass>] to create a dynamic PVC based on the Storage Class provided
+or the default cluster Storage Class. However, if the PVC exists, the operator would mount it.
 
 | mount.empty-dirs
 | []string
@@ -64,3 +66,14 @@ changes in metadata.
 |===
 
 // End of autogenerated code - DO NOT EDIT! (configuration)
+
+== Dynamic creation of PersistentVolumeClaims
+
+If your cluster has some StorageClass defined, you can configure `mount.volume` to create one PersistentVolume on your behalf. This is going to be mounted to the application Pod, according to the configuration given. See Kubernetes documentation about StorageClass to learn more.
+
+[source,console]
+$ kamel run test.yaml -t mount.volumes=my-pvc:/tmp/my-pvc:10Mi:ReadOnlyMany
+
+The above command would create a new volume on the fly if it does not exists using "default" StorageClass. You can specify any StorageClass as configuration.
+
+NOTE: if the volume exists, then it would reuse it.
diff --git a/helm/camel-k/crds/camel-k-crds.yaml b/helm/camel-k/crds/camel-k-crds.yaml
@@ -4831,8 +4831,10 @@ spec:
                           2.5.'
                         type: boolean
                       volumes:
-                        description: 'A list of Persistent Volume Claims to be mounted.
-                          Syntax: [pvcname:/container/path]'
+                        description: |-
+                          A list of Persistent Volume Claims to be mounted. Syntax: [pvcname:/container/path]. If the PVC is not found, the Integration fails.
+                          You can use the syntax [pvcname:/container/path:size:accessMode<:storageClass>] to create a dynamic PVC based on the Storage Class provided
+                          or the default cluster Storage Class. However, if the PVC exists, the operator would mount it.
                         items:
                           type: string
                         type: array
@@ -6969,8 +6971,10 @@ spec:
                           2.5.'
                         type: boolean
                       volumes:
-                        description: 'A list of Persistent Volume Claims to be mounted.
-                          Syntax: [pvcname:/container/path]'
+                        description: |-
+                          A list of Persistent Volume Claims to be mounted. Syntax: [pvcname:/container/path]. If the PVC is not found, the Integration fails.
+                          You can use the syntax [pvcname:/container/path:size:accessMode<:storageClass>] to create a dynamic PVC based on the Storage Class provided
+                          or the default cluster Storage Class. However, if the PVC exists, the operator would mount it.
                         items:
                           type: string
                         type: array
@@ -9010,8 +9014,10 @@ spec:
                           2.5.'
                         type: boolean
                       volumes:
-                        description: 'A list of Persistent Volume Claims to be mounted.
-                          Syntax: [pvcname:/container/path]'
+                        description: |-
+                          A list of Persistent Volume Claims to be mounted. Syntax: [pvcname:/container/path]. If the PVC is not found, the Integration fails.
+                          You can use the syntax [pvcname:/container/path:size:accessMode<:storageClass>] to create a dynamic PVC based on the Storage Class provided
+                          or the default cluster Storage Class. However, if the PVC exists, the operator would mount it.
                         items:
                           type: string
                         type: array
@@ -11027,8 +11033,10 @@ spec:
                           2.5.'
                         type: boolean
                       volumes:
-                        description: 'A list of Persistent Volume Claims to be mounted.
-                          Syntax: [pvcname:/container/path]'
+                        description: |-
+                          A list of Persistent Volume Claims to be mounted. Syntax: [pvcname:/container/path]. If the PVC is not found, the Integration fails.
+                          You can use the syntax [pvcname:/container/path:size:accessMode<:storageClass>] to create a dynamic PVC based on the Storage Class provided
+                          or the default cluster Storage Class. However, if the PVC exists, the operator would mount it.
                         items:
                           type: string
                         type: array
@@ -19085,8 +19093,10 @@ spec:
                           2.5.'
                         type: boolean
                       volumes:
-                        description: 'A list of Persistent Volume Claims to be mounted.
-                          Syntax: [pvcname:/container/path]'
+                        description: |-
+                          A list of Persistent Volume Claims to be mounted. Syntax: [pvcname:/container/path]. If the PVC is not found, the Integration fails.
+                          You can use the syntax [pvcname:/container/path:size:accessMode<:storageClass>] to create a dynamic PVC based on the Storage Class provided
+                          or the default cluster Storage Class. However, if the PVC exists, the operator would mount it.
                         items:
                           type: string
                         type: array
@@ -21064,8 +21074,10 @@ spec:
                           2.5.'
                         type: boolean
                       volumes:
-                        description: 'A list of Persistent Volume Claims to be mounted.
-                          Syntax: [pvcname:/container/path]'
+                        description: |-
+                          A list of Persistent Volume Claims to be mounted. Syntax: [pvcname:/container/path]. If the PVC is not found, the Integration fails.
+                          You can use the syntax [pvcname:/container/path:size:accessMode<:storageClass>] to create a dynamic PVC based on the Storage Class provided
+                          or the default cluster Storage Class. However, if the PVC exists, the operator would mount it.
                         items:
                           type: string
                         type: array
@@ -29197,8 +29209,10 @@ spec:
                               2.5.'
                             type: boolean
                           volumes:
-                            description: 'A list of Persistent Volume Claims to be
-                              mounted. Syntax: [pvcname:/container/path]'
+                            description: |-
+                              A list of Persistent Volume Claims to be mounted. Syntax: [pvcname:/container/path]. If the PVC is not found, the Integration fails.
+                              You can use the syntax [pvcname:/container/path:size:accessMode<:storageClass>] to create a dynamic PVC based on the Storage Class provided
+                              or the default cluster Storage Class. However, if the PVC exists, the operator would mount it.
                             items:
                               type: string
                             type: array
@@ -40121,8 +40135,10 @@ spec:
                               2.5.'
                             type: boolean
                           volumes:
-                            description: 'A list of Persistent Volume Claims to be
-                              mounted. Syntax: [pvcname:/container/path]'
+                            description: |-
+                              A list of Persistent Volume Claims to be mounted. Syntax: [pvcname:/container/path]. If the PVC is not found, the Integration fails.
+                              You can use the syntax [pvcname:/container/path:size:accessMode<:storageClass>] to create a dynamic PVC based on the Storage Class provided
+                              or the default cluster Storage Class. However, if the PVC exists, the operator would mount it.
                             items:
                               type: string
                             type: array

diff --git a/pkg/apis/camel/v1/trait/mount.go b/pkg/apis/camel/v1/trait/mount.go
@@ -32,7 +32,9 @@ type MountTrait struct {
 	// The destination path can be either a default location or any path specified by the user.
 	// Syntax: [configmap|secret]:name[/key][@path], where name represents the resource name, key optionally represents the resource key to be filtered and path represents the destination path
 	Resources []string `property:"resources" json:"resources,omitempty"`
-	// A list of Persistent Volume Claims to be mounted. Syntax: [pvcname:/container/path]
+	// A list of Persistent Volume Claims to be mounted. Syntax: [pvcname:/container/path]. If the PVC is not found, the Integration fails.
+	// You can use the syntax [pvcname:/container/path:size:accessMode<:storageClass>] to create a dynamic PVC based on the Storage Class provided
+	// or the default cluster Storage Class. However, if the PVC exists, the operator would mount it.
 	Volumes []string `property:"volumes" json:"volumes,omitempty"`
 	// A list of EmptyDir volumes to be mounted. Syntax: [name:/container/path]
 	EmptyDirs []string `property:"empty-dirs" json:"emptyDirs,omitempty"`

diff --git a/pkg/resources/config/crd/bases/camel.apache.org_integrationplatforms.yaml b/pkg/resources/config/crd/bases/camel.apache.org_integrationplatforms.yaml
@@ -1673,8 +1673,10 @@ spec:
                           2.5.'
                         type: boolean
                       volumes:
-                        description: 'A list of Persistent Volume Claims to be mounted.
-                          Syntax: [pvcname:/container/path]'
+                        description: |-
+                          A list of Persistent Volume Claims to be mounted. Syntax: [pvcname:/container/path]. If the PVC is not found, the Integration fails.
+                          You can use the syntax [pvcname:/container/path:size:accessMode<:storageClass>] to create a dynamic PVC based on the Storage Class provided
+                          or the default cluster Storage Class. However, if the PVC exists, the operator would mount it.
                         items:
                           type: string
                         type: array
@@ -3811,8 +3813,10 @@ spec:
                           2.5.'
                         type: boolean
                       volumes:
-                        description: 'A list of Persistent Volume Claims to be mounted.
-                          Syntax: [pvcname:/container/path]'
+                        description: |-
+                          A list of Persistent Volume Claims to be mounted. Syntax: [pvcname:/container/path]. If the PVC is not found, the Integration fails.
+                          You can use the syntax [pvcname:/container/path:size:accessMode<:storageClass>] to create a dynamic PVC based on the Storage Class provided
+                          or the default cluster Storage Class. However, if the PVC exists, the operator would mount it.
                         items:
                           type: string
                         type: array

diff --git a/pkg/resources/config/crd/bases/camel.apache.org_integrationprofiles.yaml b/pkg/resources/config/crd/bases/camel.apache.org_integrationprofiles.yaml
@@ -1542,8 +1542,10 @@ spec:
                           2.5.'
                         type: boolean
                       volumes:
-                        description: 'A list of Persistent Volume Claims to be mounted.
-                          Syntax: [pvcname:/container/path]'
+                        description: |-
+                          A list of Persistent Volume Claims to be mounted. Syntax: [pvcname:/container/path]. If the PVC is not found, the Integration fails.
+                          You can use the syntax [pvcname:/container/path:size:accessMode<:storageClass>] to create a dynamic PVC based on the Storage Class provided
+                          or the default cluster Storage Class. However, if the PVC exists, the operator would mount it.
                         items:
                           type: string
                         type: array
@@ -3559,8 +3561,10 @@ spec:
                           2.5.'
                         type: boolean
                       volumes:
-                        description: 'A list of Persistent Volume Claims to be mounted.
-                          Syntax: [pvcname:/container/path]'
+                        description: |-
+                          A list of Persistent Volume Claims to be mounted. Syntax: [pvcname:/container/path]. If the PVC is not found, the Integration fails.
+                          You can use the syntax [pvcname:/container/path:size:accessMode<:storageClass>] to create a dynamic PVC based on the Storage Class provided
+                          or the default cluster Storage Class. However, if the PVC exists, the operator would mount it.
                         items:
                           type: string
                         type: array

diff --git a/pkg/resources/config/crd/bases/camel.apache.org_integrations.yaml b/pkg/resources/config/crd/bases/camel.apache.org_integrations.yaml
@@ -7562,8 +7562,10 @@ spec:
                           2.5.'
                         type: boolean
                       volumes:
-                        description: 'A list of Persistent Volume Claims to be mounted.
-                          Syntax: [pvcname:/container/path]'
+                        description: |-
+                          A list of Persistent Volume Claims to be mounted. Syntax: [pvcname:/container/path]. If the PVC is not found, the Integration fails.
+                          You can use the syntax [pvcname:/container/path:size:accessMode<:storageClass>] to create a dynamic PVC based on the Storage Class provided
+                          or the default cluster Storage Class. However, if the PVC exists, the operator would mount it.
                         items:
                           type: string
                         type: array
@@ -9541,8 +9543,10 @@ spec:
                           2.5.'
                         type: boolean
                       volumes:
-                        description: 'A list of Persistent Volume Claims to be mounted.
-                          Syntax: [pvcname:/container/path]'
+                        description: |-
+                          A list of Persistent Volume Claims to be mounted. Syntax: [pvcname:/container/path]. If the PVC is not found, the Integration fails.
+                          You can use the syntax [pvcname:/container/path:size:accessMode<:storageClass>] to create a dynamic PVC based on the Storage Class provided
+                          or the default cluster Storage Class. However, if the PVC exists, the operator would mount it.
                         items:
                           type: string
                         type: array

diff --git a/pkg/resources/config/crd/bases/camel.apache.org_kameletbindings.yaml b/pkg/resources/config/crd/bases/camel.apache.org_kameletbindings.yaml
@@ -7630,8 +7630,10 @@ spec:
                               2.5.'
                             type: boolean
                           volumes:
-                            description: 'A list of Persistent Volume Claims to be
-                              mounted. Syntax: [pvcname:/container/path]'
+                            description: |-
+                              A list of Persistent Volume Claims to be mounted. Syntax: [pvcname:/container/path]. If the PVC is not found, the Integration fails.
+                              You can use the syntax [pvcname:/container/path:size:accessMode<:storageClass>] to create a dynamic PVC based on the Storage Class provided
+                              or the default cluster Storage Class. However, if the PVC exists, the operator would mount it.
                             items:
                               type: string
                             type: array

diff --git a/pkg/resources/config/crd/bases/camel.apache.org_pipes.yaml b/pkg/resources/config/crd/bases/camel.apache.org_pipes.yaml
@@ -7628,8 +7628,10 @@ spec:
                               2.5.'
                             type: boolean
                           volumes:
-                            description: 'A list of Persistent Volume Claims to be
-                              mounted. Syntax: [pvcname:/container/path]'
+                            description: |-
+                              A list of Persistent Volume Claims to be mounted. Syntax: [pvcname:/container/path]. If the PVC is not found, the Integration fails.
+                              You can use the syntax [pvcname:/container/path:size:accessMode<:storageClass>] to create a dynamic PVC based on the Storage Class provided
+                              or the default cluster Storage Class. However, if the PVC exists, the operator would mount it.
                             items:
                               type: string
                             type: array