Allow script templates to be overridden #121
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 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
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 |
|---|---|---|
|
|
@@ -14,7 +14,8 @@ still leveraging the default configuration for other platforms. | |
|
|
||
| Curently, in the nativepackager these archetypes are available: | ||
|
|
||
| * Java Command Line Application | ||
| * Java Server Application (Experimental - Debian Only) | ||
|
|
||
|
|
||
| Java Command Line Application | ||
|
|
@@ -24,6 +25,7 @@ A Java Command Line application is a Java application that consists of a set of | |
| custom start scripts, or services. It is just a bash/bat script that starts up a Java project. To use | ||
| this archetype in your build, do the following in your ``build.sbt``: | ||
|
|
||
| .. code-block:: scala | ||
|
|
||
| packageArchetype.java_application | ||
|
|
||
|
|
@@ -47,6 +49,7 @@ this archetype in your build, do the following in your ``build.sbt``: | |
| This archetype will use the ``mainClass`` setting of sbt (automatically discovers your main class) to generate ``bat`` and ``bin`` scripts for your project. It | ||
| produces a universal layout that looks like the following: | ||
|
|
||
| .. code-block:: none | ||
|
|
||
| bin/ | ||
| <app_name> <- BASH script | ||
|
|
@@ -56,3 +59,119 @@ produces a universal layout that looks like the following: | |
|
|
||
|
|
||
| You can add additional files to the project by placing things in ``src/windows``, ``src/universal`` or ``src/linux`` as needed. | ||
|
|
||
|
|
||
| Java Server | ||
| ----------- | ||
|
|
||
| This archetype is designed for Java applications that are intended to run as | ||
| servers or services. This archetype includes wiring such that the application | ||
| is started immediately upon startup. | ||
|
|
||
| Currently supported operating systems: | ||
|
|
||
| * Ubuntu 12.04 LTS - Upstart | ||
| * Ubuntu 12.04 LTS - init.d | ||
|
|
||
|
|
||
| The Java Server archetype has a similar installation layout as the java | ||
| application. The primary differneces are: | ||
|
|
||
|
|
||
| * Linux | ||
|
|
||
| * ``/var/log/<pkg>`` is symlinked from ``<install>/log`` | ||
|
|
||
| * Creates a start script in ``/etc/init.d`` or ``/etc/init/`` | ||
|
|
||
| * Creates a startup config file in ``/etc/default/<pkg>`` | ||
|
|
||
|
|
||
| For Debian servers, you can select to either use SystemV or Upstart for your servers. By default, Upstart (the current Ubuntu LTS default), is used. To switch to SystemV, add the following: | ||
|
|
||
| .. code-block:: scala | ||
|
|
||
| import NativePackagerKeys._ | ||
| import com.typesafe.sbt.packager.archetypes.ServerLoader | ||
|
|
||
| serverLoading in Debian := ServerLoader.SystemV | ||
|
|
||
| By default, the native packager will install and run services using the ``root`` user and group. This is not a good default for services, which should not be exposed to root access. You can change the installation and usage user via the ``daemonUser`` key: | ||
|
|
||
| .. code-block:: scala | ||
|
|
||
| daemonUser in Debian := "my_app_user" | ||
|
|
||
| The archetype will automatically append/prepend the creation/deletion of the user | ||
| to your packaging for Debian. | ||
|
There was a problem hiding this comment. We should point out here that on |
||
|
|
||
|
|
||
|
There was a problem hiding this comment. I would recommend to write something about #98 (Java_Opts) and #120 (Better upstart script) for handling running instances in Debian.
|
||
| Overriding Templates | ||
| -------------------- | ||
|
|
||
| You can override the default template used to generate any of the scripts in | ||
| any archetype. Listed below are the overridable files and variables that | ||
| you can use when generating scripts. | ||
|
|
||
| ``src/templates/bat-template`` | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Creating a file here will override the default template used to | ||
| generate the ``.bat`` script for windows distributions. | ||
|
|
||
| **Syntax** | ||
|
|
||
| ``@@APP_ENV_NAME@@`` - will be replaced with the script friendly name of your package. | ||
|
|
||
| ``@@APP_NAME@@`` - will be replaced with user friendly name of your package. | ||
|
|
||
| ``@APP_DEIFNES@@`` - will be replaced with a set of variable definitions, like | ||
|
There was a problem hiding this comment. Not |
||
| ``APP_MAIN_CLASS``, ``APP_MAIN_CLASS``. | ||
|
|
||
| You can define addiitonal variable deifnitions using ``batScriptExtraDefines``. | ||
|
|
||
|
|
||
| ``src/templates/bash-template`` | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Creating a file here will override the default template used to | ||
| generate the BASH start script found in ``bin/<application>`` in the | ||
| universal distribution | ||
|
|
||
| **Syntax** | ||
|
|
||
| ``${{template_declares}}`` - Will be replaced with a series of ``declare <var>`` | ||
| lines based on the ``bashScriptDefines`` key. You can add more defines to | ||
| the ``bashScriptExtraDefines`` that will be used in addition to the default set: | ||
|
|
||
| * ``app_mainclass`` - The main class entry point for the application. | ||
| * ``app_classpath`` - The complete classpath for the application (in order). | ||
|
|
||
|
|
||
|
|
||
| ``src/templates/start`` | ||
| ~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Creating a file here will override either the init.d startup script or | ||
| the upstart start script. It will either be located at | ||
| ``/etc/init/<application>`` or ``/etc/init.d/<application>`` depending on which | ||
| serverLoader is being used. | ||
|
|
||
| **Syntax** | ||
|
|
||
| You can use ``${{variable_name}}`` to reference variables when writing your scirpt. 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. | ||
|
|
||
| ``src/templates/etc-default`` | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Creating a file here will override the ``/etc/default/<application>`` template | ||
| used when SystemV is the server loader. | ||
|
There was a problem hiding this comment. This feature is too cool to be used only with systemV, right? There was a problem hiding this comment. If you figure out how to wire it up to upstart, we can merge it :). I was mostly documenting the state of thing as they are. I agree it's a very very nice feature for servers. There was a problem hiding this comment. Actually, I need to check the SystemV support. Could be we just use the config feature in the batch file directly and throw that in /etc/default. There was a problem hiding this comment. Ok, so it looks like the two systems are actually using two different mechanisms of starting. Right now the SystemV script is a complete script rather than just a wrapper to the BASH script we generate, like upstart. Because of this, currently, they can't share the same /etc/default file. If someone who uses SystemV could detangle that, we can make the default location for config unfortunately, things like USER= wouldn't work for SystemV. There was a problem hiding this comment. I'm not sure if both startup system have to work with the same So in the end your config file looks different for different start systems, which I think is fine. Still the SystemV script has a lot of hardcoded stuff Upstart# if configuration files exist, prepend their contents to $@
# so it can be processed by this runner
[[ -f "$script_conf_file" ]] && set -- $(loadConfigFile "$script_conf_file") "$@"Doesn't rely on environment variables. SystemVtest -e /etc/default/${{app_name}} && source /etc/default/${{app_name}}Relies on environment variables and isn't able to set Java_Opts |
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove
loader: ServerLoaderas the/etc/default/<name>should be generated withUpstartandSystemV. The we can close #98 as this fixes everything! Just placeetc-defaultin thesrc/templatesfolder. And I would add thedebianScriptReplacementsas gives us the ability to generate for examplepidsbased on the applications name, etc.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As I mention below, not quite ready for this. We need to unify the two scripts a bit more before I'm comfortable doing so. The config formats are slightly different (ENV variables vs. command line arguments), and the location would be the same...