| Next revision | Previous revision |
| dido:02-crusible:99-annexes:annex-c-requirements:03-functional-requirements:03-11-management-interfaces:start [2026/07/17 00:23] – created nick_dido | dido:02-crusible:99-annexes:annex-c-requirements:03-functional-requirements:03-11-management-interfaces:start [2026/07/31 07:34] (current) – ↷ Links adapted because of a move operation nick_dido |
|---|
| ====== C.3.11 Management Interfaces ====== | ====== C.3.11 Crucible Interfaces ====== |
| |
| [[dido:02-crusible:99-annexes:annex-c-requirements:03-functional-requirements:start|Go to Crucible Functional Requirements]] | [[dido:02-crusible:99-annexes:annex-c-requirements:03-functional-requirements:start|Go to Crucible Functional Requirements]] |
| |
| The Management Interfaces [[dido:99_annexes:annex-b-terms-and-definitions:f:functional_requirement|requirements]] define how [[dido:99_annexes:annex-b-terms-and-definitions:c:crucible|Crucible]] presents a web-based interface for managing multiple [[dido:99_annexes:annex-b-terms-and-definitions:i:infrastructure_environment|Infrastructure Environments]] and ensures that the web interface uses the same engine and command-line capabilities as the primary command-line interface. | The Crucible Interfaces [[dido:99_annexes:annex-b-terms-and-definitions:f:functional_requirement|requirements]] define how [[dido:99_annexes:annex-b-terms-and-definitions:c:crucible|Crucible]] exposes its operations through a [[dido:99_annexes:annex-b-terms-and-definitions:c:cli|Command-Line Interface (CLI)]] and a [[dido:99_annexes:annex-b-terms-and-definitions:w:web_ui|Web-Based User Interface (Web UI)]]. |
| |
| Together, these requirements establish an additional management interface without replacing or duplicating the primary command-line execution path. | Together, these requirements establish shared interface operations and separate command-line and web-based access paths. They do not require the interfaces to duplicate the underlying implementation of those operations. |
| |
| ===== Contents ===== | ===== Contents ===== |
| |
| {{indexmenu>dido:02-crusible:99-annexes:annex-c-requirements:03-functional-requirements:03-11-management-interfaces#1|js navbar nocookie maxjs#1 id#crucible_management_interfaces_requirements_nav}} | * [[dido:02-crusible:99-annexes:annex-c-requirements:03-functional-requirements:03-11-management-interfaces:fr-ui-001|FR-UI-001 — Shared Interface Operations]] |
| | * [[dido:02-crusible:99-annexes:annex-c-requirements:03-functional-requirements:03-11-management-interfaces:fr-ui-002|FR-UI-002 — Command-Line Interface]] |
| | * [[dido:02-crusible:99-annexes:annex-c-requirements:03-functional-requirements:03-11-management-interfaces:fr-ui-003|FR-UI-003 — Web-Based User Interface]] |
| |
| ===== Notes for Editors ===== | {{indexmenu>dido:02-crusible:99-annexes:annex-c-requirements:03-functional-requirements:03-11-crucible-interfaces#1|js navbar nocookie maxjs#1 id#crucible_interfaces_requirements_nav}} |
| |
| The individual requirement pages should retain the stable identifiers ''FR-UI-001'' through ''FR-UI-002''. | ===== Requirement Status ===== |
| |
| These requirements apply to Phase 2. | <todo>Review and approve the decomposition of the Crucible Interfaces requirements into shared interface operations, a Command-Line Interface, and a Web-Based User Interface.</todo> |
| |
| Individual requirement pages are leaf nodes and should not include a trailing '':start'' in their namespaces. | <todo>Confirm whether the Command-Line Interface remains the primary interface or whether the architecture treats the Command-Line Interface and Web-Based User Interface as equivalent access paths.</todo> |
| |
| The Source Statement on each requirement page should preserve the original wording from the controlling System Requirements Specification. | ---- |
| | ===== Issues ===== |
| |
| Normalized Statements should use direct, testable behavior and should identify the applicable interface, managed Infrastructure Environment information, shared engine capability, command-line operation, and required result. | <todo>Confirm whether the controlling source requires behavioral parity between the Command-Line Interface and Web-Based User Interface or requires both interfaces to use the same underlying engine implementation.</todo> |
| |
| The web-based management application should remain an additional interface. The command-line interface remains the primary interface. | <todo>Determine whether the operations exposed through both interfaces require a separately defined controlled term.</todo> |
| |
| Verification criteria should test only the behavior stated in the normalized Statement and should not introduce additional normative obligations. | ---- |
| | ===== Notes for Editors ===== |
| |
| Incoming [[dido:99_annexes:annex-b-terms-and-definitions:t:traceability|Traceability]] should use the wiki Backlinks function rather than a manually maintained list. | The individual requirement pages retain the stable identifiers ''FR-UI-001'' through ''FR-UI-003''. |
| |
| To reference a requirement Statement from another wiki page, insert: | Individual requirement pages are leaf nodes and omit a trailing '':start'' from their namespaces. |
| |
| <code dokuwiki> | The Source Statement on each requirement page preserves the original wording from the controlling System Requirements Specification. |
| {{section><namespace>#Statement&noheader&nofooter&noeditbtn}} | |
| </code> | |
| |
| Replace ''<namespace>'' with the namespace of the requirement leaf page. | Normalized Statements should use direct, testable behavior and distinguish: |
| |
| The section name following ''#'' SHALL match the section heading verbatim on the requirement page. | * Operations exposed through both interfaces |
| | * Operations invoked through the [[dido:99_annexes:annex-b-terms-and-definitions:c:cli|Command-Line Interface (CLI)]] |
| | * Operations invoked or observed through the [[dido:99_annexes:annex-b-terms-and-definitions:w:web_ui|Web-Based User Interface (Web UI)]] |
| | |
| | FR-UI-001 should specify shared externally observable operations unless the controlling source explicitly requires a common internal engine implementation. |
| | |
| | FR-UI-002 should address the Command-Line Interface without adding Web-Based User Interface behavior. |
| | |
| | FR-UI-003 should address the Web-Based User Interface without adding Command-Line Interface behavior. |
| | |
| | The category title **Crucible Interfaces** does not establish **Management** or **Management Interface** as separate controlled terms. Individual Statements should identify the actual Crucible operations exposed through each interface. |
| | |
| | Verification criteria should test only the behavior stated in each normalized Statement and should not introduce additional normative obligations. |
| | |
| | Incoming [[dido:99_annexes:annex-b-terms-and-definitions:t:traceability|Traceability]] should use the wiki Backlinks function rather than a manually maintained list. |
| |
| Do not rename a requirement page after an external citation unless a redirect or move plan is in place. | Do not rename a requirement page after an external citation unless a redirect or move plan is in place. |