open-horizon / open-horizon/devops

The all-in-one script should provide the user's credentials earlier in the process.

Open
#104 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue help wanted
Dominant language
Shell
Stars
12
Forks
46
PR merge metrics
No merged PRs in 30d

Description

The code here:
https://github.com/open-horizon/devops/blob/master/mgmt-hub/deploy-mgmt-hub.sh#L1351
never runs if even a simple and correctable error occurs. As a result, the user's credentials for the hub are essentially discarded (they are never given access to them). The user must then always start over from scratch in this situation instead of just fixing the error and continuing. Some examples of correctable errors are something going wrong during example publication or during node registration (both of which happen after after successful Management Hub setup). Both of these examples happened to me while trying to get the all-in-one running under WSL2 on Windows.
I think ideally the Management Hub's user credentials should written into a file whose filename was announced early in the script and then again near the end. For maximum user convenience the credentials would be written in a form that could simply be sourced into a shell.

Contributor guide

Open the contributing guide

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.

Research direction

Start at mgmt-hub/deploy-mgmt-hub.sh around line 1351 and trace when Management Hub setup succeeds versus when example publication or node registration fails. Define the credential file location and shell-sourceable format from the issue, then verify that its filename is announced early and again near the end and that credentials remain available after a correctable failure.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
devops
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.