New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added vagrant setup chapter in the docs #795
Conversation
Document steps to create a vagrant box for the libvirt provider. Also provide information on provider support This Fixes #792
For reading the docs reviewers can call:
next open a browser and point it to:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good 👍 The list of required configs and packages for vagrant looks precise
@tomschr if you have a minute could you go over the chapter ? would be great. Thanks |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@schaefi good work! 👍
Found a couple of minor things, see my comments below.
.. sidebar:: Abstract | ||
|
||
This page provides further information for handling | ||
vmx images built with KIWI and references the following |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
vmx -> VMX?
**boxes**. A box is a TAR archive containing a virtual disk image and | ||
some metadata. | ||
|
||
To build Vagrant boxes, you can use |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you can use -> use
|
||
To build Vagrant boxes, you can use | ||
`veewee <https://github.com/jedi4ever/veewee>`_ which builds boxes | ||
based on AutoYaST, or `Packer <http://packer.io>`_, which is provided |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think, better make two sentences:
AutoYaST, or ... -> AutoYaST. As an alternative, use Packer <http://packer.io>
_ which is provided by Vagrant itself.
based on AutoYaST, or `Packer <http://packer.io>`_, which is provided | ||
by Vagrant itself. | ||
|
||
Both tools are based on the official distribution media (DVDs). If such |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what do you mean by "official distribution media (DVD)"? Are referring to our openSUSE distribution or is it Ubuntu or ...?
Both tools are based on the official distribution media (DVDs). If such | ||
media does not exist (for example if the distribution is still under | ||
development or you want to use a collection of your own repositories), the | ||
KIWI way of building images might be helpful. In addition you can use the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would try to avoid parenthesis. What about this:
The KIWI way of building images might be helpful, if such a media does not exist.
For example, if the distribution is still under development or you want to use a
collection of your own repositories.
|
||
6. Configure sudo for vagrant user | ||
|
||
In :file:`etc/sudoers` make sure the vagrant user is |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess, this path is really meant relative to some Vagrant (image) directory, right? Maybe you should emphasis this that it is NOT the global, host-specific /etc/suders
file.
In :file:`etc/sudoers` make sure the vagrant user is | ||
configured to allow passwordless root permissions. This setup | ||
should be provided in an overlay file for the KIWI image | ||
description |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing dot after description.
Using the box requires a correct Vagrant installation on your machine. | ||
The libvirtd daemon and the libvirt default network need to be running. | ||
|
||
Once added to vagrant you can now boot the box and log in |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- added to vagrant -> added to Vagrant,
- you can now boot -> boot the box ....
|
||
Currently KIWI only supports the libvirt provider. There are | ||
other providers like virtualbox and also vmware available which | ||
requires a different box layout currently not supported by KIWI |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing dot after KIWI.
|
||
.. note:: Vagrant Providers | ||
|
||
Currently KIWI only supports the libvirt provider. There are |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add comma after "Currently".
@tomschr thanks I'v updated the text according to your findings |
Awesome thanks! How long before this is visible at https://suse.github.io/kiwi/building/working_with_images.html ? |
Cool, thanks. It wasn't there yesterday - I guess some auto-rebuild must have triggered since I looked. |
Document steps to create a vagrant box for the libvirt
provider. Also provide information on provider support
This Fixes #792