You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 45079ee
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: MANUAL.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,13 +3,16 @@
3
3
## The app, tab by tab
4
4
The app is a set of tabs across the top, each with its own audience and job. Which tabs appear depends on the role you are viewing as. The [policy](POLICY.md) sets out the allocation model behind the controls.
5
5
6
-
A **Viewing as** switcher in the header sets the current role, since the proof of concept has no real sign-in. There are four roles, each with a coloured chip. A viewer sees everything and changes nothing. A project lead plans and books for the projects they run, raising requests and holding their own reservations. A team lead divides their team's pool across its projects and raises requests across the team. Operations sets the policy, sizes the pools, configures the connectors, approves requests, and is the only role that writes to the scheduler. Operations sees every tab and lands on Analytics. The other roles land on My view, and the app hides the operations-only tabs from them.
6
+
A **Viewing as** switcher in the header sets the current role, since the proof of concept has no real sign-in. There are four roles, each with a coloured chip. A viewer sees everything and changes nothing. A project lead plans and books for the projects they run, raising requests and holding their own reservations. A team lead divides their team's pool across its projects and raises requests across the team. Operations sets the policy, sizes the pools, configures the connectors, approves requests, and is the only role that writes to the scheduler. Operations sees every tab and lands on the Overview. The other roles land on My view, and the app hides the operations-only tabs from them.
7
+
8
+
### Overview
9
+
The tab operations and direction land on. Operational tiles and a short list of what needs attention sit at the top, each tile linking to the tab behind it. Below, the app computes the longer-run indicators per period from the jobs themselves and charts them past and forecast over a configurable horizon, with policy changes marked on the trend. A resource outlook frames the acquisition decision, setting realised demand and committed entitlement against capacity, with a runway to the threshold.
7
10
8
11
### My view
9
12
A person's own projects and jobs. Tiles across the top count the projects they are on, the GPUs their running jobs hold, how many jobs are queued, and their wait times. The Projects table shows each project's budget, use and budget status, with a role chip marking the ones they lead. Where the project's team is at a phase that does not enforce that budget, the status reads "target only", since the number is a target rather than a cap there. An "Only mine" toggle is on by default. Below, the Jobs table lists what is running and queued, with wait times per lane when priced lanes are on.
10
13
11
14
### Team
12
-
For team leads and operations. Operations see a Policy card that sets the roll-out phase for this one team, ahead of or behind the organisation default, with the mechanisms it turns on shown as chips. Operations also see a Team pool card that sizes this team's pool within the total the teams share. The team lead sees Distribution across projects, splitting the pool across active projects, each allocation capped so the running total never exceeds the pool. Every change here is staged and applied explicitly.
15
+
For team leads and operations. A Policy card shows the mechanisms in force for the team as read-only switches, the same set the Policy tab carries. Operations additionally set the team's roll-out phase here, ahead of or behind the organisation default. The team lead sees Distribution across projects, splitting the team pool across active projects, each allocation capped so the running total never exceeds the pool. The size of the team pool itself is set by operations on the Budgets tab. Every change here is staged and applied explicitly.
13
16
14
17
### Queue
15
18
The live picture of jobs waiting to run and the order they will run in, which is what the allocation policies shape. Where cross-team standing is on, the ordering reflects each team's standing.
@@ -21,19 +24,16 @@ The load on the cluster over time, built from individual jobs the way it comes f
21
24
The register of team projects, one row each with its team, start, budget, consumed, a pace bar against an even spend, and a budget outlook. As in My view, a project whose team does not enforce project budgets reads "target only". Viewers get an "Only mine" default, and a toggle folds finished projects in. Selecting a row opens the full record: the leads to contact, the members, and the recent jobs.
22
25
23
26
### Budgets
24
-
The two pools and how they are divided. A bar at the top shows committed budgets against the capacity the cluster offers over the period, with an uncommitted tail below full or an over-committed overflow past it. The Team pools section lists each team's share, with its phase where that differs from the default, and the projects inside each. The Person pool section shows each person's equal allowance, their use against it, and the gap.
27
+
The two pools and how they are divided. A bar at the top shows committed budgets against the capacity the cluster offers over the period, with an uncommitted tail below full or an over-committed overflow past it. The Team pools section lists each team's share of the teams pool, with its phase where that differs from the default, and the projects inside each. Operations size each team's pool here, capped so the running total stays within the teams pool, with the remainder left unallocated. Team leads then split each pool across projects on the Team tab. The Person pool section shows each person's equal allowance, their use against it, and the gap.
25
28
26
29
### Directory
27
30
People, teams and projects as imported from Notion, browsable by person, team or project. This is where operations checks the imported structure against Notion and keeps it in step.
28
31
29
32
### Requests
30
33
A short form raises a change: a new project, a change to a project's or a team's budget, a priority change, an extension, or a reservation. Each type routes to the right approver, and a person sees an approve or decline control only on the requests that are theirs. The board shows only the people involved. A planner charts the demand that granting the pending requests would add on top of the forecast baseline, against capacity, so a request that would push demand past the hardware shows before approval.
31
34
32
-
### Analytics
33
-
For operations and direction. The operations overview sits at the top: the operational tiles and a short list of what needs attention. Below, the app computes the longer-run indicators per period from the jobs themselves and charts them past and forecast over a configurable horizon, with policy changes marked on the trend. A resource outlook frames the acquisition decision, setting realised demand and committed entitlement against capacity, with a runway to the threshold.
34
-
35
35
### Policy
36
-
Operations only: the mechanisms and values that drive allocation. The mechanisms are switches for whether budgets are enforced at the person, project and team level, whether priced lanes and time-of-use weighting apply, and whether teams carry standing between one another. The values are the numbers behind them: the person pool's share of capacity, the over-subscription factor, the lane prices, and the priority weights. Selecting a roll-out phase loads its preset, which operations can then adjust. Changes stay staged and take effect only on apply, when the app writes them to the scheduler and shows the commands.
36
+
Visible to everyone and read-only for all but operations: the mechanisms and values that drive allocation. The mechanisms are switches for whether budgets are enforced at the person, project and team level, whether priced lanes and time-of-use weighting apply, and whether teams carry standing between one another. The values are the numbers behind them: the person pool's share of capacity, the over-subscription factor, the lane prices, and the priority weights. Selecting a roll-out phase loads its preset, which operations can then adjust. Changes stay staged and take effect only on apply, when the app writes them to the scheduler and shows the commands.
37
37
38
38
### Connectors
39
39
Operations only: the systems the app reads from and writes to. SLURM is the scheduler it reads use from and writes budgets and reservations to. Notion supplies people and projects. Slack carries approvals, reminders and budget alerts, with email as a fallback. Single sign-on supplies identity, and object storage holds exports. Operations enables and configures each here.
0 commit comments