Skip to content

add documentation about disabled apps #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add documentation about disabled apps #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/apps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ networking, hardware-in-the-loop devices, etc. in a layered, scripted, and
codified manner. `phenix` itself includes four (4) default apps that get applied
to every experiment by default. In addition to the default apps, it is possible
to apply _user apps_ to an experiment using a
[scenario](configuration.md#scenario) configuration.
[scenario](configuration.md#scenario) configuration. Apps can also be disabled at startup,
either through the `phenix experiment create` command or in the scenario file. This allows apps to execute
their `running` stage only when manually triggered by the user.

## Default Apps

Expand Down Expand Up @@ -43,7 +45,7 @@ spec:
peer: rtr2
tunnels:
- local: 192.168.10.0/24
remote: 192.168.100.0/24
remote: 192.168.100.0/24>
Copy link
Collaborator

@GhostofGoes GhostofGoes Sep 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stray >

acl:
ingress:
eth0: in-rules
Expand Down
5 changes: 5 additions & 0 deletions docs/schema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,11 @@ Scenario:
setting0: true
setting1: 42
setting2: universe key
disabled:
type: boolean
default: false
example: false
nullable: true
hosts:
type: array
items:
Expand Down
6 changes: 6 additions & 0 deletions docs/state-of-health.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ in detail below.
spec:
apps:
- name: soh
disabled: false
metadata:
appMetadataProfileKey: sohProfile # metadata key to look for in other apps
c2Timeout: 5m
Expand Down Expand Up @@ -182,6 +183,11 @@ spec:

### Configuration Options

* `disabled`: Like any (non-default) phenix app, `soh` can be disabled at startup
by setting `disabled: true`. In this case, health checks will not be run at experiment
startup but can be triggered manually after the experiment is running through either
the `phenix` cli or web UI

* `appMetadataProfileKey`: since the listeners and processes one might want to
monitor could be highly dependent on other apps that are configured for an
experiment, it's possible to specify the `hostListeners` and `hostProcesses`
Expand Down