Commit 2ff7382c authored by Kevin Di Lallo's avatar Kevin Di Lallo
Browse files

build & test doc updates

minor doc update
parent bb4b9375
Loading
Loading
Loading
Loading
+24 −9
Original line number Diff line number Diff line
@@ -5,35 +5,48 @@ AdvantEDGE is a Mobile Edge Emulation Platform (MEEP) that runs on Docker & Kube
> AdvantEDGE provides an emulation environment, enabling experimentation with Edge Computing Technologies, Applications, and Services.  The platform facilitates users to explore edge / fog deployment models and their impact to applications and services in short and agile iterations.

## Motivations

- [x] **Accelerate Mobile Edge Computing adoption**
- [x] **Discover new edge application use cases & services**
- [x] **Help to answer questions such as:**
  * Where should my application components be located in the edge network?
  * How do network characteristics (such as latency, jitter, and packet loss) impact my application or service?
  * How will my application behave when the user moves within and across access networks?
  - Where should my application components be located in the edge network?
  - How do network characteristics (such as latency, jitter, and packet loss) impact my application or service?
  - How will my application behave when the user moves within and across access networks?

## Intended Users

- [x] **Edge Application Developers**
- [x] **Edge Network and Service Designers**
- [x] **Edge Researchers**
- [x] **Technologists that are simply interestied learning how the Edge works**

## Getting started
* [Setup runtime environment (Ubuntu/Dockers/Kubernetes/Helm)](docs/setup_runtime.md)

* Clone the AdvanteDGE repo<br>
- [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`)

* Setup [*meepctl*](docs/meepctl/meepctl.md) tool
- 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`

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

* [Use AdvantEDGE](docs/use.md)
- [Use AdvantEDGE](docs/use.md)

## Building

- [Setup development environment (Ubuntu/Go/Node.js/NPM)](docs/setup_dev.md)

- Clone the AdvantEDGE repo<br>
  `git clone https://github.com/<your-fork>/AdvantEDGE.git`<br>
  (*assuming local gitdir =* `~/AdvantEDGE`)

- [Build AdvantEDGE](docs/build.md)

## Concepts
An understanding of some AdvantEDGE concepts is helpful towards effectively using the platform and understanding how it works.  These core AdvantEDGE concepts are described [here](docs/concepts.md)
@@ -44,9 +57,11 @@ An understanding of some AdvantEDGE concepts is helpful towards effectively usin
- [x] External UE support

## Upstream communication

We use GitHub issues.

So just open an issue in the repo to provide user feedback, report software bugs or request enhancements.

## Licensing

Currently licensed under the *AdvantEDGE Limited Evaluation and Use License Agreement*
+1 −0
Original line number Diff line number Diff line
@@ -37,4 +37,5 @@ spec:
      initContainers:
        - name: init-{{ .Values.deployment.dependency }}
          image: busybox
          imagePullPolicy: IfNotPresent
          command: ['sh', '-c', 'until nslookup {{ .Values.deployment.dependency }} ; do echo wiating for {{ .Values.deployment.dependency }}; sleep2; done;']
+8 −5
Original line number Diff line number Diff line
# AdvantEDGE Documents

Document | Description
---------|------------
-|-
[setup_dev.md](setup_dev.md)            | Setup development environment
[setup_runtime.md](setup_runtime.md)    | Setup runtime environment
[build.md](build.md)                    | Build the platform
[deploy.md](deploy.md)                  | Deploy the platform
[use.md](use.md)                        | Get started using it
[concepts.md](use.md)  | Define concepts
[concepts.md](concepts.md)              | Define concepts
[testing.md](testing.md)                | Testing
 No newline at end of file

docs/build.md

0 → 100644
+32 −0
Original line number Diff line number Diff line
# Build Procedure
  
## Prerequisites

- Set up [AdvantEDGE Development Environment](setup_dev.md)

## Build & Install meepctl

The [_meepctl CLI tool_](meepctl/meepctl.md) tool is built & installed using a bash script.

```
cd ~/AdvantEDGE/go-apps/meepctl
./install.sh
```

A first time install of meepctl must also be configured.

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

## Build AdvantEDGE micro-services

The [_meepctl CLI tool_](meepctl/meepctl.md) is used to build the AdvantEDGE binaries using the [_meepctl build_](meepctl/meepctl_build.md) command.

```
meepctl build all
```

This command generates the _core_ micro-service binaries, as well as the frontend web application.

To deploy the new binaries, follow the [Deploy AdvantEDGE](deploy.md) procedure.
+18 −3
Original line number Diff line number Diff line
# Deployment Procedure

## Goal

- Guidance on deploying AdvantEDGE

## Pre-requisites
- setup [AdventEDGE Runtime Environment](setup_runtime.md)

- setup [AdvantEDGE Runtime Environment](setup_runtime.md)
- install and configure [meepctl CLI tool](meepctl/meepctl.md)

## Summary

- [`meepctl dockerize all`](#dockerization)
- [`meepctl deploy all`](#deployment)

###### Note

> As per the Docker/Kubernetes workflow, Docker images must be stored in a Docker registry prior to being deployed.

## Dockerization

Prior to deploying AdvantEDGE, an intermediate step is needed.
Container images of AdvantEDGE micro-services need to be generated and stored in the local Docker registry.

@@ -24,11 +30,13 @@ meepctl dockerize all
```

To verify that the operation was successful, you can list the local registry content and verify the creation time of the AdvantEDGE containers

```
docker images | grep meep
```

## Deployment

AdvantEDGE deployment is achieved through the [_meepctl CLI tool_](meepctl/meepctl.md)

AdvantEDGE micro-services are classified in two groups: _core_ & _dependencies_. [_meepctl_](meepctl/meepctl.md) tool is used to create & destroy these micro-services on the K8s cluster; this is achieved through the [_deploy_](meepctl/meepctl_deploy.md) & [_delete_](meepctl/meepctl_delete.md) commands.
@@ -36,26 +44,33 @@ AdvantEDGE micro-services are classified in two groups: _core_ & _dependencies_.
Let's see how it's done with the following examples.

Initially, deploy both groups using:

```
meepctl deploy all
```

Typically, when new AdvantEDGE version become available, only _core_ components need to be updated.
This is achieved by deleting and deploying the core group:

```
meepctl delete core
meepctl deploy core
```
alternatively
`meepctl deploy core --force` would achieve the same result

Alternatively `meepctl deploy core --force` would achieve the same result

Our favorite command to verify if everything is running

```
kubectl get pods
```

When finished using AdvantEDGE:

```
meepctl delete all
```

###### Note

> AdvantEDGE dependencies are a pre-requisite needed by the core group. Therefore behavior is undefined if the dependency group is absent/deleted when core containers are deployed
Loading