├── INSTALL
├── ChangeLog
├── Makefile.am
├── src
    ├── api_tier.py
    ├── api_brick.py
    ├── api_logrotate.py
    ├── api_heal.py
    ├── gunicorn_config.py.in
    ├── api_bitrot.py
    ├── __init__.py
    ├── api_peer.py
    ├── api_snapshot.py
    ├── Makefile.am
    ├── conf.py.in
    ├── api_quota.py
    ├── main.py
    ├── api_georep.py
    ├── api_volume.py
    ├── utils.py
    └── peer_restapi.py
├── extras
    ├── config.json
    ├── glusterrestd.service.in
    ├── glusterrestd-FreeBSD.in
    ├── Makefile.am
    └── glusterrestd-RedHat.in
├── TODO.org
├── .gitignore
├── autogen.sh
├── configure.ac
├── Design.md
├── apis.yaml
├── README.md
└── COPYING


/INSTALL:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/ChangeLog:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/Makefile.am:
--------------------------------------------------------------------------------
1 | EXTRA_DIST =
2 | SUBDIRS = src extras
3 | 


--------------------------------------------------------------------------------
/src/api_tier.py:
--------------------------------------------------------------------------------
1 | # Attach
2 | # Detach Start
3 | # Detach Stop
4 | # Detach Commit
5 | # Detach Status
6 | 


--------------------------------------------------------------------------------
/src/api_brick.py:
--------------------------------------------------------------------------------
1 | # Add Brick
2 | # Remove Brick Start
3 | # Remove Brick Stop
4 | # Remove Brick Status
5 | # Remove Brick Commit
6 | # Replace Brick
7 | 


--------------------------------------------------------------------------------
/extras/config.json:
--------------------------------------------------------------------------------
1 | {
2 |     "auth-enabled": true,
3 |     "https": false,
4 |     "port": 8080,
5 |     "csr": "/etc/glusterrest/server.csr",
6 |     "key": "/etc/glusterrest/server.key",
7 |     "num-workers": 2
8 | }
9 | 


--------------------------------------------------------------------------------
/TODO.org:
--------------------------------------------------------------------------------
1 | ** DONE Initial code base
2 |    CLOSED: [2016-09-28 Wed 20:53]
3 | ** DONE gluster-restapi CLI
4 |    CLOSED: [2016-09-28 Wed 20:53]
5 | ** TODO Usage Doc
6 | ** TODO API Doc
7 | ** TODO Documentation as github pages repo
8 | 
9 | 


--------------------------------------------------------------------------------
/src/api_logrotate.py:
--------------------------------------------------------------------------------
1 | # volume log <VOLNAME> rotate [BRICK] - rotate the log file for corresponding volume/brick
2 | # volume log rotate <VOLNAME> [BRICK] - rotate the log file for corresponding volume/brick NOTE: This is an old syntax, will be deprecated from next release.
3 | 


--------------------------------------------------------------------------------
/src/api_heal.py:
--------------------------------------------------------------------------------
1 | # volume heal <VOLNAME> [enable | disable | full |statistics [heal-count [replica <HOSTNAME:BRICKNAME>]] |info [healed | heal-failed | split-brain] |split-brain {bigger-file <FILE> | latest-mtime <FILE> |source-brick <HOSTNAME:BRICKNAME> [<FILE>]}] - self-heal commands on volume specified by <VOLNAME>
2 | 


--------------------------------------------------------------------------------
/src/gunicorn_config.py.in:
--------------------------------------------------------------------------------
 1 | import sys
 2 | sys.path.insert(1, '@GLUSTER_LIBEXECDIR@/')
 3 | 
 4 | from glusterrest.utils import get_config, load_config
 5 | 
 6 | load_config()
 7 | 
 8 | bind = ":" + str(get_config("port", 8080))
 9 | workers = get_config("num_workers", 2)
10 | errorlog = "/var/log/glusterrest/errors.log"
11 | accesslog = "/var/log/glusterrest/access.log"
12 | 


--------------------------------------------------------------------------------
/src/api_bitrot.py:
--------------------------------------------------------------------------------
1 | # volume bitrot <VOLNAME> {enable|disable} |
2 | # volume bitrot <volname> scrub-throttle {lazy|normal|aggressive} |
3 | # volume bitrot <volname> scrub-frequency {hourly|daily|weekly|biweekly|monthly} |
4 | # volume bitrot <volname> scrub {pause|resume|status} - Bitrot translator specific operation. For more information about bitrot command type  'man gluster'
5 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | glusterrest.egg-info
 2 | build
 3 | dist
 4 | *.pyc
 5 | *.pyo
 6 | conf.py
 7 | aclocal.m4
 8 | autom4te.cache
 9 | config.log
10 | configure
11 | install-sh
12 | missing
13 | config.status
14 | Makefile.in
15 | Makefile
16 | config.guess
17 | config.sub
18 | extras/glusterrestd-FreeBSD
19 | extras/glusterrestd-RedHat
20 | extras/glusterrestd.service
21 | py-compile
22 | src/gunicorn_config.py
23 | 


--------------------------------------------------------------------------------
/src/__init__.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | #
 3 | #  Copyright (c) 2016 Red Hat, Inc. <http://www.redhat.com>
 4 | #  This file is part of GlusterFS.
 5 | #
 6 | #  This file is licensed to you under your choice of the GNU Lesser
 7 | #  General Public License, version 3 or any later version (LGPLv3 or
 8 | #  later), or the GNU General Public License, version 2 (GPLv2), in all
 9 | #  cases as published by the Free Software Foundation.
10 | #
11 | 


--------------------------------------------------------------------------------
/src/api_peer.py:
--------------------------------------------------------------------------------
 1 | from utils import auth
 2 | from flask import Blueprint
 3 | 
 4 | peer_api = Blueprint('peer_api', __name__)
 5 | 
 6 | 
 7 | @peer_api.route("/<fqdn>", methods=["PUT"])
 8 | @auth
 9 | def api_peer_attach(fqdn):
10 |     pass
11 | 
12 | 
13 | @peer_api.route("/<fqdn>", methods=["DELETE"])
14 | @auth
15 | def api_peer_detach(fqdn):
16 |     pass
17 | 
18 | 
19 | @peer_api.route("", methods=["GET"])
20 | @auth
21 | def api_peer_info():
22 |     pass
23 | 


--------------------------------------------------------------------------------
/extras/glusterrestd.service.in:
--------------------------------------------------------------------------------
 1 | [Unit]
 2 | Description=Gluster REST APIs
 3 | After=syslog.target network.target
 4 | 
 5 | [Service]
 6 | Type=simple
 7 | ExecReload=/bin/kill -SIGHUP $MAINPID
 8 | KillMode=control-group
 9 | ExecStart=/usr/bin/gunicorn -c @SYSCONF_DIR@/glusterrest/gunicorn_config.py main:app --pid /var/run/glusterrest.pid --chdir @GLUSTER_LIBEXECDIR@/glusterrest
10 | PIDFile=/var/run/glusterrestd.pid
11 | 
12 | [Install]
13 | WantedBy=multi-user.target
14 | 


--------------------------------------------------------------------------------
/extras/glusterrestd-FreeBSD.in:
--------------------------------------------------------------------------------
 1 | #!/bin/sh
 2 | #
 3 | # $FreeBSD$
 4 | #
 5 | 
 6 | # PROVIDE: glusterrestd
 7 | 
 8 | . /etc/rc.subr
 9 | 
10 | name="glusterrestd"
11 | rcvar=`set_rcvar`
12 | command=/usr/bin/gunicorn
13 | pidfile="/var/run/${name}.pid"
14 | glusterrestd_flags="-D -c @SYSCONF_DIR@/glusterrest/gunicorn_config.py main:app --pid /var/run/${name}.pid --chdir @GLUSTER_LIBEXECDIR@/glusterrest"
15 | start_cmd="$command ${glusterrestd_flags}"
16 | 
17 | load_rc_config $name
18 | run_rc_command "$1"
19 | 


--------------------------------------------------------------------------------
/extras/Makefile.am:
--------------------------------------------------------------------------------
 1 | EXTRA_DIST = glusterrestd.service.in glusterrestd-FreeBSD.in \
 2 | 	glusterrestd-RedHat.in config.json
 3 | 
 4 | CLEANFILES = glusterrestd.service glusterrestd-FreeBSD \
 5 | 	glusterrestd-RedHat
 6 | 
 7 | restapiconfdir = $(sysconfdir)/glusterrest
 8 | restapiconf_DATA = config.json
 9 | 
10 | if USE_SYSTEMD
11 | systemd_DATA = glusterrestd.service
12 | endif
13 | 
14 | $(GF_DISTRIBUTION):
15 | 	@if [ ! -d $(SYSTEMD_DIR) ]; then \
16 | 		$(mkdir_p) $(DESTDIR)$(INIT_DIR); \
17 | 		$(INSTALL_PROGRAM) glusterrestd-$(GF_DISTRIBUTION) $(DESTDIR)$(INIT_DIR)/glusterrestd; \
18 | 	fi
19 | 
20 | install-exec-local: $(GF_DISTRIBUTION)
21 | 
22 | install-data-hook:
23 | 	$(INSTALL) -d -m 755 $(DESTDIR)/var/log/glusterrest
24 | 


--------------------------------------------------------------------------------
/src/api_snapshot.py:
--------------------------------------------------------------------------------
 1 | # snapshot activate <snapname> [force] - Activate snapshot volume.
 2 | # snapshot clone <clonename> <snapname> - Snapshot Clone.
 3 | # snapshot config [volname] ([snap-max-hard-limit <count>] [snap-max-soft-limit <percent>]) | ([auto-delete <enable|disable>])| ([activate-on-create <enable|disable>]) - Snapshot Config.
 4 | # snapshot create <snapname> <volname> [no-timestamp] [description <description>] [force] - Snapshot Create.
 5 | # snapshot deactivate <snapname> - Deactivate snapshot volume.
 6 | # snapshot delete (all | snapname | volume <volname>) - Snapshot Delete.
 7 | # snapshot help - display help for snapshot commands
 8 | # snapshot info [(snapname | volume <volname>)] - Snapshot Info.
 9 | # snapshot list [volname] - Snapshot List.
10 | # snapshot restore <snapname> - Snapshot Restore.
11 | # snapshot status [(snapname | volume <volname>)] - Snapshot Status.
12 | 


--------------------------------------------------------------------------------
/src/Makefile.am:
--------------------------------------------------------------------------------
 1 | EXTRA_DIST = api_bitrot.py api_georep.py api_logrotate.py api_quota.py \
 2 | 	api_tier.py cli.py __init__.py peer_restapi.py utils.py api_brick.py \
 3 | 	api_heal.py api_peer.py api_snapshot.py api_volume.py conf.py.in \
 4 | 	gunicorn_config.py glusterrest.py
 5 | 
 6 | CLEANFILES = conf.py
 7 | 
 8 | restapiconfdir = $(sysconfdir)/glusterrest
 9 | restapiconf_DATA = gunicorn_config.py
