Skip to content

Commit dc995eb

Browse files
committed
NSOL-5617 Finalize Dataset Manager documentation.
1 parent d47c597 commit dc995eb

4 files changed

Lines changed: 89 additions & 0 deletions

File tree

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,14 @@ The NetApp DataOps Toolkit is a collection of Python-based client tools that sim
99

1010
The toolkit includes [MCP Servers](mcp_servers.md) that expose many of these capabilities as "tools" that can be utilized by AI agents.
1111

12+
## Highlighted Features
13+
14+
### 🗂️ Dataset Manager
15+
16+
The **Dataset Manager** is a powerful module in the Traditional Environments toolkit that provides a simplified, intuitive interface for managing datasets backed by NetApp ONTAP storage. It abstracts away volume management complexity and exposes datasets as simple directories, with built-in support for instant cloning, snapshots, and space efficiency — all through a clean Python API.
17+
18+
➡️ See the [Dataset Manager README](netapp_dataops_traditional/docs/dataset_manager_readme.md) to get started.
19+
1220
## Getting Started
1321

1422
The NetApp DataOps Toolkit includes the following client tools:

netapp_dataops_traditional/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,14 @@ NetApp DataOps Toolkit for Traditional Environments
33

44
The NetApp DataOps Toolkit for Traditional Environments is a Python library that makes it simple for developers, data scientists, DevOps engineers, and data engineers to perform various data management tasks, such as provisioning a new data volume, near-instantaneously cloning a data volume, and near-instantaneously snapshotting a data volume for traceability/baselining. This Python library can function as either a command line utility or a library of functions that can be imported into any Python program or Jupyter Notebook. The toolkit also includes [MCP Servers](../mcp_servers.md) that expose many of the capabilities as "tools" that can be utilized by AI agents.
55

6+
## Highlighted Features
7+
8+
### 🗂️ Dataset Manager
9+
10+
The **Dataset Manager** is a powerful module that provides a simplified, intuitive interface for managing datasets backed by NetApp ONTAP storage. It presents datasets as plain directories on your local filesystem while leveraging the full power of ONTAP under the hood — instant clones, point-in-time snapshots, and space efficiency — all through a clean Python API purpose-built for data scientists and data engineers.
11+
12+
➡️ See the [Dataset Manager README](docs/dataset_manager_readme.md) to get started.
13+
614
## Compatibility
715

816
The NetApp DataOps Toolkit for Traditional Environments supports Linux and macOS hosts.

netapp_dataops_traditional/docs/dataset_manager_readme.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
- [Key Features](#key-features)
88
- [Architecture Overview](#architecture-overview)
99
- [Prerequisites](#prerequisites)
10+
- [Installation](#installation)
1011
- [Getting Started](#getting-started)
1112
- [Initial Configuration](#initial-configuration)
1213
- [Creating Your First Dataset](#creating-your-first-dataset)
@@ -129,6 +130,10 @@ Root Volume (e.g., "dataset_mgr_root")
129130
- NetApp Cloud Volumes ONTAP (ONTAP 9.7+)
130131
- Amazon FSx for NetApp ONTAP
131132

133+
**Python:**
134+
- Python 3.8–3.13
135+
- `pip` (usually bundled with Python; verify with `pip --version`)
136+
132137
**Required Utilities:**
133138
- `mount` (for checking mount status)
134139
- `mountpoint` (for validating mount points)
@@ -155,6 +160,66 @@ Your ONTAP user account needs permissions to:
155160
- NFS protocol enabled on the ONTAP SVM
156161
- Appropriate export policy rules for your host's IP address
157162

163+
## Installation
164+
165+
### Step 1: Install NFS Client Utilities (if not already installed)
166+
167+
Dataset Manager mounts ONTAP volumes via NFS, so the NFS client utilities must be installed on your system.
168+
169+
**Ubuntu / Debian:**
170+
```bash
171+
sudo apt-get update && sudo apt-get install -y nfs-common
172+
```
173+
174+
**RHEL / CentOS / Fedora:**
175+
```bash
176+
sudo dnf install -y nfs-utils
177+
```
178+
179+
**macOS:**
180+
181+
NFS client support is built in to macOS — no additional installation is required.
182+
183+
### Step 2: Install the Package
184+
185+
It is recommended to install the toolkit inside a Python virtual environment to keep dependencies isolated.
186+
187+
**Create and activate a virtual environment:**
188+
```bash
189+
python3 -m venv ~/netapp-dataops-venv
190+
source ~/netapp-dataops-venv/bin/activate
191+
```
192+
193+
**Install the toolkit:**
194+
```bash
195+
pip install netapp-dataops-traditional
196+
```
197+
198+
This installs the package with support for NetApp ONTAP (AFF, FAS, Cloud Volumes ONTAP, Amazon FSx for NetApp ONTAP, and ONTAP Select).
199+
200+
> **Tip:** Add `source ~/netapp-dataops-venv/bin/activate` to your shell's startup file (e.g., `~/.bashrc` or `~/.zshrc`) so the environment is activated automatically in new terminal sessions.
201+
202+
### Step 3: Verify Installation
203+
204+
Confirm that the toolkit was installed correctly:
205+
206+
```bash
207+
netapp_dataops_cli.py --help
208+
```
209+
210+
You should see the toolkit's help output. If the command is not found, ensure the virtual environment is activated and that its `bin` directory is on your `PATH`.
211+
212+
You can also verify the Python library is importable:
213+
214+
```python
215+
from netapp_dataops.traditional.datasets import Dataset
216+
print("Installation successful!")
217+
```
218+
219+
> **Note:** Python 3.8–3.13 is required.
220+
221+
---
222+
158223
## Getting Started
159224

160225
### Initial Configuration

netapp_dataops_traditional/docs/ontap_readme.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
The NetApp DataOps Toolkit for Traditional Environments is a Python library that makes it simple for developers, data scientists, DevOps engineers, and data engineers to perform various data management tasks, such as provisioning a new data volume, near-instantaneously cloning a data volume, and near-instantaneously snapshotting a data volume for traceability/baselining. This Python library can function as either a [command line utility](#command-line-functionality) or a [library of functions](#library-of-functions) that can be imported into any Python program or Jupyter Notebook. The toolkit also includes an [MCP Server](mcp_server.md) that exposes many of the capabilities as "tools" that can be utilized by AI agents. The ONTAP module provides this functionality for standard ONTAP instances.
44

5+
## Highlighted Features
6+
7+
### 🗂️ Dataset Manager
8+
9+
The **Dataset Manager** is a powerful module that provides a simplified, intuitive interface for managing datasets backed by NetApp ONTAP storage. It presents datasets as plain directories on your local filesystem while leveraging the full power of ONTAP under the hood — instant clones, point-in-time snapshots, and space efficiency — all through a clean Python API purpose-built for data scientists and data engineers.
10+
11+
➡️ See the [Dataset Manager README](dataset_manager_readme.md) to get started.
12+
513
## Compatibility
614

715
The NetApp DataOps Toolkit for Traditional Environments supports Linux and macOS hosts.

0 commit comments

Comments
 (0)