Skip to content

Installing a development environment

Jump to bottom
Wolfgang Hotwagner edited this page May 21, 2021 · 9 revisions

Every code-contributer for the logdata-anomaly-miner has to setup a development environment. For that the following steps are necessary:

  • Install all packages and dependencies for the logdata-anomaly-miner
  • Configure the system so that it is prepared for the logdata-anomaly-miner
  • Fork the logdata-anomaly-miner into your private github-workspace
  • Clone the development branch
  • Install the logdata-anomaly-miner from source

After that further development can be done in feature-branches of the source. If you want to test your changes locally, you have to deploy the modified files from your git-repository into your system. The following sections will explain how to do that easily.

Requirements

Installation from source

We prepared a simple installer script that runs all the installation tasks. Please note that you have to run this script as a user who is allowed to run sudo. The following script uses the url for ssh-access. If you don't have a working ssh-key on your machine, replace the url with the https-url.

cd $HOME
wget https://raw.githubusercontent.com/ait-aecid/logdata-anomaly-miner/development/scripts/aminer_install.sh
chmod +x aminer_install.sh
./aminer_install.sh -b development -u git@github.com:<YOURGITACCOUNT>/logdata-anomaly-miner.git -d $HOME/logdata-anomaly-miner

Now you have the source-tree in $HOME/logdata-anomaly-miner and a working aminer-installation on your machine.

Deploy changes

After you created a feature-branch and modified the sources, you probably want to deploy the modified files on your system and run AMiner in order to test your changes. You can do that by simply running the ansible-playbook:

cd $HOME/logdata-anomaly-miner
sed -e "s+{{SOURCEDIR}}+$PWD+g" .playbook.yml > playbook.yml
sudo ansible-playbook playbook.yml
Clone this wiki locally