Better documentation for HIL consumers/end-users

[henn]

Currently, our end-user/consumer documentation does not have any examples.

It would be good to improve this before our next release, including perhaps some scripts in the examples/ directory.

[zenhack]

The file you link to expressly refers to examples/puppet_headnode; we do have one example, which works. It is rather slapped together though.

[henn]

Ok - then we can mark this as easy :)

The documentation should be tied into the README

[zenhack]

I'd like to see a concrete list of actionable tasks for this issue; as it stands exactly what needs to be done is somewhat vague.

[henn]

Essentially, I was thinking of something that would show the basic operations of HaaS. Perhaps:

• Creates a project
• Allocates 2 nodes
• Creates 2 networks
• Attaches those networks to the nodes
• Creates a headnode that is attached to the PXE interfaces
• Resets the nodes
• Bonus points for PXE'ing an OS onto the nodes from the same script
• Tears everything down.

[zenhack]

Okay, I think that's a good checklist of things to have in an example somewhere. @gsilvis, @lokI8, thoughts?

[xuhang57]

@zenhack @naved001 So here we have a good list of examples we should come up with. Does this relate to: #903, right?

Since, this is more like how to use HIL in cli, not use HIL as a Client IMO

[naved001]

you are right, this is just how to use the HIL cli to do something useful. We can probably skip the headnode related call, and pxe booting an OS (that's not really what HIL does).

[xuhang57]

Thanks for confirming. So an updated list would be:

• Creates a project
• Creates a network

[zenhack]

Yeah, looks good to me. When we add the openvpn stuff we should also add examples for that (plus links to configuring the openvpn client).

[xuhang57]

PR merged. Closing this.