Skip to content

Commit c253449

Browse files
geroplgeropl
committed
update PRD
1 parent 0978dfb commit c253449

File tree

1 file changed

+28
-35
lines changed

1 file changed

+28
-35
lines changed

‎prd/001-infra-rollout.md‎

Lines changed: 28 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -33,19 +33,19 @@ An "Admin" section will be added to the Gitpod organization menu. This section w
3333
* **R1.2:** The list should include relevant information for each workspace (e.g., user, workspace ID, start time, project).
3434
* **R1.3:** This feature aims to restore or provide similar functionality to a previously available view that helped admins identify active users during upgrades.
3535

36-
### 4.2. Maintenance Mode Toggle (Ref: [CLC-1273](https://linear.app/gitpod/issue/CLC-1273/admin-maintenance-mode-toggle))
36+
### 4.2. Stop All Running Workspaces (Ref: [CLC-1275](https://linear.app/gitpod/issue/CLC-1275/admin-stop-all-running-workspaces-button-for-infra-update))
37+
* **R3.1:** Administrators must have an option (e.g., a button) to stop all currently running workspaces within their organization.
38+
* **R3.2:** This action is intended to ensure all running workspaces are backed up before an infrastructure update.
39+
* **R3.3:** The UI should provide a clear explanation of what this action does and its implications.
40+
* **R3.4:** This functionality must be disabled if Maintenance Mode is not active. It should only be usable when Maintenance Mode is enabled.
41+
42+
### 4.3. Maintenance Mode Toggle (Ref: [CLC-1273](https://linear.app/gitpod/issue/CLC-1273/admin-maintenance-mode-toggle))
3743
* **R2.1:** Administrators must be able to manually enable or disable a "Maintenance Mode" for their Gitpod instance.
3844
* **R2.2:** When Maintenance Mode is enabled:
3945
* Users must be prevented from starting new workspaces.
4046
* A clear warning or notification must be displayed on the dashboard indicating that the system is in maintenance.
4147
* **R2.3:** This toggle allows administrators to control the state before, during, and after an update.
4248

43-
### 4.3. Stop All Running Workspaces (Ref: [CLC-1275](https://linear.app/gitpod/issue/CLC-1275/admin-stop-all-running-workspaces-button-for-infra-update))
44-
* **R3.1:** Administrators must have an option (e.g., a button) to stop all currently running workspaces within their organization.
45-
* **R3.2:** This action is intended to ensure all running workspaces are backed up before an infrastructure update.
46-
* **R3.3:** The UI should provide a clear explanation of what this action does and its implications.
47-
* **R3.4:** This functionality must be disabled if Maintenance Mode is not active. It should only be usable when Maintenance Mode is enabled.
48-
4949
### 4.4. Schedule Maintenance Notification (Optional) (Ref: [CLC-1274](https://linear.app/gitpod/issue/CLC-1274/admin-schedule-maintenance-notification))
5050
* **R4.1:** Administrators must be able to schedule and display a maintenance notification banner on the Gitpod dashboard.
5151
* **R4.2:** The notification system must include an enable/disable toggle.
@@ -68,14 +68,7 @@ An "Admin" section will be added to the Gitpod organization menu. This section w
6868

6969
## 7. Testing Considerations
7070

71-
* **Functional Testing:** Each feature (viewing workspaces, notifications, maintenance mode, stopping workspaces) must be tested thoroughly.
72-
* **Permissions Testing:** Verify that only authorized administrators can access and use these features.
73-
* **UI/UX Testing:** Ensure the admin interface is user-friendly and provides clear information.
74-
* **Integration Testing:** Test the interaction of these features with other parts of the Gitpod system (e.g., workspace startup flow, dashboard display).
75-
* **Scenario Testing:** Test various scenarios, such as:
76-
* Scheduling a notification and then disabling it.
77-
* Enabling maintenance mode while users are attempting to start workspaces.
78-
* Stopping all workspaces when some are idle and some are active.
71+
* manual testing only
7972

8073
## 8. Deployment Considerations
8174

@@ -85,26 +78,26 @@ An "Admin" section will be added to the Gitpod organization menu. This section w
8578

8679
## 9. Implementation Progress
8780

88-
| Feature / Sub-Task | Status | Assignee | PR Link(s) | Notes |
89-
| ------------------------------------------------------ | ----------- | -------- | ---------- | --------------------------------------------------------------------- |
90-
| **Admin Page Scaffolding** | Done | Cline | | Create basic Admin page structure in Dashboard, accessible via org menu. Route: /org-admin |
91-
| **4.1 View Running Workspaces** | | | | |
92-
| - API: Fetch running workspaces | | | | `server` |
93-
| - UI: Display running workspaces | | | | `dashboard` |
94-
| **4.2 Maintenance Mode Toggle** | | | | |
95-
| - API: Get/Set Maintenance Mode | | | | `server` (state persistence) |
96-
| - Logic: Prevent new workspace starts | | | | `server` |
97-
| - UI: Toggle & Dashboard Banner | | | | `dashboard` |
98-
| **4.3 Stop All Running Workspaces** | | | | |
99-
| - API: Trigger stop all workspaces | | | | `server` |
100-
| - Logic: Iterate and stop workspaces | | | | `server` (existing API methods?) |
101-
| - UI: Button (disabled if Maint. Mode off) & Confirm | | | | `dashboard` |
102-
| **4.4 Schedule Maintenance Notification (Optional)** | | | | |
103-
| - API: Get/Set Notification | | | | `server` (state persistence) |
104-
| - UI: Form for scheduling & Dashboard Banner | | | | `dashboard` |
105-
| **General** | | | | |
106-
| - Permissions/Authorization | | | | `server` |
107-
| - Auditing | | | | `server` |
81+
| Feature / Sub-Task | Status | Assignee | PDD Links |
82+
| ------------------------------------------------------ | ----------- | -------- | ---------------------------------------------------------- |
83+
| **Admin Page Scaffolding** | Done | Cline | [001-infra-rollout-4.0.md](pdd/001-infra-rollout-4.0.md) |
84+
| **4.1 View Running Workspaces** | Done | Cline | [001-infra-rollout-4.1.md](pdd/001-infra-rollout-4.1.md) |
85+
| - API: Fetch running workspaces | | | |
86+
| - UI: Display running workspaces | | | |
87+
| **4.2 Stop All Running Workspaces** | | | |
88+
| - API: Trigger stop all workspaces | | | |
89+
| - Logic: Iterate and stop workspaces | | | |
90+
| - UI: Button (disabled if Maint. Mode off) & Confirm | | | |
91+
| **4.3 Maintenance Mode Toggle** | | | |
92+
| - API: Get/Set Maintenance Mode | | | |
93+
| - Logic: Prevent new workspace starts | | | |
94+
| - UI: Toggle & Dashboard Banner | | | |
95+
| **4.4 Schedule Maintenance Notification (Optional)** | | | |
96+
| - API: Get/Set Notification | | | |
97+
| - UI: Form for scheduling & Dashboard Banner | | | |
98+
| **General** | | | |
99+
| - Permissions/Authorization | | | |
100+
| - Auditing | | | |
108101

109102
**Status Key:** Not Started, In Progress, Blocked, In Review, Done
110103

0 commit comments

Comments
 (0)