10 | 
11 | restapidir = $(gluster_libexecdir)/glusterrest
12 | restapi_PYTHON = api_bitrot.py api_georep.py api_logrotate.py api_quota.py \
13 | 	api_tier.py __init__.py utils.py api_brick.py api_heal.py api_peer.py \
14 | 	api_snapshot.py api_volume.py conf.py main.py
15 | 
16 | restapipeerscriptdir = $(libexecdir)/glusterfs
17 | restapipeerscript_SCRIPTS = peer_restapi.py
18 | 
19 | 
20 | install-exec-hook:
21 | 	$(mkdir_p) $(DESTDIR)$(sbindir)
22 | 	rm -f $(DESTDIR)$(sbindir)/gluster-restapi
23 | 	ln -s $(libexecdir)/glusterfs/peer_restapi.py \
24 | 		$(DESTDIR)$(sbindir)/gluster-restapi
25 | 
26 | uninstall-hook:
27 | 	rm -f $(DESTDIR)$(sbindir)/gluster-restapi
28 | 


--------------------------------------------------------------------------------
/src/conf.py.in:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | #
 3 | #  Copyright (c) 2016 Red Hat, Inc. <http://www.redhat.com>
 4 | #  This file is part of GlusterFS.
 5 | #
 6 | #  This file is licensed to you under your choice of the GNU Lesser
 7 | #  General Public License, version 3 or any later version (LGPLv3 or
 8 | #  later), or the GNU General Public License, version 2 (GPLv2), in all
 9 | #  cases as published by the Free Software Foundation.
10 | #
11 | 
12 | GLUSTER_LIBEXECDIR = "@GLUSTER_LIBEXECDIR@"
13 | GLUSTERD_WORKDIR = "@glusterd_workdir@"
14 | DEFAULT_CONFIG_FILE = "@SYSCONF_DIR@/glusterrest/config.json"
15 | CUSTOM_CONFIG_FILE_TO_SYNC = "/glusterrest/config.json"
16 | CUSTOM_CONFIG_FILE = GLUSTERD_WORKDIR + CUSTOM_CONFIG_FILE_TO_SYNC
17 | APPS_FILE_TO_SYNC = "/glusterrest/apps.json"
18 | APPS_FILE = GLUSTERD_WORKDIR + APPS_FILE_TO_SYNC
19 | LOG_FILE = "/var/log/glusterrest/rest.log"
20 | ACCESS_LOG_FILE = "/var/log/glusterrest/access.log"
21 | RESTD = "glusterrestd"
22 | CONFIG_KEYS = ["auth-enabled", "https", "port", "csr", "key", "log-level",
23 |                "num-workers"]
24 | BOOL_CONFIGS = ["auth-enabled", "https"]
25 | INT_CONFIGS = ["port", "num-workers"]
26 | RESTART_CONFIGS = ["num-workers"]
27 | PID_FILE = "/var/run/glusterrest.pid"
28 | VERSION = "/v1"
29 | 


--------------------------------------------------------------------------------
/src/api_quota.py:
--------------------------------------------------------------------------------
 1 | # volume quota <VOLNAME> {enable|disable|list [<path> ...]| list-objects [<path> ...] | remove <path>| remove-objects <path> | default-soft-limit <percent>} |
 2 | # volume quota <VOLNAME> {limit-usage <path> <size> [<percent>]} |
 3 | # volume quota <VOLNAME> {limit-objects <path> <number> [<percent>]} |
 4 | # volume quota <VOLNAME> {alert-time|soft-timeout|hard-timeout} {<time>} - quota translator specific operations
 5 | # volume inode-quota <VOLNAME> enable - quota translator specific operations
 6 | from utils import auth, gluster_cmd_to_http_response
 7 | from gluster.cli import volume
 8 | from flask import Blueprint
 9 | 
10 | quota_api = Blueprint('quota_api', __name__)
11 | 
12 | 
13 | @quota_api.route("/<name>/inode-quota", methods=["POST"])
14 | @auth
15 | def api_volume_inode_quota_enable(name):
16 |     return gluster_cmd_to_http_response(volume.quota.inode_quota_enable, name)
17 | 
18 | 
19 | @quota_api.route("/<name>/quota", methods=["POST"])
20 | @auth
21 | def api_volume_quota_enable(name):
22 |     return gluster_cmd_to_http_response(volume.quota.enable, name)
23 | 
24 | 
25 | @quota_api.route("/<name>/quota", methods=["DELETE"])
26 | @auth
27 | def api_volume_quota_disable(name):
28 |     return gluster_cmd_to_http_response(volume.quota.disable, name)
29 | 
30 | 
31 | @quota_api.route("/<name>/quota/limit-usage", methods=["POST"])
32 | @auth
33 | def api_volume_inode_quota_limit_usage(name):
34 |     return gluster_cmd_to_http_response(volume.quota.inode_quota_enable, name)
35 | 


--------------------------------------------------------------------------------
/autogen.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/sh
 2 | 
 3 | echo
 4 | echo ... Gluster REST APIs autogen ...
 5 | echo
 6 | 
 7 | ## Check all dependencies are present
 8 | MISSING=""
 9 | 
10 | # Check for aclocal
11 | env aclocal --version > /dev/null 2>&1
12 | if [ $? -eq 0 ]; then
13 |   ACLOCAL=aclocal
14 | else
15 |   MISSING="$MISSING aclocal"
16 | fi
17 | 
18 | # Check for autoconf
19 | env autoconf --version > /dev/null 2>&1
20 | if [ $? -eq 0 ]; then
21 |   AUTOCONF=autoconf
22 | else
23 |   MISSING="$MISSING autoconf"
24 | fi
25 | 
26 | # Check for automake
27 | env automake --version > /dev/null 2>&1
28 | if [ $? -eq 0 ]; then
29 |   AUTOMAKE=automake
30 | else
31 |   MISSING="$MISSING automake"
32 | fi
33 | 
34 | # Check for tar
35 | env tar -cf /dev/null /dev/null > /dev/null 2>&1
36 | if [ $? -ne 0 ]; then
37 |   MISSING="$MISSING tar"
38 | fi
39 | 
40 | ## If dependencies are missing, warn the user and abort
41 | if [ "x$MISSING" != "x" ]; then
42 |   echo "Aborting."
43 |   echo
44 |   echo "The following build tools are missing:"
45 |   echo
46 |   for pkg in $MISSING; do
47 |     echo "  * $pkg"
48 |   done
49 |   echo
50 |   echo "Please install them and try again."
51 |   echo
52 |   exit 1
53 | fi
54 | 
55 | ## Do the autogeneration
56 | echo Running ${ACLOCAL}...
57 | $ACLOCAL
58 | echo Running ${AUTOCONF}...
59 | $AUTOCONF
60 | echo Running ${AUTOMAKE}...
61 | $AUTOMAKE --add-missing --force-missing --copy --foreign
62 | 
63 | # Instruct user on next steps
64 | echo
65 | echo "Please proceed with configuring, compiling, and installing."
66 | 


--------------------------------------------------------------------------------
/src/main.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | #
 3 | #  Copyright (c) 2016 Red Hat, Inc. <http://www.redhat.com>
 4 | #  This file is part of GlusterFS.
 5 | #
 6 | #  This file is licensed to you under your choice of the GNU Lesser
 7 | #  General Public License, version 3 or any later version (LGPLv3 or
 8 | #  later), or the GNU General Public License, version 2 (GPLv2), in all
 9 | #  cases as published by the Free Software Foundation.
10 | #
11 | from argparse import ArgumentParser, RawDescriptionHelpFormatter
12 | 
13 | from flask import Flask, redirect
14 | from gluster.cli import set_gluster_path
15 | 
16 | from api_volume import volume_api
17 | from api_peer import peer_api
18 | from api_georep import georep_api
19 | from utils import http_response_error
20 | from conf import VERSION
21 | 
22 | app = Flask(__name__)
23 | 
24 | 
25 | app.register_blueprint(volume_api, url_prefix=VERSION + "/volumes")
26 | app.register_blueprint(peer_api, url_prefix=VERSION + "/peers")
27 | app.register_blueprint(georep_api, url_prefix=VERSION + "/georep")
28 | 
29 | 
30 | @app.errorhandler(404)
31 | def page_not_found(e):
32 |     return http_response_error("Not Found", status=404)
33 | 
34 | 
35 | @app.route("/doc")
36 | def doc():
37 |     return ""
38 | 
39 | 
40 | @app.route("/")
41 | def home():
42 |     return redirect(VERSION + "/doc", code=302)
43 | 
44 | 
45 | def main():
46 |     parser = ArgumentParser(formatter_class=RawDescriptionHelpFormatter,
47 |                             description=__doc__)
48 |     parser.add_argument("--port", type=int, help="Port", default=9000)
49 |     parser.add_argument("--debug", help="Run Server in debug mode",
50 |                         action="store_true")
51 |     parser.add_argument("--gluster-path", help="Path of gluster Command")
52 |     args = parser.parse_args()
53 | 
54 |     if args.gluster_path:
55 |         set_gluster_path(args.gluster_path)
56 | 
57 |     if args.debug:
58 |         app.debug = True
59 | 
60 |     app.run(host="0.0.0.0", port=args.port)
61 | 
62 | 
63 | if __name__ == "__main__":
64 |     main()
65 | 


--------------------------------------------------------------------------------
/src/api_georep.py:
--------------------------------------------------------------------------------
 1 | from utils import auth
 2 | from flask import Blueprint
 3 | 
 4 | georep_api = Blueprint('georep_api', __name__)
 5 | 
 6 | 
 7 | @georep_api.route("/<mastervol>/<slaveuser>/<slavehost>/<slavevol>",
 8 |                   methods=["PUT"])
 9 | @auth
10 | def api_georep_create(mastervol, slaveuser, slavehost, slavevol):
11 |     pass
12 | 
13 | 
14 | @georep_api.route("/<mastervol>/<slaveuser>/<slavehost>/<slavevol>/start",
15 |                   methods=["POST"])
16 | @auth
17 | def api_georep_start(mastervol, slaveuser, slavehost, slavevol):
18 |     pass
19 | 
20 | 
21 | @georep_api.route("/<mastervol>/<slaveuser>/<slavehost>/<slavevol>/stop",
22 |                   methods=["POST"])
23 | @auth
24 | def api_georep_stop(mastervol, slaveuser, slavehost, slavevol):
25 |     pass
26 | 
27 | 
28 | @georep_api.route("/<mastervol>/<slaveuser>/<slavehost>/<slavevol>",
29 |                   methods=["DELETE"])
30 | @auth
31 | def api_georep_delete(mastervol, slaveuser, slavehost, slavevol):
32 |     pass
33 | 
34 | 
35 | @georep_api.route("/<mastervol>/<slaveuser>/<slavehost>/<slavevol>/config",
36 |                   methods=["GET"])
37 | @auth
38 | def api_georep_config_get(mastervol, slaveuser, slavehost, slavevol):
39 |     pass
40 | 
41 | 
42 | @georep_api.route("/<mastervol>/<slaveuser>/<slavehost>/<slavevol>/config",
43 |                   methods=["POST"])
44 | @auth
45 | def api_georep_config_set(mastervol, slaveuser, slavehost, slavevol):
46 |     pass
47 | 
48 | 
49 | @georep_api.route("/<mastervol>/<slaveuser>/<slavehost>/<slavevol>/config",
50 |                   methods=["DELETE"])
51 | @auth
52 | def api_georep_config_reset(mastervol, slaveuser, slavehost, slavevol):
53 |     pass
54 | 
55 | 
56 | # Multiple routes will go to same function, Status can be fetched with or
57 | # without Volume names
58 | @georep_api.route("", methods=["GET"])
59 | @georep_api.route("/<mastervol>", methods=["GET"])
60 | @georep_api.route("/<mastervol>/<slaveuser>/<slavehost>/<slavevol>",
61 |                   methods=["GET"])
62 | @auth
63 | def api_georep_status(mastervol=None, slaveuser=None, slavehost=None,
64 |                       slavevol=None):
65 |     pass
66 | 
67 | 
68 | @georep_api.route("/<mastervol>/<slaveuser>/<slavehost>/<slavevol>/checkpoint",
69 |                   methods=["POST"])
70 | @auth
71 | def api_checkpoint_set(mastervol, slaveuser, slavehost, slavevol):
72 |     pass
73 | 
74 | 
75 | @georep_api.route("/<mastervol>/<slaveuser>/<slavehost>/<slavevol>/checkpoint",
76 |                   methods=["GET"])
77 | @auth
78 | def api_checkpoint_get(mastervol, slaveuser, slavehost, slavevol):
79 |     pass
80 | 
81 | 
82 | @georep_api.route("/<mastervol>/<slaveuser>/<slavehost>/<slavevol>/checkpoint",
83 |                   methods=["DELETE"])
84 | @auth
85 | def api_checkpoint_del(mastervol, slaveuser, slavehost, slavevol):
86 |     pass
87 | 
88 | 
89 | # Pause
90 | # Resume
91 | 


