# Codehaus Cargo : Cargo Daemon

Created by S. Ali Tokmen, last modified on Nov 18, 2023

# Introduction

The Cargo Daemon is a Web-based application that uses the Cargo API to configure, start and stop containers on a remote machine.

The daemon is meant to be listening 24/7, to allow users to deploy new containers and web applications at their command.

It can be accessed using a browser-based UI, via Java API, Ant tasks or Maven 3 plugin.

# Why use the Cargo Daemon?

Most web containers (e.g. Tomcat, Jetty) provide built-in remote deployment facilities already, also many of them already have daemon integrations; so why use the Cargo Daemon?

- During intense redeployment (i.e., testing and even sometimes QA or production hot deployments): All of the remote deployment facilities that keep the JVM alive will eventually suffer from the dreaded `java.lang.OutOfMemoryError: PermGen space` exception if something in the web application is leaking memory.
  Most web containers try their best to track down these 'dead' objects and forcefully remove them, but it does not always succeed to reclaim the memory. With a leaking web application, the available memory starts to shrink after each redeploy, and eventually the memory is exhausted.
  The only solution to this is to kill the JVM, and restart it. And that is exactly what the Cargo Daemon tries to manage. It will try to shutdown the web application cleanly, but if that fails it will forcefully kill the JVM.
  It is the only way to guarantee that a new version of your web application always starts when you want it to.
- In heterogeneous environments: With Cargo, the way you configure the container is independent from the underlying server: you can set the different configuration properties, define datasources, add deployables, etc. transparently. You can therefore use the Cargo Daemon as a container-independent daemon, with support for the generation of the proper configuration on all supported containers.
- During upgrades and/or application server product evaluations: As Cargo is not dependent on the application server nor on its version, you can easily reuse an existing Cargo Daemon setup to use it for another version of a container, or another container altogether; without having to worry about understanding how to configure it.

# Table of Contents

The documentation for the Cargo Daemon includes:

- Installation: explains how to install and run the daemon
- Getting started: very quick guide on using the daemon

#

# Installation

To install and run the Cargo Daemon:

1. Download the Cargo Daemon from the Downloads page
2. Execute by typing:

    java -jar cargo-daemon-webapp-<version>.war

where `<version>` is the version number of the daemon that you have downloaded.

By default, the Cargo Daemon will run on HTTP port `18000`. To change it, use the `-p` option:

    java -jar cargo-daemon-webapp-<version>.war -p 18001

Additionally, Cargo Daemon will save log files in the cargo home directory unless the `-nologging` option is used.

Note that the Cargo Daemon is a WAR file; you can actually also deploy it as a WAR on any existing container. This can be useful if you want to, for example, reuse a certain security configuration.

The daemon also accepts other parameters, in the form of system properties:

Property name | Description | Mandatory? | Default value
--- | --- | --- | ---
`daemon.home` | Directory in which the standalone daemon server stores its files. These include the temporary files (such as its own WAR and server temporary files) as well as the server log files (`AWS-xxxxxxxxxxxxx.log`, where `xxxxxxxxxxxxx` is the timestamp at which the deamon was started). This property is not used and completely ignored if the daemon WAR file is deployed on an existing container. |  | `${user.home}/.cargo`
`cargo.home` | Directory in which the daemon (be it standalone or deployed on an existing container) stores the list of containers, downloaded container archives, container logs, etc. |  | `${user.home}/.cargo` Note that the standalone daemon by default sets this to `${daemon.home}`
`cargo.daemon.passwordFile` | Property file with username and passwords which would be allowed to access the Cargo Daemon: Passwords can either be put in plaintext, or prefixed with the hashing algorithm to use and the associated hash. Only `Basic` authentication is supported. Some examples:
    # Example 1: User without any password
    cargo-daemon-user_=

    # Example 2: User with a password written as plain text
    cargo-daemon-user1=cargo-password

    # Example 2, second variant: User with a password written as plain text, containing a curly bracket
    cargo-daemon-user0={cargo-password

    # Example 3: User with a password hashed in md5. The password is: cargo-password
    cargo-daemon-user2={MD5}9addb63b65b01292700094b0ef056036

    # Example 4: User with a password hashed in sha1. The password is: cargo-password
    cargo-daemon-user3={SHA-1}2681c738294805939045be2a4af53b687c25bf4d
Note: This functionality is new with Cargo Daemon version 1.10.11. |  | N/A

#

# Getting started using the browser UI

To use the Cargo Daemon via the browser UI, simply open `http://<machine>:<port>/` -where `<machine>` is the machine host name or IP address and `<port>` is the port number used (default is `18000`):

- To start a container, fill in the form and press Start:
  Note: The start button is actually equivalent to a restart in Cargo's terms, i.e. in the case a container with the same `handle id` already exists then it will be stopped first before your container is started. This also implies that in case the new container fails to start, the old one will not be restarted.
- To stop, restart, delete or view logs of a container, use the actions on the containers list:
- The Cargo Daemon keeps a persistent record on disk of all the containers that have been submitted. Containers that have been submitted will stay in the list, even when they are stopped. This allows you to manually restart them, or view the logs even after the container is stopped.
- If you want the container to be removed from the list, simply press the delete button.
- Containers can also be submitted with the `autostart` property, this will automatically restart the container if the daemon notices it is stopped.

#

# Getting started with the Java API / Ant tasks / Maven 3 plugin

As stated before, the Cargo Daemon is also available programmatically:

- The details of the Java API can be seen on the Javadoc for o.c.c.tools.daemon.DaemonClient

- To use the Daemon via Ant tasks, simply add the `<daemon>` tag in the task and use the daemon-start or daemon-stop tasks:

      <cargo containerId="tomcat7x" action="daemon-start">
        <zipUrlInstaller
          installURL="https://repo.maven.org/maven2/org/apache/tomcat/tomcat/7.0.68/tomcat-7.0.68.zip"
              downloadDir="${basedir}/../../../../core/samples/java/installs"
              extractDir="${catalina.root}">
            </zipUrlInstaller>
        <configuration home="${catalina.base}">
          [...]
        </configuration>
        <daemon>
          <property name="cargo.daemon.handleid" value="test1"/>
          <property name="cargo.daemon.url" value="http://localhost:18000/"/>
          <property name="cargo.daemon.username" value="myuser"/>
          <property name="cargo.daemon.password" value="secret"/>
        </daemon>
      </cargo>

- The details of the configuration for the Maven 3 plugin is documented in the
  Daemon configuration section of the Maven 3 plugin reference guide and the example can be seen via the Daemon archetype.

## Attachments:

Container options.png (image/png)
Container options.png (image/png)
Container options.png (image/png)
Container options.png (image/png)
Container actions.png (image/png)
Container options.png (image/png)
Container options.png (image/png)
Container options.png (image/png)
Container options.png (image/png)
Container options.png (image/png)
Container options.png (image/png)