Getting started guide

[gbraad]

We need a Getting Started Guide to help the user to get up and running in no time.

• installation of the needed crc-driver-libvirt driver plugin
  • actually handled by the crc setup command
• basic usage crc start
• ... note: at this point no other commands exist yet (see command roadmap Command roadmap #70 )
• use with oc (export of kubeconfig)

[kowen-rh]

Looks like we have the start, stop, and delete commands at the moment -- is that correct?

[gbraad]

@robin-owen this is correct and setup to check and fix issues to make CRC run (note: start only checks before running).

You could try the following binary:

https://15-165193530-gh.circle-artifacts.com/0/crc/linux-amd64/crc

[kowen-rh]

I've built the binary myself and noticed that there's no setup command documented in crc --help. Is that expected at this time?

[gbraad]

I filed an issue for this: #87

[kowen-rh]

We could also use general troubleshooting information.

AFAIK, the general procedure for troubleshooting is to delete the current VM via crc delete and retry with crc start. (This is assuming that crc setup has already been run and none of the files crc setup configures have been modified by the user. At the moment, this would be an advanced use case which we are not planning to document yet.)

Is there any other troubleshooting information for common issues or errors which could be encountered?

Edit: In the future, we'll likely want a dedicated troubleshooting guide, but for the simple uses we have at the moment, I think it makes sense to include all of this information in a single guide.

[gbraad]

After a successful crc start, there is a minimum of 4 minutes that you would have to wait for the cluster to start all the needed containers, operators and whatever else is needed until it settles down and can actually serve a request. Note: at the moment we do not yet read the status from the cluster so it is kind of a 'fire-and-forget' for now after crc start finished.

If the cluster is up, you can use oc after doing an export KUBECONFIG=[..]/kubeconfig or log into the console with the kubeadmin user. all this information is now in files that are extracted from the image bundle. This can be found at ~/.crc/machines/crc/.../.

[gbraad]

As discussed with @rowen, commands like crc config set is now considered to be advanced usage, and likely ONLY necessary to address as part of troubleshooting at this point

[gbraad]

Fixed with #109

[anjannath]

Fixed in e8255c6