--------------------------------------------------------------------------------
/configure.ac:
--------------------------------------------------------------------------------
 1 | AC_INIT([Hello World], [0.1])
 2 | 
 3 | AM_INIT_AUTOMAKE
 4 | AM_PATH_PYTHON([2.6])
 5 | AC_CANONICAL_HOST
 6 | 
 7 | VERSION=0.1.0
 8 | 
 9 | dnl systemddir and flag
10 | AC_ARG_WITH(systemddir,
11 |             [  --with-systemddir=DIR systemd service files in DIR @<:@PREFIX/lib/systemd/system@:>@],
12 |             [systemddir=$withval],
13 |             [systemddir='${prefix}/lib/systemd/system'])
14 | AC_SUBST(systemddir)
15 | AM_CONDITIONAL([USE_SYSTEMD], test [ -d '/usr/lib/systemd/system' ])
16 | 
17 | dnl Init dir
18 | AC_ARG_WITH(initdir,
19 |             [  --with-initdir=DIR init.d scripts in DIR @<:@/etc/init.d@:>@],
20 |             [initdir=$withval],
21 |             [initdir='/etc/init.d'])
22 | AC_SUBST(initdir)
23 | 
24 | dnl Gluster Libexecdir Path
25 | AC_ARG_WITH(gluster_libexecdir,
26 |             [  --with-gluster-libexecdir=DIR Gluster Libexec @<:@PREFIX/libexec/glusterfs@:>@],
27 |             [gluster_libexecdir=$withval],
28 |             [gluster_libexecdir='${prefix}/libexec/glusterfs'])
29 | AC_SUBST(gluster_libexecdir)
30 | 
31 | dnl Glusterd workdir Path
32 | AC_ARG_WITH(glusterd_workdir,
33 |             [  --with-glusterd-workdir=DIR Glusterd Workdir @<:@/var/lib/glusterd@:>@],
34 |             [glusterd_workdir=$withval],
35 |             [glusterd_workdir='/var/lib/glusterd'])
36 | AC_SUBST(glusterd_workdir)
37 | 
38 | # Default value for sbindir
39 | prefix_temp=$prefix
40 | exec_prefix_temp=$exec_prefix
41 |  
42 | test "${prefix}" = "NONE" && prefix="${ac_default_prefix}"
43 | test "${exec_prefix}" = "NONE" && exec_prefix='${prefix}'
44 | 
45 | # Initial Value is $exec_prefix/sbin
46 | sbintemp="${sbindir}"
47 | 
48 | # Expands to $prefix/sbin
49 | eval sbintemp=\"${sbintemp}\"
50 | # Expands to /usr/local/sbin or /usr/sbin if --prefix is passed
51 | eval sbintemp=\"${sbintemp}\"
52 | SBINDIR=${sbintemp}
53 | 
54 | sysconfdirtemp="${sysconfdir}"
55 | eval sysconfdirtemp=\"${sysconfdirtemp}\"
56 | SYSCONF_DIR=${sysconfdirtemp}
57 | 
58 | gluster_libexecdirtemp="${gluster_libexecdir}"
59 | eval gluster_libexecdirtemp=\"${gluster_libexecdirtemp}\"
60 | GLUSTER_LIBEXECDIR=${gluster_libexecdirtemp}
61 | 
62 | prefix=$prefix_temp
63 | exec_prefix=$exec_prefix_temp
64 | 
65 | AC_SUBST(SBINDIR)
66 | AC_SUBST(VERSION)
67 | AC_SUBST(SYSCONF_DIR)
68 | AC_SUBST(GLUSTER_LIBEXECDIR)
69 | 
70 | GF_DISTRIBUTION=
71 | AC_CHECK_FILE([/etc/debian_version])
72 | AC_CHECK_FILE([/etc/redhat-release])
73 | 
74 | if test "x$ac_cv_file__etc_debian_version" = "xyes"; then
75 |    GF_DISTRIBUTION=Debian
76 | fi
77 | if test "x$ac_cv_file__etc_redhat_release" = "xyes"; then
78 |    GF_DISTRIBUTION=Redhat
79 | fi
80 | case $host_os in
81 |      *freebsd*)
82 |      GF_DISTRIBUTION=FreeBSD
83 | esac
84 | 
85 | AC_SUBST(GF_DISTRIBUTION)
86 | 
87 | 
88 | AC_CONFIG_FILES([Makefile
89 |                  src/Makefile
90 |                  extras/Makefile
91 |                  src/conf.py
92 |                  src/gunicorn_config.py
93 |                  extras/glusterrestd.service
94 |                  extras/glusterrestd-FreeBSD
95 |                  extras/glusterrestd-RedHat])
96 |  
97 | AC_OUTPUT
98 | 


--------------------------------------------------------------------------------
/extras/glusterrestd-RedHat.in:
--------------------------------------------------------------------------------
  1 | #!/bin/bash
  2 | #
  3 | # glusterrestd   Startup script for the glusterfs REST APIs server
  4 | #
  5 | # chkconfig:   - 20 80
  6 | # description: Gluster REST APIs Server
  7 | 
  8 | ### BEGIN INIT INFO
  9 | # Provides: glusterrestd
 10 | # Required-Start: $local_fs $network
 11 | # Required-Stop: $local_fs $network
 12 | # Should-Start:
 13 | # Should-Stop:
 14 | # Default-Start: 2 3 4 5
 15 | # Default-Stop: 0 1 6
 16 | # Short-Description: glusterfs REST APIs server
 17 | # Description:       GlusterFS REST APIs Server
 18 | ### END INIT INFO
 19 | #
 20 | 
 21 | # Source function library.
 22 | . /etc/rc.d/init.d/functions
 23 | 
 24 | BASE=glusterrestd
 25 | 
 26 | # Fedora File System Layout dictates /run
 27 | [ -e /run ] && RUNDIR="/run"
 28 | PIDFILE="${RUNDIR:-/var/run}/${BASE}.pid"
 29 | 
 30 | PID=`test -f $PIDFILE && cat $PIDFILE`
 31 | 
 32 | GLUSTERRESTD_BIN=/usr/bin/gunicorn
 33 | GLUSTERRESTD_OPTS="-D -c @SYSCONF_DIR@/glusterrest/gunicorn_config.py main:app --pid $PIDFILE --chdir @GLUSTER_LIBEXECDIR@/glusterrest/"
 34 | GLUSTERRESTD="$GLUSTERRESTD_BIN $GLUSTERRESTD_OPTS"
 35 | RETVAL=0
 36 | 
 37 | LOCKFILE=/var/lock/subsys/${BASE}
 38 | 
 39 | # Start the service $BASE
 40 | start()
 41 | {
 42 |        if pidofproc -p $PIDFILE $GLUSTERRESTD_BIN &> /dev/null; then
 43 |            echo "glusterrestd service is already running with pid $PID"
 44 |            return 0
 45 |        else
 46 |            echo -n $"Starting $BASE:"
 47 |            daemon $GLUSTERRESTD &
 48 |            RETVAL=$?
 49 |            echo
 50 |            [ $RETVAL -eq 0 ] && touch $LOCKFILE
 51 |            return $RETVAL
 52 |        fi
 53 | }
 54 | 
 55 | # Stop the service $BASE
 56 | stop()
 57 | {
 58 |     echo -n $"Stopping $BASE:"
 59 |     if pidofproc -p $PIDFILE $GLUSTERRESTD_BIN &> /dev/null; then
 60 |         killproc -p $PIDFILE $BASE
 61 |     else
 62 |         killproc $BASE
 63 |     fi
 64 |     RETVAL=$?
 65 |     echo
 66 |     [ $RETVAL -eq 0 ] && rm -f $LOCKFILE
 67 |     return $RETVAL
 68 | }
 69 | 
 70 | restart()
 71 | {
 72 |     stop
 73 |     start
 74 | }
 75 | 
 76 | reload()
 77 | {
 78 |     echo -n $"Reloading $prog: "
 79 |     killproc -p ${PIDFILE} ${BASE} -HUP
 80 |     RETVAL=$?
 81 |     echo
 82 | }
 83 | 
 84 | force_reload()
 85 | {
 86 |     restart
 87 | }
 88 | 
 89 | rh_status()
 90 | {
 91 |     status $BASE
 92 | }
 93 | 
 94 | rh_status_q()
 95 | {
 96 |     rh_status &>/dev/null
 97 | }
 98 | 
 99 | 
100 | ### service arguments ###
101 | case $1 in
102 |     start)
103 |         rh_status_q && exit 0
104 |         $1
105 |         ;;
106 |     stop)
107 |         rh_status_q || exit 0
108 |         $1
109 |         ;;
110 |     restart)
111 |         $1
112 |         ;;
113 |     reload)
114 |         rh_status_q || exit 7
115 |         $1
116 |         ;;
117 |     force-reload)
118 |         force_reload
119 |         ;;
120 |     status)
121 |         rh_status
122 |         ;;
123 |     condrestart|try-restart)
124 |         rh_status_q || exit 0
125 |         restart
126 |         ;;
127 |     *)
128 |         echo $"Usage: $0 {start|stop|status|restart|condrestart|try-restart|reload|force-reload}"
129 |         exit 1
130 | esac
131 | 
132 | exit $?
133 | 


