https://github.com/hal/halos-distribution
halOS Distribution
https://github.com/hal/halos-distribution
monitoring openshift wildfly
Last synced: 4 days ago
JSON representation
halOS Distribution
- Host: GitHub
- URL: https://github.com/hal/halos-distribution
- Owner: hal
- License: apache-2.0
- Created: 2020-06-12T11:26:18.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2022-12-28T18:21:44.000Z (over 3 years ago)
- Last Synced: 2025-02-24T16:39:30.387Z (over 1 year ago)
- Topics: monitoring, openshift, wildfly
- Language: Shell
- Size: 102 KB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# halOS Distribution
halOS stands for **HAL** on **O**pen**S**hift. It is derived from [HAL](https://hal.github.io/) 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](https://github.com/hal/halos-proxy) (back-end)
2. [Console](https://github.com/hal/halos-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](https://developers.redhat.com/developer-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](https://docs.openshift.com/container-platform/latest/cli_reference/openshift_cli/getting-started-cli.html#installing-openshift-cli) `oc`.
## Setup
The `./setup.sh` script contains everything to set up OpenShift, halOS and sample services:
```shell
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](https://quay.io/repository/halconsole/halos). The demo services are based on [quay.io/hpehl/wildfly-halos-demo](https://quay.io/repository/hpehl/wildfly-halos-demo), [quay.io/hpehl/quarkus-halos-demo](https://quay.io/repository/hpehl/quarkus-halos-demo) and [quay.io/halconsole/wildfly](https://quay.io/repository/halconsole/wildfly).
### Quickstart
To set up everything and open the console in the browser, simply run
```shell
./setup.sh all
./console.sh
```
## Cleanup
To clean everything up again, use the `./cleanup.sh` script:
```shell
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](https://github.com/hal/halos-proxy#development) and the [console](https://github.com/hal/halos-console#development).