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.
halOS consists of two parts:
- Proxy (back-end, this repository)
- Console (front-end)
This repository contains the proxy. The proxy is a microservice running next to the managed services. It connects to the managed services and interacts with them. It exposes a REST API that is consumed by the console.
- Quarkus
- JAX-RS
- Server Sent Events
- fabric8 OpenShift client
./mvnw installPlease refer to the halOS distribution about how to set up all services on OpenShift, start halOS and access the console.
To run the proxy, you need to have access to 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.
Once you have access to your OpenShift cluster, create a .env file in the proxy folder and add the following settings:
_DEV_QUARKUS_KUBERNETES-CLIENT_MASTER-URL=<OpenShift REST API>
_DEV_QUARKUS_KUBERNETES-CLIENT_TOKEN=<security token>
_DEV_QUARKUS_KUBERNETES-CLIENT_NAMESPACE=<your namespace>Then start the proxy in dev mode, using
cd proxy
./mvnw quarkus:dev