Unclear messages in the sunbeam command outputs

[Tytus Kurek]

Following the multi-node tutorial at https://microstack.run/docs/multi-node I've found some of the messages in the sunbeam command outputs unclear:

1) Running the "sunbeam cluster bootstrap" command, I get the following questions:

Management networks shared by hosts (CIDRs, separated by comma):
MetalLB address allocation range (supports multiple ranges, comma separated):
Disks to attach to MicroCeph:

however:
- the tutorial doesn't define what the "management networks" are
- the tutorial doesn't define what MetalLB is and how it's used in the context of Sunbeam
- the tutorial doesn't define how multiple network ranges can be used in the context of Sunbeam
- it is unclear how the disks to attach to MicroCeph should be specified

I suggest those questions are re-defined to avoid the confusion:

Control plane networks (CIDRs, separated by a comma):
Control plane API ranges (IP ranges, separated by a comma):
Disks to attach to Ceph storage (paths, separated by a comma):

2) Running the "sunbeam configure" command, I get the following questions:

Local or remote access to VMs [local/remote]:
CIDR of network to use for external networking:
IP address of default gateway for external network:
Populate OpenStack cloud with demo user, default images, flavors etc:
Username to use for access to OpenStack:
Password to use for access to OpenStack:
Network range to use for project network:
List of nameservers guests should use for DNS resolution:
Enable ping and SSH access to instances?:
Start of IP allocation range for external network:
End of IP allocation range for external network:
Network type for access to external network:
Writing openrc to demo-openrc ... done
Free network interface that will be configured for external traffic:

however:
- those questions don't seem to be grouped by their logical context
- some of those questions could be more meaningful and aligned with the structure of the aforementioned questions

I suggest those questions are re-defined to avoid the confusion:

Local or remote access to VMs [local/remote]:
External network (CIDR):
External network's allocation range (IP range):
External network's gateway (IP):
External network type [flat/vlan]:
External network interface:
Nameservers guests should use for DNS resolution (IPs, separated by a comma):
Populate the cloud with demo user, default images, flavors etc [y/n]:
Username to use for access to the cloud:
Password to use for access to the cloud:
Project's internal network (CIDR):
Enable ping and SSH access to instances [y/n]:
Writing the RC file to ./demo-openrc ... done

I would also consider adding the following output:

The cloud has been configured for sample usage.
Now run "source ./demo-openrc" command to start using the OpenStack client or access the OpenStack dashboard at <URL goes here>

Happy to debate.

[Billy Olsen (billy-olsen)]

Agreed that a bit more clarification could be done here.