From 39cd14e6f392428a5f9745a1514efaadb3001905 Mon Sep 17 00:00:00 2001 From: ocelot-inc <pgulutzan@ocelot.ca> Date: Fri, 8 Nov 2013 14:48:33 -0700 Subject: [PATCH] server.administration.xml add section about tarantool_deploy.sh --- doc/user/server-administration.xml | 44 ++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/doc/user/server-administration.xml b/doc/user/server-administration.xml index 29f7d07423..39ae004386 100644 --- a/doc/user/server-administration.xml +++ b/doc/user/server-administration.xml @@ -122,6 +122,50 @@ last xlog lsn: 0 </section> +<section xml:id="tarantool_deploy"> +<title>Utility <code>tarantool_deploy</code></title> +<para> +With tarantool_deploy one can set up so that, during system boot, +one or more instances of the tarantool_box server will start. +Technically, tarantool_deploy will place instructions in <filename>/etc/init.d</filename> +which will initiate tarantool_box with appropriate options and +with settings that maximize resource usage. +The root password is necessary. These options are available, +as shown by <code>tarantool_deploy --help</code>: +<programlisting> +Tarantool deployment script: add more Tarantool instances. +usage: tarantool_deploy.sh [options] <instance> + + --prefix <path> installation path (/usr) + --prefix_etc <path> installation etc path (/etc) + --prefix_var <path> installation var path (/var) + + --status display deployment status + --dry don't create anything, show commands + + --debug show commands + --yes don't prompt + --help display this usage +</programlisting> +</para> +<para> +The default prefixes (<filename>/usr</filename> and <filename>/etc</filename> and <filename>/var</filename>) are appropriate +if a Tarantool installation was done with default settings, +for example tarantool_box should be in <filename>/usr/bin</filename>. +The only necessary argument is the "instance", which is an +arbitrary numeric identification formatted as digit.digit. +The following is a sample run: +<programlisting><prompt>$ </prompt>tarantool_deploy.sh 0.1 +tarantool_deploy.sh: About to deploy Tarantool instance 0.1. +tarantool_deploy.sh: Continue? [n/y] +y +tarantool_deploy.sh: >>> deploy instance 0.1 +tarantool_deploy.sh: >>> updating deployment config +tarantool_deploy.sh: done +</programlisting> +</para> +</section> + <section xml:id="os-install-notes"> <title>System-specific administration notes</title> <blockquote><para> -- GitLab