Merge pull request #48 from rook/ceph-nfs-deprecation-notice

docs: add Rook NFS deprecation notice

Documentation/README.md

@@ -1,5 +1,7 @@
 # Rook
 
+**The Rook NFS operator is [deprecated](https://github.com/rook/nfs#deprecated)**
+
 Rook is an open source **cloud-native storage orchestrator**, providing the platform, framework, and support for a diverse set of storage solutions to natively integrate with cloud-native environments.
 
 Rook turns storage software into self-managing, self-scaling, and self-healing storage services. It does this by automating deployment, bootstrapping, configuration, provisioning, scaling, upgrading, migration, disaster recovery, monitoring, and resource management. Rook uses the facilities provided by the underlying cloud-native container management, scheduling and orchestration platform to perform its duties.

Documentation/common-issues.md

@@ -5,6 +5,8 @@ weight: 8000
 
 # Common Issues
 
+**The Rook NFS operator is [deprecated](https://github.com/rook/nfs#deprecated)**
+
 To help troubleshoot your Rook clusters, here are some tips on what information will help solve the issues you might be seeing.
 If after trying the suggestions found on this page and the problem is not resolved, the Rook team is very happy to help you troubleshoot the issues in their Slack channel. Once you have [registered for the Rook Slack](https://slack.rook.io), proceed to the General channel to ask for assistance.
 

Documentation/development-flow.md

@@ -5,6 +5,8 @@ weight: 12000
 
 # Contributing
 
+**The Rook NFS operator is [deprecated](https://github.com/rook/nfs#deprecated)**
+
 Thank you for your time and effort to help us improve Rook! Here are a few steps to get started. If you have any questions,
 don't hesitate to reach out to us on our [Slack](https://rook-io.slack.com) dev channel.
 

Documentation/k8s-pre-reqs.md

@@ -6,6 +6,8 @@ weight: 1000
 
 # Prerequisites
 
+**The Rook NFS operator is [deprecated](https://github.com/rook/nfs#deprecated)**
+
 Rook can be installed on any existing Kubernetes cluster as long as it meets the minimum version
 and Rook is granted the required privileges (see below for more information).
 

Documentation/nfs-crd.md

@@ -5,6 +5,8 @@ weight: 3000
 
 # NFS Server CRD
 
+**The Rook NFS operator is [deprecated](https://github.com/rook/nfs#deprecated)**
+
 NFS Server can be created and configured using the `nfsservers.nfs.rook.io` custom resource definition (CRD).
 Please refer to the [user guide walk-through](nfs.md) for complete instructions.
 This page will explain all the available configuration options on the NFS CRD.

Documentation/quickstart.md

@@ -6,6 +6,8 @@ weight: 2000
 
 # Network Filesystem (NFS) Quickstart
 
+**The Rook NFS operator is [deprecated](https://github.com/rook/nfs#deprecated)**
+
 Welcome to Rook! We hope you have a great experience installing the Rook **cloud-native storage orchestrator** platform
 to enable highly available, durable storage in your Kubernetes cluster.
 

README.md

@@ -5,7 +5,14 @@
 [![Go Report Card](https://goreportcard.com/badge/github.com/rook/nfs)](https://goreportcard.com/report/github.com/rook/nfs)
 [![Slack](https://slack.rook.io/badge.svg)](https://slack.rook.io)
 
-# What is Rook?
+# Deprecated
+The Rook NFS operator has been deprecated due to lack of community support. We recommend that users
+consider [Rook-Ceph's CephNFS](https://rook.github.io/docs/rook/latest/ceph-nfs-crd.html) which is
+under active development. Alternatively, there is a
+[classical, non-CSI NFS server provisioner](https://github.com/kubernetes-sigs/nfs-ganesha-server-and-external-provisioner)
+if users don't wish to run a CephCluster and CephFilesystem to host NFS storage.
+
+## What is Rook?
 
 Rook is an open source **cloud-native storage orchestrator** for Kubernetes, providing the platform, framework, and support for a diverse set of storage solutions to natively integrate with cloud-native environments.