egeoffrey / egeoffrey-controller

The eGeoffrey controller manages the configuration of all the modules and coordinates sensors and run alerting rules
1 stars 0 forks source link

egeoffrey-controller

This is an eGeoffrey controller package.

Description

The eGeoffrey controller manages the configuration of all the modules and coordinates sensors and run alerting rules.

Install

To install this package, run the following command from within your eGeoffrey installation directory:

egeoffrey-cli package install egeoffrey-controller

After the installation, remember to run also egeoffrey-cli house start to ensure the Docker image of the package is effectively downloaded and started. To validate the installation, go and visit the 'eGeoffrey Admin' / 'Packages' page of your eGeoffrey instance. All the modules, default configuration files and out-of-the-box contents if any will be automatically deployed and made available.

Content

The following modules are included in this package.

For each module, if requiring a configuration file to start, its settings will be listed under 'Module configuration'. Additionally, if the module is a service, the configuration expected to be provided by each registered sensor associated to the service is listed under 'Service configuration'.

To configure each module included in this package, once started, click on the 'Edit Configuration' button on the 'eGeoffrey Admin' / 'Modules' page of your eGeoffrey instance.

Contribute

If you are the author of this package, simply clone the repository, apply any change you would need and run the following command from within this package's directory to commit your changes and automatically push them to Github:

egeoffrey-cli repo commit "<comment>"

After taking this action, remember you still need to build (see below) the package (e.g. the Docker image) to make it available for installation.

If you are a user willing to contribute to somebody's else package, submit your PR (Pull Request); the author will take care of validating your contributation, merging the new content and building a new version.

Build

Building is required only if you are the author of the package. To build a Docker image and automatically push it to Docker Hub, run the following command from within this package's directory:

egeoffrey-cli repo build egeoffrey-controller

To function properly, when running in a Docker container, the following additional configuration settings has to be added to e.g. your docker-compose.yml file (when installing through egeoffrey-cli, this is not needed since done automatically upon installation):

environment:
- EGEOFFREY_LOGGING_LOCAL=0
volumes:
- ./data/egeoffrey/logs:/egeoffrey/logs
- ./data/egeoffrey/config:/egeoffrey/config

Uninstall

To uninstall this package, run the following command from within your eGeoffrey installation directory:

egeoffrey-cli pacakge uninstall egeoffrey-controller

Remember to run also egeoffrey-cli house start to ensure the changes are correctly applied.

Tags

The following tags are associated to this package:

controller

Version

The version of this egeoffrey-controller is 1.4-9 on the master branch.