{section}
{column}
These Debian packages can be downloaded on [Petals' website|http://petals.ow2.org].
h1. Installing Petals ESB
Nowadays, no public repository exists containing the Debian packages of Petals ESB. So to install yours, you must download them, next install them with your favorite Debian tools ({{synaptic}}, {{apt-get}}, {{dpkg}}).
Several Debian packages are available:
|| Package || Description || Depends on || Required for a production use ||
| {{petals-commons}} | The base package of all Petals products | {{base-files}} | required |
| {{petals-esb}} | The base package of Petals ESB to run a minimalist container | {{java7-runtime-headless}}, {{curl}} and {{petals-commons}} | required |
| {{petals-esb-autoloader}} | The extension "Petals ESB Autoloader" | {{petals-esb}} | not recommended |
| {{petals-esb-artfifact-repository}} | The extension "Petals ESB artifact repository" | {{petals-esb}} | optional |
| {{petals-esb-wsapi}} | The extension "Petals ESB WS API" | {{petals-esb-artfifact-repository}} | optional |
+Note 1:+ The Petals ESB Autoloader is not recommended in production mode because of security reasons.
+Note 2:+ If your security policy requires to push your JBI artifacts on the host instead of downloading them, you can:
* use the extension Petals ESB artifact repository and push your JBI artifacts in its repository,
* or, push your JBI artifacts in a dedicated directory and use a remote Petals CLI with local file-based URLs.
{column}
{column:width=35%}
{panel:title=Table of contents}{toc:outline=true}{panel}
{panel:title=Contributors}{contributors:order=name|mode=list|showAnonymous=true|showCount=true|showLastTime=true}{panel}
{column}
{section}
h1. Uninstalling Petals ESB
According to Debian policies, Petals ESB packages can be uninstalled with or without purging configuration files, with your favorite Debian tools ({{synaptic}}, {{apt-get}}, {{dpkg}}).
In addition to the runtime files, the purge will remove following directories containing some configuration or working files:
* {{/etc/petals-esb/container-enable}}
* {{/var/lib/petals-esb}}
* {{/var/log/petals-esb}}
* {{/var/run/petals-esb}}
The dedicated Petals system user and group are also removed when purging packages. The Petals container configurations ({{/etc/petals-esb/container-available}}) are never removed except the sample one, to be reused eventually.
{tip}All Petals ESB containers declared into {{/etc/petals-esb/container-enable}} will be automatically stopped during the uninstallation process. If you have started manually other Petals ESB containers, you must stop them before to launch the uninstallation process.{tip}
h1. Upgrading Petals ESB
To update the installed version of Petals ESB:
* just uninstalled Petals ESB packages without purging it:
{code}> sudo dpkg -r petals-esb ...{code}
* and installed new Petals ESB packages.
{tip}All Petals ESB containers declared into {{/etc/petals-esb/container-enable}} will be automatically stopped during the uninstallation process and restarted during the installation process. If you have started manually other Petals ESB containers, you must stop them before to launch the uninstallation process, and restart them after the installation process.{tip}
h1. Content of the packages
h2. Content of the package "{{petals-esb}}"
This package arrives with following directories and files:
* {{/usr/bin/petals-esb}}: The script used to start a Petals container,
* {{/usr/bin/petals-esb.sh}}: A link to {{/usr/bin/petals-esb}}, for compatibility with previous versions,
* {{/usr/share/petals-esb}}: Directory containing all Java libraries required by Petals ESB,
* {{/usr/share/petals-esb/extensions}}: Directory containing all extensions of Petals ESB,
* {{/etc/init.d/petals-esb}}: Automatic startup/stop script
* {{/etc/petals-esb/container-available/<container-name>}}: A directory containing the configuration of a Petals container:
** {{server.properties}}: the base configuration of the Petals container,
** usually, the following configuration files are placed in the same directory than the file {{server.properties}}:
*** {{topology.xml}}: the Petals topology of which the container is a member,
*** {{loggers.properties}}: configuration file of the logging system based on JDK Logging,
* {{/etc/petals-esb/container-enable}}: A directory containing links to sub-directoryies of {{/etc/petals-esb/container-available}}. If a container is linked into this directory, it will be automatically started on machine startup,
* {{/var/lib/petals-esb/<container-name>}}: Default location of the root directory of the Petals container data area. It will contain:
** the sub-directory {{repository}} is the *default* storage area of the internal repository containing installed/deployed artefacts,
** the sub-directory {{work}} used as internal working area of the *default* container,
* {{/var/log/petals-esb/<container-name>}}: Default location in which logging files of the Petals container will be written,
* {{/usr/share/petals-esb/licenses}}: Directory containing license files.
h2. Content of the package "{{petals-esb-autoloader}}"
In addition to the extension JAR file put in the directory {{/usr/share/petals-esb/extensions}}, this package arrives with 2 new sub-directories of the root directory of the Petals container data area:
* the sub-directory {{install}}: the directory scanned by the auto-loader of the container to install/deploy artfifact,
* the sub-directory {{installed}}: the directory scanned by the auto-loader of the container to uninstall/undeploy artfifact.
h2. Content of the package "{{petals-esb-artfifact-repository}}"
In addition to the extension JAR file put in the directory {{/usr/share/petals-esb/extensions}}, this package arrives with one new sub-directory of the root directory of the Petals container data area:
* the sub-directory {{artifacts}} in which artifacts should be placed before installation/deployment according to the following sub-tree:
** {{sl}}: in which all JBI shared library archives are put,
** {{components}}: in which all JBI component archives are put,
** {{sa}}: in which all JBI service assembly archives are put.
h2. Content of the package "{{petals-esb-wsapi}}"
This package provides only extension JARs file put in the directory {{/usr/share/petals-esb/extensions}}.
{column}
These Debian packages can be downloaded on [Petals' website|http://petals.ow2.org].
h1. Installing Petals ESB
Nowadays, no public repository exists containing the Debian packages of Petals ESB. So to install yours, you must download them, next install them with your favorite Debian tools ({{synaptic}}, {{apt-get}}, {{dpkg}}).
Several Debian packages are available:
|| Package || Description || Depends on || Required for a production use ||
| {{petals-commons}} | The base package of all Petals products | {{base-files}} | required |
| {{petals-esb}} | The base package of Petals ESB to run a minimalist container | {{java7-runtime-headless}}, {{curl}} and {{petals-commons}} | required |
| {{petals-esb-autoloader}} | The extension "Petals ESB Autoloader" | {{petals-esb}} | not recommended |
| {{petals-esb-artfifact-repository}} | The extension "Petals ESB artifact repository" | {{petals-esb}} | optional |
| {{petals-esb-wsapi}} | The extension "Petals ESB WS API" | {{petals-esb-artfifact-repository}} | optional |
+Note 1:+ The Petals ESB Autoloader is not recommended in production mode because of security reasons.
+Note 2:+ If your security policy requires to push your JBI artifacts on the host instead of downloading them, you can:
* use the extension Petals ESB artifact repository and push your JBI artifacts in its repository,
* or, push your JBI artifacts in a dedicated directory and use a remote Petals CLI with local file-based URLs.
{column}
{column:width=35%}
{panel:title=Table of contents}{toc:outline=true}{panel}
{panel:title=Contributors}{contributors:order=name|mode=list|showAnonymous=true|showCount=true|showLastTime=true}{panel}
{column}
{section}
h1. Uninstalling Petals ESB
According to Debian policies, Petals ESB packages can be uninstalled with or without purging configuration files, with your favorite Debian tools ({{synaptic}}, {{apt-get}}, {{dpkg}}).
In addition to the runtime files, the purge will remove following directories containing some configuration or working files:
* {{/etc/petals-esb/container-enable}}
* {{/var/lib/petals-esb}}
* {{/var/log/petals-esb}}
* {{/var/run/petals-esb}}
The dedicated Petals system user and group are also removed when purging packages. The Petals container configurations ({{/etc/petals-esb/container-available}}) are never removed except the sample one, to be reused eventually.
{tip}All Petals ESB containers declared into {{/etc/petals-esb/container-enable}} will be automatically stopped during the uninstallation process. If you have started manually other Petals ESB containers, you must stop them before to launch the uninstallation process.{tip}
h1. Upgrading Petals ESB
To update the installed version of Petals ESB:
* just uninstalled Petals ESB packages without purging it:
{code}> sudo dpkg -r petals-esb ...{code}
* and installed new Petals ESB packages.
{tip}All Petals ESB containers declared into {{/etc/petals-esb/container-enable}} will be automatically stopped during the uninstallation process and restarted during the installation process. If you have started manually other Petals ESB containers, you must stop them before to launch the uninstallation process, and restart them after the installation process.{tip}
h1. Content of the packages
h2. Content of the package "{{petals-esb}}"
This package arrives with following directories and files:
* {{/usr/bin/petals-esb}}: The script used to start a Petals container,
* {{/usr/bin/petals-esb.sh}}: A link to {{/usr/bin/petals-esb}}, for compatibility with previous versions,
* {{/usr/share/petals-esb}}: Directory containing all Java libraries required by Petals ESB,
* {{/usr/share/petals-esb/extensions}}: Directory containing all extensions of Petals ESB,
* {{/etc/init.d/petals-esb}}: Automatic startup/stop script
* {{/etc/petals-esb/container-available/<container-name>}}: A directory containing the configuration of a Petals container:
** {{server.properties}}: the base configuration of the Petals container,
** usually, the following configuration files are placed in the same directory than the file {{server.properties}}:
*** {{topology.xml}}: the Petals topology of which the container is a member,
*** {{loggers.properties}}: configuration file of the logging system based on JDK Logging,
* {{/etc/petals-esb/container-enable}}: A directory containing links to sub-directoryies of {{/etc/petals-esb/container-available}}. If a container is linked into this directory, it will be automatically started on machine startup,
* {{/var/lib/petals-esb/<container-name>}}: Default location of the root directory of the Petals container data area. It will contain:
** the sub-directory {{repository}} is the *default* storage area of the internal repository containing installed/deployed artefacts,
** the sub-directory {{work}} used as internal working area of the *default* container,
* {{/var/log/petals-esb/<container-name>}}: Default location in which logging files of the Petals container will be written,
* {{/usr/share/petals-esb/licenses}}: Directory containing license files.
h2. Content of the package "{{petals-esb-autoloader}}"
In addition to the extension JAR file put in the directory {{/usr/share/petals-esb/extensions}}, this package arrives with 2 new sub-directories of the root directory of the Petals container data area:
* the sub-directory {{install}}: the directory scanned by the auto-loader of the container to install/deploy artfifact,
* the sub-directory {{installed}}: the directory scanned by the auto-loader of the container to uninstall/undeploy artfifact.
h2. Content of the package "{{petals-esb-artfifact-repository}}"
In addition to the extension JAR file put in the directory {{/usr/share/petals-esb/extensions}}, this package arrives with one new sub-directory of the root directory of the Petals container data area:
* the sub-directory {{artifacts}} in which artifacts should be placed before installation/deployment according to the following sub-tree:
** {{sl}}: in which all JBI shared library archives are put,
** {{components}}: in which all JBI component archives are put,
** {{sa}}: in which all JBI service assembly archives are put.
h2. Content of the package "{{petals-esb-wsapi}}"
This package provides only extension JARs file put in the directory {{/usr/share/petals-esb/extensions}}.