CombinedSummary

pydantic model mobu.models.summary.CombinedSummary

Summary of all app state.

Parameters:

data (Any)

Show JSON schema

{
   "title": "CombinedSummary",
   "description": "Summary of all app state.",
   "type": "object",
   "properties": {
      "flocks": {
         "items": {
            "$ref": "#/$defs/FlockSummary"
         },
         "title": "Info about all running flocks",
         "type": "array"
      },
      "ci_manager": {
         "anyOf": [
            {
               "$ref": "#/$defs/CiManagerSummary"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Info about GitHub CI workers"
      }
   },
   "$defs": {
      "CiJobSummary": {
         "description": "Information about a job.",
         "properties": {
            "commit_url": {
               "description": "GitHub URL to the commit being worked on",
               "examples": [
                  "https://github.com/lsst-sqre/mobu/commit/dd534286bb932dd22d61f97f960a5985b7513ec8"
               ],
               "format": "uri",
               "maxLength": 2083,
               "minLength": 1,
               "title": "Commit URL",
               "type": "string"
            }
         },
         "required": [
            "commit_url"
         ],
         "title": "CiJobSummary",
         "type": "object"
      },
      "CiManagerSummary": {
         "description": "Information about the CiManager.",
         "properties": {
            "workers": {
               "description": "The workers being managed",
               "examples": [
                  [
                     {
                        "current_job": {
                           "commit_url": "https://github.com/lsst-sqre/mobu/commit/dd534286bb932dd22d61f97f960a5985b7513ec8"
                        },
                        "num_processed": 123,
                        "user": {
                           "gidnumber": 456,
                           "groups": [],
                           "uidnumber": 123,
                           "username": "bot-mobu-someuser"
                        }
                     }
                  ]
               ],
               "items": {
                  "$ref": "#/$defs/CiWorkerSummary"
               },
               "title": "Background workers",
               "type": "array"
            },
            "num_queued": {
               "description": "Number of jobs waiting for a free worker",
               "examples": [
                  123
               ],
               "title": "Queued jobs",
               "type": "integer"
            }
         },
         "required": [
            "workers",
            "num_queued"
         ],
         "title": "CiManagerSummary",
         "type": "object"
      },
      "CiWorkerSummary": {
         "description": "Information about a running worker.",
         "properties": {
            "user": {
               "$ref": "#/$defs/User",
               "description": "User that the worker works as",
               "examples": [
                  {
                     "gidnumber": null,
                     "groups": [],
                     "uidnumber": null,
                     "username": "bot-mobu-someuser"
                  },
                  {
                     "gidnumber": 456,
                     "groups": [],
                     "uidnumber": 123,
                     "username": "bot-mobu-someuser"
                  }
               ]
            },
            "num_processed": {
               "description": "Number of jobs this worker has processed since mobu started",
               "examples": [
                  123
               ],
               "title": "Number of jobs processed",
               "type": "integer"
            },
            "current_job": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/CiJobSummary"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "The job the worker is currently running, if any",
               "examples": [
                  {
                     "commit_url": "https://github.com/lsst-sqre/mobu/commit/dd534286bb932dd22d61f97f960a5985b7513ec8"
                  }
               ],
               "title": "Current job summary"
            }
         },
         "required": [
            "user",
            "num_processed",
            "current_job"
         ],
         "title": "CiWorkerSummary",
         "type": "object"
      },
      "FlockSummary": {
         "description": "Summary statistics about a running flock.",
         "properties": {
            "name": {
               "examples": [
                  "autostart"
               ],
               "title": "Name of the flock",
               "type": "string"
            },
            "business": {
               "examples": [
                  "NotebookRunnerCounting"
               ],
               "title": "Name of the business the flock is running",
               "type": "string"
            },
            "start_time": {
               "anyOf": [
                  {
                     "format": "date-time",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "Will be null if the flock hasn't started",
               "examples": [
                  "2021-07-21T19:43:40.446072+00:00"
               ],
               "title": "When the flock was started"
            },
            "monkey_count": {
               "examples": [
                  5
               ],
               "title": "Number of monkeys in the flock",
               "type": "integer"
            },
            "success_count": {
               "examples": [
                  455
               ],
               "title": "Total number of monkey successes in flock",
               "type": "integer"
            },
            "failure_count": {
               "examples": [
                  4
               ],
               "title": "Total number of monkey failures in flock",
               "type": "integer"
            }
         },
         "required": [
            "name",
            "business",
            "start_time",
            "monkey_count",
            "success_count",
            "failure_count"
         ],
         "title": "FlockSummary",
         "type": "object"
      },
      "Group": {
         "description": "Configuration for the group memberships of a user.",
         "properties": {
            "name": {
               "examples": [
                  "g_special_users"
               ],
               "minLength": 1,
               "pattern": "^g_",
               "title": "Name of the group",
               "type": "string"
            },
            "id": {
               "examples": [
                  123181
               ],
               "title": "Numeric GID of the group",
               "type": "integer"
            }
         },
         "required": [
            "name",
            "id"
         ],
         "title": "Group",
         "type": "object"
      },
      "User": {
         "description": "Configuration for the user whose credentials the monkey will use.",
         "properties": {
            "username": {
               "description": "Must start with 'bot-mobu'",
               "examples": [
                  "bot-mobu-testuser"
               ],
               "pattern": "^bot-mobu",
               "title": "Username",
               "type": "string"
            },
            "uidnumber": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "If omitted, Gafaelfawr will assign a UID. (Gafaelfawr UID assignment requires Firestore be configured.)",
               "examples": [
                  60001
               ],
               "title": "Numeric UID"
            },
            "gidnumber": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "If omitted but a UID was specified, use a GID equal to the UID. If both are omitted, Gafaelfawr will assign a UID and GID. (Gafaelfawr UID and GID assignment requires Firestore and synthetic user private groups to be configured.)",
               "examples": [
                  60001
               ],
               "title": "Primary GID"
            },
            "groups": {
               "default": [],
               "description": "Groups of which the user is a member",
               "items": {
                  "$ref": "#/$defs/Group"
               },
               "title": "Groups",
               "type": "array"
            }
         },
         "required": [
            "username"
         ],
         "title": "User",
         "type": "object"
      }
   },
   "required": [
      "flocks"
   ]
}

Fields:

• ci_manager (mobu.models.ci_manager.CiManagerSummary | None)

• flocks (list[mobu.models.flock.FlockSummary])

field ci_manager: CiManagerSummary | None = None

field flocks: list[FlockSummary] [Required]