zarf icon indicating copy to clipboard operation
zarf copied to clipboard

Evaluate Replicated's Troubleshoot for Prereq / Support package integration

Open jeff-mccoy opened this issue 2 years ago • 2 comments

Troubleshoot offers some really valuable support tools for airgapped envs we should evaluate for use with Zarf.

jeff-mccoy avatar Jun 27 '22 22:06 jeff-mccoy

@Madeline-UX FYSA

jeff-mccoy avatar Jun 29 '22 16:06 jeff-mccoy

Validated User Need:

User Story As a user (software release engineer) I need to know what the prerequisites are to install and run a package on a system before I install or update the package in a disconnected environment.

Current Problem Zarf users have reported experiences of not being able to successfully deploy Zarf or Zarf packages on the first attempt due to their system not meeting tech requirements that were not clearly communicated before installation or after failure to install (CPU, memory, storage). The impact of these issues has been time spent troubleshooting and reaching back to the team for support.

Examples

  • Some users work on systems that cap CPU (ex max of 20 CPU does not meet the minimum software factory package requirement of 32 CPU)
  • BB core package is still 300 GB (3 PS5 games) which may be more than a system or machine available
  • If pre-requisites are stated in docs, that still doesn't help users in Airgap who don't have access back to the internet.
  • Some users do not have control over partition size

Needs

  • Make technical prerequisites clear on package download (ex. on docs)
  • Ensure users can see a list of requirements before they install a package in a disconnected environment
  • Clear error messages that state which requirement is not met if the install fails
  • Pre-update message with pre-req changes introduced by a package update
  • Allow package creators to set pre-recs in helm charts/package config

Scenarios WIP

@megamind @YrrepNoj Interested in your feedback

Madeline-UX avatar Jul 01 '22 19:07 Madeline-UX