diff --git a/README.md b/README.md index f6f61f7ce..c0bbee190 100644 --- a/README.md +++ b/README.md @@ -30,15 +30,30 @@ Before getting started we recommend familiarity with key [AdvantEDGE concepts](d - [Setup runtime environment (Ubuntu/Dockers/Kubernetes/Helm)](docs/setup_runtime.md) -- Clone the AdvantEDGE repo
- `git clone https://github.com//AdvantEDGE.git`
- (*assuming local gitdir =* `~/AdvantEDGE`) +- Clone the AdvantEDGE repo + ``` + git clone https://github.com//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..linux-amd64.tar.gz + ``` - Setup [*meepctl*](docs/meepctl/meepctl.md) tool - 1. Copy to an executable path
- `sudo cp ~/AdvantEDGE/bin/meepctl/meepctl /usr/local/bin/` - 2. Configure
- `meepctl config set --ip --gitdir /home//AdvantEDGE` + - Copy to an executable path + ``` + sudo cp ~/AdvantEDGE/bin/meepctl/meepctl /usr/local/bin/ + ``` + - Configure + ``` + meepctl config set --ip --gitdir /home//AdvantEDGE + ``` - [Deploy AdvantEDGE](docs/deploy.md) diff --git a/docs/setup_runtime.md b/docs/setup_runtime.md index 3632e9a69..6a4a0ec8a 100644 --- a/docs/setup_runtime.md +++ b/docs/setup_runtime.md @@ -48,11 +48,11 @@ We use the kubeadm method from [here](https://kubernetes.io/docs/setup/independe Versions we use: -- 1.09, 1.10, 1.12, 1.13, 1.14 +- 1.13, 1.14 >**IMPORTANT NOTE**
K8s deployment has a dependency on the node's IP address.
-From our experience, it is **strongly recommended** to ensure that your platfrom always gets the same IP address for the main interface when it reboots. It also makes usage of the platform easier since it will reside at a well-known IPon your network.
+From our experience, it is **strongly recommended** to ensure that your platfrom always gets the same IP address for the main interface when it reboots. It also makes usage of the platform easier since it will reside at a well-known IP on your network.
Depending on your network setup, this can be achieved either by setting a static IP address on the host or configuring the DHCP server to always give the same IP address to your platform.
How we do it: diff --git a/docs/use/monitoring.md b/docs/use/monitoring.md index 18c998f67..2608256b5 100644 --- a/docs/use/monitoring.md +++ b/docs/use/monitoring.md @@ -1,14 +1,17 @@ # 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. @@ -18,11 +21,14 @@ To access Kibana frontend, open AdvantEDGE frontend `:30000 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. +As a result, all the saved objects needed to populate Kibana's dashboards and index pattern are set. \ No newline at end of file diff --git a/examples/demo1/README.md b/examples/demo1/README.md index f8371d1ea..1ac4d5364 100644 --- a/examples/demo1/README.md +++ b/examples/demo1/README.md @@ -75,7 +75,9 @@ When the external UE moves in the network and transitions from one edge instance 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: @@ -86,6 +88,14 @@ cd ~/AdvantEDGE/examples/demo1/ > **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..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. @@ -99,12 +109,7 @@ cd ~/AdvantEDGE/examples/demo1/ #### 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.
-> 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 diff --git a/go-apps/meepctl/install.sh b/go-apps/meepctl/install.sh index d27565fd1..52f37dd33 100755 --- a/go-apps/meepctl/install.sh +++ b/go-apps/meepctl/install.sh @@ -7,6 +7,7 @@ BASEDIR=$(dirname "$SCRIPT") # Configure environment GOOS=linux IMAGE_NAME=meepctl +BINDIR=../../bin/meepctl echo "$IMAGE_NAME" cd $BASEDIR @@ -27,6 +28,10 @@ golangci-lint run echo "...build" go build -o ./$IMAGE_NAME . +# Copy to bin folder +mkdir -p $BINDIR +cp ./$IMAGE_NAME $BINDIR + # Install echo "...install" go install