Romp Documentation

Romp Package Layout

Romp Documentation Note - This documentation is incomplete.

As we continue working on Romp, the documentation will be updated.

A Romp Package is a special Universal Package that contains everything Romp will need to deploy an application and/or infrastructure configuration.

Romp Packages at a minimum must include a standard installation and configuration script (install.otter), and a metadata file (upack.json).

Aside from the primary configuration script, and the required metadata file, packages can also contain variables, credentials, extensions, Otter rafts, and additional metadata (rompPackage.json).

A Romp-pack package has the following layout:

    package/
        rafts/
            raft1/…
            raft2/…
        extensions/
        upack.json
        rompVariables.json
        rompCredentials.json
        rompPackage.json
        install.otter

The rafts/ directory contains exported Otter rafts which are used by the install script. Each subdirectory in this directory is equivalent to a named filesystem raft.

The extensions/ directory contains the Otter extensions that the plan requires. Romp will automatically load them. This directory is optional; if extensions are not present then runtime execution errors may result.

The install.otter file is a standard OtterScript configuration plan that will be run when the package is installed. It may use any of the resources contained in the embedded rafts.

More on this topic: