Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 1053670

Summary: "compress" option name for over-wire-compression is extremely misleading and should be changed
Product: [Community] GlusterFS Reporter: Justin Clift <jclift>
Component: cliAssignee: Niels de Vos <ndevos>
Status: CLOSED CURRENTRELEASE QA Contact:
Severity: high Docs Contact:
Priority: unspecified    
Version: pre-releaseCC: gluster-bugs, kwade, ndevos, ppai
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: glusterfs-3.5.0 Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2014-04-17 11:52:28 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 923540, 1049981    

Description Justin Clift 2014-01-15 15:43:36 UTC
Description of problem:

  Gluster 3.5 will include a useful new "over-the-wire" encryption
  ability, that can be set at volume level.

  The option name used to set it is unfortunately extremely misleading,
  and should be changed before 3.5 is released.

  At present, the option is set using:

    # gluster volume set <vol_name> compress on

  "compress" here is misleading, as it sounds like it's enabling
  _volume level disk compression_.  Better naming is needed, to indicate
  it's over-the-wire compression only.

  Possible suggestions:

    * transfer_compression
    * wire_compression
    * client_server_compression
    * [we can ask on gluster-devel too]

  Really, almost anything other then just "compress" or "compression"
  by itself. :)


Additional info:

  http://www.gluster.org/community/documentation/index.php/Features/On-Wire_Compression_%2B_Decompression

Comment 1 Justin Clift 2014-01-15 15:45:33 UTC
This is the BZ for the new over-the-wire compression code:

  https://bugzilla.redhat.com/show_bug.cgi?id=923540

Comment 2 Justin Clift 2014-01-15 15:55:10 UTC
s/encryption/compression/

Obviously needed more coffee when typing this. :/

Comment 3 Justin Clift 2014-01-22 14:23:34 UTC
Two more suggestions:

* sending_compression
* over_the_wire_compression <-- completely clear

Comment 4 Niels de Vos 2014-01-22 15:20:43 UTC
Discussed in todays meeting, network.compression has at least some acceptance.

Comment 5 Justin Clift 2014-01-22 20:52:20 UTC
"network.compression" sounds good. :)

Comment 6 Prashanth Pai 2014-01-23 05:12:27 UTC
+1 for "network.compression"

Comment 7 Anand Avati 2014-01-23 11:12:59 UTC
REVIEW: http://review.gluster.org/6765 (features/compress: rename "compress" option to "network.compression") posted (#1) for review on master by Niels de Vos (ndevos)

Comment 8 Niels de Vos 2014-01-23 11:44:26 UTC
Posted for the master branch, waiting for more comments and inclusion before backporting to release-3.5.

Comment 9 Anand Avati 2014-01-23 14:22:56 UTC
REVIEW: http://review.gluster.org/6765 (features/compress: rename "compress" option to "network.compression") posted (#2) for review on master by Niels de Vos (ndevos)

Comment 10 Anand Avati 2014-01-24 09:27:33 UTC
COMMIT: http://review.gluster.org/6765 committed in master by Vijay Bellur (vbellur) 
------
commit 460ed4184801d5346c58cc32a34704910345a184
Author: Niels de Vos <ndevos>
Date:   Thu Jan 23 12:12:07 2014 +0100

    features/compress: rename "compress" option to "network.compression"
    
    Prevent mistaking the "compress" options for storage (at rest)
    compression. The cdc-xlator is implemented to support compressing of
    network traffic (READ and WRITE FOPs).
    
    URL: http://www.gluster.org/community/documentation/index.php/Features/On-Wire_Compression_+_Decompression
    Change-Id: I9fedf4106dcb226d135ab92e4b533aff284881d7
    BUG: 1053670
    CC: Venky Shankar <vshankar>
    CC: Prashanth Pai <ppai>
    Signed-off-by: Niels de Vos <ndevos>
    Reviewed-on: http://review.gluster.org/6765
    Reviewed-by: Prashanth Pai <ppai>
    Reviewed-by: Kaleb KEITHLEY <kkeithle>
    Tested-by: Gluster Build System <jenkins.com>
    Reviewed-by: Vijay Bellur <vbellur>

Comment 11 Anand Avati 2014-01-24 09:40:30 UTC
REVIEW: http://review.gluster.org/6773 (features/compress: rename "compress" option to "network.compression") posted (#1) for review on release-3.5 by Niels de Vos (ndevos)

Comment 12 Anand Avati 2014-01-27 05:41:07 UTC
COMMIT: http://review.gluster.org/6773 committed in release-3.5 by Vijay Bellur (vbellur) 
------
commit 3744b1dfe3baedfd2f210edd7680454a5e32296f
Author: Niels de Vos <ndevos>
Date:   Fri Jan 24 10:38:16 2014 +0100

    features/compress: rename "compress" option to "network.compression"
    
    Prevent mistaking the "compress" options for storage (at rest)
    compression. The cdc-xlator is implemented to support compressing of
    network traffic (READ and WRITE FOPs).
    
    URL: http://www.gluster.org/community/documentation/index.php/Features/On-Wire_Compression_+_Decompression
    Master-Change-Id: I9fedf4106dcb226d135ab92e4b533aff284881d7
    Master-Reviewed-on: http://review.gluster.org/6765
    Change-Id: Ib882af855b36df93fac46236c349c33dd4c3ced4
    BUG: 1053670
    Signed-off-by: Niels de Vos <ndevos>
    Reviewed-on: http://review.gluster.org/6773
    Tested-by: Gluster Build System <jenkins.com>
    Reviewed-by: Prashanth Pai <ppai>

Comment 13 Niels de Vos 2014-04-17 11:52:28 UTC
This bug is getting closed because a release has been made available that should address the reported issue. In case the problem is still not fixed with glusterfs-3.5.0, please reopen this bug report.

glusterfs-3.5.0 has been announced on the Gluster Developers mailinglist [1], packages for several distributions should become available in the near future. Keep an eye on the Gluster Users mailinglist [2] and the update infrastructure for your distribution.

[1] http://thread.gmane.org/gmane.comp.file-systems.gluster.devel/6137
[2] http://thread.gmane.org/gmane.comp.file-systems.gluster.user