From 38d7ffca0b591694c17509d20c8bf55606e60536 Mon Sep 17 00:00:00 2001 From: Trygve Laugstøl Date: Sun, 27 Oct 2013 15:07:31 +0100 Subject: app-ls-apps: o New command to list all applications installed under a directory. app-foreach-app: o New command to execute another command for each app installed under the current directory. app-init/app-install-file: o Adding -C and -c to prepand and append config files around the appliation's build-in configuration files. app-cat-conf: o Use $APP_HOME as the 'appliation installation directory' if set. app-operator-pid: o Support PID files created by the launcher. --- docs/app-cat-conf.txt | 5 ++++ docs/app-conf.txt | 5 ++++ docs/app-install-file.txt | 24 +++++++++++++++++++ docs/app-operator-pid.txt | 27 +++++++++++++++++++++ docs/app.txt | 61 +++++++++++++++++++++++++++++++++++++---------- docs/appinternals.txt | 8 +++++++ 6 files changed, 117 insertions(+), 13 deletions(-) create mode 100644 docs/app-install-file.txt create mode 100644 docs/app-operator-pid.txt (limited to 'docs') diff --git a/docs/app-cat-conf.txt b/docs/app-cat-conf.txt index fe2a5b4..57fe693 100644 --- a/docs/app-cat-conf.txt +++ b/docs/app-cat-conf.txt @@ -68,4 +68,9 @@ SEE ALSO git-config(1) +APP.SH +------ + +Part of the linkman:app[1] suite. + // vim: set ft=asciidoc: diff --git a/docs/app-conf.txt b/docs/app-conf.txt index c686960..3afeda4 100644 --- a/docs/app-conf.txt +++ b/docs/app-conf.txt @@ -20,4 +20,9 @@ DESCRIPTION Interface to the configuration values used by 'app.sh'. Modelled after the 'git-config' command. 'list' is the default command +APP.SH +------ + +Part of the linkman:app[1] suite. + // vim: set ft=asciidoc: diff --git a/docs/app-install-file.txt b/docs/app-install-file.txt new file mode 100644 index 0000000..bb7cc48 --- /dev/null +++ b/docs/app-install-file.txt @@ -0,0 +1,24 @@ +app-install-file(1) +=================== + +NAME +---- +app-install-file - Low-level installation of an app + +SYNOPSIS +-------- +[verse] +'app-operator-pid' ... + +TODOs +----- + +Tests for prepending and appending configuration:: + Missing. + +APP.SH +------ + +Part of the linkman:app[1] suite. + +// vim: set ft=asciidoc: diff --git a/docs/app-operator-pid.txt b/docs/app-operator-pid.txt new file mode 100644 index 0000000..9e0a454 --- /dev/null +++ b/docs/app-operator-pid.txt @@ -0,0 +1,27 @@ +app-operator-pid(1) +=================== + +NAME +---- +app-operator-pid - Controls the running instance of the app + +SYNOPSIS +-------- +[verse] +'app-operator-pid' ... + +TODOs +----- + +Support configurable signal to send on shutdown:: + TERM might be exessive for some apps. + +Tests for app.pid_management=launcher:: + Missing. + +APP.SH +------ + +Part of the linkman:app[1] suite. + +// vim: set ft=asciidoc: diff --git a/docs/app.txt b/docs/app.txt index c578c5d..9ab0ba7 100644 --- a/docs/app.txt +++ b/docs/app.txt @@ -10,28 +10,37 @@ SYNOPSIS [verse] 'app' +DOCUMENTATION +------------- + QUICK START ~~~~~~~~~~~ - $ app init -d my-app maven org.example:my-app:1.0-SNAPSHOT - $ cd my-app - $ app start - $ app conf set app.version 1.0 - $ app upgrade - $ app restart +------------------------------------------------------------------------ +$ app init -d my-app maven org.example:my-app:1.0-SNAPSHOT +$ cd my-app +$ app start +$ app conf set app.version 1.0 +$ app upgrade +$ app restart +------------------------------------------------------------------------ INSTALLING AN APPLICATION ~~~~~~~~~~~~~~~~~~~~~~~~~ This resolved and downloads an appliaction from a Maven repository: - $ app init -d my-app maven org.example:my-app:1.0-SNAPSHOT +------------------------------------------------------------------------ +$ app init -d my-app maven org.example:my-app:1.0-SNAPSHOT +------------------------------------------------------------------------ By default it will download from the central repository, but this is not always what you want. To get it to use another repository give the `-r` option: - $ app init -d my-app maven -f http://repo.example.org/snapshots org.example:my-app:1.0-SNAPSHOT +------------------------------------------------------------------------ +$ app init -d my-app maven -f http://repo.example.org/snapshots org.example:my-app:1.0-SNAPSHOT +------------------------------------------------------------------------ UPGRADING AN APPLICATION ~~~~~~~~~~~~~~~~~~~~~~~~ @@ -40,7 +49,9 @@ If your application is configured with the Maven resolver and the version is a SNAPSHOT version, you can use this to upgrade your application through a cron job: - $ app upgrade +------------------------------------------------------------------------ +$ app upgrade +------------------------------------------------------------------------ With the resolver will try to resolve `app.version` to the latest version. If it's change it will automatically download and install the @@ -49,12 +60,34 @@ latest version. CHANGING VERSION OF AN APPLICATION ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - $ app conf set app.version 1.0 - $ app sync-version +------------------------------------------------------------------------ +$ app conf set app.version 1.0 +$ app sync-version +------------------------------------------------------------------------ `app-sync-version` will first run the resolver to resolve the version and if that has changed, it will download and install the new version. +CREATING APPS +------------- + +TODO + +CREATING HOOKS +~~~~~~~~~~~~~~ + +TODO + +CREATING LAUNCHERS +~~~~~~~~~~~~~~~~~~ + +Trick when you don't know why your app won't start: + +------------------------------------------------------------------------ +exec 1>/tmp/myapp.out +exec 2>/tmp/myapp.err +------------------------------------------------------------------------ + TODOs ----- @@ -68,8 +101,10 @@ TODOs SEE ALSO -------- -linkman:app-conf[1], linkman:app-cat-conf[1], -linkman:appinternals[1], +linkman:app-conf[1], +linkman:app-install-file[1], +linkman:app-operator-pid[1], +linkman:appinternals[1] // vim: set ft=asciidoc: diff --git a/docs/appinternals.txt b/docs/appinternals.txt index 9291fa0..ce19923 100644 --- a/docs/appinternals.txt +++ b/docs/appinternals.txt @@ -33,6 +33,14 @@ ENVIRONMENT VARIABLES --------------------- `APPSH_HOME`:: + .. + `APP_HOME`:: + .. + +APP.SH +------ + +Part of the linkman:app[1] suite. // vim: set ft=asciidoc: -- cgit v1.2.3