docs: overhaul main README with badges, catalog, and missing samples#278
Open
avivdeg wants to merge 2 commits intoNetApp:mainfrom
Open
docs: overhaul main README with badges, catalog, and missing samples#278avivdeg wants to merge 2 commits intoNetApp:mainfrom
avivdeg wants to merge 2 commits intoNetApp:mainfrom
Conversation
- Add CI, license, stars, forks, and contributors badges - Add Quick Navigation table summarizing the 4 tracks - Add Getting Started section with clone instructions - Add one-line descriptions for every sample in the catalog - Add 3 samples missing from ToC (ec2-user-data-iscsi, FSxN-Report, Harvest on EC2) - Add Related Resources table (AWS docs, Workload Factory, BlueXP, monitoring repo) - Surface Monitoring deprecation notice (moved to NetApp/FSx-ONTAP-monitoring) - Fix 'Netapp' typo to 'NetApp' in overview - Add Contributing section with link to CONTRIBUTING.md
kcantrel
requested changes
Apr 16, 2026
Collaborator
kcantrel
left a comment
kcantrel
left a comment
There was a problem hiding this comment.
Please consider the comments I made.
|
|
||
| --- | ||
|
|
||
| ## Sample Catalog |
Collaborator
There was a problem hiding this comment.
Change "Sample" to "Samples", otherwise it looks like a template that wasn't changed.
| | Track | Focus | Samples | | ||
| |:------|:------|:-------:| | ||
| | [Infrastructure as Code](/Infrastructure_as_Code) | Terraform, CloudFormation & Ansible templates for provisioning and configuring FSx ONTAP resources | 11 | | ||
| | [EKS](/EKS) | Persistent storage for Kubernetes with Trident Protect, PV migration & log collection | 4 | |
Collaborator
There was a problem hiding this comment.
I think the focus is too specific. Maybe:
Samples of how to use FSxN with your EKS deployments leveraging Trident and Trident Protect.
| |:------|:------|:-------:| | ||
| | [Infrastructure as Code](/Infrastructure_as_Code) | Terraform, CloudFormation & Ansible templates for provisioning and configuring FSx ONTAP resources | 11 | | ||
| | [EKS](/EKS) | Persistent storage for Kubernetes with Trident Protect, PV migration & log collection | 4 | | ||
| | [Management Utilities](/Management-Utilities) | Day-2 operations — SnapMirror, secrets rotation, auto-grow, iSCSI, reporting & more | 9 | |
Collaborator
There was a problem hiding this comment.
In this case, the focus is too vague. How about:
Day-2 operations - Auto manage SnapMirror relationships, Auto rotate FSxN credentials, sample scripts leveraging APIs, and more.
| | [Infrastructure as Code](/Infrastructure_as_Code) | Terraform, CloudFormation & Ansible templates for provisioning and configuring FSx ONTAP resources | 11 | | ||
| | [EKS](/EKS) | Persistent storage for Kubernetes with Trident Protect, PV migration & log collection | 4 | | ||
| | [Management Utilities](/Management-Utilities) | Day-2 operations — SnapMirror, secrets rotation, auto-grow, iSCSI, reporting & more | 9 | | ||
| | [Monitoring](/Monitoring) | CloudWatch dashboards, alarms, LUN metrics, Harvest/Grafana & ONTAP service health | 7 | |
Collaborator
There was a problem hiding this comment.
I've been meaning to take out the monitoring references in this repo. I only left the code here for historical reasons in case someone has a pointer to a specific folder. So, let's take out this row of the table.
| * **[CloudFormation](/Infrastructure_as_Code/CloudFormation)** | ||
| * [Deploy FSx ONTAP](/Infrastructure_as_Code/CloudFormation/deploy-fsx-ontap) — One-click FSx ONTAP deployment stack | ||
| * [Export FSx ONTAP Configuration to CloudFormation](/Infrastructure_as_Code/CloudFormation/Export-FSxN-CloudFormation) — Reverse-engineer existing resources into templates | ||
| * [Custom Resources Samples](/Infrastructure_as_Code/CloudFormation/NetApp-FSxN-Custom-Resources-Samples) — Lambda-backed custom resources for advanced provisioning |
Collaborator
There was a problem hiding this comment.
Maybe change the description to be:
Examples of using the NetApp's CloudFormation extensions for advanced provisioning.
| * [Export FSx ONTAP Configuration to CloudFormation](/Infrastructure_as_Code/CloudFormation/Export-FSxN-CloudFormation) — Reverse-engineer existing resources into templates | ||
| * [Custom Resources Samples](/Infrastructure_as_Code/CloudFormation/NetApp-FSxN-Custom-Resources-Samples) — Lambda-backed custom resources for advanced provisioning | ||
| * **[Terraform](/Infrastructure_as_Code/Terraform)** | ||
| * [FSx ONTAP deployment](/Infrastructure_as_Code/Terraform/deploy-fsx-ontap) — Core Terraform module for FSx ONTAP |
Collaborator
There was a problem hiding this comment.
Maybe change the description to:
Comprehensive Terraform template (stand alone and module) to deploy an FSx for ONTAP.
| * [Monitor ONTAP metrics from FSx ONTAP using python Lambda function](/Monitoring/monitor-ontap-services) | ||
| * [Backup EKS Applications with Trident Protect](/EKS/Backup-EKS-Applications-with-Trident-Protect) — Backup and restore PVCs using Trident Protect | ||
| * [EKS non-stdout logs collection into ELK](/EKS/EKS-logs-to-ELK) — Shared FSx ONTAP storage for non-standard log collection | ||
| * [FSx for NetApp ONTAP as persistent storage for EKS](/EKS/FSxN-as-PVC-for-EKS) — Sandbox environment for FSx ONTAP PVC integration |
Collaborator
There was a problem hiding this comment.
Maybe:
End to end EKS environment with FSx for ONTAP as the persistent storage.
|
|
||
| * [Auto Create SnapMirror Relationships](/Management-Utilities/auto_create_sm_relationships) — Automatically create SnapMirror relationships between file systems | ||
| * [Auto Set FSxN Auto Grow](/Management-Utilities/auto_set_fsxn_auto_grow) — Automatically enable volume auto-grow | ||
| * [AWS CLI Management Scripts](/Management-Utilities/fsx-ontap-aws-cli-scripts) — Collection of AWS CLI scripts for FSx ONTAP operations |
Collaborator
There was a problem hiding this comment.
Maybe:
Collection of scripts for managing AWS FSx for ONTAP.
| * [Workload Factory API Samples](/Management-Utilities/Workload-Factory-API-Samples) — Bash scripts demonstrating Workload Factory API usage | ||
|
|
||
| ### Monitoring | ||
|
|
Collaborator
There was a problem hiding this comment.
Just delete this Monitoring section
| | AWS FSx for NetApp ONTAP documentation | [docs.aws.amazon.com](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/what-is-fsx-ontap.html) | | ||
| | NetApp Workload Factory | [console.workloads.netapp.com](https://console.workloads.netapp.com) | | ||
| | FSx ONTAP Monitoring (dedicated repo) | [NetApp/FSx-ONTAP-monitoring](https://github.com/NetApp/FSx-ONTAP-monitoring) | | ||
| | NetApp BlueXP | [bluexp.netapp.com](https://bluexp.netapp.com) | |
Collaborator
There was a problem hiding this comment.
Change BlueXP to "Console" and the URL to console.netapp.com
- Reword EKS focus to mention Trident and Trident Protect - Reword Management Utilities focus to be more specific - Remove Monitoring row from Quick Navigation table - Remove entire Monitoring section from catalog (moved to dedicated repo) - Rename 'Sample Catalog' to 'Samples Catalog' - Reword Custom Resources description (CloudFormation extensions) - Reword Terraform deploy description (comprehensive template) - Reword FSxN-as-PVC-for-EKS description (end to end EKS environment) - Reword AWS CLI scripts description - Change BlueXP to Console with console.netapp.com URL
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR modernizes the main README to make the repository more discoverable, navigable, and professional.
What changed
Added:
Management-Utilities/ec2-user-data-iscsi-create-and-mountManagement-Utilities/FSxN-ReportMonitoring/monitor_fsxn_with_harvest_on_ec2NetApp/FSx-ONTAP-monitoringFixed:
Preserved:
No breaking changes
This is a documentation-only change to
README.md. No code, workflows, or other files are modified.