Merge pull request #16 from idcc-dev/release-1.0.0

- [Setup runtime environment (Ubuntu/Dockers/Kubernetes/Helm)](docs/setup_runtime.md)

- Clone the AdvantEDGE repo<br>

  `git clone https://github.com/<your-fork>/AdvantEDGE.git`<br>

  (*assuming local gitdir =* `~/AdvantEDGE`)

- Clone the AdvantEDGE repo

  ```

  git clone https://github.com/<your-fork>/AdvantEDGE.git

  ```

  > **Note:** Assumes local gitdir = `~/AdvantEDGE`

- Obtain AdvantEDGE binaries

  - [Build from source](#building)

  - Optionally use pre-built binaries (from GitHub release)

    ```

    # Get bin folder tarball from desired release

    cd ~/AdvantEDGE

    tar -zxvf advantedge.<version>.linux-amd64.tar.gz

    ```

- Setup [*meepctl*](docs/meepctl/meepctl.md) tool

  1. Copy to an executable path<br>

    `sudo cp ~/AdvantEDGE/bin/meepctl/meepctl /usr/local/bin/`

  2. Configure<br>

    `meepctl config set --ip <your-node-ip> --gitdir /home/<user>/AdvantEDGE`

  - Copy to an executable path

    ```

    sudo cp ~/AdvantEDGE/bin/meepctl/meepctl /usr/local/bin/

    ```

  - Configure

    ```

    meepctl config set --ip <your-node-ip> --gitdir /home/<user>/AdvantEDGE

    ```

- [Deploy AdvantEDGE](docs/deploy.md)

Versions we use:

- 1.09, 1.10, 1.12, 1.13, 1.14

- 1.13, 1.14

>**IMPORTANT NOTE**<br>

K8s deployment has a dependency on the node's IP address.<br>

# Monitoring

AdvantEDGE uses Elastic Stack to provide monitoring capabilities.

Prior to using AdvantEDGE's monitoring feature, it is necessary to configure it.

The following steps explain how to configure monitoring.

## Pre-requisites

- Familiarize with [AdvantEDGE Concepts](../concepts.md)

- [Deploy AdvantEDGE](../deploy.md)

## Elastic Stack

AdvantEDGE uses [Elastic Stack](https://www.elastic.co/products/) as a monitoring pipeline. It provides centralized logging for AdvantEDGE scenarios and core components. Elastic Stack components run in pods on the platform.

[Kibana](https://www.elastic.co/products/kibana) is the visualization component of Elastic Stack, it runs in a pod on the K8s cluster and provides a frontend of its own.

This will open a new browser tab with the Kibana frontend in it.

## Configure Monitoring

Prior to using the monitoring pipeline, it is necessary to configure it.

Configuration is done by issuing the following command:

'''

```

meepctl config kibana

'''

```

> **Note:** This command must be run every time the Elastic Stack is reinstalled on the platform

As a result, all the saved objects needed to populate Kibana's dashboards and index pattern are set.

 No newline at end of file

The following steps need to be done prior to using this scenario

#### Build demo binaries

#### Obtain demo binaries

##### Build from source

To build _iperf-proxy_ & _demo-server_ binaries from source code:

> **NOTE:** Binary files are created in ./bin/ folder

##### Optionally use pre-built binaries (from GitHub release)

```

# Get bin folder tarball from desired release

cd ~/AdvantEDGE/examples/demo1

tar -zxvf demo1.<version>.linux-amd64.tar.gz

```

#### Dockerize demo applications

Demo Application binaries must be dockerized (containerized) as container images in the local Docker registry. This step is necessary every time the demo binaries are updated.

#### Configure demo specific dashboards

Only need to do it once, or when the demo dashboard changes

Follow the procedure described in [Scenario Monitoring](../../docs/use/monitoring.md#configure-dashboards). The demo specific dashboard that is loaded can also be found at `AdvantEDGE/examples/demo1/demo1-dashboards.json`

> Demo specific dashboards are stored in Kibana.<br>

> Next time you want to use the demo scenario; demo specific dashboard will be available.

Follow the procedure described in [Scenario Monitoring](../../docs/use/monitoring.md#configure-dashboards). The demo specific dashboard that is loaded can also be found at `~/AdvantEDGE/examples/demo1/demo1-dashboards.json`

#### Start iperf proxy

# Copy frontend to bin folder

rm -r $DEMOBIN/static

mkdir -p $DEMOBIN/static

cp -Rf $BASEDIR/src/demo-frontend/dist/* $DEMOBIN/static

cp -Rf $BASEDIR/bin/demo-frontend/* $DEMOBIN/static

# Copy Dockerfile to bin folder

cp $BASEDIR/src/demo-server/Dockerfile $DEMOBIN