Romp Documentation

Romp Package Layout

  • Last Modified: 2019-07-18

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 Package has the following layout:

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

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

The install.otter and uninstall.otter files are standard OtterScript plans that will be run when the package is installed or uninstalled. They may use any of the resources contained in the embedded rafts.

More on this topic:

Is this documentation incorrect or incomplete? Help us by contributing!

This documentation is licensed under CC-BY-SA-4.0 and stored in GitHub.

Generated from commit ce197caa on master