-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #15 from idcc-dev/release-1.0.0
Release 1.0.0
- Loading branch information
Showing
902 changed files
with
87,221 additions
and
32,402 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| *~ | ||
| .swp | ||
| .bak | ||
| node_modules/ | ||
| pkg/ | ||
| vendor/ | ||
| dist/ | ||
| bin | ||
| examples/demo1/bin |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| linters: | ||
| disable-all: true | ||
| enable: | ||
| - deadcode | ||
| # - depguard | ||
| # - dupl | ||
| - errcheck | ||
| # - gochecknoglobals | ||
| # - gochecknoinits | ||
| # - goconst | ||
| # - gocritic | ||
| # - gocyclo | ||
| # - gofmt | ||
| - goimports | ||
| # - golint | ||
| # - gosec | ||
| - gosimple | ||
| - govet | ||
| - ineffassign | ||
| # - interfacer | ||
| # - lll | ||
| # - maligned | ||
| # - misspell | ||
| # - nakedret | ||
| # - prealloc | ||
| # - scopelint | ||
| - staticcheck | ||
| - structcheck | ||
| # - stylecheck | ||
| - typecheck | ||
| # - unconvert | ||
| # - unparam | ||
| - unused | ||
| - varcheck |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,46 +1,84 @@ | ||
| # AdvantEDGE | ||
|  | ||
|
|
||
| AdvantEDGE is a Mobile Edge Emulation Platform (MEEP) that runs on Docker & Kubernetes | ||
| AdvantEDGE is a Mobile Edge Emulation Platform (MEEP) that runs on Docker & Kubernetes. | ||
|
|
||
| MEEP provides an environment to experiment with Mobile Edge Computing (MEC) technologies and edge / fog deployment models in short and agile iterations. | ||
| > 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. | ||
| ## Motivation | ||
|
|
||
| ## Motivations | ||
| - [x] **Accelerate Mobile Edge Computing adoption** | ||
| - [x] **Discover new edge application use cases & services** | ||
| - [x] **Answer these questions:** | ||
| * Where should my application components be located in the network? | ||
| * What are network characteristics limitations of my application? | ||
| * How will my application behave when the user moves in the network? | ||
| - [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? | ||
|
|
||
| ## 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** | ||
|
|
||
| ## Concepts | ||
|
|
||
| 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) | ||
|
|
||
| ## 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 | ||
| ``` | ||
| 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 | ||
|
|
||
| - [Setup development environment (Ubuntu/Go/Node.js/NPM/Linters)](docs/setup_dev.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 | ||
| 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` | ||
| - [Build AdvantEDGE](docs/build.md) | ||
|
|
||
| * [Deploy AdvantEDGE](docs/deploy.md) | ||
| ## Testing | ||
|
|
||
| * [Use AdvantEDGE](docs/use.md) | ||
|
|
||
| ## Concepts | ||
| The following AdvantEDGE concepts are described [here](docs/concepts.md) | ||
| - [x] Micro-service Architecture | ||
| - [x] Macro-network Model | ||
| - [x] Network characteristics | ||
| - [x] Network mobility | ||
| - [x] External UE support | ||
| The AdvantEDGE platform test procedures are described [here](docs/testing.md) | ||
|
|
||
| ## 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* |
This file was deleted.
Oops, something went wrong.
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.