From 9dea6ea6c552409d1fc71fe19ff6eb88842f442a Mon Sep 17 00:00:00 2001 From: Dan Fuchs Date: Wed, 8 Jan 2025 15:25:21 -0600 Subject: [PATCH] DM-48364: mobu - update docs --- applications/mobu/README.md | 3 ++- applications/mobu/values.yaml | 6 +++++- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/applications/mobu/README.md b/applications/mobu/README.md index 233b45bc17..78522c83b0 100644 --- a/applications/mobu/README.md +++ b/applications/mobu/README.md @@ -14,7 +14,8 @@ 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.available_services | 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 `available_services` list. See 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 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.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. | diff --git a/applications/mobu/values.yaml b/applications/mobu/values.yaml index f0ac9fed58..4c213f0175 100644 --- a/applications/mobu/values.yaml +++ b/applications/mobu/values.yaml @@ -22,6 +22,11 @@ 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 `available_services` list. + # See https://mobu.lsst.io/user_guide/in_repo_config.html#service-specific-notebooks + available_services: [] + # -- Autostart specification. Must be a list of mobu flock specifications. # Each flock listed will be automatically started when mobu is started. autostart: [] @@ -32,7 +37,6 @@ config: 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 # @default -- disabled. githubCiApp: null