gryf/boxpy
1
0
Fork 0
mirror of https://github.com/gryf/boxpy.git synced 2026-01-03 08:44:11 +01:00
Code Issues Projects Releases Wiki Activity

Update readme file.

Browse Source
This commit is contained in:
gryf
2021-06-04 18:54:56 +02:00
parent 1a058a1e2a
commit e8264c5c69
1 changed files with 21 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.rst
View File

@@ -2,19 +2,16 @@
box.py box.py
====== ======
Box.py is a simple automation tool meant to run Ubuntu cloud image on top of Box.py is a simple automation tool meant to run Ubuntu or Fedora cloud images
VirtualBox. on top of VirtualBox.
What it does is simply download official cloud image for Ubuntu server, set up What it does is simply download official cloud image, set up VM, tweak it up
VM, tweak it up and do the initial pre-configuration using generated config and do the initial pre-configuration using generated config drive.
drive.
I've wrote this little tool just to not click myself to death using web browser I've wrote this little tool just to not click myself to death using web browser
for downloading cloud images, and going through VirtualBox GUI (or figuring out for downloading cloud images, and going through VirtualBox GUI (or figuring out
weird named options for ``vboxmanage`` ;P) weird named options for ``vboxmanage`` ;P)
Perhaps other distros would be supported in the future.
Requirements Requirements
------------ ------------
@@ -108,6 +105,23 @@ with the real value of public key. Every ``$`` sign, especially in
will become a ``$$``. Perhaps I'll change the approach for writing ssh key, will become a ``$$``. Perhaps I'll change the approach for writing ssh key,
since that's a little bit annoying. since that's a little bit annoying.
For that reason, a little improvement has been done, so now its possible to
pass filenames to the custom config, instead of filling up
``write_files.contents``:
.. code:: yaml
write_files:
- path: /opt/somefile.txt
permissions: '0644'
filename: /path/to/local/file.txt
during processing this file, boxpy will look for ``filename`` key in the yaml
file for the ``write_files`` sections, and it will remove that key read the
file and put its contents under ``content`` key. What is more important, that
will be done after template processing, so that there will be no interference
for possible ``$`` characters.
What is more interesting is the fact, that you could use whatever cloud-init What is more interesting is the fact, that you could use whatever cloud-init
accepts, and a special section, for keeping configuration, so that you don't accepts, and a special section, for keeping configuration, so that you don't
need to provide all the option every time you boot up similar VM. For example: need to provide all the option every time you boot up similar VM. For example: