Introduction Petals Cockpit is a web interface to administrate a set of Petals ESB topologies. It is a Java standalone server application running as backend, which serves over HTTPS an Angular 2 frontend application that will run in the browser. From the web interface, users can connect to running instances of Petals containers and then administrate and deploy artifacts on them. The backend uses a data base to hold all persistent informations, like users and workspaces. Petals Cockpit 0.22.0 works with Petals ESB 5.2.0, but may also work in degraded mode with previous versions.

Table of contents Introduction Installing Petals Cockpit Requirements Installing from .zip file Building and running from docker Building and running from sources Installation directory Configuring Petals Cockpit Contributors No contributors found for: authors on selected page(s)

Installing Petals Cockpit

Requirements

Petals Cockpit needs Java 8 to run the backend. If you have more than one JRE available, set the environment variable JAVA_HOME with the path of the JRE you want to use.

The H2 Database used by the backend is automatically handled, there is no other usable DB for now, but it is foreseen.

The supported browsers are Chrome and chromium variants. While not officially supported, the frontend is highly compatible with Firefox.

Installing from .zip file

1. Get latest compiled version from Petals Cockpit project page
2. Unpack it and go into the directory
3. On POSIX systems, if needed, set the execute bit on petals-cockpit.sh
4. Run Petals Cockpit script and follow instructions : 

   $ ./petals-cockpit.sh
   

Building and running from docker

A pre-built Petals Cockpit docker image is hosted on its docker hub public repository.
Docker must be properly installed on your system for these commands to function.

1. Download the image:

   $ docker pull petals/petals-cockpit:latest
   

2. Start in detached mode

   $ docker run -d -p 8080:8080 --name petals-cockpit petals/petals-cockpit:latest
   

For exhaustive information about building and running a docker image of Petals Cockpit, see the Github docker-petals-cockpit project page.

Building and running from sources

1. Build the frontend

   $ cd frontend && yarn run build:product && cd ..
   

2. Build Petals Cockpit (it will also build the backend)

   $ mvn -s ci/settings.xml clean verify antrun:run@build-product-dist
   

3. The final distribution directory (as found in the .zip version) will be in cockpit/target/dist. On POSIX systems, if needed, set the execute bit on petals-cockpit.sh
4. From there, run the script:

   $ ./petals-cockpit.sh
   

For exhaustive information about building and running Petals Cockpit from its sources, see the Gitlab Petals Cockpit project page.

Installation directory

petals-cockpit-X.X.X
    ??? conf
    ?   ??? config.yml
    ??? db
    ?   ??? cockpit.mv.db
    ?   ??? cockpit.trace.db
    ??? lib
    ?   ??? petals-cockpit-X.X.X-capsule.jar
    ??? logs
    ?   ??? cockpit-access.log
    ?   ??? cockpit.log
    ??? petals-cockpit.sh
    ??? conf    ??? README.txt
    ?   ??? config.yml

 petals-cockpit-X.X.X
    ??? conf
    ?   ??? config.yml
    ??? db
    ?   ??? cockpit.mv.db
    ?   ??? cockpit.trace.db
    ??? lib
    ?   ??? petals-cockpit-X.X.X-capsule.jar
    ??? logs
    ?   ??? cockpit-access.log
    ?   ??? cockpit.log
    ??? petals-cockpit.sh
    ??? conf    ??? README.txt

Configuring Petals Cockpit