Added docs for mounting file systems for job. (#373)

Author: lu-ohai

docs/source/user_guide/jobs/infra_and_runtime.rst

@@ -152,6 +152,61 @@ see also `ADS Logging <../logging/logging.html>`_.
 
 With logging configured, you can call :py:meth:`~ads.jobs.DataScienceJobRun.watch` method to stream the logs.
 
+
+Mounting File Systems
+---------------------
+
+Data Science Job supports mounting multiple types of file systems,
+see `Data Science Job Mounting File Systems <https://docs.oracle.com/en-us/iaas/data-science/using/jobs-create.htm>`_. A maximum number of 5 file systems are
+allowed to be mounted for each Data Science Job. You can specify a list of file systems to be mounted
+by calling :py:meth:`~ads.jobs.DataScienceJob.with_storage_mount()`. For each file system to be mounted,
+you need to pass a dictionary with ``src`` and ``dest`` as keys. For example, you can pass
+``<mount_target_ip_address>@<export_path>`` as the value for ``src`` to mount OCI File Storage and you can also
+pass ``oci://<bucket_name>@<namespace>/<prefix>`` to mount OCI Object Storage. The value of
+``dest`` indicates the path and directory to which you want to mount the file system and must be in the
+format as ``<destination_path>/<destination_directory_name>``. The ``<destination_directory_name>`` is required
+while the ``<destination_path>`` is optional. The ``<destination_path>`` must start with character ``/`` if provided.
+If not, the file systems will be mounted to ``/mnt/<destination_directory_name>`` by default.
+
+
+.. tabs::
+
+  .. code-tab:: python
+    :caption: Python
+
+    from ads.jobs import DataScienceJob
+
+    infrastructure = (
+        DataScienceJob()
+        .with_log_group_id("<log_group_ocid>")
+        .with_log_id("<log_ocid>")
+        .with_storage_mount(
+          {
+            "src" : "<mount_target_ip_address>@<export_path>",
+            "dest" : "<destination_path>/<destination_directory_name>"
+          }, # mount oci file storage to path "<destination_path>/<destination_directory_name>"
+          {
+            "src" : "oci://<bucket_name>@<namespace>/<prefix>",
+            "dest" : "<destination_directory_name>"
+          } # mount oci object storage to path "/mnt/<destination_directory_name>"
+        )
+    )
+
+  .. code-tab:: yaml
+    :caption: YAML
+
+    kind: infrastructure
+    type: dataScienceJob
+    spec:
+      logGroupId: <log_group_ocid>
+      logId: <log_ocid>
+      storageMount:
+      - src: <mount_target_ip_address>@<export_path>
+        dest: <destination_path>/<destination_directory_name>
+      - src: oci://<bucket_name>@<namespace>/<prefix>
+        dest: <destination_directory_name>
+
+
 Runtime
 =======
 

docs/source/user_guide/jobs/tabs/infra_config.rst

@@ -22,6 +22,17 @@
         .with_shape_config_details(memory_in_gbs=16, ocpus=1)
         # Minimum/Default block storage size is 50 (GB).
         .with_block_storage_size(50)
+        # A maximum number of 5 file systems are allowed to be mounted for a job.
+        .with_storage_mount(
+          {
+            "src" : "<mount_target_ip_address>@<export_path>",
+            "dest" : "<destination_path>/<destination_directory_name>"
+          }, # mount oci file storage to path "<destination_path>/<destination_directory_name>"
+          {
+            "src" : "oci://<bucket_name>@<namespace>/<prefix>",
+            "dest" : "<destination_directory_name>"
+          } # mount oci object storage to path "/mnt/<destination_directory_name>"
+        )
     )
 
   .. code-tab:: yaml
@@ -40,3 +51,8 @@
         ocpus: 1
       shapeName: VM.Standard.E3.Flex
       subnetId: <subnet_ocid>
+      storageMount:
+      - src: <mount_target_ip_address>@<export_path>
+        dest: <destination_path>/<destination_directory_name>
+      - src: oci://<bucket_name>@<namespace>/<prefix>
+        dest: <destination_directory_name>

docs/source/user_guide/jobs/tabs/quick_start_job.rst

@@ -24,6 +24,17 @@
             .with_shape_config_details(memory_in_gbs=16, ocpus=1)
             # Minimum/Default block storage size is 50 (GB).
             .with_block_storage_size(50)
+            # A maximum number of 5 file systems are allowed to be mounted for a job.
+            .with_storage_mount(
+              {
+                "src" : "<mount_target_ip_address>@<export_path>",
+                "dest" : "<destination_path>/<destination_directory_name>"
+              }, # mount oci file storage to path "<destination_path>/<destination_directory_name>"
+              {
+                "src" : "oci://<bucket_name>@<namespace>/<prefix>",
+                "dest" : "<destination_directory_name>"
+              } # mount oci object storage to path "/mnt/<destination_directory_name>"
+            )
         )
         .with_runtime(
             PythonRuntime()
@@ -59,6 +70,11 @@
             ocpus: 1
           shapeName: VM.Standard.E3.Flex
           subnetId: <subnet_ocid>
+          storageMount:
+          - src: <mount_target_ip_address>@<export_path>
+            dest: <destination_path>/<destination_directory_name>
+          - src: oci://<bucket_name>@<namespace>/<prefix>
+            dest: <destination_directory_name>
       runtime:
         kind: runtime
         type: python