Skip to content

Commit

Permalink
F OpenNebula/one#6430: Refactor References section
Browse files Browse the repository at this point in the history
* Virtual Machine Template
* Image Template
* Virtual Network Template
* Command Line Interface
* Guest OS Installation
* Contextualization (Open Source Cloud)
* Contextualization (VMWare vCenter)

Signed-off-by: Victor Hansson <[email protected]>
  • Loading branch information
vichansson committed Jul 1, 2024
1 parent 45a9bcc commit f84ca89
Show file tree
Hide file tree
Showing 11 changed files with 57 additions and 61 deletions.
Binary file modified source/images/sunstone_datablock_create.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/images/sunstone_marketplace_list_import.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/sunstone_network_options-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/sunstone_network_options-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/images/sunstone_network_options.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/images/sunstone_user_inputs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 15 additions & 9 deletions source/management_and_operations/references/creating_images.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ To retrieve images from the OpenNebula Marketplace:

|sunstone_marketplace_list_import|

Using the CLI, you can list an import images using these commands:
Using the CLI, you can list and import images using these commands:

.. prompt:: text $ auto

Expand Down Expand Up @@ -63,7 +63,7 @@ If you need to incorporate additional content or include a new base OS, refer to
Manual Installation
===================

If you are using KVM hypervisor you can create base images using OpenNebula by manually installing the operating system.
If you are using the KVM hypervisor you can create base images using OpenNebula by manually installing the operating system.

.. note::

Expand Down Expand Up @@ -105,13 +105,19 @@ Step 3. Create a Template to do the Installation

You'll need to create a VM Template with the following characteristics:

* In *Storage* tab, ``DISK 0`` disk will be the installation disk (future base image) created in step 2, and ``DISK 1`` Second disk will be the installation CD image created in step 1.
* In *Network* tab, attach ``NIC 0`` to a Virtual Network as it will be needed to download context packages.
* In *Boot* tab of *OS & CPU* tab, enable (check) both disks for booting.
In the **Advanced Options** step:

* Under the *Storage* tab, ``DISK 0`` disk will be the installation disk (future base image) created in step 2, and ``DISK 1`` Second disk will be the installation CD image created in step 1.

* Under the *Network* tab, attach ``NIC 0`` to a Virtual Network as it will be needed to download context packages.

* Under the *OS & CPU* tab in the *Boot order* section, enable (check) both disks for booting.
The boot order will be: first the installation media and second the installation disk.
* In *Input/Output* tab: enable VNC in *Graphics* and set ``Tablet`` ``USB`` in *Inputs*.

* Under the *Input/Output* tab: enable VNC in *Graphics* and set ``Tablet`` ``USB`` in *Inputs*.
This will be useful in case the OS has a graphical installation.


This can be done from the CLI as well using this command:

.. prompt:: bash $ auto
Expand All @@ -120,14 +126,14 @@ This can be done from the CLI as well using this command:

Now, instantiate the recently created VM Template and do the guest OS installation using the VNC viewer.
You'll need to configure the network manually as there are no context packages in the installation media.
Upon completion, tell the instanter to reboot the machine, login to the guest OS and follow the :ref:`Open Cloud Contextualization <kvm_contextualization>` instructions.
Upon completion, tell the instantiater to reboot the machine, login to the guest OS and follow the :ref:`Open Cloud Contextualization <kvm_contextualization>` instructions.

As a tip, one of the latest things you should do when using this method is disabling ``root`` password and deleting any extra users created by the installation tools.
As a tip, one of the final things you should do when using this method is disabling ``root`` password and deleting any extra users created by the installation tools.

Step 4. Shutdown the Machine and Configure the Image
----------------------------------------------------

Now, you can shutdown the Virtual Machine from the guest OS. When the Vitual Machine appears as ``POWEROFF`` in OpenNebula, terminate it.
Now, you can shutdown the Virtual Machine from the guest OS. When the Virtual Machine appears as ``POWEROFF`` in OpenNebula, terminate it.

Make sure to change the attribute ``PERSISTENT`` of the installation disk image to ``NO`` and set access permissions for other users (optional).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,17 @@ OpenNebula provides a set of contextualization packages for different operating
* Resize disk partitions as needed.
* Execute custom actions during boot.

All the OS appliances available in the `OpenNebula Marketplace <https://marketplace.opennebula.io/appliance>`_ comes already with all the software installed. If you want to build these images yourself take a look at the `OpenNebula Apps project <https://github.com/OpenNebula/one-apps>`_.
All the OS appliances available in the `OpenNebula Marketplace <https://marketplace.opennebula.io/appliance>`_ comes with all the software pre-installed. If you want to build these images yourself, take a look at the `OpenNebula Apps project <https://github.com/OpenNebula/one-apps>`_.

Install the Context Packages
============================

Additionally you can install the packages manually in any running VM guest, just grab the `latest version of the context packages for your OS system <https://github.com/OpenNebula/one-apps/releases>`_ and install them (don't forget to save your changes to the VM disk!).
Additionally you can install the packages manually in any running VM guest, just grab the `latest version of the context packages for your operating system <https://github.com/OpenNebula/one-apps/releases>`_ and install them (don't forget to save your changes to the VM disk!).

Using the Context Packages
==========================

Configuration parameters are passed to the contextualization packages through the ``CONTEXT`` attribute of the virtual machine. The most common attributes are network configuration, user credentials and startup scripts. These parameters can be both added using the CLI to the template or using Sunstone Template wizard. Here is an example of the context section using the CLI:
Configuration parameters are passed to the contextualization packages through the ``CONTEXT`` attribute of the virtual machine. The most common attributes are network configuration, user credentials and startup scripts. These parameters can be added both using the CLI or using the Sunstone Template wizard. Here is an example of the context section using the CLI:

.. code-block:: bash
Expand All @@ -33,12 +33,12 @@ Configuration parameters are passed to the contextualization packages through th
START_SCRIPT = "yum install -y ntpdate"
]
In the following links you can learn more details on how to:
From the following links you can learn more about:

* `Network configuration <https://github.com/OpenNebula/one-apps/wiki/linux_feature#network-configuration>`_.
* `Setup user credentials <https://github.com/OpenNebula/one-apps/wiki/linux_feature#user-credentials>`_.
* `Execute scripts on boot <https://github.com/OpenNebula/one-apps/wiki/linux_feature#execute-scripts-on-boot>`_.
* `Filesystem tunning <https://github.com/OpenNebula/one-apps/wiki/linux_feature#file-system-configuration>`_.
* `Filesystem tuning <https://github.com/OpenNebula/one-apps/wiki/linux_feature#file-system-configuration>`_.
* `Other OS settings and OneGate <https://github.com/OpenNebula/one-apps/wiki/linux_feature#other-system-configuration>`_.

Contextualization Reference
Expand Down
Loading

0 comments on commit f84ca89

Please sign in to comment.