Update readme and setup environment files

Author: stecatta00

README.md

@@ -48,7 +48,7 @@ This way, we can run several emulated edge nodes by simply executing multiple Do
 - Docker CE 25.0.1
 - Sysbox CE 0.6.3
 
-#### Setup environment using the Ansible playbook
+#### Setup environment and deploy using the Ansible playbook
 
 Install [Ansible](https://www.ansible.com/), an agentless automation tool that you install on a single host, referred to as the control node.  
 Then, using the [setup_playbook.yaml](setup_playbook.yaml) file, your Ansible control node can setup the environment to execute DFaaS on the managed node(s) specified in an inventory file.
@@ -69,13 +69,16 @@ Run the `ansible-playbook` command on the control node to execute the tasks spec
 
 `-i` : path to an inventory file  
 `--extra-vars` : to specify the Sysbox version and shiftfs branch to be installed
+`--tags` : to specify steps of the playbook to be executed
 
 > The following command assumes you are using Ubuntu 22.04 LTS with kernel version 5.15 or 5.16.
 
 ```shell
-ansible-playbook -i inventory.yaml setup_playbook.yaml --extra-vars "sysbox_ver=0.6.3 shiftfs_ver=k5.16"
+ansible-playbook -i inventory.yaml setup_playbook.yaml --extra-vars "sysbox_ver=0.6.3 shiftfs_ver=k5.16" --tags "installation, deploy"
 ```
 
+This Ansible playbook installs the required software and executes the [docker-compose.yml](docker-compose.yml), deploying three DFaaS nodes containers, and a fourth container called [operator](operator), which deploys functions on DFaaS nodes and starts specified load tests.
+
 #### Manual
 
 _Ansible_
@@ -95,20 +98,6 @@ You can follow the [official user guide](https://github.com/nestybox/sysbox/blob
 > We instead recommend installing [shiftfs](https://github.com/nestybox/sysbox/blob/master/docs/user-guide/install-package.md#installing-shiftfs)
 > according to your kernel version as suggested by the Sysbox CE user guide.
 
-### Build Docker images
-
-```shell
-# Paths assume you are executing from the project root directory
-docker build -t dfaas-agent-builder:latest -f docker/dfaas-agent-builder.dockerfile dfaasagent
-docker build -t dfaas-node:latest -f docker/dfaas-node.dockerfile docker
-```
-
-### Run a 3 nodes network via Docker Compose
-See the provided [docker-compose.yml](docker-compose.yml) file for technical details.
-```shell
-docker compose up -d
-```
-
 ### Deploy functions
 This script deploy the same set of functions on each of the nodes by using [docker/files/deploy_functions.sh](docker/files/deploy_functions.sh).
 The [deploy_functions.sh](docker/files/deploy_functions.sh) script waits for the OpenFaaS gateway to be up (max 20 retries, 10s delay),
@@ -125,6 +114,8 @@ the default name you get when using the provided docker-compose.yml file.
 ./utils/deploy-functions-to-nodes.sh 3 "dfaas-node-" "-1"
 ```
 
+Alternatively you can exploit the deployment functionalities of the [operator](operator).
+
 ### Invoke a function
 Each node exposes port `808x:80` (e.g., `node-1` exposed port is `8081:80`), where port `80` is the HAProxy port.
 This example assumes you run DFaaS nodes via Docker Compose with the provided [docker-compose.yml](docker-compose.yml) file.
@@ -163,10 +154,11 @@ jq -ncM '{method: "GET", url: "http://localhost:8081/function/figlet", body: "He
   vegeta report -every=200ms
 ```
 
+You can also start multiple parallel Vegeta attacks exploiting [operator](operator) functionalities.
+
 ### Create plots from vegeta results
-You can produce some plots from vegeta results by exploiting the `vegeta plot` command or
-our [utils/plot.py](utils/plot.py) script.
-To use our script, you need to install the required Python packages listed in [utils/plot-requirements.txt](utils/plot-requirements.txt).
+You can produce some plots from vegeta results by exploiting the `vegeta plot` command or our [plot-results.py](operator/docker/files/plot-results.py) script, which is automatically executed after tests execution with the [operator](operator).
+To use our script, you need to install the required Python packages listed in [plot-requirements.txt](operator/docker/files/plot-requirements.txt).
 
 ```shell
 # Encode results as JSON
@@ -175,10 +167,11 @@ cat $VEGFOLDER/results.bin | vegeta encode > $VEGFOLDER/results.json
 # Create plot with vegeta
 cat cat $VEGFOLDER/results.bin | vegeta plot > $VEGFOLDER/plot.html
 
-# 1st arg: path int results.json
-# 2nd arg: path output plot
-# 3rd arg: rate req/s used for the attack
-./utils/plot.py $VEGFOLDER/results.json $VEGFOLDER/plot.png 50
+# 1st arg: path  results.json
+# 2nd arg: path output folder
+# 3rd arg: rate req/s used for the attack (if merged is True specify rate=0)
+# 4th arg: boolean merged (is the input file merged from multiple attacks?)
+./operator/docker/files/plot-results.py $VEGFOLDER/results.json $VEGFOLDER/plots 50 False
 ```
 
 ### Forwarding traffic as a malicious node

docker-compose.yml

@@ -51,12 +51,12 @@ services:
   operator:
     image: dfaas-operator:latest
     build:
-      context: ./docker
-      dockerfile: docker/dfaas-operator.dockerfile
+      context: ./operator/docker
+      dockerfile: ./operator/docker/dfaas-operator.dockerfile
     env_file:
-      - dfaasoperator.env
+      - ./operator/dfaasoperator.env
     volumes:
-      - $HOME/vegeta-results:/vegeta-results
+      - $HOME:/tests
     networks:
       p2p-overlay:
 

setup_playbook.yaml

@@ -11,6 +11,8 @@
     - name: Update apt packages
       apt:
         update_cache: true
+      tags:
+      - installation
 
     - name: Install required system packages
       apt:
@@ -29,54 +31,70 @@
         - apt-transport-https
         - software-properties-common
         - git
+      tags:
+      - installation
 
     - name: Create directory for Docker's GPG key
       file:
         path: /etc/apt/keyrings
         state: directory
         mode: '0755'
+      tags:
+      - installation
 
     - name: Add Docker's official GPG key
       apt_key:
         url: https://download.docker.com/linux/ubuntu/gpg
         keyring: /etc/apt/keyrings/docker.gpg
         state: present
+      tags:
+      - installation
 
     - name: Change GPG key permissions
       file:
         path: /etc/apt/keyrings/docker.gpg
         state: file
         mode: 'a+r'
+      tags:
+      - installation
 
     - name: Set up the stable repository
       apt_repository:
         repo: deb [arch={{ arch_mapping[ansible_architecture] | default(ansible_architecture) }} signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu {{ ansible_lsb.codename }} stable
         filename: docker
         state: present
         update_cache: true
+      tags:
+      - installation
 
     - name: Install Docker and related packages
       apt:
         name: "{{ item }}"
         state: present
         update_cache: true
       loop:
-        - docker-ce=5:27.0.3-1~ubuntu.{{ ansible_lsb.release }}~{{ ansible_lsb.codename }}
-        - docker-ce-cli=5:27.0.3-1~ubuntu.{{ ansible_lsb.release }}~{{ ansible_lsb.codename }}
+        - docker-ce=5:27.1.1-1~ubuntu.{{ ansible_lsb.release }}~{{ ansible_lsb.codename }}
+        - docker-ce-cli=5:27.1.1-1~ubuntu.{{ ansible_lsb.release }}~{{ ansible_lsb.codename }}
         - containerd.io
         - docker-buildx-plugin
         - docker-compose-plugin
+      tags:
+      - installation
 
     - name: Add Docker group
       group:
         name: docker
         state: present
+      tags:
+      - installation
 
     - name: Add user to docker group
       user:
         name: "{{ ansible_user_id }}"
         groups: "docker"
         append: true
+      tags:
+      - installation
 
     - name: Enable and start Docker services
       systemd:
@@ -86,51 +104,100 @@
       loop:
         - docker.service
         - containerd.service
+      tags:
+      - installation
 
     - name: Create sysbox directory
       file:
         path: ./sysbox
         state: directory
+      tags:
+      - installation
 
     - name: Download sysbox package
       get_url:
         url:
           https://downloads.nestybox.com/sysbox/releases/v{{ sysbox_ver }}/sysbox-ce_{{ sysbox_ver }}-0.linux_{{ arch_mapping[ansible_architecture] | default(ansible_architecture) }}.deb
         dest: ./sysbox/sysbox-ce.deb
+      tags:
+      - installation
 
     - name: Install sysbox package
       apt: deb=./sysbox/sysbox-ce.deb
+      tags:
+      - installation
 
     - name: Git clone shiftfs repository
       git:
         repo: https://github.com/toby63/shiftfs-dkms.git
         dest: ./shiftfs-{{ shiftfs_ver }}
         single_branch: yes
         version: '{{ shiftfs_ver }}'
+      tags:
+      - installation
 
     - name: Update kernel
       shell: ./shiftfs-{{ shiftfs_ver }}/update1
+      tags:
+      - installation
 
     - name: Build Makefile
       make:
         chdir: ./shiftfs-{{ shiftfs_ver }}
         file: Makefile.dkms
-    - name: Git clone dfaas repository
-      git:
-        repo: https://github.com/UNIMIBInside/dfaas.git
-        dest: ./dfaas-repo
-        single_branch: yes
-        version: stecattaneo-dev
+      tags:
+      - installation
+
+    - name: Copy dfaasagent directory
+      ansible.builtin.copy:
+        src: ./dfaasagent
+        dest: ~/dfaas/
+      tags:
+      - deploy
+    
+    - name: Copy docker directory
+      ansible.builtin.copy:
+        src: ./docker
+        dest: ~/dfaas/
+      tags:
+      - deploy
+
+    - name: Copy docker compose file
+      ansible.builtin.copy:
+        src: ./docker-compose.yml
+        dest: ~/dfaas/
+      tags:
+      - deploy
+
+    - name: Copy ENV file
+      ansible.builtin.copy:
+        src: ./dfaasagent.env
+        dest: ~/dfaas/dfaasagent.env
+      tags:
+      - deploy
+
+    - name: Copy Operator directory
+      ansible.builtin.copy:
+        src: ./operator
+        dest: ~/dfaas/
+      tags:
+      - deploy
+
     - name: Build Docker images
       ansible.builtin.command:
-        chdir: ./dfaas-repo
+        chdir: ~/dfaas
         cmd: "{{ item }}"
       loop:
         - "docker build -t dfaas-agent-builder:latest -f docker/dfaas-agent-builder.dockerfile dfaasagent"
         - "docker build -t dfaas-node:latest -f docker/dfaas-node.dockerfile docker"
-        - "docker build -t dfaas-operator:latest -f docker/dfaas-operator.dockerfile docker"
+        - "docker build -t dfaas-operator:latest -f operator/docker/dfaas-operator.dockerfile operator/docker"
+      tags:
+      - deploy
+
     - name: Deploy Docker Compose stack
       ansible.builtin.command:
-        chdir: ./dfaas-repo
+        chdir: ~/dfaas
         cmd: docker compose up -d
+      tags:
+        - deploy