--------------------------------------------------------------------------------
/src/api_volume.py:
--------------------------------------------------------------------------------
  1 | # -*- coding: utf-8 -*-
  2 | #
  3 | #  Copyright (c) 2016 Red Hat, Inc. <http://www.redhat.com>
  4 | #  This file is part of GlusterFS.
  5 | #
  6 | #  This file is licensed to you under your choice of the GNU Lesser
  7 | #  General Public License, version 3 or any later version (LGPLv3 or
  8 | #  later), or the GNU General Public License, version 2 (GPLv2), in all
  9 | #  cases as published by the Free Software Foundation.
 10 | #
 11 | 
 12 | from utils import auth, gluster_cmd_to_http_response, boolify
 13 | from gluster.cli import volume
 14 | from flask import Blueprint, request
 15 | 
 16 | volume_api = Blueprint('volume_api', __name__)
 17 | 
 18 | 
 19 | def validate_volume_create_options(data):
 20 |     # def create(volname, bricks, replica=0, stripe=0, arbiter=0, disperse=0,
 21 |     #        disperse_data=0, redundancy=0, transport="tcp", force=False):
 22 |     # for k in data.keys():
 23 |     #     if k not in ["bricks", "replica", "stripe",
 24 |     #                  "arbiter", "disperse", "disperse_data",
 25 |     #                  "redundancy", "transport", "force"]:
 26 | 
 27 |     pass
 28 | 
 29 | 
 30 | @volume_api.route("/<name>", methods=["PUT"])
 31 | @auth
 32 | def api_volume_create(name):
 33 |     data = request.get_json()
 34 |     validate_volume_create_options(data)
 35 |     bricks = data.get("bricks")
 36 |     del data["bricks"]
 37 |     return gluster_cmd_to_http_response(volume.create, name, bricks, **data)
 38 | 
 39 | 
 40 | @volume_api.route("/<name>/start", methods=["POST"])
 41 | @auth
 42 | def api_volume_start(name):
 43 |     force = boolify(request.form.get("force", "0"))
 44 |     return gluster_cmd_to_http_response(volume.start, name, force=force)
 45 | 
 46 | 
 47 | @volume_api.route("/<name>/stop", methods=["POST"])
 48 | @auth
 49 | def api_volume_stop(name):
 50 |     force = boolify(request.form.get("force", "0"))
 51 |     return gluster_cmd_to_http_response(volume.stop, name, force=force)
 52 | 
 53 | 
 54 | @volume_api.route("/<name>", methods=["DELETE"])
 55 | @auth
 56 | def api_volume_delete(name):
 57 |     force = boolify(request.form.get("force", "0"))
 58 |     return gluster_cmd_to_http_response(volume.stop, name, force=force)
 59 | 
 60 | 
 61 | @volume_api.route("/<name>", methods=["GET"])
 62 | @volume_api.route("", methods=["GET"])
 63 | @auth
 64 | def api_volume_get(name=None):
 65 |     status = boolify(request.args.get("status", "0"))
 66 |     if status:
 67 |         return gluster_cmd_to_http_response(volume.status_detail, name)
 68 |     else:
 69 |         return gluster_cmd_to_http_response(volume.info, name)
 70 | 
 71 | 
 72 | @volume_api.route("/<name>/options", methods=["GET"])
 73 | @auth
 74 | def api_volume_options_get(name):
 75 |     opt = boolify(request.args.get("option", "all"))
 76 |     return gluster_cmd_to_http_response(volume.optget, name, opt)
 77 | 
 78 | 
 79 | @volume_api.route("/<name>/options", methods=["POST"])
 80 | @auth
 81 | def api_volume_options_set(name):
 82 |     opts = request.get_json()
 83 |     return gluster_cmd_to_http_response(volume.optset, name, opts)
 84 | 
 85 | 
 86 | @volume_api.route("/<name>/options", methods=["DELETE"])
 87 | @auth
 88 | def api_volume_options_reset(name):
 89 |     data = request.get_json()
 90 |     return gluster_cmd_to_http_response(volume.optreset, name,
 91 |                                         data["option"], data["force"])
 92 | 
 93 | 
 94 | @volume_api.route("/<name>/rebalance/start", methods=["POST"])
 95 | @auth
 96 | def api_volume_rebalance_start(name):
 97 |     data = request.get_json()
 98 |     if data.get("fixed-layout", False):
 99 |         return gluster_cmd_to_http_response(volume.rebalance.fix_layout_start,
100 |                                             name)
101 |     else:
102 |         return gluster_cmd_to_http_response(volume.rebalance.start,
103 |                                             name,
104 |                                             force=data.get("force", False))
105 | 
106 | 
107 | @volume_api.route("/<name>/rebalance/stop", methods=["POST"])
108 | @auth
109 | def api_volume_rebalance_stop(name):
110 |     return gluster_cmd_to_http_response(volume.rebalance.stop, name)
111 | 
112 | 
113 | @volume_api.route("/<name>/rebalance", methods=["GET"])
114 | @auth
115 | def api_volume_rebalance_status(name):
116 |     return gluster_cmd_to_http_response(volume.rebalance.status, name)
117 | 
118 | 
119 | @volume_api.route("/<name>/barrier", methods=["POST"])
120 | @auth
121 | def api_volume_barrier_enable(name):
122 |     return gluster_cmd_to_http_response(volume.barrier_enable, name)
123 | 
124 | 
125 | @volume_api.route("/<name>/barrier", methods=["DELETE"])
126 | @auth
127 | def api_volume_barrier_disable(name):
128 |     return gluster_cmd_to_http_response(volume.barrier_disable, name)
129 | 


