Skip to content

Commit 64e62f5

Browse files
committed
add documentation about disabled apps
1 parent 5dede3b commit 64e62f5

File tree

3 files changed

+14
-1
lines changed

3 files changed

+14
-1
lines changed

docs/apps.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ networking, hardware-in-the-loop devices, etc. in a layered, scripted, and
55
codified manner. `phenix` itself includes four (4) default apps that get applied
66
to every experiment by default. In addition to the default apps, it is possible
77
to apply _user apps_ to an experiment using a
8-
[scenario](configuration.md#scenario) configuration.
8+
[scenario](configuration.md#scenario) configuration. Apps can also be disabled at startup,
9+
either through the `phenix experiment create` command or in the scenario file. This allows apps to execute
10+
their `running` stage only when manually triggered by the user.
911

1012
## Default Apps
1113

docs/schema.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,11 @@ Scenario:
5555
setting0: true
5656
setting1: 42
5757
setting2: universe key
58+
disabled:
59+
type: boolean
60+
default: false
61+
example: false
62+
nullable: true
5863
hosts:
5964
type: array
6065
items:

docs/state-of-health.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ in detail below.
114114
spec:
115115
apps:
116116
- name: soh
117+
disabled: false
117118
metadata:
118119
appMetadataProfileKey: sohProfile # metadata key to look for in other apps
119120
c2Timeout: 5m
@@ -182,6 +183,11 @@ spec:
182183
183184
### Configuration Options
184185
186+
* `disabled`: Like any (non-default) phenix app, `soh` can be disabled at startup
187+
by setting `disabled: true`. In this case, health checks will not be run at experiment
188+
startup but can be triggered manually after the experiment is running through either
189+
the `phenix` cli or web UI
190+
185191
* `appMetadataProfileKey`: since the listeners and processes one might want to
186192
monitor could be highly dependent on other apps that are configured for an
187193
experiment, it's possible to specify the `hostListeners` and `hostProcesses`

0 commit comments

Comments
 (0)