Unverified Commit a30c246d authored by Kevin Di Lallo's avatar Kevin Di Lallo Committed by GitHub
Browse files

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

Release 1.0.0
parents 4252b824 9187befb

.gitignore

0 → 100644
+9 −0
Original line number Diff line number Diff line 
*~

.swp

.bak

node_modules/

pkg/

vendor/

dist/

bin

examples/demo1/bin

.golangci.yml

0 → 100644
+34 −0
Original line number Diff line number Diff line 
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
 
 No newline at end of file

.meepctl-repocfg.yaml

+46 −22
Original line number Diff line number Diff line
@@ -6,62 +6,86 @@ repo: 
    meep-user:

      service-account: charts/meep-user/meep-user-serviceaccount.yaml

      cluster-role-binding: charts/meep-user/meep-user-clusterrolebinding.yaml

      codecov: false

      lint: false

    meep-ctrl-engine:

      src: src/meep-ctrl-engine

      src: go-apps/meep-ctrl-engine

      bin: bin/meep-ctrl-engine

      chart: charts/meep-ctrl-engine

    meep-initializer:

      src: src/meep-initializer

      bin: bin/meep-initializer

      chart: charts/meep-initializer

      codecov: true

      lint: true

      docker-data:

        static: bin/meep-frontend

    meep-frontend:

      src: js-apps/meep-frontend

      bin: bin/meep-frontend

      codecov: false

      lint: true

      local-deps:

        meep-ctrl-engine-api: js-packages/meep-ctrl-engine-client

    meep-webhook:

      src: go-apps/meep-webhook

      bin: bin/meep-webhook

      chart: charts/meep-webhook

      build-flags:

        - -mod=vendor

      codecov: false

      lint: true

    meep-mg-manager:

      src: src/meep-mg-manager

      src: go-apps/meep-mg-manager

      bin: bin/meep-mg-manager

      chart: charts/meep-mg-manager

      codecov: true

      lint: true

    meep-mon-engine:

      src: src/meep-mon-engine

      src: go-apps/meep-mon-engine

      bin: bin/meep-mon-engine

      chart: charts/meep-mon-engine

      build-flags:

        - -mod=vendor

      codecov: true

      lint: true

    meep-tc-engine:

      src: src/meep-tc-engine

      src: go-apps/meep-tc-engine

      bin: bin/meep-tc-engine

      chart: charts/meep-tc-engine

      codecov: true

      lint: true

    meep-tc-sidecar:

      src: src/meep-tc-sidecar

      src: go-apps/meep-tc-sidecar

      bin: bin/meep-tc-sidecar

      codecov: false

      lint: true

    meep-virt-engine:

      src: src/meep-virt-engine

      src: go-apps/meep-virt-engine

      bin: bin/meep-virt-engine

      chart: charts/meep-virt-engine

      template: charts/meep-virt-engine/virt-templates

      codecov: true

      lint: true

  dep:

    elastic:

      es:

        version: 1.9.1

        values: charts/elasticsearch/elastic-values.yaml

        chart: incubator/elasticsearch

        version: "1.9.1"

        values: charts/elasticsearch/elastic-values.yaml

        pv: charts/elasticsearch/meep-pv-es.yaml

      es-curator:

        chart: charts/elasticsearch-curator

      kibana:

        version: 0.14.5

        values: charts/kibana/kibana-values.yaml

        chart: stable/kibana

        chart: charts/kibana

      filebeat:

        version: 1.0.2

        values: charts/filebeat/filebeat-values.yaml

        chart: stable/filebeat

        version: "1.0.2"

        values: charts/filebeat/values.yaml

      metricbeat:

        template: charts/metricbeat/values-template.yaml

        values: charts/metricbeat/values.yaml

        chart: charts/metricbeat

    couchdb:

      chart: charts/couchdb

      pv: charts/couchdb/meep-pv-couchdb.yaml

    redis:

      version: 4.0.1

      values: charts/redis/redis-values.yaml

      chart: stable/redis

      version: "4.0.1"

      values: charts/redis/values.yaml

    k8s:

      kube-state-metrics:

        chart: charts/kube-state-metrics

README.md

+63 −25
Original line number Diff line number Diff line 
# AdvantEDGE

![AdvantEDGE-logo](./docs/images/AdvantEDGE-logo_Blue-01.png)



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*

bin/meep-ctrl-engine/Dockerfile

deleted100644 → 0
+0 −18
Original line number Diff line number Diff line 
# Copyright 2017 The Kubernetes Authors.

#

# Licensed under the Apache License, Version 2.0 (the "License");

# you may not use this file except in compliance with the License.

# You may obtain a copy of the License at

#

#     http://www.apache.org/licenses/LICENSE-2.0

#

# Unless required by applicable law or agreed to in writing, software

# distributed under the License is distributed on an "AS IS" BASIS,

# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

# See the License for the specific language governing permissions and

# limitations under the License.



FROM debian:9.6-slim

COPY ./meep-ctrl-engine /meep-ctrl-engine

COPY ./static /static

ENTRYPOINT /meep-ctrl-engine