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
+50-19Lines changed: 50 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
<!--
2
-
Copyright (c) 2023 The Johns Hopkins University Applied Physics
2
+
Copyright (c) 2022-2026 The Johns Hopkins University Applied Physics
3
3
Laboratory LLC.
4
4
5
5
This file is part of the Asynchronous Network Management System (ANMS).
@@ -21,13 +21,42 @@ subcontract 1658085.
21
21
-->
22
22
# AMMOS ANMS
23
23
24
-
This is a detailed developer-focused documentation for the AMMOS Asynchronous Network Management System (ANMS).
24
+
This is the quickstart documentation for the AMMOS Asynchronous Network Management System (ANMS).
25
25
26
26
### Copyright
27
27
28
-
Copyright (C) 2022-2025 The Johns Hopkins University Applied Physics Laboratory LLC.
28
+
Copyright (C) 2022-2026 The Johns Hopkins University Applied Physics Laboratory LLC.
29
29
30
-
[[_TOC_]]
30
+
# Start Here: Which Documentation Should You Use?
31
+
32
+
ANMS supports multiple types of users. The appropriate documentation depends on how you are interacting with the system.
33
+
34
+
**1. Are you installing ANMS from this source repository?**
35
+
36
+
If yes, then use this README for:
37
+
* Quickstart instructions
38
+
* Installation steps
39
+
* Basic configuration
40
+
* High-level overview
41
+
42
+
For detailed operational guidance after installation, refer to the ANMS User Guide, found here: www.nasa-ammos.github.io/anms-docs/.
43
+
44
+
**2. Are you an AMMOS user or operating an already-installed ANMS instance (not from source)?**
45
+
46
+
If yes, do not rely on this README for operational guidance. Refer to the ANMS Product Guide and ANMS User Guide for:
47
+
* System usage
48
+
* Operational workflows
49
+
* Configuration details
50
+
51
+
**NOTE:** These guides apply to *all* users once ANMS is installed.
52
+
53
+
**3. Are you a developer contributing to ANMS or setting up a development environment?**
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:
56
+
* Local development environment configuration
57
+
* Testing workflows
58
+
* Contribution guidelines
59
+
* Additional troubleshooting guidance
31
60
32
61
# Quick Start
33
62
@@ -37,19 +66,20 @@ This section details prerequisites to installing the ANMS from source on a devel
37
66
38
67
### Software and OS Versions
39
68
40
-
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.
41
-
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.
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
+
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.
42
71
43
-
The ANMS UI capability has been tested on Firefox version 96.0.1.
44
-
There is no capability that should preclude operation on other modern browsers.
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 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.
73
+
74
+
The ANMS UI should work on all modern browsers.
45
75
46
76
### Network Setup
47
77
48
78
If your computer is behind a network proxy, this may cause issues related to using self-signed certificates when pulling dependencies to build Docker images.
49
-
Though ANMS can be run behind a proxy; building the ANMS Docker images from behind a network proxy may result in errors.
79
+
Though ANMS can be run behind a proxy, building the ANMS Docker images from behind a network proxy may result in errors.
50
80
51
-
The first steps in each of the container image `Dockerfile` is to attempt to download an APLNIS root CA to validate the APLNIS HTTPS proxy.
52
-
When building images outside of the APLNIS, this download will gracefully fail and the image will not be able to run within the APLNIS. The URL for this certificate can be changed for users requiring equivalent functionality on their own networks.
81
+
The first steps in each of the container image `Dockerfile` is to attempt to download the appropriate root CA to validate your HTTPS proxy.
82
+
When building images outside of the internal network, it is possible that this download will gracefully fail and the image will not be able to run within the internal network. The URL for this certificate can be changed for users requiring equivalent functionality on their own networks.
53
83
54
84
### Special Notes on Podman
55
85
@@ -62,7 +92,8 @@ Note: If running on a system where **SELinux** is enabled, the system will not s
62
92
63
93
### Upgrading ANMS
64
94
65
-
If upgrading from an earlier version, a few steps are necessary to clear out earlier state.
95
+
If upgrading from an earlier version, a few steps are necessary to clear out the earlier state. **NOTE:** please see the `UPGRADING.md` file in this repo for specific changes when one wishes to preserve data.
96
+
66
97
The following command sequence uses standard Docker commands to stop all containers and remove all "dangling" images, networks, and volumes.
67
98
68
99
:warning: The last command in this sequence removes volumes, **which include DB state**.
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.
83
114
84
-
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.
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_REBUILD=y ./quickstart.sh`. See the script header for details.
85
116
86
-
To stop the system use `podman compose -f testenv-compose.yml -f docker-compose.yml down`.
117
+
To stop the system, use `podman compose -f testenv-compose.yml -f docker-compose.yml down`.
87
118
88
-
To start the system in the future use `podman compose -f testenv-compose.yml up` and `podman compose up`.
119
+
To start the system in the future, use `podman compose -f testenv-compose.yml up` and `podman compose up`.
89
120
90
121
## Manual Startup
91
-
Choose the appropriate docker, podman or podman-compose commands in the directions below as appropriate for your system.
122
+
Choose the appropriate docker, podman, or podman-compose commands in the directions below as appropriate for your system.
92
123
93
-
- Edit `.env` file as appropriately
124
+
- Edit `.env` file as appropriate.
94
125
- Select appropriate profile(s) as desired.
95
126
- Core ANMS services are always started.
96
127
- The 'full' profile starts up all UI and related services.
@@ -111,8 +142,8 @@ Choose the appropriate docker, podman or podman-compose commands in the directio
- 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.
115
-
- Build test environemnt images using one of the following:
145
+
- 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
+
- Build test environment images using one of the following:
0 commit comments