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 5 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 database 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 Configuration file Application connector Database Logging  Launching Petals Cockpit Using parameters Using commands Adding user and workspace Managing users Logging in Adding the first user with token Administrating users Adding a new user Managing existing users Using user preferences Changing theme Managing workspace The workspace perspective Creating the first workspace Adding a new workspace Selecting workspace Adding a description Managing people able to user this workspace Removing workspace Navigating between workspaces 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. 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.

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

The installation directory from ZIP archive and compiled sources contains :

• conf directory which contains the config.yml server configuration file
• db directory which contains the generated cockpit.mv.db and cockpit.trace.db database files.
• lib directory which contains the petals-cockpit-X.X.X-capsule.jar application jarfile.
• logs directory which contains the log files generated at runtime.
• third-party directory which contains:
  • licenses directory which contains backend licenses
  • third-party-backend-licenses.xml linking dependencies to their license
• petals-cockpit.sh run script.
• README.txt helper file.
• LICENSE.md Petals Cockpit license file.
• COPYRIGHT Petals Cockpit copyright file.
• THIRD-PARTY-BACKEND lists backend dependecies licenses
• THIRD-PARTY-FRONTEND lists backend frontend licenses

Configuring Petals Cockpit

Configuration file

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

The server is based on Dropwizard, you should find more informations about configuration on their website.

Application connector

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

server:
  applicationConnectors:
    - type: http
      port: 8080

Database

This section allows you to choose which database the backend will use.

You can specify the adress, driver and user/password to connect to the database.

 database:
  driverClass: org.h2.Driver
  user: petals
  password: petals
  url: jdbc:h2:./db/cockpit
  validationQuery: "/* Health Check */ SELECT 1"

Petals Cockpit 0.22.0 has only been tested with H2 database. Be careful changing this.  Validation query may have to be adapted as well to the chosen DB.

Logging 

This section allows you to choose where and how logs are displayed and archived. Dropwizard provides a rather customisable configuration system, this is the default for Petals Cockpit:

 server:
  requestLog:
    appenders:
      - type: file
        currentLogFilename: ./logs/cockpit-access.log
        archivedLogFilenamePattern: ./logs/cockpit-access-%d.log.gz

logging:
#Global logging setting
  level: INFO

#Specific cockpit loggers settings
#(will bypass the console threshold & filter)
  loggers:
    "org.ow2.petals.cockpit.server":
      level: INFO
      appenders:
        - type: console

#File logging uses global setting, console filters out global cockpit output
#(to avoid duplicates from previous specific logger)
  appenders:
    - type: file
      currentLogFilename: ./logs/cockpit.log
      archivedLogFilenamePattern: ./logs/cockpit-%d.log.gz
      archivedFileCount: 5
    - type: console
      threshold: WARN
      filterFactories:
      - type: cockpit-server-filter-factory

server.requestLog.appenders allows to choose where to log all REST requests reaching the server.

logging.appenders allows to choose where to log the application output, you can filter it by logging level. Levels can be OFF, ERROR, WARN, INFO, DEBUG, TRACE, or ALL.

• logging.level is the global level for the application output, it controls directly what will be found in logging.appenders.type: file (./logs/cockpit.log)
• logging.appenders.threshold (under type: console) is the level that will be displayed in the console from all sources (except from org.ow2.petals.cockpit.server.*). Cannot be set lower than global level.
• logging.loggers allows to set specific loggers at independent levels. Here you can set any specific java class or package to the desired level on top of the rest.

This way, by default, output from org.ow2.petals.cockpit.server.* java classes (petals cockpit code specifically) will be displayed under INFO level. While global output (from dropwizard framework or other dependencies) will remain at WARN level in the console.
The console filter cockpit-server-filter-factory filters out all output from org.ow2.petals.cockpit.server.*, in order to prevent duplicates from the specific logger it is advised to leave it.

Launching Petals Cockpit

When you launch Petals Cockpit for the first time, a Database will be created (if none was found at configured URL).

Also, if no user were found in the database, a token will be be generated in order to add an administrator using the web interface. For instance :

