Skip to content
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

DM-48364: mobu - update docs #4054

Merged
merged 1 commit into from
Jan 9, 2025
Merged

DM-48364: mobu - update docs #4054

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
5 changes: 3 additions & 2 deletions applications/mobu/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@ Continuous integration testing
|-----|------|---------|-------------|
| affinity | object | `{}` | Affinity rules for the mobu frontend pod |
| config.autostart | list | `[]` | Autostart specification. Must be a list of mobu flock specifications. Each flock listed will be automatically started when mobu is started. |
| config.githubCiApp | string | disabled. | Configuration for the GitHub refresh app integration. See https://mobu.lsst.io/operations/github_ci_app.html#add-phalanx-configuration |
| config.githubRefreshApp | string | disabled. | Configuration for the GitHub refresh app integration. See https://mobu.lsst.io/operations/github_refresh_app.html#add-phalanx-configuration |
| config.availableServices | list | `[]` | Which applications (tap, butler, etc.) are available in this environment. Notebooks can specify a `mobu.required_services` list in their metadata, and mobu will only run them if all services in that list are in this `availableServices` list. See [the Mobu documentation](https://mobu.lsst.io/user_guide/in_repo_config.html#service-specific-notebooks) |
| config.githubCiApp | string | disabled. | Configuration for the GitHub CI app integration. See [the Mobu documentation](https://mobu.lsst.io/operations/github_ci_app.html#add-phalanx-configuration) |
| config.githubRefreshApp | string | disabled. | Configuration for the GitHub refresh app integration. See [the Mobu documentation](https://mobu.lsst.io/operations/github_refresh_app.html#add-phalanx-configuration) |
| config.logLevel | string | `"INFO"` | Log level. Set to 'DEBUG' to include the output from all flocks in the main mobu log. |
| config.metrics.application | string | `"mobu"` | Name under which to log metrics. Generally there is no reason to change this. |
| config.metrics.enabled | bool | `false` | Whether to enable sending metrics |
Expand Down
1 change: 1 addition & 0 deletions applications/mobu/tests/github_ci_app_enabled_test.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ tests:
path: "data['config.yaml']"
value: |
autostart: []
availableServices: []
githubCiApp:
acceptedGithubOrgs:
- org1
Expand Down
1 change: 1 addition & 0 deletions applications/mobu/tests/github_disabled_test.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ tests:
path: "data['config.yaml']"
value: |
autostart: []
availableServices: []
githubCiApp: null
githubRefreshApp: null
logLevel: INFO
Expand Down
1 change: 1 addition & 0 deletions applications/mobu/tests/github_refresh_app_enabled_test.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ tests:
path: "data['config.yaml']"
value: |
autostart: []
availableServices: []
githubCiApp: null
githubRefreshApp:
acceptedGithubOrgs:
Expand Down
12 changes: 9 additions & 3 deletions applications/mobu/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,24 @@ ingress:
annotations: {}

config:
# -- Which applications (tap, butler, etc.) are available in this
# environment. Notebooks can specify a `mobu.required_services` list in their
# metadata, and mobu will only run them if all services in that list are in
# this `availableServices` list. See
# [the Mobu documentation](https://mobu.lsst.io/user_guide/in_repo_config.html#service-specific-notebooks)
availableServices: []

# -- Autostart specification. Must be a list of mobu flock specifications.
# Each flock listed will be automatically started when mobu is started.
autostart: []

# -- Configuration for the GitHub refresh app integration.
# See https://mobu.lsst.io/operations/github_refresh_app.html#add-phalanx-configuration
# See [the Mobu documentation](https://mobu.lsst.io/operations/github_refresh_app.html#add-phalanx-configuration)
# @default -- disabled.
githubRefreshApp: null

# -- Configuration for the GitHub CI app integration.
# -- Configuration for the GitHub refresh app integration.
# See https://mobu.lsst.io/operations/github_ci_app.html#add-phalanx-configuration
# See [the Mobu documentation](https://mobu.lsst.io/operations/github_ci_app.html#add-phalanx-configuration)
# @default -- disabled.
githubCiApp: null

Expand Down
Loading