Skip to content

Commit 921b287

Browse files
authored
Update README.md
Clarification of docker usage
1 parent dbe3070 commit 921b287

File tree

1 file changed

+11
-22
lines changed

1 file changed

+11
-22
lines changed

services/alarm-server/README.md

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -50,29 +50,18 @@ some useful startup arguments include
5050

5151
## Docker
5252

53-
Docker compose files are provided for convenience to cover two use cases:
53+
Docker compose files are provided to cover two use cases:
5454

55-
1. ```docker-compose-alarm-server-only.yml``` will run the alarm server. Required environment variables:
56-
* ```KAFKA_HOST_IP_ADDRESS``` must be set to identify the Kafka server external IP address.
57-
* ```CONFIG``` identifies the configuration (topic) name.
58-
* ```ALARM_SERVICE_SETTINGS_FILE``` file in user's home directory specifying EPICS related settings, e.g.
59-
```org.phoebus.pv/default=pva```.
60-
2. ```docker-compose-alarm-server-only-import.yml``` will run the alarm server for the
61-
purpose of importing a configuration. Environment variables must be se as in case 1.
62-
Additionally, the environment variable ```CONFIG_FILE``` must identify an alarm
63-
configuration file in the current user's home directory.
55+
1. ```docker-compose-alarm-server-only-import.yml``` will run the alarm server for the
56+
purpose of importing a configuration.
57+
2. ```docker-compose-alarm-server-only.yml``` will run the alarm server.
6458

65-
Docker supports environment variables to be set in a file (default ```.env``` in current directory) like so:
59+
The docker compose files do **not** launch 3rd party services needed by the alarm service. User is advocated to
60+
consult https://github.com/ControlSystemStudio/phoebus/blob/master/services/README.md for information on how
61+
to prepare the required environment and alarm service settings files, and how launch these services through docker.
6662

67-
```KAFKA_HOST_IP_ADDRESS=1.2.3.4```
68-
```CONFIG=Accelerator```
69-
.
70-
.
71-
.
63+
To launch docker, use:
64+
```>docker compose --env-file <path-to-environment-file> -f docker-compose-alarm-server-only*.yml up```
7265

73-
This may be preferable compared to setting environment variables on command line, e.g.
74-
75-
```>export KAFKA_HOST_IP_ADDRESS=1.2.3.4```.
76-
77-
**NOTE:** Accessing IOCs over pva (default mode in the Docker compose files) works **only** if IOC is running on the
78-
same host as the Docker container. Moreover, this has been verified to work only on Linux.
66+
**NOTE:** Accessing IOCs over pva (default mode in the alarm serv) works **only** if IOC is running on the
67+
same host as the Docker container. Moreover, this has been verified to work only on Linux.

0 commit comments

Comments
 (0)