summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorJeremy Kerr <jk@ozlabs.org>2018-08-13 11:48:23 +0800
committerJeremy Kerr <jk@ozlabs.org>2018-08-13 11:48:23 +0800
commita87af8462346f7db6cac87ba13bac5a4b20132c3 (patch)
tree6b68b1ab78278e6dbeec2365e1bfb3f2b9b1587b /README
parent4ac9246f8391ac5af736046fa6001632f91c1173 (diff)
downloadjsnbd-a87af8462346f7db6cac87ba13bac5a4b20132c3.tar.gz
jsnbd-a87af8462346f7db6cac87ba13bac5a4b20132c3.zip
nbd-proxy: replace hook dir with a single executable
A future change will run the executable asynchronously. With a directory of hooks, this gets overly complicated. Replace the directory-of-hooks concept with a single hook. The hook itself can then spawn multiple hooks if required (eg, with run-parts). Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
Diffstat (limited to 'README')
-rw-r--r--README12
1 files changed, 6 insertions, 6 deletions
diff --git a/README b/README
index 0d3030e..d7e1ec7 100644
--- a/README
+++ b/README
@@ -54,12 +54,12 @@ There is no authentication or authorisation implemented in the nbd proxy. Your
websocket proxy should implement proper authentication before nbd-proxy is
connected to the websocket endpoint.
-State hooks
------------
+State hook
+----------
-The nbd-proxy has a facility to run hooks on state change. When a
-nbd session is established or shut down, the proxy will run any executables
-found under the hook path (by default, /etc/nbd-proxy/state.d/).
+The nbd-proxy has a facility to run an program on state change. When a nbd
+session is established or shut down, the proxy will run the executable at
+/etc/nbd-proxy/state.
-These hooks are called with two arguments: the action ("start" or "stop"),
+This executable is called with two arguments: the action ("start" or "stop"),
and the name of the configuration (as specified in the config.json file).
OpenPOWER on IntegriCloud