REVIEW-19: SDIACT-124 Streamline software deployment with improved packaging - Joint SD&I Test and Operations Readiness Review

SDIACT-124 provides XSEDE software developers and integrators with tools and documentation on how to use the XSEDE source repositories, how to build software packages, and how to distribute software packages thru XSEDE software repositories.

Most important review feedback:

• Throughout the documents us the term "publication" rather than "distribution"
• Suggested using diagrams/workflows to help describe the processes
• Several additional definitions recommended
• Suggested more precisely specifying MUST or SHOULD design elements
• Suggested reordering some design material to more closely follow the natural workflow
• Many other smaller suggestions

Documentation

• Introduction
  • See Developer guide below
• Design/Security overview
  • Security and General Design Description
• Administrator guide
  • https://software.xsede.org/svn/sdi/activities/sdiact-124/trunk/Plans/XSEDESoftwarePublishingRepositoryAdministration-1.2.pdf
• Deployment Plan
  • n/a
• Developer guide
  • https://software.xsede.org/svn/sdi/activities/sdiact-124/trunk/Plans/XSEDESoftwarePackagingDeveloperDocumentation-1.3.pdf
• Defect, issue, and risk reporting
  • See SDIACT-124 test plan below
• Acceptance test plan
  • Test Plan
• Testing resources
  • software.xsede.org

Package information: All software packages (e.g., server and client packages) for this CI are listed.

Documentation and Installation instructions: The deployment plan for this CI on XSEDE is clearly described as well as the installation instructions and any XSEDE specific configuration instructions.

Test environment and facilities: The test environment needed to adequately to validate this component is described. Should indicate also whether testing can be performed within a VM and if not, the reasons for it.

Assumptions: Lists any assumptions needed before testing can begin (e.g., accounts needed).

Test procedures, cases, and scenarios: Lists the tests that should be run or an associated test suite and expected performance metrics if applicable.

Defect, issue, and risk reporting: Deployment plans should include defect and issue reporting information. The testing plan could reference that same information from the deployment plan, or provide alternate information if defects and issues need to be reported differently during testing. Risks, as well as defects and issues, should be part of the testing report.