-
Notifications
You must be signed in to change notification settings - Fork 43
Missing steps in Vagrant install document #321
Description
There appears to be some information missing from some of the documentation on setting up Vagrant.
This top-level document: https://github.com/clearlinux/cloud-native-setup/tree/master/clr-k8s-examples says to either
Follow instructions in the Vagrant docs
Or, follow our detailed steps
Now you have a 3 node cluster up and running.
The 'detailed steps' link is to this document: https://github.com/clearlinux/cloud-native-setup/blob/master/clr-k8s-examples/vagrant.md In about the middle of that document, immediately after installing the software, it says to run "vagrant up" (with or without CPU and memory settings, and with or without specifying "clr-01" as the type of VM to create).
The first document says that after following those steps from the second document, you'll have a cluster up and running. What actually happens is you get this message in red:
A Vagrant environment or target machine is required to run this
command. Run vagrant init to create a new Vagrant environment. Or,
get an ID of a target machine from vagrant global-status to run
this command on. A final option is to change to a directory with a
Vagrantfile and to try again.
It appears the above documents are missing the "vagrant init" step described in the chained documents pointed to by the 'Vagrant docs' link:
https://www.vagrantup.com/intro/getting-started/install.html#installing-vagrant
https://www.vagrantup.com/intro/getting-started/project_setup.html
I would think it would be appropriate to flag as a bug in the '.../vagrant.md' document that it fails to mention the necessary "vagrant init" step. I would think somebody from the outside who tries to follow the recipe will lose some confidence in the quality of the documentation.
Thanks,
Robert Riches