--------------------------------------------------------------------------------
/Design.md:
--------------------------------------------------------------------------------
  1 | # Management REST API Server for Gluster
  2 | 
  3 | This project is aimed to provide RESTful interface for Gluster
  4 | Management activities like Volume Create, Start, Stop
  5 | etc by exposing Gluster CLI commands via REST.
  6 | 
  7 | REST services will be run in all nodes of Cluster, applications can
  8 | send HTTP call to any node of Cluster. Applications can
  9 | communicate easily with Gluster Cluster using REST API instead of
 10 | running Gluster commands via `ssh` or having agents in each node.
 11 | 
 12 | Note: Native REST interface will be available with Glusterd 2.0.
 13 | 
 14 | ## Installation
 15 | 
 16 | This project depends on glustercli-python, Install using
 17 | 
 18 |     pip install glustercli
 19 | 
 20 | Clone the repo and install using,
 21 | 
 22 |     ./autogen.sh
 23 |     ./configure
 24 |     make install
 25 | 
 26 | Usage
 27 | -----
 28 | Enable and Start glusterrestd service in all Gluster nodes using,
 29 | 
 30 |     systemctl enable glusterrestd
 31 |     systemctl start glusterrestd
 32 | 
 33 | Status can be checked using `gluster-restapi status`.
 34 | 
 35 | Register your application using,
 36 | 
 37 |     gluster-restapi app-add <APP_ID> <SECRET>
 38 | 
 39 | Application should sign all requests using this key, read more
 40 | about the signing process in "Authentication" section. This app secret
 41 | can be reset any time using
 42 | 
 43 |     gluster-restapi app-reset <APP_ID> <SECRET>
 44 | 
 45 | Application can be deleted using below command,
 46 | 
 47 |     gluster rest app-del <APP_ID>
 48 | 
 49 | ### Authentication
 50 | For POST and PUT requests, the request body must be JSON, with the
 51 | `Content-Type` header set to `application/json`
 52 | 
 53 | Authorization header must be included with every request. Auth header
 54 | should have following details
 55 | 
 56 |     Bearer <TOKEN>
 57 | 
 58 | Example,
 59 | 
 60 |     Authorization: "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9. \
 61 |         eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6ImdsdXN0ZXIiLCJhZG1 \
 62 |         pbiI6dHJ1ZX0.5jCURTbAZV0i5f_ux7PYFUzF-waCtYMM0LrF1Zl2hd0"
 63 | 
 64 | TOKEN is [JSON Web Token](http://jwt.io/) generated using following claims
 65 | 
 66 |     iss: Issuer(Application ID)
 67 |     iat: Issued Time
 68 |     exp: Expiry time
 69 |     qsh: SHA256 hash of resource identifier(Ex: SHA256("GET\n/v1/volumes")
 70 | 
 71 | qsh is custom claim used to protect against URL tampering. JWT
 72 | signature provides protection against man-in-the-middle modification
 73 | of claims, but the same token can be used of multiple URIs. qsh is
 74 | SHA256 hash calculated using HTTP Method, URI, Query params and
 75 | POST/PUT/DELETE data. qsh claim usage here is similar to
 76 | [Heketi](https://github.com/heketi/heketi) and
 77 | [Atlassian](https://developer.atlassian.com/blog/2015/01/understanding-jwt/)
 78 | projects.
 79 | 
 80 | For example, to calculate qsh for `GET /v1/volumes?status=1`
 81 | 
 82 |     string_to_hash = "GET\n/v1/volumes\nstatus=1"
 83 |     qsh = sha256(string_to_hash)
 84 | 
 85 | To calculate qsh for `POST /v1/volumes/gv1/start -d '{"force": true}'`
 86 | 
 87 |     post_data = '{"force": true}'
 88 |     string_to_hash = "POST\n/v1/volumes/gv1/start\n${post_data}"
 89 |     qsh = sha256(string_to_hash)
 90 | 
 91 | Following example shows generation of JWT and making REST call(using Python)
 92 | 
 93 |     import hashlib
 94 |     from datetime import datetime, timedelta
 95 | 
 96 |     import jwt
 97 |     import requests
 98 | 
 99 |     APP_ID = "myapp"
100 |     APP_SECRET = "myappsecret"
101 |     BASE_URL = "http://localhost:8080"
102 |     URL = "/v1/volumes"
103 | 
104 |     qsh_data = "GET\n" + URL
105 |     qsh = hashlib.sha256(qsh_data).hexdigest()
106 |     claims = {
107 |         "iss": APP_ID,
108 |         "qsh": qsh,
109 |         "iat": datetime.utcnow(),
110 |         "exp": datetime.utcnow() + timedelta(minutes=5)
111 |     }
112 |     token = jwt.encode(claims, APP_SECRET, algorithm='HS256')
113 |     headers = {
114 |         "Authorization": "Bearer {0}".format(token)
115 |     }
116 | 
117 |     volinfo = requests.get(BASE_URL + URL, headers=headers)
118 | 
119 | ### Consuming REST APIs
120 | Applications can persist the peers list(`GET /v1/peers`) of the
121 | Cluster. Application can connect to any node of Cluster and consume
122 | REST APIs, if a connected node goes down in Cluster, application can
123 | choose another node to make REST calls.
124 | 
125 | ### Configuration
126 | 
127 | REST server can be configured using `config` subcommand.
128 | 
129 |     gluster-restapi config-get [<NAME>]
130 |     gluster-restapi config-set <NAME> <VALUE>
131 |     gluster-restapi config-reset <NAME|all>
132 | 
133 | Available configurations,
134 | 
135 |     https enabled    # Enable https
136 |     port  443        # Port of REST Service
137 |     auth  enabled    # Enable Authentication
138 | 
139 | ## API Documentation
140 | -----------------
141 | Coming Soon
142 | 
143 | 
144 | ## Comments and Discussion
145 | [JWT Shared secret vs Shared Token](http://www.gluster.org/pipermail/gluster-devel/2016-March/048508.html)
146 | 


--------------------------------------------------------------------------------
/apis.yaml:
--------------------------------------------------------------------------------
  1 | # API - Peer Attach
  2 | - title: Peer Attach
  3 |   group: Peers
  4 |   id: peer-attach
  5 |   method: PUT
  6 |   url: /peers/:fqdn
  7 |   query_params:
  8 |     - name: fqdn
  9 |       type: String
 10 |       help: Host Name or IP
 11 |       required: True
 12 |   response:
 13 |     status: 201 Created
 14 |     out:
 15 |       error: String
 16 |       errno: Int
 17 |       output: String
 18 |   example_output:
 19 |     error: ""
 20 |     errno: 0
 21 |     output: ""
 22 | 
 23 | # API - Peer Detach
 24 | - title: Peer Detach
 25 |   group: Peers
 26 |   id: peer-detach
 27 |   method: DELETE
 28 |   url: /peers/:fqdn
 29 |   query_params:
 30 |     - name: fqdn
 31 |       type: String
 32 |       help: Host Name or IP
 33 |       required: True
 34 |   response:
 35 |     status: 204 No Content
 36 |     out:
 37 |       error: String
 38 |       errno: Int
 39 |       output: String
 40 |   example_output:
 41 |     error: ""
 42 |     errno: 0
 43 |     output: ""
 44 | 
 45 | # API - Peers List
 46 | - title: Peers List
 47 |   group: Peers
 48 |   id: peer-list
 49 |   method: GET
 50 |   url: /peers
 51 |   response:
 52 |     status: 200 OK
 53 |     out:
 54 |       error: String
 55 |       errno: Int
 56 |       output: PeersList
 57 |   example_output:
 58 |     error: ""
 59 |     errno: 0
 60 |     output: ""
 61 | 
 62 | - title: Create Volume
 63 |   group: Volumes
 64 |   id: volume-create
 65 |   method: PUT
 66 |   url: /volumes/:name
 67 |   query_params:
 68 |     - name: name
 69 |       type: String
 70 |       help: Volume Name
 71 |       required: True
 72 |   data_params:
 73 |     - name: bricks
 74 |       type: "[String]"
 75 |       help: Bricks
 76 |       required: True
 77 | 
 78 |     - name: replica
 79 |       type: Int
 80 |       required: False
 81 |       help: Replica Count
 82 |       default: 0
 83 |   response:
 84 |     status: 200 OK
 85 |     out:
 86 |       error: String
 87 |       errno: Int
 88 |       output: String
 89 |   example_output:
 90 |     error: ""
 91 |     errno: 0
 92 |     output: "volume create: gv1: success: please start the volume to access data"
 93 | 
 94 | - title: Start Volume
 95 |   group: Volumes
 96 |   id: volume-start
 97 |   method: POST
 98 |   url: /volumes/:name/start
 99 |   query_params:
100 |     - name: name
101 |       type: String
102 |       help: Volume Name
103 |       required: True
104 |   data_params:
105 |     - name: force
106 |       type: "Int"
107 |       help: Force Start the Volume
108 |       required: False
109 |       default: 0
110 |   response:
111 |     status: 200 OK
112 |     out:
113 |       error: String
114 |       errno: Int
115 |       output: String
116 |   example_output:
117 |     error: ""
118 |     errno: 0
119 |     output: ""
120 | 
121 | - title: Stop Volume
122 |   group: Volumes
123 |   id: volume-stop
124 |   method: POST
125 |   url: /volumes/:name/stop
126 |   query_params:
127 |     - name: name
128 |       type: String
129 |       help: Volume Name
130 |       required: True
131 |   data_params:
132 |     - name: force
133 |       type: "Int"
134 |       help: Force Stop the Volume
135 |       required: False
136 |       default: 0
137 |   response:
138 |     status: 200 OK
139 |     out:
140 |       error: String
141 |       errno: Int
142 |       output: String
143 |   example_output:
144 |     error: ""
145 |     errno: 0
146 |     output: ""
147 | 
148 | - title: Restart Volume
149 |   group: Volumes
150 |   id: volume-restart
151 |   method: POST
152 |   url: /volumes/:name/restart
153 |   query_params:
154 |     - name: name
155 |       type: String
156 |       help: Volume Name
157 |       required: True
158 |   data_params:
159 |     - name: force
160 |       type: Int
161 |       help: Force Restart the Volume
162 |       required: False
163 |       default: 0
164 |   response:
165 |     status: 200 OK
166 |     out:
167 |       error: String
168 |       errno: Int
169 |       output: String
170 |   example_output:
171 |     error: ""
172 |     errno: 0
173 |     output: ""    
174 | 
175 | - title: Get Volume Options
176 |   group: Volumes
177 |   id: volume-options-get
178 |   method: GET
179 |   url: /volumes/:name/options
180 |   query_params:
181 |     - name: name
182 |       type: String
183 |       help: Volume Name
184 |       required: True
185 | 
186 |     - name: option
187 |       type: String
188 |       help: Option Name
189 |       required: False
190 |   response:
191 |     status: 200 OK
192 |     out:
193 |       error: String
194 |       errno: Int
195 |       output: "[Options]"
196 |   example_output:
197 |     error: ""
198 |     errno: 0
199 |     output: ""
200 | 
201 | - title: Set Volume Options
202 |   group: Volumes
203 |   id: volume-options-set
204 |   method: POST
205 |   url: /volumes/:name/options
206 |   query_params:
207 |     - name: name
208 |       type: String
209 |       help: Volume Name
210 |       required: True
211 |   data_params:
212 |     - name: options
213 |       type: "[[String, String]]"
214 |       help: Options List
215 |       required: True
216 |   response:
217 |     status: 200 OK
218 |     out:
219 |       error: String
220 |       errno: Int
221 |       output: String
222 |   example_output:
223 |     error: ""
224 |     errno: 0
225 |     output: ""
226 | 
227 | - title: Reset Volume Options
228 |   group: Volumes
229 |   id: volume-options-reset
230 |   method: DELETE
231 |   url: /volumes/:name/options
232 |   query_params:
233 |     - name: name
234 |       type: String
235 |       help: Volume Name
236 |       required: True
237 |   data_params:
238 |     - name: option
239 |       type: String
240 |       help: Option Name
241 |       required: True
242 |   response:
243 |     status: 200 OK
244 |     out:
245 |       error: String
246 |       errno: Int
247 |       output: String
248 |   example_output:
249 |     error: ""
250 |     errno: 0
251 |     output: ""
252 | 
253 | - title: Delete Volume
254 |   group: Volumes
255 |   id: volume-delete
256 |   method: DELETE
257 |   url: /volumes/:name
258 |   query_params:
259 |     - name: name
260 |       type: String
261 |       help: Volume Name
262 |       required: True
263 |   response:
264 |     status: 204 No Content
265 |     out:
266 |       error: String
267 |       errno: Int
268 |       output: String
269 |   example_output:
270 |     error: ""
271 |     errno: 0
272 |     output: ""


--------------------------------------------------------------------------------
/src/utils.py:
--------------------------------------------------------------------------------
  1 | # -*- coding: utf-8 -*-
  2 | #
  3 | #  Copyright (c) 2016 Red Hat, Inc. <http://www.redhat.com>
  4 | #  This file is part of GlusterFS.
  5 | #
  6 | #  This file is licensed to you under your choice of the GNU Lesser
  7 | #  General Public License, version 3 or any later version (LGPLv3 or
  8 | #  later), or the GNU General Public License, version 2 (GPLv2), in all
  9 | #  cases as published by the Free Software Foundation.
 10 | #
 11 | 
 12 | import json
 13 | from functools import wraps
 14 | import os
 15 | import logging
 16 | import fcntl
 17 | 
 18 | import jwt
 19 | from flask import request
 20 | from gluster.cli import GlusterCmdException
 21 | 
 22 | from conf import (DEFAULT_CONFIG_FILE,
 23 |                   CUSTOM_CONFIG_FILE,
 24 |                   APPS_FILE)
 25 | 
 26 | _config = {}
 27 | _log_level = {}
 28 | 
 29 | REQUIRED_CLAIMS = ["iss", "iat", "exp", "qsh"]
 30 | DEFAULT_CONTENT_TYPE = {"Content-Type": "application/json; charset=utf-8"}
 31 | 
 32 | 
 33 | # Init Logger instance
 34 | logger = logging.getLogger(__name__)
 35 | 
 36 | 
 37 | def boolify(inp):
 38 |     if inp in ["1", "True", "true", "Yes", "yes"]:
 39 |         return True
 40 |     return False
 41 | 
 42 | 
 43 | def http_response_error(err, status=401):
 44 |     out = {"error": err, "errno": -1, "output": ""}
 45 |     return (json.dumps(out),
 46 |             status,
 47 |             DEFAULT_CONTENT_TYPE)
 48 | 
 49 | 
 50 | def get_config(item, default_value=None):
 51 |     if not _config:
 52 |         load_config()
 53 |     return _config.get(item, default_value)
 54 | 
 55 | 
 56 | def load_config():
 57 |     """
 58 |     Load/Reload the config from REST Config files. This function will
 59 |     be triggered during init and when SIGUSR2.
 60 |     """
 61 |     global _config
 62 |     _config = {}
 63 |     if os.path.exists(DEFAULT_CONFIG_FILE):
 64 |         _config = json.load(open(DEFAULT_CONFIG_FILE))
 65 |     if os.path.exists(CUSTOM_CONFIG_FILE):
 66 |         _config.update(json.load(open(CUSTOM_CONFIG_FILE)))
 67 | 
 68 | 
 69 | def load_log_level():
 70 |     """
 71 |     Reads log_level from Config file and sets accordingly. This function will
 72 |     be triggered during init and when SIGUSR2.
 73 |     """
 74 |     global logger, _log_level
 75 |     new_log_level = _config.get("log_level", "INFO")
 76 |     if _log_level != new_log_level:
 77 |         logger.setLevel(getattr(logging, new_log_level.upper()))
 78 |         _log_level = new_log_level.upper()
 79 | 
 80 | 
 81 | def load_all():
 82 |     load_config()
 83 |     load_log_level()
 84 | 
 85 | 
 86 | def get_qsh(method, path, args):
 87 |     pass
 88 | 
 89 | 
 90 | def get_app_secret(iss):
 91 |     if not os.path.exists(APPS_FILE):
 92 |         return None
 93 | 
 94 |     with open(APPS_FILE) as f:
 95 |         apps = json.load(f)
 96 |         data = apps.get(iss, None)
 97 | 
 98 |     return data
 99 | 
100 | 
101 | def auth(func):
102 |     @wraps(func)
103 |     def wrapper(*args, **kwargs):
104 |         if not _config.get("auth-enabled"):
105 |             return func(*args, **kwargs)
106 | 
107 |         # Collect Authorization header, validate if format is different
108 |         # than "Bearer <TOKEN>"
109 |         auth_header = request.headers.get("Authorization", "").strip()
110 |         auth_header_parts = ["", ""]
111 |         if auth_header != "":
112 |             auth_header_parts = auth_header.split(" ")
113 |             if len(auth_header_parts) != 2 or \
114 |                auth_header_parts[0].lower() != "bearer":
115 |                 return http_response_error(
116 |                     "Authorization header format must be Bearer <TOKEN>",
117 |                     status=401)
118 | 
119 |         try:
120 |             payload_data = jwt.decode(auth_header_parts[1], verify=False)
121 |         except jwt.DecodeError:
122 |             return http_response_error("Invalid Token", status=401)
123 | 
124 |         # Check for required claims
125 |         for claim_name in REQUIRED_CLAIMS:
126 |             if payload_data.get(claim_name, None) is not None:
127 |                 return http_response_error(
128 |                     "Token missing {0} Claim".format(claim_name),
129 |                     status=401)
130 | 
131 |         # Claims["qsh"] is SHA256 hash generated by Client, this will
132 |         # change wrt URL,Method and parameters. Generate qsh by using
133 |         # User inputs, this will be compared with Claims["qsh"]
134 |         qsh = get_qsh(request.method, request.path, request.args)
135 | 
136 |         if qsh != payload_data.get("qsh"):
137 |             return http_response_error(
138 |                 "Invalid qsh claim in token",
139 |                 status=401)
140 | 
141 |         try:
142 |             app_secret = get_app_secret(payload_data.get("iss"))
143 |             if app_secret is None:
144 |                 return http_response_error("Invalid App Id", status=401)
145 | 
146 |             jwt.decode(auth_header_parts[1], key=app_secret)
147 |         except jwt.ExpiredSignatureError:
148 |             return http_response_error("Expired Token", status=401)
149 |         except jwt.DecodeError:
150 |             return http_response_error("Invalid Token", status=401)
151 |             pass
152 | 
153 |         # All Success, Call the actual Function
154 |         return func(*args, **kwargs)
155 | 
156 |     return wrapper
157 | 
158 | 
159 | def gluster_cmd_to_http_response(func, *args, **kwargs):
160 |     out = {"output": "", "error": "", "errno": 0}
161 |     status_code = kwargs.get("success_status_code", 200)
162 |     try:
163 |         out["output"] = func(*args, **kwargs)
164 |     except GlusterCmdException as e:
165 |         # e.message is a tuple, contains (rc, out, err)
166 |         out["errno"] = e.message[0]
167 |         out["error"] = e.message[2]
168 |         status_code = 500
169 | 
170 |     return (json.dumps(out),
171 |             status_code,
172 |             DEFAULT_CONTENT_TYPE)
173 | 
174 | 
175 | class LockedOpen(object):
176 | 
177 |     def __init__(self, filename, *args, **kwargs):
178 |         self.filename = filename
179 |         self.open_args = args
180 |         self.open_kwargs = kwargs
181 |         self.fileobj = None
182 | 
183 |     def __enter__(self):
184 |         """
185 |         If two processes compete to update a file, The first process
186 |         gets the lock and the second process is blocked in the fcntl.flock()
187 |         call. When first process replaces the file and releases the lock,
188 |         the already open file descriptor in the second process now points
189 |         to a  "ghost" file(not reachable by any path name) with old contents.
190 |         To avoid that conflict, check the fd already opened is same or
191 |         not. Open new one if not same
192 |         """
193 |         f = open(self.filename, *self.open_args, **self.open_kwargs)
194 |         while True:
195 |             fcntl.flock(f, fcntl.LOCK_EX)
196 |             fnew = open(self.filename, *self.open_args, **self.open_kwargs)
197 |             if os.path.sameopenfile(f.fileno(), fnew.fileno()):
198 |                 fnew.close()
199 |                 break
200 |             else:
201 |                 f.close()
202 |                 f = fnew
203 |         self.fileobj = f
204 |         return f
205 | 
206 |     def __exit__(self, _exc_type, _exc_value, _traceback):
207 |         self.fileobj.close()
208 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | ## Installation
  2 | 
  3 | This project depends on `glustercli-python`. Install `glustercli-python` using,
  4 | 
  5 |     git clone https://github.com/gluster/glustercli-python.git
  6 |     cd glustercli-python
  7 |     python setup.py install
  8 | 
  9 | Install Gluster REST APIs using,
 10 | 
 11 |     git clone https://github.com/gluster/restapi.git
 12 |     cd restapi
 13 |     ./autogen.sh
 14 |     ./configure --with-systemddir=/usr/lib/systemd/system/ \
 15 |         --with-glusterd-workdir=/var/lib/glusterd \
 16 |         --with-gluster-libexecdir=/usr/libexec/glusterfs
 17 |     make
 18 |     make install
 19 |     
 20 | For systems which are not using systemd can pass
 21 | `--with-initdir=/etc/init.d` or `--with-initdir=/etc/rc.d` to install
 22 | service files.
 23 | 
 24 | ## Setup
 25 | 
 26 | Gluster REST Servers can be run in one or more nodes of Cluster
 27 | depending on the High availability requirement.
 28 | 
 29 | Enable and Start `glusterrest` service in all required peer nodes.
 30 | 
 31 | (Systemd)
 32 | 
 33 |     systemctl enable glusterrestd
 34 |     systemctl start glusterrestd
 35 | 
 36 | (SysVInit - CentOS 6)
 37 | 
 38 |     chkconfig glusterrestd on
 39 |     service glusterrestd start
 40 | 
 41 | (FreeBSD) Add the following in `/etc/rc.conf`
 42 | 
 43 | glusterrestd_enable="YES"
 44 | 
 45 | And start the glusterrestd using,
 46 | 
 47 |     service glusterrestd start
 48 | 
 49 | ## Status
 50 | 
 51 | Status Can be checked using,
 52 | 
 53 |     gluster-eventsapi status
 54 | 
 55 | Example output:
 56 | 
 57 |     +-----------+-------------+-----------------------+
 58 |     |    NODE   | NODE STATUS | GLUSTERRESTD STATUS   |
 59 |     +-----------+-------------+-----------------------+
 60 |     | localhost |          UP |                    UP |
 61 |     | node2     |          UP |                    UP |
 62 |     +-----------+-------------+-----------------------+
 63 | 
 64 | ## Configuration
 65 | 
 66 | View all configurations using,
 67 | 
 68 |     usage: gluster-restapi config-get [-h] [--name NAME]
 69 |      
 70 |     optional arguments:
 71 |       -h, --help   show this help message and exit
 72 |       --name NAME  Config Name
 73 | 
 74 | Example output:
 75 | 
 76 |     +--------------+-----------------------------+
 77 |     |         NAME | VALUE                       |
 78 |     +--------------+-----------------------------+
 79 |     |        https | False                       |
 80 |     |  num-workers | 2                           |
 81 |     |          key | /etc/glusterrest/server.key |
 82 |     | auth-enabled | True                        |
 83 |     |         port | 8080                        |
 84 |     |          csr | /etc/glusterrest/server.csr |
 85 |     +--------------+-----------------------------+
 86 | 
 87 | To change any configuration,
 88 | 
 89 |     usage: gluster-restapi config-set [-h] name value
 90 |      
 91 |     positional arguments:
 92 |       name        Config Name
 93 |       value       Config Value
 94 |      
 95 |     optional arguments:
 96 |       -h, --help  show this help message and exit
 97 | 
 98 | Example output,
 99 | 
100 |     +-----------+-------------+-------------+
101 |     |    NODE   | NODE STATUS | SYNC STATUS |
102 |     +-----------+-------------+-------------+
103 |     | localhost |          UP |          OK |
104 |     | node2     |          UP |          OK |
105 |     +-----------+-------------+-------------+
106 | 
107 | To Reset any configuration,
108 | 
109 |     usage: gluster-restapi config-reset [-h] name
110 |      
111 |     positional arguments:
112 |       name        Config Name or all
113 |      
114 |     optional arguments:
115 |       -h, --help  show this help message and exit
116 | 
117 | Example output,
118 | 
119 |     +-----------+-------------+-------------+
120 |     |    NODE   | NODE STATUS | SYNC STATUS |
121 |     +-----------+-------------+-------------+
122 |     | localhost |          UP |          OK |
123 |     | node2     |          UP |          OK |
124 |     +-----------+-------------+-------------+
125 | 
126 | **Note**: If any node status is not UP or sync status is not OK, make
127 |   sure to run `gluster-restapi sync` from a peer node.
128 | 
129 | ## Add node to the Cluster
130 | 
131 | When a new node added to the cluster,
132 | 
133 | - Enable and Start `glusterrestd` in the new node using the steps
134 |   mentioned above
135 | - Run `gluster-restapi sync` command from a peer node other than the
136 |   new node.
137 | 
138 | ## Applications
139 | 
140 | If Auth is enabled using, `gluster-restapi config-set auth-enabled
141 | true` then Application needs to be registered using `gluster-restapi
142 | app-add` command.
143 | 
144 | JSON Web Tokens are used for authenticating REST calls.
145 | 
146 | Add Application,
147 | 
148 |     usage: gluster-restapi app-add [-h] appid appsecret
149 |      
150 |     positional arguments:
151 |       appid       Application ID
152 |       appsecret   Application Secret
153 |      
154 |     optional arguments:
155 |       -h, --help  show this help message and exit
156 | 
157 | Reset Application Secret,
158 | 
159 |     usage: gluster-restapi app-reset [-h] appid appsecret
160 |      
161 |     positional arguments:
162 |       appid       Application ID
163 |       appsecret   Application Secret
164 |      
165 |     optional arguments:
166 |       -h, --help  show this help message and exit
167 | 
168 | Delete Application using,
169 | 
170 |     usage: gluster-restapi app-del [-h] appid
171 |      
172 |     positional arguments:
173 |       appid       Application ID
174 |      
175 |     optional arguments:
176 |       -h, --help  show this help message and exit
177 | 
178 | 
179 | Example,
180 | 
181 |     gluster-restapi app-add mywebapp mywebappsecret
182 | 
183 | ## Authentication
184 | 
185 | For POST and PUT requests, the request body must be JSON, with the
186 | `Content-Type` header set to `application/json`
187 | 
188 | Authorization header must be included with every request. Auth header
189 | should have following details
190 | 
191 |     Bearer <TOKEN>
192 | 
193 | Example,
194 | 
195 |     Authorization: "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9. \
196 |         eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6ImdsdXN0ZXIiLCJhZG1 \
197 |         pbiI6dHJ1ZX0.5jCURTbAZV0i5f_ux7PYFUzF-waCtYMM0LrF1Zl2hd0"
198 | 
199 | TOKEN is [JSON Web Token](http://jwt.io/) generated using following claims
200 | 
201 |     iss: Issuer(Application ID)
202 |     iat: Issued Time
203 |     exp: Expiry time
204 |     qsh: SHA256 hash of resource identifier(Ex: SHA256("GET\n/v1/volumes")
205 | 
206 | qsh is custom claim used to protect against URL tampering. JWT
207 | signature provides protection against man-in-the-middle modification
208 | of claims, but the same token can be used of multiple URIs. qsh is
209 | SHA256 hash calculated using HTTP Method, URI, Query params and
210 | POST/PUT/DELETE data. qsh claim usage here is similar to
211 | [Atlassian](https://developer.atlassian.com/blog/2015/01/understanding-jwt/)
212 | project.
213 | 
214 | For example, to calculate qsh for `GET /v1/volumes?status=1`
215 | 
216 |     string_to_hash = "GET\n/v1/volumes\nstatus=1"
217 |     qsh = sha256(string_to_hash)
218 | 
219 | To calculate qsh for `POST /v1/volumes/gv1/start -d '{"force": true}'`
220 | 
221 |     post_data = '{"force": true}'  # Sort By Keys
222 |     string_to_hash = "POST\n/v1/volumes/gv1/start\n${post_data}"
223 |     qsh = sha256(string_to_hash)
224 | 
225 | Following example shows generation of JWT and making REST call(using Python)
226 | 
227 |     import hashlib
228 |     from datetime import datetime, timedelta
229 | 
230 |     import jwt
231 |     import requests
232 | 
233 |     APP_ID = "mywebapp"
234 |     APP_SECRET = "mywebappsecret"
235 |     BASE_URL = "http://localhost:8080"
236 |     URL = "/v1/volumes"
237 | 
238 |     qsh_data = "GET\n" + URL
239 |     qsh = hashlib.sha256(qsh_data).hexdigest()
240 |     claims = {
241 |         "iss": APP_ID,
242 |         "qsh": qsh,
243 |         "iat": datetime.utcnow(),
244 |         "exp": datetime.utcnow() + timedelta(minutes=5)
245 |     }
246 |     token = jwt.encode(claims, APP_SECRET, algorithm='HS256')
247 |     headers = {
248 |         "Authorization": "Bearer {0}".format(token)
249 |     }
250 | 
251 |     volinfo = requests.get(BASE_URL + URL, headers=headers)
252 | 
253 | ## REST Client
254 | 
255 | TODO
256 | 


--------------------------------------------------------------------------------
/src/peer_restapi.py:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env python
  2 | # -*- coding: utf-8 -*-
  3 | #
  4 | #  Copyright (c) 2016 Red Hat, Inc. <http://www.redhat.com>
  5 | #  This file is part of GlusterFS.
  6 | #
  7 | #  This file is licensed to you under your choice of the GNU Lesser
  8 | #  General Public License, version 3 or any later version (LGPLv3 or
  9 | #  later), or the GNU General Public License, version 2 (GPLv2), in all
 10 | #  cases as published by the Free Software Foundation.
 11 | #
 12 | 
 13 | from __future__ import print_function
 14 | import os
 15 | import json
 16 | from errno import EEXIST
 17 | import fcntl
 18 | from errno import EACCES, EAGAIN
 19 | import signal
 20 | 
 21 | from prettytable import PrettyTable
 22 | 
 23 | from gluster.cliutils import (Cmd, node_output_ok, node_output_notok,
 24 |                               sync_file_to_peers, GlusterCmdException,
 25 |                               output_error, execute_in_peers, runcli)
 26 | 
 27 | from glusterrest.conf import APPS_FILE_TO_SYNC, APPS_FILE, \
 28 |     DEFAULT_CONFIG_FILE, CUSTOM_CONFIG_FILE, CUSTOM_CONFIG_FILE_TO_SYNC, \
 29 |     RESTD, CONFIG_KEYS, BOOL_CONFIGS, RESTART_CONFIGS, INT_CONFIGS, \
 30 |     PID_FILE
 31 | from glusterrest.utils import LockedOpen
 32 | 
 33 | 
 34 | def file_content_overwrite(fname, data):
 35 |     with open(fname + ".tmp", "w") as f:
 36 |         f.write(json.dumps(data))
 37 | 
 38 |     os.rename(fname + ".tmp", fname)
 39 | 
 40 | 
 41 | def create_custom_config_file_if_not_exists():
 42 |     mkdirp(os.path.dirname(CUSTOM_CONFIG_FILE))
 43 |     if not os.path.exists(CUSTOM_CONFIG_FILE):
 44 |         with open(CUSTOM_CONFIG_FILE, "w") as f:
 45 |             f.write("{}")
 46 | 
 47 | 
 48 | def create_apps_file_if_not_exists():
 49 |     mkdirp(os.path.dirname(APPS_FILE))
 50 |     if not os.path.exists(APPS_FILE):
 51 |         with open(APPS_FILE, "w") as f:
 52 |             f.write("{}")
 53 | 
 54 | 
 55 | def boolify(value):
 56 |     val = False
 57 |     if value.lower() in ["enabled", "true", "on", "yes"]:
 58 |         val = True
 59 |     return val
 60 | 
 61 | 
 62 | def mkdirp(path, exit_on_err=False, logger=None):
 63 |     """
 64 |     Try creating required directory structure
 65 |     ignore EEXIST and raise exception for rest of the errors.
 66 |     Print error in stderr and exit
 67 |     """
 68 |     try:
 69 |         os.makedirs(path)
 70 |     except (OSError, IOError) as e:
 71 |         if e.errno == EEXIST and os.path.isdir(path):
 72 |             pass
 73 |         else:
 74 |             output_error("Fail to create dir %s: %s" % (path, e))
 75 | 
 76 | 
 77 | def is_active():
 78 |     state = False
 79 |     pid = None
 80 |     if os.path.exists(PID_FILE):
 81 |         with open(PID_FILE) as f:
 82 |             pid = int(f.read().strip())
 83 | 
 84 |     if pid is not None:
 85 |         try:
 86 |             os.kill(pid, 0)
 87 |             with open("/proc/{0}/cmdline".format(pid)) as f:
 88 |                 data = f.read()
 89 |                 if "gunicorn" in data and "glusterrest" in data:
 90 |                     state = True
 91 |         except OSError:
 92 |             pass
 93 | 
 94 |     return state
 95 | 
 96 | 
 97 | def reload_service():
 98 |     pid = None
 99 |     if is_active():
100 |         with open(PID_FILE) as f:
101 |             try:
102 |                 pid = int(f.read().strip())
103 |             except ValueError:
104 |                 pid = None
105 |         if pid is not None:
106 |             os.kill(pid, signal.SIGHUP)
107 | 
108 |     return (0, "", "")
109 | 
110 | 
111 | def sync_to_peers():
112 |     if os.path.exists(APPS_FILE):
113 |         try:
114 |             sync_file_to_peers(APPS_FILE_TO_SYNC)
115 |         except GlusterCmdException as e:
116 |             output_error("Failed to sync Apps file: [Error: {0}]"
117 |                          "{1}".format(e[0], e[2]))
118 | 
119 |     if os.path.exists(CUSTOM_CONFIG_FILE):
120 |         try:
121 |             sync_file_to_peers(CUSTOM_CONFIG_FILE_TO_SYNC)
122 |         except GlusterCmdException as e:
123 |             output_error("Failed to sync Config file: [Error: {0}]"
124 |                          "{1}".format(e[0], e[2]))
125 | 
126 |     out = execute_in_peers("node-reload")
127 |     table = PrettyTable(["NODE", "NODE STATUS", "SYNC STATUS"])
128 |     table.align["NODE STATUS"] = "r"
129 |     table.align["SYNC STATUS"] = "r"
130 | 
131 |     for p in out:
132 |         table.add_row([p.hostname,
133 |                        "UP" if p.node_up else "DOWN",
134 |                        "OK" if p.ok else "NOT OK: {0}".format(
135 |                            p.error)])
136 | 
137 |     print (table)
138 | 
139 | 
140 | def node_output_handle(resp):
141 |     rc, out, err = resp
142 |     if rc == 0:
143 |         node_output_ok(out)
144 |     else:
145 |         node_output_notok(err)
146 | 
147 | 
148 | def action_handle(action):
149 |     out = execute_in_peers("node-" + action)
150 |     column_name = action.upper()
151 |     if action == "status":
152 |         column_name = RESTD.upper()
153 | 
154 |     table = PrettyTable(["NODE", "NODE STATUS", column_name + " STATUS"])
155 |     table.align["NODE STATUS"] = "r"
156 |     table.align[column_name + " STATUS"] = "r"
157 | 
158 |     for p in out:
159 |         status_col_val = "OK" if p.ok else "NOT OK: {0}".format(
160 |             p.error)
161 |         if action == "status":
162 |             status_col_val = "DOWN"
163 |             if p.ok:
164 |                 status_col_val = p.output
165 | 
166 |         table.add_row([p.hostname,
167 |                        "UP" if p.node_up else "DOWN",
168 |                        status_col_val])
169 | 
170 |     print (table)
171 | 
172 | 
173 | class NodeReload(Cmd):
174 |     name = "node-reload"
175 | 
176 |     def run(self, args):
177 |         node_output_handle(reload_service())
178 | 
179 | 
180 | class ReloadCmd(Cmd):
181 |     name = "reload"
182 | 
183 |     def run(self, args):
184 |         action_handle("reload")
185 | 
186 | 
187 | class NodeStatus(Cmd):
188 |     name = "node-status"
189 | 
190 |     def run(self, args):
191 |         node_output_ok("UP" if is_active() else "DOWN")
192 | 
193 | 
194 | class StatusCmd(Cmd):
195 |     name = "status"
196 | 
197 |     def run(self, args):
198 |         action_handle("status")
199 | 
200 | 
201 | class AppAddCmd(Cmd):
202 |     name = "app-add"
203 | 
204 |     def args(self, parser):
205 |         parser.add_argument("appid", help="Application ID")
206 |         parser.add_argument("appsecret", help="Application Secret")
207 | 
208 |     def run(self, args):
209 |         create_apps_file_if_not_exists()
210 | 
211 |         with LockedOpen(APPS_FILE, 'r+'):
212 |             data = json.load(open(APPS_FILE))
213 |             if data.get(args.appid, None) is not None:
214 |                 output_error("Application already exists")
215 | 
216 |             data[args.appid] = args.appsecret
217 | 
218 |             file_content_overwrite(APPS_FILE, data)
219 | 
220 |         sync_to_peers()
221 | 
222 | 
223 | class AppResetCmd(Cmd):
224 |     name = "app-reset"
225 | 
226 |     def args(self, parser):
227 |         parser.add_argument("appid", help="Application ID")
228 |         parser.add_argument("appsecret", help="Application Secret")
229 | 
230 |     def run(self, args):
231 |         create_apps_file_if_not_exists()
232 | 
233 |         with LockedOpen(APPS_FILE, 'r+'):
234 |             data = json.load(open(APPS_FILE))
235 |             if data.get(args.appid, None) is None:
236 |                 output_error("Application does not exists")
237 | 
238 |             data[args.appid] = args.appsecret
239 | 
240 |             file_content_overwrite(APPS_FILE, data)
241 | 
242 |         sync_to_peers()
243 | 
244 | 
245 | class AppDelCmd(Cmd):
246 |     name = "app-del"
247 | 
248 |     def args(self, parser):
249 |         parser.add_argument("appid", help="Application ID")
250 | 
251 |     def run(self, args):
252 |         create_apps_file_if_not_exists()
253 | 
254 |         with LockedOpen(APPS_FILE, 'r+'):
255 |             data = json.load(open(APPS_FILE))
256 |             if data.get(args.appid, None) is None:
257 |                 output_error("Application does not exists")
258 | 
259 |             del data[args.appid]
260 | 
261 |             file_content_overwrite(APPS_FILE, data)
262 | 
263 |         sync_to_peers()
264 | 
265 | 
266 | class ConfigGetCmd(Cmd):
267 |     name = "config-get"
268 | 
269 |     def args(self, parser):
270 |         parser.add_argument("--name", help="Config Name")
271 | 
272 |     def run(self, args):
273 |         data = json.load(open(DEFAULT_CONFIG_FILE))
274 |         if os.path.exists(CUSTOM_CONFIG_FILE):
275 |             data.update(json.load(open(CUSTOM_CONFIG_FILE)))
276 | 
277 |         if args.name is not None and args.name not in CONFIG_KEYS:
278 |             output_error("Invalid Config item")
279 | 
280 |         table = PrettyTable(["NAME", "VALUE"])
281 |         table.align["NAME"] = "r"
282 |         table.align["VALUE"] = "l"
283 |         if args.name is None:
284 |             for k, v in data.items():
285 |                 table.add_row([k, v])
286 |         else:
287 |             table.add_row([args.name, data[args.name]])
288 | 
289 |         print (table)
290 | 
291 | 
292 | def read_file_content_json(fname):
293 |     content = "{}"
294 |     with open(fname) as f:
295 |         content = f.read()
296 |         if content.strip() == "":
297 |             content = "{}"
298 | 
299 |     return json.loads(content)
300 | 
301 | 
302 | class ConfigSetCmd(Cmd):
303 |     name = "config-set"
304 | 
305 |     def args(self, parser):
306 |         parser.add_argument("name", help="Config Name")
307 |         parser.add_argument("value", help="Config Value")
308 | 
309 |     def run(self, args):
310 |         if args.name not in CONFIG_KEYS:
311 |             output_error("Invalid Config item")
312 | 
313 |         create_custom_config_file_if_not_exists()
314 | 
315 |         with LockedOpen(CUSTOM_CONFIG_FILE, 'r+'):
316 |             data = json.load(open(DEFAULT_CONFIG_FILE))
317 |             if os.path.exists(CUSTOM_CONFIG_FILE):
318 |                 config_json = read_file_content_json(CUSTOM_CONFIG_FILE)
319 |                 data.update(config_json)
320 | 
321 |             # Do Nothing if same as previous value
322 |             if data[args.name] == args.value:
323 |                 return
324 | 
325 |             # TODO: Validate Value
326 |             new_data = read_file_content_json(CUSTOM_CONFIG_FILE)
327 | 
328 |             v = args.value
329 |             if args.name in BOOL_CONFIGS:
330 |                 v = boolify(args.value)
331 | 
332 |             if args.name in INT_CONFIGS:
333 |                 v = int(args.value)
334 | 
335 |             new_data[args.name] = v
336 |             file_content_overwrite(CUSTOM_CONFIG_FILE, new_data)
337 | 
338 |             # If any value changed which requires restart of REST server
339 |             restart = False
340 |             if args.name in RESTART_CONFIGS:
341 |                 restart = True
342 | 
343 |             sync_to_peers()
344 |             if restart:
345 |                 print ("\nRestart glusterrestd service in all nodes")
346 | 
347 | 
348 | class ConfigResetCmd(Cmd):
349 |     name = "config-reset"
350 | 
351 |     def args(self, parser):
352 |         parser.add_argument("name", help="Config Name or all")
353 | 
354 |     def run(self, args):
355 |         create_custom_config_file_if_not_exists()
356 | 
357 |         with LockedOpen(CUSTOM_CONFIG_FILE, 'r+'):
358 |             changed_keys = []
359 |             data = {}
360 |             if os.path.exists(CUSTOM_CONFIG_FILE):
361 |                 data = read_file_content_json(CUSTOM_CONFIG_FILE)
362 | 
363 |             if not data:
364 |                 return
365 | 
366 |             if args.name.lower() == "all":
367 |                 for k, v in data.items():
368 |                     changed_keys.append(k)
369 | 
370 |                 # Reset all keys
371 |                 file_content_overwrite(CUSTOM_CONFIG_FILE, {})
372 |             else:
373 |                 changed_keys.append(args.name)
374 |                 del data[args.name]
375 |                 file_content_overwrite(CUSTOM_CONFIG_FILE, data)
376 | 
377 |             # If any value changed which requires restart of REST server
378 |             restart = False
379 |             for key in changed_keys:
380 |                 if key in RESTART_CONFIGS:
381 |                     restart = True
382 |                     break
383 | 
384 |             sync_to_peers()
385 |             if restart:
386 |                 print ("\nRestart glusterrestd service in all nodes")
387 | 
388 | 
389 | class SyncCmd(Cmd):
390 |     name = "sync"
391 | 
392 |     def run(self, args):
393 |         sync_to_peers()
394 | 
395 | 
396 | def main():
397 |     runcli()
398 | 
399 | 
400 | if __name__ == "__main__":
401 |     main()
402 | 


--------------------------------------------------------------------------------
/COPYING:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 |   The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 |   When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 |   To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 |   For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 |   Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 |   For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 |   Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 |   Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 |   The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 |                        TERMS AND CONDITIONS
 72 | 
 73 |   0. Definitions.
 74 | 
 75 |   "This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 |   "Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 |   "The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 |   To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 |   A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 |   To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 |   To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 |   An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 |   1. Source Code.
113 | 
114 |   The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 |   A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 |   The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 |   The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 |   The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 |   The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 |   2. Basic Permissions.
155 | 
156 |   All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 |   You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 |   Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 |   No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 |   When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 |   4. Conveying Verbatim Copies.
196 | 
197 |   You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 |   You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 |   5. Conveying Modified Source Versions.
209 | 
210 |   You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 |     a) The work must carry prominent notices stating that you modified
215 |     it, and giving a relevant date.
216 | 
217 |     b) The work must carry prominent notices stating that it is
218 |     released under this License and any conditions added under section
219 |     7.  This requirement modifies the requirement in section 4 to
220 |     "keep intact all notices".
221 | 
222 |     c) You must license the entire work, as a whole, under this
223 |     License to anyone who comes into possession of a copy.  This
224 |     License will therefore apply, along with any applicable section 7
225 |     additional terms, to the whole of the work, and all its parts,
226 |     regardless of how they are packaged.  This License gives no
227 |     permission to license the work in any other way, but it does not
228 |     invalidate such permission if you have separately received it.
229 | 
230 |     d) If the work has interactive user interfaces, each must display
231 |     Appropriate Legal Notices; however, if the Program has interactive
232 |     interfaces that do not display Appropriate Legal Notices, your
233 |     work need not make them do so.
234 | 
235 |   A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 |   6. Conveying Non-Source Forms.
246 | 
247 |   You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 |     a) Convey the object code in, or embodied in, a physical product
253 |     (including a physical distribution medium), accompanied by the
254 |     Corresponding Source fixed on a durable physical medium
255 |     customarily used for software interchange.
256 | 
257 |     b) Convey the object code in, or embodied in, a physical product
258 |     (including a physical distribution medium), accompanied by a
259 |     written offer, valid for at least three years and valid for as
260 |     long as you offer spare parts or customer support for that product
261 |     model, to give anyone who possesses the object code either (1) a
262 |     copy of the Corresponding Source for all the software in the
263 |     product that is covered by this License, on a durable physical
264 |     medium customarily used for software interchange, for a price no
265 |     more than your reasonable cost of physically performing this
266 |     conveying of source, or (2) access to copy the
267 |     Corresponding Source from a network server at no charge.
268 | 
269 |     c) Convey individual copies of the object code with a copy of the
270 |     written offer to provide the Corresponding Source.  This
271 |     alternative is allowed only occasionally and noncommercially, and
272 |     only if you received the object code with such an offer, in accord
273 |     with subsection 6b.
274 | 
275 |     d) Convey the object code by offering access from a designated
276 |     place (gratis or for a charge), and offer equivalent access to the
277 |     Corresponding Source in the same way through the same place at no
278 |     further charge.  You need not require recipients to copy the
279 |     Corresponding Source along with the object code.  If the place to
280 |     copy the object code is a network server, the Corresponding Source
281 |     may be on a different server (operated by you or a third party)
282 |     that supports equivalent copying facilities, provided you maintain
283 |     clear directions next to the object code saying where to find the
284 |     Corresponding Source.  Regardless of what server hosts the
285 |     Corresponding Source, you remain obligated to ensure that it is
286 |     available for as long as needed to satisfy these requirements.
287 | 
288 |     e) Convey the object code using peer-to-peer transmission, provided
289 |     you inform other peers where the object code and Corresponding
290 |     Source of the work are being offered to the general public at no
291 |     charge under subsection 6d.
292 | 
293 |   A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 |   A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 |   "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 |   If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 |   The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 |   Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 |   7. Additional Terms.
344 | 
345 |   "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 |   When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 |   Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 |     a) Disclaiming warranty or limiting liability differently from the
366 |     terms of sections 15 and 16 of this License; or
367 | 
368 |     b) Requiring preservation of specified reasonable legal notices or
369 |     author attributions in that material or in the Appropriate Legal
370 |     Notices displayed by works containing it; or
371 | 
372 |     c) Prohibiting misrepresentation of the origin of that material, or
373 |     requiring that modified versions of such material be marked in
374 |     reasonable ways as different from the original version; or
375 | 
376 |     d) Limiting the use for publicity purposes of names of licensors or
377 |     authors of the material; or
378 | 
379 |     e) Declining to grant rights under trademark law for use of some
380 |     trade names, trademarks, or service marks; or
381 | 
382 |     f) Requiring indemnification of licensors and authors of that
383 |     material by anyone who conveys the material (or modified versions of
384 |     it) with contractual assumptions of liability to the recipient, for
385 |     any liability that these contractual assumptions directly impose on
386 |     those licensors and authors.
387 | 
388 |   All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 |   If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 |   Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 |   8. Termination.
408 | 
409 |   You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 |   However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 |   Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 |   Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 |   9. Acceptance Not Required for Having Copies.
436 | 
437 |   You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 |   10. Automatic Licensing of Downstream Recipients.
447 | 
448 |   Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 |   An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 |   You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 |   11. Patents.
472 | 
473 |   A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 |   A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 |   In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 |   If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 |   If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 |   A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 |   Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 |   12. No Surrender of Others' Freedom.
541 | 
542 |   If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 |   13. Use with the GNU Affero General Public License.
553 | 
554 |   Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 |   14. Revised Versions of this License.
564 | 
565 |   The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 |   Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 |   If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 |   Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 |   15. Disclaimer of Warranty.
590 | 
591 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 |   16. Limitation of Liability.
601 | 
602 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 |   17. Interpretation of Sections 15 and 16.
613 | 
614 |   If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 |                      END OF TERMS AND CONDITIONS
622 | 
623 |             How to Apply These Terms to Your New Programs
624 | 
625 |   If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 | 
629 |   To do so, attach the following notices to the program.  It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 | 
634 |     <one line to give the program's name and a brief idea of what it does.>
635 |     Copyright (C) <year>  <name of author>
636 | 
637 |     This program is free software: you can redistribute it and/or modify
638 |     it under the terms of the GNU General Public License as published by
639 |     the Free Software Foundation, either version 3 of the License, or
640 |     (at your option) any later version.
641 | 
642 |     This program is distributed in the hope that it will be useful,
643 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
644 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645 |     GNU General Public License for more details.
646 | 
647 |     You should have received a copy of the GNU General Public License
648 |     along with this program.  If not, see <http://www.gnu.org/licenses/>.
649 | 
650 | Also add information on how to contact you by electronic and paper mail.
651 | 
652 |   If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 | 
655 |     <program>  Copyright (C) <year>  <name of author>
656 |     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 |     This is free software, and you are welcome to redistribute it
658 |     under certain conditions; type `show c' for details.
659 | 
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License.  Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 | 
664 |   You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | <http://www.gnu.org/licenses/>.
668 | 
669 |   The GNU General Public License does not permit incorporating your program
670 | into proprietary programs.  If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library.  If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License.  But first, please read
674 | <http://www.gnu.org/philosophy/why-not-lgpl.html>.
675 | 


--------------------------------------------------------------------------------