Merge branch 'release-v2.7.0' of https://bitbucket.ngage.netapp.com/scm/sie-bb/netapp-dataops-toolkit into feature/mcp-flexcache-k8s

Author: mboglesby

netapp_dataops_k8s/netapp_dataops/k8s/__init__.py

@@ -4,7 +4,7 @@
 by applications using the import method of utilizing the toolkit.
 """
 
-__version__ = "2.5.0"
+__version__ = "2.6.0"
 
 import base64
 from datetime import datetime

netapp_dataops_k8s/netapp_dataops/netapp_dataops_k8s_cli.py

@@ -689,16 +689,16 @@
 Create a new FlexCache volume.
 
 Required Options/Arguments:
-\t-f, --flexcache-vol=\tName of flexcache volume
-\t-s, --source-svm=\tSource SVM name
-\t-v, --source-vol=\tSource volume name
-\t-z, --flexcache-size=\tSize of flexcache volume (Format: '1024Mi', '100Gi', '10Ti', etc.).
-\t-b, --backend-name=\tName of tridentbackendconfig.
+\t-f, --flexcache-vol=\t\tName of flexcache volume
+\t-s, --source-svm=\t\tSource SVM name
+\t-v, --source-vol=\t\tSource volume name
+\t-z, --flexcache-size=\t\tSize of flexcache volume (Format: '1024Mi', '100Gi', '10Ti', etc.).
+\t-b, --backend-name=\t\tName of tridentbackendconfig.
 
 Optional Options/Arguments:
-\t-h, --help\t\tPrint help text.
-\t-c, --junction=\t\tThe junction path for the FlexCache volume.
-\t-n, --namespace=\tKubernetes namespace to create the new PersistentVolumeClaim (PVC) in. If not specified, the PVC will be created in the "default" namespace.
+\t-h, --help\t\t\tPrint help text.
+\t-c, --junction=\t\t\tThe junction path for the FlexCache volume.
+\t-n, --namespace=\t\tKubernetes namespace to create the new PersistentVolumeClaim (PVC) in. If not specified, the PVC will be created in the "default" namespace.
 \t-t, --trident-namespace=\tKubernetes namespace where Trident is installed. If not specified, the namespace "trident" will be used.
 
 Examples:

netapp_dataops_k8s/setup.cfg

@@ -37,6 +37,7 @@ install_requires =
     tabulate
     kubernetes
     netapp-ontap
+    fastmcp
 python_requires = >=3.8,<3.14
 
 [options.packages.find]

netapp_dataops_traditional/Examples/README.md

@@ -9,8 +9,3 @@ This directory contains different examples including Jupyter Notebooks, YAML fil
 
 In this example we demonstrate an AI workflow in a Jupyter Notebook using Keras and MLflow. This notebook's goal is to give you an understanding of how to use the DataOps Toolkit with MLFlow for dataset-to-model traceability.
 
-## SageMaker Notebook Instances with FSx for NetApp ONTAP
-
-[notebookInstance-FSXVolume-stack.yaml](notebookInstance-FSXVolume-stack.yaml)
-
-An AWS CloudFormation template for deploying Amazon SageMaker Notebook instances with access to an Amazon FSx for NetApp ONTAP filesystem.

netapp_dataops_traditional/Examples/notebookInstance-FSXVolume-stack.yaml

@@ -91,6 +91,7 @@ Data volume management operations:
 - [List all data volumes.](#cli-list-volumes)
 - [Mount an existing data volume locally as "read-only" or "read-write".](#cli-mount-volume)
 - [Unmount an existing data volume.](#cli-unmount-volume)
+- [Create a new flexcache volume.](#cli-create-flexcache)
 
 Snapshot management operations:
 - [Create a new snapshot for a data volume.](#cli-create-snapshot)
@@ -400,6 +401,51 @@ Unmounting volume at '/test1'.
 Volume unmounted successfully.
 ```
 
+<a name="cli-create-flexcache"></a>
+
+#### Create a New FlexCache Volume
+
+The NetApp DataOps Toolkit can be used to create a new FlexCache volume. A FlexCache volume acts as a local cache for a remote volume, enabling faster access to frequently used data. The command for creating a new FlexCache volume is `netapp_dataops_cli.py create flexcache`.
+
+The following options/arguments are required:
+
+```
+    -n, --flexcache-vol=    Name of the FlexCache volume to be created.
+    -v, --source-volume=    Name of the source volume.
+    -s, --source-svm=       Name of the source SVM.
+```
+
+The following options/arguments are optional:
+
+```
+    -t, --flexcache-svm=    Name of the SVM where the FlexCache volume will reside.
+    -u, --cluster-name=     Non-default hosting cluster.
+    -j, --junction=         Custom junction path for the FlexCache volume to be exported at. If not specified, junction path will be: ("/"+FlexCache Volume Name).
+    -z, --flexcache-size=   Size of the FlexCache volume. Format: '1024MB', '100GB', '10TB', etc. (default is 10% of the origin volume size or 1GB per constituent, whichever is greater).
+    -e, --export-policy=    NFS export policy to use for the FlexCache volume (default: 'default').
+    -m, --mountpoint=       Local mountpoint to mount the FlexCache volume after creation. If not specified, the volume will not be mounted locally. On Linux hosts, must be run as root if specified.
+    -x, --readonly=         Mount the FlexCache volume as read-only if True. (default is False).
+    -h, --help              Print help text.
+```
+
+##### Example Usage
+
+Create a FlexCache volume named 'cache1' in SVM 'svm0' for the source volume 'source1' in the source SVM 'svm1'.
+
+```sh
+netapp_dataops_cli.py create flexcache --flexcache-vol=cache1 --flexcache-svm=svm0 --source-volume=source1 --source-svm=svm1
+Creating FlexCache: svm1:source1 -> svm0:cache1
+FlexCache created successfully.
+```
+
+Create a FlexCache volume named 'cache2' in SVM 'svm0' for the source volume 'source2' in the source SVM 'svm1', with a size of 500GB.
+
+```sh
+netapp_dataops_cli.py create flexcache --flexcache-vol=cache2 --flexcache-svm=svm0 --source-volume=source2 --source-svm=svm1 --flexcache-size=500GB
+Creating FlexCache: svm1:source2 -> svm0:cache2
+FlexCache created successfully.
+```
+
 ### Snapshot Management Operations
 
 <a name="cli-create-snapshot"></a>
@@ -943,7 +989,7 @@ Setting state to snapmirrored, action:resync
 The NetApp DataOps Toolkit can also be utilized as a library of functions that can be imported into any Python program or Jupyter Notebook. In this manner, data scientists and data engineers can easily incorporate data management tasks into their existing projects, programs, and workflows. This functionality is only recommended for advanced users who are proficient in Python.
 
 ```py
-from netapp_dataops.traditional import clone_volume, create_volume, delete_volume, list_volumes, mount_volume, create_snapshot, delete_snapshot, list_snapshots, restore_snapshot, list_cloud_sync_relationships, sync_cloud_sync_relationship, list_snap_mirror_relationships, sync_snap_mirror_relationship, prepopulate_flex_cache, push_directory_to_s3, push_file_to_s3, pull_bucket_from_s3, pull_object_from_s3
+from netapp_dataops.traditional import clone_volume, create_volume, delete_volume, list_volumes, mount_volume, create_snapshot, delete_snapshot, list_snapshots, restore_snapshot, list_cloud_sync_relationships, sync_cloud_sync_relationship, list_snap_mirror_relationships, sync_snap_mirror_relationship, create_flexcache, prepopulate_flex_cache, push_directory_to_s3, push_file_to_s3, pull_bucket_from_s3, pull_object_from_s3
 ```
 
 Note: The prerequisite steps outlined in the [Getting Started](#getting-started) section still appy when the toolkit is being utilized as an importable library of functions.
@@ -957,6 +1003,7 @@ Data volume management operations:
 - [List all data volumes.](#lib-list-volumes)
 - [Mount an existing data volume locally as read-only or read-write.](#lib-mount-volume)
 - [Unmount an existing data volume.](#lib-unmount-volume)
+- [Create a new flexcache volume.](#lib-create-flexcache)
 
 Snapshot management operations:
 - [Create a new snapshot for a data volume.](#lib-create-snapshot)
@@ -1223,6 +1270,44 @@ APIConnectionError              # The storage system/service API returned an err
 InvalidVolumeParameterError     # An invalid parameter was specified.
 ```
 
+<a name="lib-create-flexcache"></a>
+
+#### Create a New FlexCache Volume
+
+The NetApp DataOps Toolkit can be used to create a new FlexCache volume as part of any Python program or workflow. A FlexCache volume acts as a local cache for a remote volume, enabling faster access to frequently used data. This functionality is useful for distributed environments where data needs to be accessed quickly and efficiently.
+
+##### Function Definition
+
+```py
+def create_flexcache(
+    source_vol: str,                # Name of the source volume (required).
+    source_svm: str,                # Name of the source SVM (required).
+    flexcache_vol: str,             # Name of the FlexCache volume to be created (required).
+    flexcache_svm: str = None,      # Name of the SVM where the FlexCache volume will reside (optional, defaults to config SVM).
+    cluster_name: str = None,       # Non-default cluster name, same credentials as the default credentials should be used (optional).
+    flexcache_size: str = None,     # Size of the FlexCache volume. Format: '1024MB', '100GB', '10TB', etc. (optional). Default is 10% of the source volume size or 1GB per constituent, whichever is greater.
+    junction: str = None,           # Custom junction path for the FlexCache volume to be exported at. If not specified, junction path will be: ("/"+FlexCache Volume Name).
+    export_policy: str = "default", # NFS export policy to use for the FlexCache volume (default: 'default').
+    mountpoint: str = None,         # Local mountpoint to mount the FlexCache volume after creation. If not specified, the volume will not be mounted locally. On Linux hosts, must be run as root if specified.
+    readonly: bool = False,         # Mount the FlexCache volume as read-only if True.
+    print_output: bool = False      # Denotes whether or not to print messages to the console during execution.
+):
+```
+
+##### Return Value
+
+None
+
+##### Error Handling
+
+If an error is encountered, the function will raise an exception of one of the following types. These exception types are defined in `netapp_dataops.traditional`.
+
+```py
+InvalidConfigError              # Config file is missing or contains an invalid value.
+APIConnectionError              # The storage system/service API returned an error.
+InvalidVolumeParameterError     # An invalid parameter was specified.
+``` 
+
 ### Snapshot Management Operations
 
 <a name="lib-create-snapshot"></a>

netapp_dataops_traditional/README.md

@@ -19,7 +19,7 @@ def load_credentials():
 
     # If path not found, raise an error that config.json file doesn't exist
     if not os.path.exists(credentials_path):
-        raise FileNotFoundError("Credentials file 'config.json' not found in the netapp_dataops directory.")
+        raise FileNotFoundError("Credentials file 'config.json' not found in the ~/.netapp_dataops directory.")
 
     # Opens the file specified, reads its contents, parses the contents as JSON, and stores the resulting data
     with open(credentials_path, 'r') as f:
@@ -48,4 +48,4 @@ def load_credentials():
         if key not in config:
             raise ValueError(f"Missing required key '{key}' in 'config.json' file.")
 
-    return config # Returns the validated configuration dictionary
+    return config # Returns the validated configuration dictionary