Design doc: Studio screens and Central Manager routes for automatic upgrades

オープン
#2,091 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
42/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
技術スタック
typescript
領域
documentation

調査の方向性

Start by reviewing the upgrade decision issues and the existing Studio routes and components named in the issue, including /edit/version, /scaling, /notifications, and /admin with AdminShell. Then map each listed screen to its Central Manager routes and account for the current notification, permission, and version flows. Done means a design document is merged with every route matching its linked issue and reviewed by the engineer building the screens.

索引モデルが issue の本文から書いたものです。

説明

documentation

Start: Waits for sign-off of the upgrade decisions.
Delivery: in one PR with #2092 and #2093.

What and why

Central Manager is adding automatic monthly upgrades for Fabric clusters (HarperFast/central-manager#1177). That brings several new customer screens and staff pages to Studio, each backed by new Central Manager routes. This issue is a short design document in this repo: each screen, where it sits, and the routes it calls. It should be complete enough to hand to an engineer who has not followed the backend work (D37).

Scope

The document covers these screens:

Screen Where Central Manager routes
Upgrades: schedule and next cycle, move a date earlier, conservative-track hold Organization menu GET /UpgradeSchedule, GET and PATCH /UpgradeCycle (HarperFast/central-manager#1191)
Upgrade history Cluster menu, next to Version GET /Cluster/:id/upgrades (HarperFast/central-manager#1191)
Stage link Cluster settings PUT /Cluster/:id (HarperFast/central-manager#1179), POST /OrganizationLink (HarperFast/central-manager#1178)
Notices in the bell, banner and notification center Existing components GET /OrganizationNotification plus its subscription (HarperFast/central-manager#1180)
Notification settings Organization settings NotificationSettings, NotificationPreference (HarperFast/central-manager#1181)
Staff: releases, blackouts, exceptions /admin /Admin/HarperRelease, /Admin/UpgradeBlackout, /Admin/UpgradeException (HarperFast/central-manager#1182, HarperFast/central-manager#1184, HarperFast/central-manager#1185)
Staff: organization page (upgrade track, slot, off-hours) /admin, new /Admin/Organization, /Admin/UpgradeSchedule (HarperFast/central-manager#1184)
Staff: plan and status /admin GET /Admin/Upgrade/plan, GET /Admin/Upgrade/status (HarperFast/central-manager#1186, HarperFast/central-manager#1190)
Staff: scoped notice form Existing notifications page POST /Admin/OrganizationNotification (HarperFast/central-manager#1180)
Staff: permission grants /admin, new /Admin/StaffPermissionGrant (HarperFast/central-manager#1183)

And how Studio behaves until the backend is switched on:

  • Studio has no feature flags. Pages stay hidden while their routes answer 404 or the mode is off. Staff pages are gated on the new permissions, which GET /User/current returns (HarperFast/central-manager#1183).
  • Types come from Central Manager's OpenAPI spec (pnpm update-sdk regenerates api.gen.d.ts). Every new route is documented in that spec, so no hand-typed entries in api.patch.d.ts should be needed.

Current Studio behavior the document should account for:

  • "Version" is not its own page. It is the shared cluster editor at /edit/version, and /scaling is the progress screen after a submit.
  • A manual version change has no confirmation dialog. The product proposal (HarperFast/central-manager#707) asks for one; the document should say whether it is in scope.
  • Studio hides downgrades with a client-side filter. Central Manager now refuses them on the server (HarperFast/central-manager#1187).
  • Notices: the bell, banner and /notifications read GET /SystemStatus/, refreshed by an anonymous WebSocket with a 60-second poll as fallback. Dismissals live in localStorage (AckedNotificationIds). The organization notice subscription is authenticated.
  • The staff area (/admin, AdminShell) filters menu items with hasStaffPermission and has no router guards. There is no staff organization page today.

Out of scope

  • Building the screens: #2092, #2093, #2094.

Depends on decisions

The scope may change with sign-off of the upgrade decisions. If one of these changes, revisit this issue.

  • Studio gets a rough screen-and-endpoint design document, complete enough to hand to another engineer (D37).
  • Everything ships off and is turned on by configuration, so Studio pages stay hidden until then (D38).
  • Launch scope includes the upgrade history page; customers changing their own slot comes after launch (D43).
  • The screens follow the decisions listed in the issues each one belongs to. When one of those changes, update this document too.

Depends on

  • The route list above. The routes are designed; they do not have to be built before the document is written.

Needed by

  • #2092, #2093, #2094.

Acceptance

  • The document is merged in this repo.
  • Every route it names exists in the linked Central Manager issues, with the same method and path.
  • The engineer who will build the screens has reviewed it.

Part of HarperFast/central-manager#1177.

🤖 Generated by Claude Code (Claude Opus 5.5); posted via @Devin-Holland.

主要言語
TypeScript
スター
5
フォーク
4
平均マージ
2日 13時間
マージ済み PR(30日)
60

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

HarperFast/studio のほかの issue

HarperFast/studio の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。