diff --git a/docs/index.rst b/docs/index.rst index 34e6161de4b3700e6598dfc6e8545e06ec52c18d..356d405157cd625973086d0026af6df3ee05ff54 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -15,6 +15,7 @@ Contents: overview install + usage Indices and tables diff --git a/docs/snapshots/01_wizard.png b/docs/snapshots/01_wizard.png new file mode 100644 index 0000000000000000000000000000000000000000..44012808c919f62afc97e9e9001ed096f1646efd Binary files /dev/null and b/docs/snapshots/01_wizard.png differ diff --git a/docs/snapshots/02_name.png b/docs/snapshots/02_name.png new file mode 100644 index 0000000000000000000000000000000000000000..8101e5030a16adce9f45f7b2800534b56db4eb6f Binary files /dev/null and b/docs/snapshots/02_name.png differ diff --git a/docs/snapshots/03_description.png b/docs/snapshots/03_description.png new file mode 100644 index 0000000000000000000000000000000000000000..2d66c1d87718a825ae3622985a12f3f90e35c8b7 Binary files /dev/null and b/docs/snapshots/03_description.png differ diff --git a/docs/snapshots/04_account.png b/docs/snapshots/04_account.png new file mode 100644 index 0000000000000000000000000000000000000000..55f528332f766d10b645e558f4b0b8b96a70e5db Binary files /dev/null and b/docs/snapshots/04_account.png differ diff --git a/docs/snapshots/05_token.png b/docs/snapshots/05_token.png new file mode 100644 index 0000000000000000000000000000000000000000..125847ca7b361a722a7fbedfc9365bbbbd7735ea Binary files /dev/null and b/docs/snapshots/05_token.png differ diff --git a/docs/snapshots/06_confirm.png b/docs/snapshots/06_confirm.png new file mode 100644 index 0000000000000000000000000000000000000000..8afdcd89f905f9d5379cb2f392ece22ea124f202 Binary files /dev/null and b/docs/snapshots/06_confirm.png differ diff --git a/docs/usage.rst b/docs/usage.rst new file mode 100644 index 0000000000000000000000000000000000000000..32e09ddbb17170e05dd48601641eb8de06fb696d --- /dev/null +++ b/docs/usage.rst @@ -0,0 +1,51 @@ +Usage +===== + +snf-image-creator comes in 2 variants: + * snf-mkimage: A user-friendly dialog-based program + * snf-image-creator: A non-interactive command line program + +Creating a new image +-------------------- + +Suppose you want to create a new ubuntu server image. Download the installation +disk from the internet: + +.. code-block:: console + + $ wget http://ubuntureleases.tsl.gr/12.04.1/ubuntu-12.04.1-server-amd64.iso + +Create a 2G sparce file to host the new system: + +.. code-block:: console + + $ truncate -s 2G ubuntu_hd.raw + +And install the ubuntu system on this file: + +.. code-block:: console + + $ sudo kvm -boot d -drive file=ubuntu_hd.raw,format=raw,cache=none,if=virtio \ + -cdrom ubuntu-12.04.1-server-amd64.iso + +After this, become root, activate the virtual environment you have installed +snf-image-creator in, and use *snf-mkimage* to create and upload the image: + +.. code-block:: console + + $ sudo -s + $ source /path/to/snf-image-env/bin/activate + $ snf-mkimage ubuntu_hd.raw + +In the first screen you will be asked to choose if you want to run the program +in *Wizand* or *Expert* mode. Choose *Wizard*. + +.. image:: /snapshots/01_wizard.png + +Then you will be asked to provide a name, a description, an ~okeanos account +and the token corresponding to this account. After that you will be asked to +confirm the provided data. + +.. image:: /snapshots/06_confirm.png + +Choosing *YES* will create the image and upload it to your ~okeanos account.