Petals Cockpit 0.22.0-SNAPSHOT

Version 13 by Pierre Souquet
on Apr 23, 2018 17:03.

<< Changes from 12 to 13

compared with

Version 14 by Pierre Souquet
on Apr 23, 2018 17:28.

Changes from 14 to 15 >>

Key

This line was removed.

This word was removed. This word was added.

This line was added.

Changes (2)

View Page History

...

{section}
{column}

h1. 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.

{warning}
Petals Cockpit *0.22.0* works with Petals ESB *5.2.0*, but may also work in degraded mode with previous versions.
{warning}
{column}
{column:width=40%}
{panel:title=Table of contents}{toc}{panel}
{panel:title=Contributors}{contributors:order=name|mode=list}{panel}
{column}
{section}

h1. Installing Petals Cockpit

h2. Requirements

Petals Cockpit needs [Java 8|http://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html] to run the backend. {color:#333333}If you have more than one JRE available, set the environment variable JAVA_HOME with the path of the JRE you want to use.{color}

The [H2 Database|http://www.h2database.com/html/main.html] used by the backend is automatically handled. It can be changed from configuration files but, for now, no other than H2 were tested.

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

h2. Installing from .zip file

# Get latest compiled version from [Petals Cockpit project page|https://gitlab.com/linagora/petals-cockpit]
# Unpack it and go into the directory
# On POSIX systems, if needed, set the [execute bit|https://en.wikipedia.org/wiki/File_system_permissions] on *petals-cockpit.sh*
# Run Petals Cockpit script and follow instructions : 
{code}
$ ./petals-cockpit.sh
{code}

h2. Building and running from docker

A pre-built Petals Cockpit docker image is hosted on [its docker hub public repository|https://hub.docker.com/r/petals/petals-cockpit/].
Docker must be properly installed on your system for these commands to function.

# Download the image:
{code}
$ docker pull petals/petals-cockpit:latest
{code}
# Start in detached mode
{code}
$ docker run -d -p 8080:8080 --name petals-cockpit petals/petals-cockpit:latest
{code}

For exhaustive information about building and running a docker image of Petals Cockpit, see the [Github docker-petals-cockpit project page|https://github.com/petalslink/docker-petals-cockpit].

h2. Building and running from sources

# Build the frontend
{code}
$ cd frontend && yarn run build:product && cd ..
{code}
# Build Petals Cockpit (it will also build the backend)
{code}
$ mvn -s ci/settings.xml clean verify antrun:run@build-product-dist
{code}
# 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|https://en.wikipedia.org/wiki/File_system_permissions] on *petals-cockpit.sh*
# From there, run the script:
{code}
$ ./petals-cockpit.sh
{code}

For exhaustive information about building and running Petals Cockpit from its sources, see the [Gitlab Petals Cockpit project page|https://gitlab.com/linagora/petals-cockpit].

h2. Installation directory

The installation directory from ZIP archive and compiled sources contains :
* A *conf* directory which contains the *config.yml* server configuration file
* A *db* directory which contains the generated *cockpit.mv.db* and *cockpit.trace.db* data base files.
* A *lib* directory which contains the *petals-cockpit-X.X.X-capsule.jar* application jarfile.
* A *logs* directory which contains the log files generated at runtime.
* A *petals-cockpit.sh* run script.
* A *README.txt* helper file.

h1. Configuring Petals Cockpit

h2. Configuration file

The configuration file: *./conf/config.yml* allows you to configure cockpit server.

The server based on *Dropwizard*, you should find more informations about configuration [on their website.|http://www.dropwizard.io]

h3. Application connector

Here you can modify the port on which the frontend application will be served :

server:
  # the backend will be served via /api on 8080
  # note: this is relative to applicationContextPath
  rootPath: /api
  # the frontend will be served via / on 8080
  applicationContextPath: /
  applicationConnectors:
    - type: http
      port: 8080

{code}
server:

...

Validation query may have to be adapted as well to the chosen DB.{warning}

h3. Logging 

...

Wiki

Helpful links

Petals Cockpit 0.22.0-SNAPSHOT

Changes (2)