Pipeline Editor: Extend data volume node property

docs/source/user_guide/pipelines.md

@@ -209,6 +209,8 @@ The following alphabetically sorted list identifies the node properties that are
    - Format: 
      - _Mount path_: the path where the PVC shall be mounted in the container. Example: `/mnt/datavol/`
      - _Persistent volume claim name_: a valid [Kubernetes resource name](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names) identifying a PVC that exists in the Kubernetes namespace where the pipeline nodes are executed. Example: `my-data-pvc`
+     - _Sub path_: relative path within the volume from which the container's volume should be mounted. Defaults to the volume's root. Example: `existing/path/in/volume`
+     - _Mount volume read-only_: whether to mount the volume in read-only mode
    - Data volumes are not mounted when the pipeline is executed locally.
 
 ##### Disable node caching

elyra/pipeline/airflow/processor_airflow.py

@@ -607,7 +607,8 @@ def render_mounts(self, elyra_parameters: Dict[str, ElyraProperty]) -> str:
         str_to_render = ""
         for v in elyra_parameters.get(pipeline_constants.MOUNTED_VOLUMES, []):
             str_to_render += f"""
-                 VolumeMount(name="{v.pvc_name}", mount_path="{v.path}", sub_path=None, read_only=False),"""
+                 VolumeMount(name="{v.pvc_name}", mount_path="{v.path}",
+                 sub_path="{v.sub_path}", read_only={v.read_only}),"""
         return dedent(str_to_render)
 
     def render_secrets(self, elyra_parameters: Dict[str, ElyraProperty], cos_secret: Optional[str]) -> str:
@@ -679,7 +680,12 @@ def add_mounted_volume(self, instance: VolumeMount, execution_object: Any, **kwa
             }
         )
         execution_object["volume_mounts"].append(
-            {"mountPath": instance.path, "name": instance.pvc_name, "read_only": False}
+            {
+                "mountPath": instance.path,
+                "name": instance.pvc_name,
+                "sub_path": instance.sub_path,
+                "read_only": instance.read_only,
+            }
         )
 
     def add_kubernetes_pod_annotation(self, instance: KubernetesAnnotation, execution_object: Any, **kwargs) -> None:

elyra/pipeline/component_parameter.py

@@ -284,6 +284,7 @@ def get_schema(cls) -> Dict[str, Any]:
         """Build the JSON schema for an Elyra-owned component property"""
         schema = super().get_schema()
         schema["enum"] = ["True", "False"]
+        schema["uihints"] = {"ui:placeholder": "Use runtime default"}
         return schema
 
     def get_value_for_display(self) -> Dict[str, Any]:
@@ -499,11 +500,32 @@ class VolumeMount(ElyraPropertyListItem):
             required=True,
             use_in_key=False,
         ),
+        ListItemPropertyAttribute(
+            attribute_id="sub_path",
+            display_name="Sub Path",
+            placeholder="relative/path/within/volume",
+            input_type="string",
+            hidden=False,
+            required=False,
+            use_in_key=False,
+        ),
+        ListItemPropertyAttribute(
+            attribute_id="read_only",
+            display_name="Mount volume read-only",
+            placeholder=None,
+            default_value=False,
+            input_type="boolean",
+            hidden=False,
+            required=False,
+            use_in_key=False,
+        ),
     ]
 
-    def __init__(self, path, pvc_name, **kwargs):
+    def __init__(self, path: str, pvc_name: str, sub_path: str, read_only: bool, **kwargs):
         self.path = path
         self.pvc_name = pvc_name
+        self.sub_path = sub_path
+        self.read_only = read_only
 
     def get_all_validation_errors(self) -> List[str]:
         """Identify configuration issues for this instance"""
@@ -514,14 +536,27 @@ def get_all_validation_errors(self) -> List[str]:
             validation_errors.append("Required persistent volume claim name was not specified.")
         elif not is_valid_kubernetes_resource_name(self.pvc_name):
             validation_errors.append(f"PVC name '{self.pvc_name}' is not a valid Kubernetes resource name.")
+        if self.sub_path and self.sub_path.startswith("/"):
+            validation_errors.append(f"Sub-path '{self.sub_path}' must be a relative path.")
 
         return validation_errors
 
     def add_to_execution_object(self, runtime_processor: RuntimePipelineProcessor, execution_object: Any, **kwargs):
         """Add VolumeMount instance to the execution object for the given runtime processor"""
         self.path = f"/{self.path.strip('/')}"  # normalize path
+        if self.read_only is None:
+            self.read_only = False
         runtime_processor.add_mounted_volume(instance=self, execution_object=execution_object, **kwargs)
 
+    def should_discard(self) -> bool:
+        """
+        Returns a boolean indicating whether this VolumeMount instance should be silently discarded on
+        the basis of its mount path, PVC name, and sub-path attribute values. If these attributes
+        don't contain values this instance will not be validated or processed.
+        """
+        # ignore the read_only attribute because it always contains a value
+        return not (self.path or self.pvc_name or self.sub_path)
+
 
 class KubernetesAnnotation(ElyraPropertyListItem):
     """An ElyraProperty representing a single Kubernetes annotation"""

elyra/pipeline/kfp/processor_kfp.py

@@ -792,7 +792,14 @@ def add_mounted_volume(self, instance: VolumeMount, execution_object: Any, **kwa
         )
         if volume not in execution_object.volumes:
             execution_object.add_volume(volume)
-        execution_object.container.add_volume_mount(V1VolumeMount(mount_path=instance.path, name=instance.pvc_name))
+        execution_object.container.add_volume_mount(
+            V1VolumeMount(
+                mount_path=instance.path,
+                name=instance.pvc_name,
+                sub_path=instance.sub_path,
+                read_only=instance.read_only,
+            )
+        )
 
     def add_kubernetes_pod_annotation(self, instance: KubernetesAnnotation, execution_object: Any, **kwargs) -> None:
         """Add KubernetesAnnotation instance to the execution object for the given runtime processor"""

elyra/tests/pipeline/resources/additional_generic_properties.json

@@ -47,6 +47,16 @@
           "type": "string",
           "title": "Persistent Volume Claim Name",
           "default": ""
+        },
+        "read_only": {
+          "default": false,
+          "title": "Mount volume read-only",
+          "type": "boolean"
+        },
+        "sub_path": {
+          "default": "",
+          "title": "Sub Path",
+          "type": "string"
         }
       },
       "required": ["path", "pvc_name"]
@@ -58,6 +68,9 @@
         },
         "pvc_name": {
           "ui:placeholder": "pvc-name"
+        },
+        "sub_path": {
+          "ui:placeholder": "relative/path/within/volume"
         }
       }
     },

elyra/tests/pipeline/test_pipeline_definition.py

@@ -188,11 +188,13 @@ def test_property_id_collision_with_system_property(monkeypatch, catalog_instanc
     # pipeline node and in the pipeline default properties
     derive1_vols = custom_node_derive1.get_component_parameter(MOUNTED_VOLUMES)
     assert derive1_vols.to_dict() == {
-        "/mnt/vol2": {"path": "/mnt/vol2", "pvc_name": "pvc-claim-2"},
-        "/mnt/vol1": {"path": "/mnt/vol1", "pvc_name": "pvc-claim-1"},
+        "/mnt/vol2": {"path": "/mnt/vol2", "pvc_name": "pvc-claim-2", "read_only": None, "sub_path": None},
+        "/mnt/vol1": {"path": "/mnt/vol1", "pvc_name": "pvc-claim-1", "read_only": None, "sub_path": None},
     }
     derive2_vols = custom_node_derive2.get_component_parameter(MOUNTED_VOLUMES)
-    assert derive2_vols.to_dict() == {"/mnt/vol2": {"path": "/mnt/vol2", "pvc_name": "pvc-claim-2"}}
+    assert derive2_vols.to_dict() == {
+        "/mnt/vol2": {"path": "/mnt/vol2", "pvc_name": "pvc-claim-2", "read_only": None, "sub_path": None}
+    }
 
     # TestOperator defines its own "mounted_volumes" property
     # and should skip the Elyra system property of the same name

elyra/tests/pipeline/test_validation.py

@@ -446,8 +446,13 @@ def test_valid_node_property_volumes(validation_manager):
 
     volumes = ElyraPropertyList(
         [
-            VolumeMount(path="/mount/test", pvc_name="rwx-test-claim"),  # valid
-            VolumeMount(path="/mount/test_two", pvc_name="second-claim"),  # valid
+            VolumeMount(path="/mount/test", pvc_name="rwx-test-claim", sub_path=None, read_only=False),
+            VolumeMount(path="/mount/test", pvc_name="rwx-test-claim", sub_path="", read_only=False),
+            VolumeMount(path="/mount/test", pvc_name="rwx-test-claim", sub_path="relative/path", read_only=False),
+            VolumeMount(path="/mount/test_two", pvc_name="second-claim", sub_path="", read_only=True),
+            VolumeMount(path="/mount/test_two", pvc_name="second-claim", sub_path="path", read_only=True),
+            VolumeMount(path="/mount/test_two", pvc_name="second-claim", sub_path="path/", read_only=True),
+            VolumeMount(path="/mount/test_two", pvc_name="second-claim", sub_path="path/in/volume", read_only=None),
         ]
     )
     node_dict["app_data"]["component_parameters"][MOUNTED_VOLUMES] = volumes
@@ -466,13 +471,18 @@ def test_invalid_node_property_volumes(validation_manager):
 
     volumes = ElyraPropertyList(
         [
-            VolumeMount(path="", pvc_name=""),  # missing mount path and pvc name
-            VolumeMount(path=None, pvc_name=None),  # missing mount path and pvc name
-            VolumeMount(path="", pvc_name="pvc"),  # missing mount path
-            VolumeMount(path=None, pvc_name="pvc"),  # missing mount path
-            VolumeMount(path="/path", pvc_name=""),  # missing pvc name
-            VolumeMount(path="/path/", pvc_name=None),  # missing pvc name
-            VolumeMount(path="/mount/test_four", pvc_name="second#claim"),  # invalid pvc name
+            VolumeMount(path="", pvc_name="", sub_path="", read_only=True),  # missing mount path and pvc name
+            VolumeMount(path=None, pvc_name=None, sub_path=None, read_only=True),  # missing mount path and pvc name
+            VolumeMount(path="", pvc_name="pvc", sub_path="", read_only=True),  # missing mount path
+            VolumeMount(path=None, pvc_name="pvc", sub_path=None, read_only=True),  # missing mount path
+            VolumeMount(path="/path", pvc_name="", sub_path="", read_only=True),  # missing pvc name
+            VolumeMount(path="/path/", pvc_name=None, sub_path=None, read_only=False),  # missing pvc name
+            VolumeMount(
+                path="/mount/test_four", pvc_name="second#claim", sub_path=None, read_only=False
+            ),  # invalid pvc name
+            VolumeMount(
+                path="/path", pvc_name="pvc", sub_path="/absolute/path", read_only=False
+            ),  # sub_path must be relative
         ]
     )
     node_dict["app_data"]["component_parameters"][MOUNTED_VOLUMES] = volumes
@@ -482,7 +492,7 @@ def test_invalid_node_property_volumes(validation_manager):
         node_id=node.id, node_label=node.label, node=node, param_name=MOUNTED_VOLUMES, response=response
     )
     issues = response.to_json().get("issues")
-    assert len(issues) == 9, issues
+    assert len(issues) == 10, issues
     assert issues[0]["severity"] == 1
     assert issues[0]["type"] == "invalidVolumeMount"
     assert issues[0]["data"]["propertyName"] == MOUNTED_VOLUMES
@@ -496,6 +506,7 @@ def test_invalid_node_property_volumes(validation_manager):
     assert "Required persistent volume claim name was not specified." in issues[6]["message"]
     assert "Required persistent volume claim name was not specified." in issues[7]["message"]
     assert "PVC name 'second#claim' is not a valid Kubernetes resource name." in issues[8]["message"]
+    assert "Sub-path '/absolute/path' must be a relative path." in issues[9]["message"]
 
 
 def test_valid_node_property_kubernetes_toleration(validation_manager):