You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-7Lines changed: 8 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,7 +52,8 @@ If yes, do not rely on this README for operational guidance. Refer to the ANMS P
52
52
53
53
**3. Are you a developer contributing to ANMS or setting up a development environment?**
54
54
55
-
If yes, refer to both this Readme and the ANMS Wiki [Development Guide](https://github.com/NASA-AMMOS/anms/wiki/Development-Guide) for:
55
+
If yes, refer to both this README and the ANMS Wiki [Development Guide](https://github.com/NASA-AMMOS/anms/wiki/Development-Guide) for:
56
+
56
57
* Local development environment configuration
57
58
* Testing workflows
58
59
* Contribution guidelines
@@ -66,10 +67,10 @@ This section details prerequisites to installing the ANMS from source on a devel
66
67
67
68
### Software and OS Versions
68
69
69
-
The setup of ANMS and demos listed in this README have been tested on macOS 11.6.4 (Big Sur), RHEL 9 and Ubuntu 20.04.
70
+
The setup of ANMS and demos listed in this README have been tested on macOS 11.6.4 (Big Sur), RHEL 9 and Ubuntu 20.04.
70
71
To run the ANMS tool, you must also install Docker Engine version 20.10.10 or newer or Podman 5.2.2+. You will also need either Docker Compose version 1.29.2+ or podman-compose. Docker and Podman can generally be used interchangeably.
71
72
72
-
**NOTE:**`docker-compose` can be used with `podman`, and `docker-compose` is generally recommended for improved reliability over `podman-compose`, with some platforms (e.g. Mac) failing to startup correctly with Podman. In all cases, recent versions of the installed compose tool are invoked with `podman compose` or `docker compose` as appropriate.
73
+
**NOTE:**`docker-compose` can be used with `podman`, and `docker-compose` is generally recommended for improved reliability over `podman-compose`, with some platforms (e.g. Mac) failing to start up correctly with Podman. In all cases, recent versions of the installed compose tool are invoked with `podman compose` or `docker compose` as appropriate.
The quickstart script will configure, pull, and start the ANMS system for the first time. See comments in the script for additional details, including optional ENV variables to override default behavior.
114
115
115
-
NOTICE: By default, quick start will pull pre-built containers from the github registry (ghcr.io). To force a rebuild, run it as `FORCE_REBULD=y ./quickstart.sh`. See the script header for details.
116
+
NOTICE: By default, quick start will pull pre-built containers from the github registry (ghcr.io). To force a rebuild, run it as `FORCE_REBUILD=y ./quickstart.sh`. See the script header for details.
116
117
117
118
To stop the system, use `podman compose -f testenv-compose.yml -f docker-compose.yml down`.
118
119
@@ -121,7 +122,7 @@ To start the system in the future, use `podman compose -f testenv-compose.yml up
121
122
## Manual Startup
122
123
Choose the appropriate docker, podman, or podman-compose commands in the directions below as appropriate for your system.
123
124
124
-
- Edit `.env` file as appropriately
125
+
- Edit `.env` file as appropriate.
125
126
- Select appropriate profile(s) as desired.
126
127
- Core ANMS services are always started.
127
128
- The 'full' profile starts up all UI and related services.
@@ -142,7 +143,7 @@ Choose the appropriate docker, podman, or podman-compose commands in the directi
- Note: The docker format argument here enables suppoort for HEALTHCHECK. If omitted, the system will run but will be unable to report the health of the system. This flag does not appear necessary when using the no-dash version of compose.
146
+
- Note: The docker format argument here enables support for HEALTHCHECK. If omitted, the system will run but will be unable to report the health of the system. This flag does not appear necessary when using the no-dash version of compose.
146
147
- Build test environment images using one of the following:
147
148
-`docker compose -f testenv-compose.yml build`
148
149
-`podman compose -f testenv-compose.yml build`
@@ -193,7 +194,7 @@ point. With ANMS running, go to `localhost:8080` and log in to the database with
193
194
194
195
### ADM and Agent Updates
195
196
196
-
Changes to ADMs are handled on the Manager by uploading a new version of the ADM via the Web UI.
197
+
By default after building the system, ANMS starts with the ADMs defined in `deps/dtnma-adms` and ADMs added to `anms-core/extra_adms`. Changes to and adding new ADMs are handled on the Manager by uploading a new version of the ADM via the Web UI or the REST POST endpoint `http://localhost:5555/adms/`.
197
198
The manager will then be able to use the new ADM.
198
199
199
200
Changes to a test Agent are more complicated, and require auto-generated C sources built into the ION source tree.
0 commit comments