WARN  [2018-04-24 12:19:58,370] org.ow2.petals.cockpit.server.CockpitApplication: No users are present in the database: setup your installation via http://127.0.1.1:8080/setup?token=t3Zm5A8MtNUcRJgHPxwc

Be sure to have logging correctly set up for it to display.

There are also parameters and commands usable at launch.

Using parameters

Parameters can be added to the launching script petals-cockpit.sh :

Example:

$ ./petals-cockpit.sh --debug --no-db-migrate

Using commands

Adding user and workspace

The add-user command allows you to add an user

Example:

Adding a non admin user without workspace

$ ./petals-cockpit.sh add-user -u myUserName -n myName -p myPassword

Adding an admin user with workspace

$ ./petals-cockpit.sh add-user --username myUserName --name myName -p myPassword -w myWorkspace -a

Managing users

Logging in

When connecting to the web application, you have to log in. Type in your username and password to do so.

<img login>

Adding the first user with token

If no user are present in the database, a dialog box will allow you tu add one. You will have to use the token provided by the backend (if you used the link {ip}:{port}/setup?token={token} the token field will be pre-filled). You must fill the remaining username, password and name fields to be able to add the user. You will be redirected to the login page.

<img login token>

Administrating users

If you are an Administrator, you have access to the Administration page. To go there click on the gear icon on the top right corner. <img administration gear icon>

<img user administration page>

Adding a new user

By clicking on "ADD A NEW USER" you can open a form to add a new user. Type in his username, name and password and click "ADD" to add him.

Managing existing users

On the right you can see the list of exising users. By clicking on an user an edition form will unfold. You can then:

• Set him a new name and / or password. Type in the new values in the corresponding field to change them. Leaving password empty will not change his password. Then click "SAVE" ;
• Delete him by clicking on "DELETE".

Using user preferences

Once logged, you can access user preferences by clicking on the profile icon in the top right corner (the one on the far right).

<img user pref logo>

Changing theme

Here you can select the GUI theme. For now, this preference is stored locally on you browser local storage and is linked to the server address (Meaning each cockpit backend instance will have a shared theme set for any users using the same browser on the same machine).

Managing workspace

The workspace perspective

The workspace perspective is the perspective that opens by default when launching Petals Cockpit. 

The workspace is the entity that preserve the project and their contents. We can represent this as a directory. 
It aims to manage the different elements that make up the workspace: in particular the import of one or more bus ESB and the configuration of the elements in relation to it as well as consultation of existing services.

By default, this perspective contains the following windows :

• The Workspaces view displays the workspaces accessible by the authenticated user and allows to add new ones by clicking on the button seems like list in the top left corner near the workspace name ;
• The view of a Workspace that allows you to obtain information about it (description and list of users) is accessible by clicking on the button with its name in the top left corner or in the selection window at workspace ;
• The Bus Import view displays a specific import form with controls on the imput fields. To access it, just click on the button with an add icon in the area to the left where is the content of Petals ;
• The Petals view which allows to obtain a tree with all the elements attached to the bus. These elements are also called resources. Each of these resources has a detailed view, some also have a view of operations ;
• The Services view provides a detailed view of the service names and their dependencies ;

Creating the first workspace

Once logged in, you must set a name to your workspace. Then click on the add button to save it in a normally empty list on first use.
You can then see the name of the created workspace and your authorized access to access it.

Adding a new workspace

You can create as many workspace as you want, but by default they will all be empty.
It will be necessary to select the one on which you wish to work by simply clicking on it.

<img workspaces list>

Selecting workspace

Once workspace loaded, you will be redirected to the workspace page.

<img workspace overview>

Adding a description

By clicking on the edit icon from the whiteboard description area, you can put a specific description using markup formatting: *markdown*.
Then click “SUBMIT” to save or “CANCEL” if you want reset description.

Managing people able to user this workspace

WIP

Removing workspace

WIP

Navigating between workspaces

It is possible to browse the list of available workspaces for the user (ie, having access to it) and navigate between the workspaces.