Commit 5ffff3b2 authored by Kevin Di Lallo's avatar Kevin Di Lallo
Browse files

Merge branch 'release-1.1.0'

parents a30c246d 37b921cc
Loading
Loading
Loading
Loading
+12 −4
Original line number Diff line number Diff line
#AdvantEDGE
version: 1.0.0
version: 1.1.0
repo:
  name: AdvantEDGE
  core:
@@ -45,6 +45,14 @@ repo:
        - -mod=vendor
      codecov: true
      lint: true
    meep-loc-serv:
      src: go-apps/meep-loc-serv
      bin: bin/meep-loc-serv
      chart: charts/meep-loc-serv
      build-flags:
        - -mod=vendor
      codecov: true
      lint: true
    meep-tc-engine:
      src: go-apps/meep-tc-engine
      bin: bin/meep-tc-engine
@@ -64,11 +72,11 @@ repo:
      codecov: true
      lint: true
  dep:
    docker-registry:
      chart: charts/docker-registry
    elastic:
      es:
        chart: incubator/elasticsearch
        version: "1.9.1"
        values: charts/elasticsearch/elastic-values.yaml
        chart: charts/elasticsearch
        pv: charts/elasticsearch/meep-pv-es.yaml
      es-curator:
        chart: charts/elasticsearch-curator

.vscode/settings.json

0 → 100644
+3 −0
Original line number Diff line number Diff line
{
    "go.formatTool": "goimports"
}
 No newline at end of file
+20 −38
Original line number Diff line number Diff line
![AdvantEDGE-logo](./docs/images/AdvantEDGE-logo_Blue-01.png)

_Complete AdvantEDGE documentation is now available in the [AdvantEDGE Wiki](https://github.com/InterDigitalInc/AdvantEDGE/wiki)_

------

AdvantEDGE is a Mobile Edge Emulation Platform (MEEP) that runs on Docker & Kubernetes.

> 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.
@@ -24,60 +28,38 @@ AdvantEDGE is a Mobile Edge Emulation Platform (MEEP) that runs on Docker & Kube

An understanding of some AdvantEDGE concepts is helpful towards effectively using the platform and understanding how it works.

Before getting started we recommend familiarity with key [AdvantEDGE concepts](docs/concepts.md)
Before getting started we recommend familiarity with key [AdvantEDGE concepts](https://github.com/InterDigitalInc/AdvantEDGE/wiki/platform-concepts)

## Getting started
To get started using AdvantEDGE, the following high-level steps are needed:

- Setup runtime environment (Ubuntu/Dockers/Kubernetes/Helm)
- Clone AdvantEDGE repo
- Install & Configure meepctl tool
- Deploy AdvantEDGE micro-services

Step-by-step details are available in the [Wiki](https://github.com/InterDigitalInc/AdvantEDGE/wiki#getting-started)

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

- 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
  - 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)

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

## Building
The backend portion of AdvantEDGE is implemented as a collection of micro-services in Golang.

- [Setup development environment (Ubuntu/Go/Node.js/NPM/Linters)](docs/setup_dev.md)
The frontend portion of AdvantEDGE is implemented using Javascript, React and Redux technologies.

- Clone the AdvantEDGE repo<br>
  `git clone https://github.com/<your-fork>/AdvantEDGE.git`<br>
  (*assuming local gitdir =* `~/AdvantEDGE`)
To re-build either of these components, you first need to setup the development environment and then use the meepctl tool.

- [Build AdvantEDGE](docs/build.md)
Step-by-step details are available in the [Wiki](https://github.com/InterDigitalInc/AdvantEDGE/wiki#building)

## Testing
The AdvantEDGE platform comes with automated system tests using Cypress.

The AdvantEDGE platform test procedures are described [here](docs/testing.md)
Step-by-step details are available in the [Wiki](https://github.com/InterDigitalInc/AdvantEDGE/wiki/test-advantedge)

## Upstream communication

We use GitHub issues.

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

## Licensing

+4 −0
Original line number Diff line number Diff line
@@ -103,6 +103,10 @@ spec:
{{- if .Values.nodeSelector }}
      nodeSelector:
{{ toYaml .Values.nodeSelector | indent 8 }}
{{- end }}
      {{- if .Values.affinity }}
      affinity:
{{ toYaml .Values.affinity | indent 8 }}
      {{- end }}
      volumes:
        - name: config-storage
+8 −0
Original line number Diff line number Diff line
@@ -129,3 +129,11 @@ couchdbConfig:
  #   q: 8 # Create 8 shards for each database

meepOrigin: core

affinity:
  nodeAffinity:
    requiredDuringSchedulingIgnoredDuringExecution:
      nodeSelectorTerms:
      - matchExpressions:
        - key: node-role.kubernetes.io/master
          operator: Exists
 No newline at end of file
Loading