doc: Initial draft of 4.0.0 release notes

This is an initial draft, that should render right in
github.

Need inputs from contributors to complete the notes.

Change-Id: I0e6a4f88b44ff46685e66f139758a2247954639d
BUG: 1539842
Signed-off-by: ShyamsundarR <srangana@redhat.com>

1 files changed, 328 insertions, 0 deletions

diff --git a/doc/release-notes/4.0.0.md b/doc/release-notes/4.0.0.md
new file mode 100644
index 00000000000..c7757f0ed02
--- /dev/null
+++ b/doc/release-notes/4.0.0.md
@@ -0,0 +1,328 @@
+# Release notes for Gluster 4.0.0
+
+** DRAFT DRAFT ! DRAFT !!!**
+
+**Header for the release - TBD**
+
+The most notable features and changes are documented on this page. A full list
+of bugs that have been addressed is included further below.
+
+- [Major changes and features](#major-changes-and-features)
+- [Major issues](#major-issues)
+- [Bugs addressed in the release](#bugs-addressed)
+
+Further, as 3.13 is a short term maintenance release, features included
+in that release are available with 4.0.0 as well, and could be of interest to
+users upgrading to 4.0.0 from older than 3.13 releases. The 3.13 [release notes](http://docs.gluster.org/en/latest/release-notes/)
+captures the list of features that were introduced with 3.13.
+
+**NOTE:** As 3.13 was a short term maintenance release, it will reach end of
+life (EOL) with the release of 4.0.0. ([reference](https://www.gluster.org/release-schedule/))
+
+## Major changes and features
+
+Features are categorized into the following sections,
+
+- [Management](#management)
+- [Monitoring](#monitoring)
+- [Performance](#performance)
+- [Geo-replication](#geo-replication)
+- [Standalone](#standalone)
+- [Developer related](#developer-related)
+
+### Management
+
+#### 1. GlusterD2
+**Notes for users:**
+- Need GD2 team to fill in enough links and information here covering,
+    - What it is
+    - Install and configuration steps
+    - Future plans (what happens in 4.1.0 and further)
+
+**Limitations:**
+
+**Known Issues:**
+
+### Monitoring
+#### 1. More metrics on fops at every translate layer
+**Notes for users:**
+- https://github.com/gluster/glusterfs/issues/137
+- Release notes needs:
+    - Needs appropriate documentation
+    - Also, need some developer documentation to aid in debugging using this information
+
+**Limitations:**
+
+
+**Known Issues:**
+
+#### 2. Monitoring support
+**Notes for users:**
+- https://github.com/gluster/glusterfs/issues/168
+- Usage needs documentation
+- Release notes:
+    - Need documentation to point to and some terse statement for the release notes
+
+**Limitations:**
+
+
+**Known Issues:**
+
+
+### Performance
+#### 1. EC: Make metadata [F]STAT/[F]GETXATTR operations faster
+**Notes for users:**
+- https://github.com/gluster/glusterfs/issues/368
+- Auto enabled, no options or documentation required
+- Release notes:
+    - Can be handled by the release team
+
+**Limitations:**
+
+
+**Known Issues:**
+
+#### 2. To make md-cache capable to serve nameless lookup
+**Notes for users:**
+- https://github.com/gluster/glusterfs/issues/232
+- Release notes:
+    - Need to have some detail on what workloads will stand to gain by this change
+
+**Limitations:**
+
+
+**Known Issues:**
+
+#### 3. md-cache: Allow runtime addition of xattrs to the list of xattrs that md-cache caches
+**Notes for users:**
+- https://github.com/gluster/glusterfs/issues/297
+- Needs user documentation for option performance.xattr-cache-list
+- Release notes:
+    - Need documentation of the option, and also some details of when to use this feature
+    - Maybe better if this appeared in the documentation and we could point to the same
+
+**Limitations:**
+
+
+**Known Issues:**
+
+#### 4. Cache last stripe of an EC volume while write is going on
+**Notes for users:**
+- https://github.com/gluster/glusterfs/issues/256
+- Release notes:
+    - Needs option documentation and also use-case details, as to when to enable this
+
+**Limitations:**
+
+
+**Known Issues:**
+
+#### 5. tie-breaker logic for blocking inodelks/entrylk in SHD
+**Notes for users:**
+- https://github.com/gluster/glusterfs/issues/354
+- Release notes:
+    - Internal feature to enable faster(?) self-heal, mention it as such
+
+**Limitations:**
+
+
+**Known Issues:**
+
+### Geo-replication
+#### 1. JSON output for Geo-rep status and config for Glusterd2 integration
+**Notes for users:**
+- https://github.com/gluster/glusterfs/issues/361
+- Added option --json to the gsyncd.py script
+    - Are end users going to use the status command here?
+    - Documentation update?
+- Release notes:
+    - If there is no end user impact, no specific notes are needed for the same
+
+**Limitations:**
+
+
+**Known Issues:**
+
+#### 2. Enhance Geo-replication to use Volinfo from Config file
+**Notes for users:**
+- https://github.com/gluster/glusterfs/issues/396
+- Documentation needs to be updated with the changed conf file section
+- Release notes:
+    - Need documentation of explanation of the process in the notes, and also when to use the same
+
+**Limitations:**
+
+
+**Known Issues:**
+
+#### 3. Geo-replication: Improve gverify.sh logs
+**Notes for users:**
+- https://github.com/gluster/glusterfs/issues/395
+- Release notes:
+    - Needs documentation around new log file locations and possibly strings to check for mount failures etc.
+
+**Limitations:**
+
+
+**Known Issues:**
+
+#### 4. Geo-rep: Cleanup stale (unusable) XSYNC changelogs.
+**Notes for users:**
+- https://github.com/gluster/glusterfs/issues/376
+- Release notes:
+    - A note on change in behavior maybe needed
+
+**Limitations:**
+
+
+**Known Issues:**
+
+#### 5. Improve gsyncd configuration and arguments handling
+**Notes for users:**
+- https://github.com/gluster/glusterfs/issues/73
+- Release notes:
+    - Needs user facing documentation for newer options and such
+    - There seems to be code improvement as well in the patches, so that may not be needed in the release notes
+
+**Limitations:**
+
+
+**Known Issues:**
+
+### Standalone
+#### 1. Ability to force permissions while creating files/directories on a volume
+**Notes for users:**
+- https://github.com/gluster/glusterfs/issues/301
+- Adds options,
+    - "create-mask" and "create-directory-mask"
+    - "force-create-mode" and "force-create-directory"
+    - End user documentation is required
+- Release notes:
+    - Need a summary of what the option would enable and how to set the same
+    - If relevant user documentation is added, we maybe able to point to the same as well
+
+**Limitations:**
+
+
+**Known Issues:**
+
+#### 2. Replace MD5 usage to enable FIPS support
+**Notes for users:**
+- https://github.com/gluster/glusterfs/issues/230
+- Need a lot of context on options and versions before which this feature can be used
+- Release notes:
+    - Need help from authors to complete
+
+**Limitations:**
+
+
+**Known Issues:**
+
+#### 3. Dentry fop serializer xlator on brick stack
+**Notes for users:**
+- https://github.com/gluster/glusterfs/issues/397
+- Release notes:
+    - Needs option documentation and when to use the same comments
+
+**Limitations:**
+
+
+**Known Issues:**
+
+#### 4. Add option to disable nftw() based deletes when purging the landfill directory
+**Notes for users:**
+- https://github.com/gluster/glusterfs/issues/371
+- Release notes:
+    - Document option to use and when to use the same
+
+**Limitations:**
+
+
+**Known Issues:**
+
+#### 5. Add option in POSIX to limit hardlinks per inode
+**Notes for users:**
+- https://github.com/gluster/glusterfs/issues/370
+- Release notes:
+    - Use github description
+
+**Limitations:**
+
+
+**Known Issues:**
+
+#### 6. Enhancements for directory listing in readdirp
+**Notes for users:**
+- https://github.com/gluster/glusterfs/issues/239
+- Potentially has some behavioral change in the way rebalance works, needs some documentation efforts there
+- Release notes:
+    - Note the changes in rebalance behavior, any performance gains?
+
+**Limitations:**
+
+
+**Known Issues:**
+
+### Developer related
+#### 1. xlators should not provide init(), fini() and others directly, but have class_methods
+**Notes for developers:**
+- https://github.com/gluster/glusterfs/issues/164
+- Some developer documentation needs to be updated for this change
+- Release notes:
+    - Can be handled by the release team
+
+#### 2. Framework for distributed testing
+**Notes for developers:**
+- https://github.com/gluster/glusterfs/issues/374
+- Developer README already present
+- Release notes:
+    - Can be handled by the release team
+
+#### 3. New API for acquiring mandatory locks
+**Notes for developers:**
+- https://github.com/gluster/glusterfs/issues/393
+- Code comment for API exists, and release notes can point to that
+- Release notes:
+    - Can be handled by the release team
+
+#### 4. New on-wire protocol (XDR) needed to support iattx and cleaner dictionary structure
+**Notes for developers:**
+- https://github.com/gluster/glusterfs/issues/384
+- Requires some developer writeup, to explain out the changes
+- Release notes:
+    - Can point to developer notes, if made available
+
+#### 5. Leases support on GlusterFS
+**Notes for developers:**
+- https://github.com/gluster/glusterfs/issues/350
+- Developer documentation is available in the header file
+- Release notes:
+    - Can be handled by the release team
+
+#### 6. The protocol xlators should prevent sending binary values in a dict over the networks
+**Notes for developers:**
+- https://github.com/gluster/glusterfs/issues/203
+- Release notes:
+    - Pont to developer documentation if any
+
+#### 7. Translator to handle 'global' options
+**Notes for developers:**
+- https://github.com/gluster/glusterfs/issues/303
+- Release notes:
+    - Needs developer documentation for future improvements in this area
+
+#### 8. Information on RPC programs
+**Notes for developers:**
+- https://github.com/gluster/glusterfs/issues/140
+- Release notes:
+    - Point to the provided documentation
+
+## Major issues
+
+**TBD**
+
+## Bugs addressed
+
+Bugs addressed since release-3.13.0 are listed below.
+
+**TBD**
\ No newline at end of file