|
1 | 1 | # Developer Scripts
|
2 | 2 |
|
3 |
| -Main Author: Jim White |
| 3 | +## ARCHIVED |
| 4 | +**PLEASE READ** - this repository is archived. For the EdgeX Docker Compose files for each release, please go to https://github.com/edgexfoundry/edgex-compose. The release Docker Compose files in this repository will no longer be updated/maintained. |
4 | 5 |
|
5 |
| -Copyright 2016-17, Dell, Inc. |
6 | 6 |
|
7 |
| -This repos contains scripts, batch files, JSON used in REST calls and other miscellaneous items used by developers buiding EdgeX. |
| 7 | +<hr/> |
8 | 8 |
|
9 |
| -## Running on Linux |
10 |
| - |
11 |
| -For convenience there are a couple of scripts that help you get up and running |
12 |
| - |
13 |
| -### Run this First |
14 |
| - |
15 |
| -**linux_setup.sh**, this script assumes: |
16 |
| - |
17 |
| -* you are starting with a fresh install of mongodb |
18 |
| -* that init_mongo.js has not been run before |
19 |
| - |
20 |
| -This script will: |
21 |
| - |
22 |
| -* create the necessary folder(s) for database placement |
23 |
| -* start mongod without the "--auth" option |
24 |
| -* initialize the mongo database (via init_mongo.js) |
25 |
| -* restart mongod with the "--auth" option |
26 |
| -* leave mongo in a state of waiting for a connection. |
27 |
| - |
28 |
| -### Run This Second |
29 |
| - |
30 |
| -**prepare-environment.sh**, this script will clone the set of modules you need. You can pass a list of valid modules. |
31 |
| - |
32 |
| ->MODULES: core-data-client core-domain core-exception core-test |
33 |
| ->export-domain export-test support-domain support-logging-client |
34 |
| ->support-notifications-client core-data core-metadata-client |
35 |
| -
|
36 |
| -**Note**, if you run the script without parameters, you can manually choose which modules you want to be installed. |
37 |
| - |
38 |
| -### Running EdgeX |
39 |
| - |
40 |
| -**run-it.sh**, this script will start the services |
41 |
| -in order as described [HERE](https://docs.edgexfoundry.org/Ch-GettingStartedUsers.html). |
42 |
| - |
43 |
| -### Updating EdgeX |
44 |
| - |
45 |
| -**update-packages.sh**, this script will update the installed packages in your working copy |
46 |
| - |
47 |
| -### Reset |
48 |
| - |
49 |
| -**reset-dockers.sh**, this script removes all containers and images from your environment. Very useful for development, when you want to reset everything from scratch |
50 |
| - |
51 |
| -### Containerization |
52 |
| - |
53 |
| -**create-containers.sh**, this script creates containers and images defined in the environment variable `DOCKERS` |
| 9 | +The other files in this repository are legacy developer initialization, startup and support scripts and files. These are not used with the latest releases of EdgeX Foundry. These are only used with Geneva or earlier releases. |
0 commit comments