-
Notifications
You must be signed in to change notification settings - Fork 445
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
148 additions
and
182 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| .. _systemloaders: | ||
|
|
||
| Systemloaders | ||
| ============= | ||
|
|
||
| SBT native packager provides support for different systemloaders in order to register your application as a service on | ||
| your target system, start it automatically and provide systemloader specific configuration. | ||
|
|
||
| .. tip:: You can use systemloaders with the :ref:`java-app-plugin` or the :ref:`java-server-plugin`! | ||
|
|
||
| Overview | ||
| -------- | ||
|
|
||
| There is a generic ``SystemloaderPlugin`` which configures default settings and requires necessary plugins. It gets | ||
| triggered automatically, when you enable a specific systemloader plugin. If you want to implement your own loader, | ||
| you should require the ``SystemloaderPlugin``. | ||
|
|
||
| General Settings | ||
| ~~~~~~~~~~~~~~~~ | ||
|
|
||
| ``serverLoading`` | ||
| Loading system to be used for application start script (SystemV, Upstart, Systemd). | ||
| This setting can be used to trigger systemloader specific behaviour in your build. | ||
|
|
||
| ``startRunlevels`` | ||
| Sequence of runlevels on which application will start up | ||
|
|
||
| ``stopRunlevels`` | ||
| Sequence of runlevels on which application will stop | ||
|
|
||
| ``requiredStartFacilities`` | ||
| Names of system services that should be provided at application start | ||
|
|
||
| ``requiredStopFacilities`` | ||
| Names of system services that should be provided at application stop | ||
|
|
||
|
|
||
| SystemV | ||
| ------- | ||
|
|
||
| Native packager provides different SysV scripts for ``rpm`` (CentOS, RHEL, Fedora) and ``debian`` (Debian, Ubuntu) | ||
| package based systems. Enable SystemV with: | ||
|
|
||
| .. code-block:: scala | ||
| enablePlugins(SystemVPlugin) | ||
| The :ref:`java-server-plugin` provides a ``daemonStdoutLogFile`` setting, that you can use to redirect the systemV | ||
| output into a file. | ||
|
|
||
| Systemd | ||
| ------- | ||
|
|
||
| In order to enable Systemd add this plugin: | ||
|
|
||
| .. code-block:: scala | ||
| enablePlugins(SystemdPlugin) | ||
| Upstart | ||
| ------- | ||
|
|
||
| SystemV alternative developed by `Ubuntu <http://upstart.ubuntu.com/>`_. Native packager adds support for rpm as well, | ||
| but we recommend using Systemd if possible. | ||
|
|
||
| .. code-block:: scala | ||
| enablePlugins(UpstartPlugin) | ||
| *As a side note Fedora/RHEL/Centos family of linux specifies* ``Default requiretty`` *in its* ``/etc/sudoers`` | ||
| *file. This prevents the default Upstart script from working correctly as it uses sudo to run the application | ||
| as the* ``daemonUser`` *. Simply disable requiretty to use Upstart or modify the Upstart template.* | ||
|
|
||
| Customization | ||
| ------------- | ||
|
|
||
| Customize Start Script | ||
| ~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Sbt Native Packager leverages templating to customize various start/stop scripts and pre/post install tasks. | ||
| As an example, to alter the ``loader-functions`` which manage the specific start and stop process commands | ||
| for SystemLoaders you can to the ``linuxScriptReplacements`` map: | ||
|
|
||
| .. code-block:: scala | ||
| import com.typesafe.sbt.packager.archetypes.TemplateWriter | ||
| linuxScriptReplacements += { | ||
| val functions = sourceDirectory.value / "templates" / "custom-loader-functions" | ||
| // Nil == replacements. If you want to replace stuff in your script put them in this Seq[(String,String)] | ||
| "loader-functions" -> TemplateWriter.generateScript(functions.toURL, Nil) | ||
| } | ||
| which will add the following resource file to use start/stop instead of initctl in the post install script: | ||
|
|
||
| .. code-block:: bash | ||
| startService() { | ||
| app_name=$1 | ||
| start $app_name | ||
| } | ||
| stopService() { | ||
| app_name=$1 | ||
| stop $app_name | ||
| } | ||
| The :doc:`debian </formats/debian>` and :doc:`redhat </formats/rpm>` pages have further information on overriding | ||
| distribution specific actions. | ||
|
|
||
| Override Start Script | ||
| ~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| It's also possible to override the entire script/configuration for your service manager. | ||
| Create a file ``src/templates/systemloader/$loader`` and it will be used instead. | ||
|
|
||
| Possible values: | ||
|
|
||
| * ``$loader`` - ``upstart``, ``systemv`` or ``systemd`` | ||
|
|
||
| **Syntax** | ||
|
|
||
| You can use ``${{variable_name}}`` to reference variables when writing your script. The default set of variables is: | ||
|
|
||
| * ``descr`` - The description of the server. | ||
| * ``author`` - The configured author name. | ||
| * ``exec`` - The script/binary to execute when starting the server | ||
| * ``chdir`` - The working directory for the server. | ||
| * ``retries`` - The number of times to retry starting the server. | ||
| * ``retryTimeout`` - The amount of time to wait before trying to run the server. | ||
| * ``app_name`` - The name of the application (linux friendly) | ||
| * ``app_main_class`` - The main class / entry point of the application. | ||
| * ``app_classpath`` - The (ordered) classpath of the application. | ||
| * ``daemon_user`` - The user that the server should run as. | ||
| * ``daemon_log_file`` - Absolute path to daemon log file. |