Merge pull request #4054 from lsst-sqre/tickets/DM-44145/mobu-docs-up…

…date DM-48364: mobu - update docs
lsst-sqre · Jan 9, 2025 · bd63077 · bd63077
2 parents 8c0694c + 47ad162
commit bd63077
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 5 deletions.
diff --git a/applications/mobu/README.md b/applications/mobu/README.md
@@ -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 |

diff --git a/applications/mobu/tests/github_ci_app_enabled_test.yaml b/applications/mobu/tests/github_ci_app_enabled_test.yaml
@@ -52,6 +52,7 @@ tests:
           path: "data['config.yaml']"
           value: |
             autostart: []
+            availableServices: []
             githubCiApp:
               acceptedGithubOrgs:
               - org1

diff --git a/applications/mobu/tests/github_disabled_test.yaml b/applications/mobu/tests/github_disabled_test.yaml
@@ -14,6 +14,7 @@ tests:
           path: "data['config.yaml']"
           value: |
             autostart: []
+            availableServices: []
             githubCiApp: null
             githubRefreshApp: null
             logLevel: INFO

diff --git a/applications/mobu/tests/github_refresh_app_enabled_test.yaml b/applications/mobu/tests/github_refresh_app_enabled_test.yaml
@@ -36,6 +36,7 @@ tests:
           path: "data['config.yaml']"
           value: |
             autostart: []
+            availableServices: []
             githubCiApp: null
             githubRefreshApp:
               acceptedGithubOrgs:

diff --git a/applications/mobu/values.yaml b/applications/mobu/values.yaml
@@ -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