halOS Distribution

halOS stands for HAL on OpenShift. It is derived from HAL and allows monitoring and inspection of WildFly and other services running on OpenShift. Although the focus is on WildFly, halOS supports monitoring arbitrary services. This is achieved through the concept of capabilities and extensions.

Architecture

halOS consists of two parts:

1. Proxy (back-end)
2. Console (front-end)

This repository contains scripts to set up halOS on an OpenShift cluster. The easiest way to get started is to use the OpenShift sandbox. The sandbox provides you with a private OpenShift environment in a shared, multi-tenant OpenShift cluster that is pre-configured with a set of developer tools.

Finally, you need to install the OpenShift command line tools oc.

Setup

The ./setup.sh script contains everything to set up OpenShift, halOS and sample services:

USAGE:
    setup.sh [FLAGS] all|openshift|halos|services

FLAGS:
    -d, --dev           Apply development settings
    -h, --help          Prints help information
    -v, --version       Prints version information
    --no-color          Uses plain text output

ARGUMENTS:
    all                 Setup everything
    openshift           Setup service account, roles and role binding
    halos               Deploy halOS service and routes
    services            Deploy WildFly and Quarkus demo services

You can set up everything in one go using ./setup.sh all, or do it incrementally. The latter is useful if you first want to start halOS and then start the services. If you choose to set it up incrementally, make sure to run ./setup.sh openshift first.

halOS is deployed from quay.io/halconsole/halos. The demo services are based on quay.io/hpehl/wildfly-halos-demo, quay.io/hpehl/quarkus-halos-demo and quay.io/halconsole/wildfly.

Quickstart

To set up everything and open the console in the browser, simply run

./setup.sh all
./console.sh

Cleanup

To clean everything up again, use the ./cleanup.sh script:

USAGE:
    cleanup.sh [FLAGS] all|halos|services

FLAGS:
    -d, --dev           Apply development settings
    -h, --help          Prints help information
    -v, --version       Prints version information
    --no-color          Uses plain text output

ARGUMENTS:
    all                 Cleanup everything
    halos               Undeploy halOS service and routes
    services            Undeploy WildFly and Quarkus demo services

Development

To run halOS in dev mode, follow the related sections for the proxy and the console.