diff options
author | raghavendra talur <raghavendra.talur@gmail.com> | 2015-08-20 15:09:31 +0530 |
---|---|---|
committer | Humble Devassy Chirammal <humble.devassy@gmail.com> | 2015-08-31 02:27:22 -0700 |
commit | 9e9e3c5620882d2f769694996ff4d7e0cf36cc2b (patch) | |
tree | 3a00cbd0cc24eb7df3de9b2eeeb8d42ee9175f88 /done/GlusterFS 3.7/Easy addition of Custom Translators.md | |
parent | f6055cdb4dedde576ed8ec55a13814a69dceefdc (diff) |
Create basic directory structure
All new features specs go into in_progress directory.
Once signed off, it should be moved to done directory.
For now,
This change moves all the Gluster 4.0 feature specs to
in_progress. All other specs are under done/release-version.
More cleanup required will be done incrementally.
Change-Id: Id272d301ba8c434cbf7a9a966ceba05fe63b230d
BUG: 1206539
Signed-off-by: Raghavendra Talur <rtalur@redhat.com>
Reviewed-on: http://review.gluster.org/11969
Reviewed-by: Humble Devassy Chirammal <humble.devassy@gmail.com>
Reviewed-by: Prashanth Pai <ppai@redhat.com>
Tested-by: Humble Devassy Chirammal <humble.devassy@gmail.com>
Diffstat (limited to 'done/GlusterFS 3.7/Easy addition of Custom Translators.md')
-rw-r--r-- | done/GlusterFS 3.7/Easy addition of Custom Translators.md | 129 |
1 files changed, 129 insertions, 0 deletions
diff --git a/done/GlusterFS 3.7/Easy addition of Custom Translators.md b/done/GlusterFS 3.7/Easy addition of Custom Translators.md new file mode 100644 index 0000000..487770e --- /dev/null +++ b/done/GlusterFS 3.7/Easy addition of Custom Translators.md @@ -0,0 +1,129 @@ +Feature +------- + +Easy addition of custom translators + +Summary +------- + +I'd like to propose we add a way for people to easily add custom +translators they've written. (using C, or Glupy, or whatever) + +Owners +------ + +Justin Clift <jclift@redhat.com> +Anand Avati <avati@redhat.com> + +Current status +-------------- + +At present, when a custom translator has been developed it's difficult +to get it included in generated .vol files properly. + +It **can** be done using the GlusterFS "filter" mechanism, but that's +non optimal and open to catastrophic failure. + +Detailed Description +-------------------- + +Discussed on the gluster-devel mailing list here: + +[http://lists.nongnu.org/archive/html/gluster-devel/2013-08/msg00074.html](http://lists.nongnu.org/archive/html/gluster-devel/2013-08/msg00074.html) + +We could have a new install Gluster sub-dir, which takes a .so/.py +translator file, and a JSON fragment to say what to do with it. No CLI. + +This would suit deployment via packaging, and should be simple enough +for developers to make use of easily as well. + +Benefit to GlusterFS +-------------------- + +Having an easily usable / deployable approach for custom translators is +a key part of extending the Gluster Developer Community, especially in +combination with rapid feature prototyping through Glupy. + +Scope +----- + +### Nature of proposed change + +Modification of existing code, to enable much easier addition of custom +translators. + +### Implications on packaging + +The gluster-devel package should include all the necessary header and +library files to compile a standalone glusterfs translator. + +### Implications on development + +/usr/share/doc/gluster-devel/examples/translators/hello-world should +contain skeleton translator code (well commented), README.txt and build +files. This code becomes the starting point to implement a new +translator. Make a few changes and you should be able to build, install, +test and package your translator. + +Ideally, this would be implemented via a script. + +Similar to autoproject, "translator-gen NAME" should produce all the +necessary skeleton translator code and associated files. This avoids +erroneous find-replace steps. + +### Implications on manageability + +TBD + +### Implications on presentation layer + +N/A + +### Implications on persistence layer + +TBD + +### Implications on 'GlusterFS' backend + +TBD + +### Modification to GlusterFS metadata + +TBD + +### Implications on 'glusterd' + +TBD + +How To Test +----------- + +TBD + +User Experience +--------------- + +TBD + +Dependencies +------------ + +No new dependencies. + +Documentation +------------- + +At least "Getting Started" documentation and API documentation needs to +be created, including libglusterfs APIs. + +Status +------ + +Initial concept proposal only. + +Comments and Discussion +----------------------- + +- An initial potential concept for the JSON fragment is on the mailing + list: + - <http://lists.nongnu.org/archive/html/gluster-devel/2013-08/msg00080.html> |