Add Ansible roles

[stefanDeveloper]

Summary

Currently, we only support Docker. Some users may request to run modules on host systems directly. Therefore, Ansible roles are needed.

[stefanDeveloper]

See https://github.com/torfsen/python-systemd-tutorial/blob/master/python_demo_service.service for more information

[stefanDeveloper]

@lamr02n I suggest implementing the Ansible roles in a new repository at https://github.com/heiDGAF. What are your thoughts on that?

[lamr02n]

I suggest implementing the Ansible roles in a new repository. What are your thoughts on that?

After some research, I found that having two separate repositories for the two implementations could lead to some difficulties regarding pushing changes to them. Since we're still in development, we would have to manually copy changes to both repos (unless we find a clever automatic way to do that).

I suggest that we go for either (1) a subdirectory in the current repo for Ansible or (2) two separate repos for Docker and Ansible, with a third one with the base implementation.

In option (1) almost nothing would change in comparison to the current workflow, but it would result in a bigger repo size which might be disadvantageous to some users. Option (2) would mean that we have to remove the Docker implementation from the current repo, and add two repos importing the base module.

I personally think that option (2) would be the best approach in the long run since adding new implementations would be easiest. However, we thoroughly have to plan this to get it right. Is that an approach that sounds realistic to you @stefanDeveloper?

[stefanDeveloper]

There is no need to push changes to both repositories simultaneously. The Ansible repository only consists of Ansible Files. Deploying heiDGAF without Docker means cloning the repository and setting the correct start script (systemd config).
I would avoid option (1). For option (2), I don't see the need for a third repository to hold the base implementation. I would prefer to have all Python code in one place. Extracting the Docker images to another repository is an option. However, I don't see a big advantage in doing so. If a user wants to use the Ansible Roles to deploy the Docker containers (currently out of scope), we fetch the containers from Docker Hub.
So yes, let's go with a slim option (2).

[lamr02n]

So yes, let's go with a slim option (2).

Ah, alright. Thanks for clarifying! Yes, this sounds good from my side.

[stefanDeveloper]

For simplicity, we do not integrate Ansible Roles for heiDGAF.
In essence, users either have to install Docker / set up a Swarm Cluster and deploy them accordingly or start it as a systemd service.
As an example, users can just copy the systemd file and deploy via Ansible or add it manually.

# systemd unit file for the heiDGAF


[Unit]

# Human readable name of the unit
Description=heiDGAF Collector


[Service]

# Command to execute when the service is started
ExecStart=/usr/bin/python /srv/docker/heiDGAF/src/logcollector/collector.py 

# Disable Python's buffering of STDOUT and STDERR, so that output from the
# service shows up immediately in systemd's logs
Environment=PYTHONUNBUFFERED=1

# Automatically restart the service if it crashes
Restart=on-failure

# Our service will notify systemd once it is up and running
Type=notify

# Use a dedicated user to run our service
User=python_demo_service


[Install]

# Tell systemd to automatically start this service when the system boots
# (assuming the service is enabled)
WantedBy=default.target

Just make sure the config.yaml is in the correct folder.