Buildstream - Final Deployment and Training

Open
  • Is something wrong?
#5,542 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
Over a week
Newbie friendliness
8/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Active
Domain
devops

Research direction

The payload names no source files, tests or entry points; it is a delivery spec covering staging defect fixes, production installation, a final user manual and two training sessions. Start by checking whether prerequisite BR-30785 is finished and which staging defects are still open. Done means the acceptance criteria AC-001 to AC-003 are met: zero open P1/P2 defects, a health endpoint returning 200 with the release-tag version, and recorded training sessions.

Written by the indexing model from the issue text.

Description

Buildstream - Final Deployment and Training

Summary

This specification covers Final Software Deployment and User Training. The engineering team will resolve any minor software defects identified during final validation on the staging environment, deploy the final software on the production system, deliver the final user manual, and provide two virtual one-hour training sessions.

Problem Statement

The deployment requires the final production software to be defect-free in staging, fully deployed on the production system, and accompanied by formal documentation and training. Failure to complete these steps delays final delivery and delivery completion.

Value Proposition

Customer Value
  • Operators receive the final software installed on the production system.
  • Users receive the final user manual and two live training sessions to ensure successful adoption.

User Personas

  • End User: Attends the virtual training sessions and utilizes the final user manual and production system software.
  • Site Administrator: Validates the resolution of minor defects and oversees the production system deployment.

Use Cases

Use Case 1: Final Defect Resolution

Actor: Site Administrator
Context: Final validation is occurring on the staging environment.
Action: Minor defects are identified and resolved.
Result: The software is fully validated and ready for production system deployment.

Use Case 2: Production System Deployment & Handoff

Actor: Site Administrator & End User
Context: The software is ready for final deployment.
Action: The engineering team installs the software on the production system and provides the final manual.
Result: The production system is fully operational with the delivered software and documentation.

Use Case 3: User Training

Actor: End User
Context: The final software has been deployed.
Action: Users attend virtual training sessions provided by the engineering team.
Result: Users are trained and equipped to utilize the final software.

Scope Definition

Goals (Execution Outcomes)
  • Goal 1: Resolve any minor software defects identified during final validation on the staging environment.
  • Goal 2: Install the final software on the production system.
  • Goal 3: Provide the final user manual to the operators.
  • Goal 4: Conduct two virtual, one-hour training sessions.
Non-Goals (Scope Boundaries)
  • Non-Goal 1: Development of new features not previously defined in the delivery plan.
  • Non-Goal 2: Training beyond the explicitly mandated two, one-hour virtual sessions.

Requirements

Note: The following requirements are derived from the final delivery definitions.

Requirement: Staging Environment Defect Resolution [Req 1]

The system must be free of identified minor defects prior to production system deployment.

Scenario: Pre-deployment validation
  • When minor software defects are identified, the engineering team resolves any minor software defects identified during final validation on the staging environment, prior to deployment on the production system.
Requirement: Production System Installation and Manual [Req 2]

The final software and documentation must be delivered to the production system.

Scenario: Final installation and handoff
  • When completion of validation occurs, the engineering team installs the final software on the production system.
  • The engineering team delivers the final user manual.
Requirement: User Training [Req 3]

The operators must receive training on the final software.

Scenario: Post-deployment training
  • When training is requested, the engineering team provides two virtual, one-hour training sessions covering the final software.

Usability

  • The provision of the final user manual and the two virtual training sessions are explicitly included to ensure high usability and adoption by the operators.

Reliability

  • The engineering team must resolve minor software defects on the staging environment prior to main deployment to guarantee reliability on the production system.

Security

N/A - This feature introduces no new security boundaries beyond standard Omnia RBAC/TLS.

Performance

  • The final software must operate defect-free on the production system as verified during the staging phase.

Documentation

  • The engineering team must provide the final user manual to the operators.

Dependencies

  • Prerequisite: BR-30785 (Buildstream Web Portal Production Stabilization).
  • Infrastructure: Requires access to the production system for final installation.

Risks

Risk Category Impact Likelihood Mitigation
Delivery Failure Technical High Low Strictly adhere to the exact delivery criteria for the final delivery.
Buildstream Dependencies Technical High Medium The buildstream is highly dependent on the image builder within OpenCHAMI, the GitLab interface and APIs, and the storage of images on S3 on PowerScale. Ensure these external dependencies are highly available and properly integrated.

Acceptance Criteria

  • AC-001: All defects logged against the staging environment during final validation are resolved and verified closed. The staging environment passes a full regression test suite with zero open P1/P2 defects before production deployment is approved. [Req 1]
  • AC-002: The final software is installed on the production system, the application health endpoint returns HTTP 200, and the deployed version string matches the release tag. The final user manual (PDF, HTML, or hosted wiki) is delivered and accessible to operators - it covers all features delivered across prior deliveries (BR-81107 through BR-30785). [Req 2]
  • AC-003: Two virtual training sessions of at least one hour each are conducted and recorded. Attendance records confirm that designated end users were invited. Session recordings and/or slide decks are delivered to the site as reusable training artifacts. [Req 3]

Assumptions / Open Questions

Assumptions
  • A1: Required underlying hardware and OS capabilities are present.
Open Questions
  • None.
Dominant language
Python
Stars
9
Forks
175
Avg merge
1d 23h
Merged PRs (30d)
137

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from dell/omnia

All issues in dell/omnia

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.