Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Installer installs software dependencies and asks users to complete setup with poor guidance #140

Open
4 tasks
rcj4747 opened this issue Sep 11, 2019 · 0 comments

Comments

@rcj4747
Copy link

rcj4747 commented Sep 11, 2019

Summary
On a clean Ubuntu 19.10 Server installation the installer will install docker, kubectl, and helm, plus chain the actual IBM Cloud CLI installer. For each of these dependencies the user is instructed to complete the installation following external instructions.

The URLs point to extremely generic install landing pages that offer numerous installation methods. It is difficult for the user to determine what must be done as it is unclear what actions the installer has taken on behalf of the user without the user re-downloading your installer and inspecting the source. And it is not stated what configuration of those tools is required for the IBM Cloud CLI.

The URLs themselves and calls to action for the user to perform additional configuration are buried in the log (and not summarized at the end). Also buried in the output is the IBM Cloud CLI data gather opt-out instructions. So the end-user might miss this entirely.

The installer is doing too much and too little at the same time. Too much in that the installer is taking responsibility for installing dependencies but without verifying them (issue #44) and in ways that are not against reasonable best-practices (issue #139 / issue #138). Too little by dropping the configuration task in the lap of the user without guidance. It might be better to check for the dependencies and if they are not present (or not at the correct version) point the user to installation instructions provided by developers of that software.

Steps to reproduce
(include tooling version, platform, etc)

  1. On ubuntu run 'lxd launch ubuntu:19.10 ibm-cli-test' to create a clean 19.10 container for a recreate
  2. Run 'lxd exec ibm-cli-test bash' to get a root shell
  3. Run 'curl -sL https://ibm.biz/idt-installer | bash' and review the messages
  4. Follow the URLs from the log and ask what a user without implementation knowledge of the installer would do given the instructions:

Operating System
Specify: (MacOS, Linux, Windows)
Ubuntu Linux 19.10

Supporting details
(Logs, stack traces, images, etc. Wrap in <detail> ... </detail> tags as appropriate)


Development "done" checklist

  • Test case to verify
  • Public Documentation updated
  • Change added to "release notes" as appropropriate
  • Notification to stakeholders (OM, other squads, etc)
@rcj4747 rcj4747 changed the title Installer installs software dependencies and asks users to complete setup with no guidance Installer installs software dependencies and asks users to complete setup with poor guidance Sep 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant