diff --git a/source/ext/spellchecking/wordlists/opennebula.txt b/source/ext/spellchecking/wordlists/opennebula.txt index e8d10edec..a056206dc 100644 --- a/source/ext/spellchecking/wordlists/opennebula.txt +++ b/source/ext/spellchecking/wordlists/opennebula.txt @@ -14,6 +14,7 @@ Autostart Backported Balancer Bool +Broadcom Bzip CaaS Cardinality @@ -226,6 +227,7 @@ boolean booleans bootable bootloader +browseable btrfs bugfixes busLogic @@ -388,6 +390,7 @@ instantiater instantiation integrations integrators +interoperable iommu ionice iops @@ -673,9 +676,11 @@ tmp toolchain toolset topologies +tty tunables tx txt +ubuntu udev uid umask diff --git a/source/images/6.10-fireedge_login.png b/source/images/6.10-fireedge_login.png new file mode 100644 index 000000000..0600ef1b7 Binary files /dev/null and b/source/images/6.10-fireedge_login.png differ diff --git a/source/images/6.10-sunstone_dashboard.png b/source/images/6.10-sunstone_dashboard.png new file mode 100644 index 000000000..34f3a2d10 Binary files /dev/null and b/source/images/6.10-sunstone_dashboard.png differ diff --git a/source/images/6.10-vOneCloud-download-deploy-001.png b/source/images/6.10-vOneCloud-download-deploy-001.png new file mode 100644 index 000000000..a3b39e8c2 Binary files /dev/null and b/source/images/6.10-vOneCloud-download-deploy-001.png differ diff --git a/source/quick_start/deployment_basics/index.rst b/source/quick_start/deployment_basics/index.rst index 305aa2c43..37e5a0fe3 100644 --- a/source/quick_start/deployment_basics/index.rst +++ b/source/quick_start/deployment_basics/index.rst @@ -9,5 +9,5 @@ Deployment Basics Overview Try OpenNebula Front-end on AWS - Try OpenNebula Front-end on VMware + Try OpenNebula Front-end on Broadcom VMware Try OpenNebula Hosted Front-end diff --git a/source/quick_start/deployment_basics/try_opennebula_on_vmware.rst b/source/quick_start/deployment_basics/try_opennebula_on_vmware.rst index 4593b5a8d..384c2aba6 100644 --- a/source/quick_start/deployment_basics/try_opennebula_on_vmware.rst +++ b/source/quick_start/deployment_basics/try_opennebula_on_vmware.rst @@ -1,15 +1,33 @@ .. _try_opennebula_on_vmware: -===================================== -Deploy OpenNebula Front-end on VMware -===================================== +============================================== +Deploy OpenNebula Front-end on Broadcom VMware +============================================== -In this guide, we'll go through a Front-end OpenNebula environment deployment, where all the OpenNebula services needed to use, manage and run the cloud will be deployed through an OVA and collocated on the single VM running on a vCenter instance. Afterwards, you can follow the Operations and Usage basics guides of this same Quick Start to launch edge clusters based on open source hypervisors. +In this tutorial, we’ll use **vOneCloud** to install an OpenNebula Front-end on top of an existing Broadcom VMware installation. Completing this tutorial takes approximately five minutes. + +**vOneCLoud** is an Open Virtual Appliance (OVA) for Broadcom VMware vSphere. It contains a complete OpenNebula Front-end, installed and configured on an AlmaLinux OS. It is free to download and use, and may be used for small-size production deployments. With **vOneCloud**, you can deploy on top of your VMware infrastructure all of the OpenNebula services needed to use, manage and run OpenNebula. + +In this tutorial, we’ll complete the following high-level steps: + + #. Verify the system requirements. + #. Download vOneCloud. + #. Deploy the vOneCloud OVA. + #. Configure the vOneCloud virtual appliance. + #. Access the OpenNebula Front-end through the FireEdge GUI. + +After finishing this tutorial, you will have deployed a complete, ready-to-use OpenNebula Front-end on top of your VMware infrastructure. You will then be able to log in via the FireEdge GUI, define hosts and deploy virtual machines. + +Brief Overview of vOneCloud +=========================== .. image:: /images/vonecloud_logo.png :align: center -vOneCloud is a virtual appliance for vSphere that builds on top of your vCenter an OpenNebula cloud for development, testing or product evaluation in five minutes. In a nutshell, it is an OVA file with a configured AlmaLinux and OpenNebula installation. vOneCloud is free to download and use and can be also used for small-size production deployments. +vOneCloud ships with a default of 2 vCPUs, 16 GiB of RAM and 100GB of disk size. It is certified for infrastructures of the following dimensions: + +- Up to 1000 VMs in total +- Up to 100 users, with a limit of 10 users accessing the system simultaneously vOneCloud ships with the following components under the hood: @@ -23,146 +41,223 @@ vOneCloud ships with the following components under the hood: | **Phusion Passenger** | Default version shipped in AlmaLinux 8 (used to run Sunstone) | +-----------------------+--------------------------------------------------------------------------------------------------+ -.. _control_console: +.. _accounts: + +vOneCloud ships with several pre-created user accounts, described below: + ++----------+---------------------+-------------------------+----------------------------------------------------------------------------------+ +| Account | Interface | Role | Description | ++==========+=====================+=========================+==================================================================================+ +| root | Linux | Appliance administrator | This user can log into the appliance (local login, no SSH). | ++----------+---------------------+-------------------------+----------------------------------------------------------------------------------+ +| oneadmin | Linux | Service user | Used to run all OpenNebula services. | ++----------+---------------------+-------------------------+----------------------------------------------------------------------------------+ +| oneadmin | OpenNebula Sunstone | Cloud administrator | Cloud administrator. Run any task in OpenNebula, including creating other users. | ++----------+---------------------+-------------------------+----------------------------------------------------------------------------------+ + +vOneCloud includes the Control Console, a text-based interface that offers menus for configuring the appliance. You can access the Control Console by opening the vOneCloud appliance console in vCenter. We will use the Control Console to configure vOneCloud in the steps below. -vOneCloud comes with a Control Console, a text-based wizard accessible through the vCenter console to the vOneCloud appliance. It is available by opening the vOneCloud appliance console in vCenter. It requires no authentication since only the vCenter administrator will be able to open the vOneCloud console. It can be used to configure the network, root password and change the password of the OpenNebula oneadmin user. +.. note:: -.. _vonecloud_requirements: + Please bear in mind that vOneCloud is shipped only for evaluation purposes. -Requirements -============ -.. note :: +Step 1. Verify the System Requirements +====================================== - In order to follow the :ref:`Running Kubernetes Clusters ` with your vOneCloud instance, you will need a publicly accessible IP address so the deployed services can report to the OneGate server. See :ref:`OneGate Configuration ` for more details. +To deploy and use the vOneCloud appliance, you will need the following: -The following components are needed to use the vOneCloud appliance: + * **vCenter 7.0** with ESX hosts grouped into clusters. + * **ESX 7.0** with at least 16 GB of free RAM and a datastore with 100 GB of free space. + * **Information** for connecting to vCenter7.0: + - IP or DNS address + - Login credentials (username and password) of an admin user + * **Web browser**: Firefox (3.5 and above) or Chrome. -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **Component** | **Observations** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| vCenter 7.0 | - ESX hosts need to be grouped into clusters. | -| | - The IP or DNS needs to be known, as well as the credentials (username and password) of an admin user. | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| ESX 7.0 | - With at least 16 GB of free RAM and 100GB of free size on a datastore. | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Firefox (> 3.5) and Chrome | Other browsers, including Safari, are **not** supported and may not work well. | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + .. warning :: + + Other browsers, including Safari, are not supported and may not work well. -vOneCloud ships with a default of 2 vCPUs, 16 GiB of RAM and 100GB of disk size, and as such it has been certified for infrastructures of the following dimensions: +Step 2. Download vOneCloud +========================== -- Up to 1.000 VMs in total -- Up to 100 users, the limit being 10 users accessing the system simultaneously +To download vOneCloud, you will need to complete the `download form `__. -Take into account that vOneCloud is shipped for evaluation purposes. +Download the OVA and save it to a convenient location. -.. _accounts: +Step 3. Deploy the vOneCloud OVA +==================================== -Accounts -================================================================================ +Log in to your vCenter installation. Determine which cluster to deploy vOneCloud on. -vOneCloud ships with several pre-created user accounts which will be described in this section: +In the left-hand pane, right-click the desired cluster, then click **Deploy OVF Template**. -+----------+---------------------+-------------------------+----------------------------------------------------------------------------------+ -| Account | Interface | Role | Description | -+==========+=====================+=========================+==================================================================================+ -| root | linux | Appliance administrator | This user can log into the appliance (local login, no SSH). | -+----------+---------------------+-------------------------+----------------------------------------------------------------------------------+ -| oneadmin | linux | Service user | Used to run all OpenNebula services. | -+----------+---------------------+-------------------------+----------------------------------------------------------------------------------+ -| oneadmin | OpenNebula Sunstone | Cloud administrator | Cloud administrator. Run any task in OpenNebula, including creating other users. | -+----------+---------------------+-------------------------+----------------------------------------------------------------------------------+ +.. image:: /images/6.10-vOneCloud-download-deploy-001.png + :align: center + :scale: 70% -.. _download_and_deploy: +| -Download and Deploy -================================================================================ +In the **Deploy OVF Template** dialog box, select **Local file**, then click **Browse**. Search for and select the vOneCloud appliance OVA that you downloaded. -vOneCloud can be downloaded by completing the form `here `__. +Click **Next**. In the next few screens, follow the vCenter wizard to deploy vOneCloud as you would any other OVA. You will need to select the compute resource to deploy on, the datastore where the OVA will be copied, and the network that the virtual appliance will use. -The OVA file can be imported into an existing vCenter infrastructure. It is based on `AlmaLinux 8 `__ with VMware tools enabled. +.. note:: -Follow the next steps to deploy a fully functional OpenNebula cloud. + The datastore used for the vOneCloud appliance needs to have at least 100 GB of available space. + +The final screen displays a summary of deployment information. Click **Finish**. -Step 1. Deploying the OVA --------------------------------------------------------------------------------- +Wait for the deployment to complete. This should not take more than a few moments. -Log in to your vCenter installation and select the appropriate datacenter and cluster where you want to deploy the appliance. Select ``Deploy OVF Template``. +After the VM has finished booting, the Web Console should display the OpenNebula Control Console: -.. image:: /images/vOneCloud-download-deploy-001.png +.. image:: /images/control-console.png :align: center + :scale: 60% -Browse to the download path of the OVA that can be downloaded from the link above. +| -Select the name, folder, and a compute resource where you want vOneCloud to be deployed. Also, you'll need to select the datastore in which to copy the OVA. +At this point, the vOneCloud virtual appliance is up and running. -Select the network. You will need to choose a network that has access to the ESX hosts. +.. note:: -Review the settings selection and click finish. Wait for the Virtual Machine Template to appear in the cluster. + If instead of the Control Console you see a normal Linux tty login screen: + + .. image:: /images/control-console-wrong.png + :align: center + :scale: 60% + + then the virtual appliance is displaying the wrong tty terminal. The vOneCloud Control Console is on tty1. To access tty1, press ``Ctrl+Alt+F1``. + +In the next steps we’ll configure the vOneCloud appliance. -.. image:: /images/vOneCloud-download-deploy-007.png - :align: center +Step 4. Configure vOneCloud +=========================== -After importing the vOneCloud OVA it needs to be cloned into a Virtual Machine. Before powering it on, the vOneCloud Virtual Machine can be edited to, for instance, add a new network interface, increase the amount of RAM, the available CPUs for performance, etc. Now you can power on the Virtual Machine. +We’ll configure the following: -.. _download_and_deploy_control_console: + * Network connection for the vOneCloud appliance + * OpenNebula user ``oneadmin`` password + * Linux ``root`` password + * IP address or FQDN for the public endpoint of FireEdge -Step 2. vOneCloud Control Console - Initial Configuration --------------------------------------------------------------------------------- +Step 4.1. Configure the Network +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -When the VM boots up you will see in the VM console in vCenter the :ref:`vOneCloud Control Console `, showing this wizard: +The vOneCloud appliance is configured to connect automatically via DHCP. If you are using DHCP, you can skip to the :ref:`next step `. If using a manual network configuration, read on. -.. image:: /images/control-console.png - :align: center +To configure the network, in the Control Console press ``1``. Then, follow these steps: -If you are presented instead with the following: + #. Select **Edit a connection**. + #. Select **System eth0**. + #. Select **IPv4 Configuration**, then **Show**. + #. Change the configuration from ``Automatic`` to ``Manual``. + #. Fill in the required information for manual configuration: + - **Addresses**: IPv4 address in /24 notation, e.g. ``10.0.1.249/24``. To add more addresses, use the **Add** item under the **Addresses** field. + - **Gateway**: IP address of the Gateway for the appliance. + - **DNS servers**: IP address(es) of one or more DNS servers. + - **Search domain** (optional): Search domains for DNS. -.. image:: /images/control-console-wrong.png +Below is an example of a static network configuration on the available network interface, ``eth0``. The interface is set on the 10.0.1.x Class C network, the gateway is at 10.0.1.1 and the DNS server at 8.8.8.8. + +.. image:: /images/network-conf-example.png :align: center + :scale: 60% + +| -You are being presented with the wrong tty. You will need to press Ctrl+Alt+F1 to access the Control Console. +After filling in the information, select **OK** to exit the dialog. -In this wizard you first need to **configure the network**. If you are using DHCP you can simply skip to the next item. +In the next screen, select **Activate a connection** and ensure that **System eth0** is activated. Then, select **Set system hostname** and type a hostname. -If you are using a static network configuration, answer yes and you will need to use a ncurses interface to: -- "Edit a connection" -- Select "System eth0" -- Change IPv4 CONFIGURATION from to and select "Show" -- Input the desired IP address/24 in Addresses -- Input Gateway and DNS Servers -- Select OK and then quit the dialog +.. _Step 4.2: -Here's an example of static network configuration on the available network interface on the 10.0.1.x class C network, with a gateway in 10.0.1.1 and using 8.8.8.8 as the DNS server: +Step 4.2. Configure the OpenNebula User Password +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. image:: /images/network-conf-example.png - :align: center +In the Control Console, press ``2`` to configure the password for the OpenNebula user, ``oneadmin``. -The second action needed is to set the **oneadmin account password**. You will need this to log in to OpenNebula. Check the :ref:`Accounts section ` to learn more about vOneCloud roles and users. +Enter the desired password. You will use this password to log into the FireEdge GUI in the last step of this tutorial. -.. image:: /images/set_oneadmin_password.png - :align: center +.. important:: -.. _advanced_login: + This password is for the OpenNebula system user account, not to be confused with the Linux user ``oneadmin``. + +.. _Step 4.3: + +Step 4.3. Configure the Linux ``root`` User Password +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +In the Control Console, press ``3`` to set the password for the Linux OS ``root`` user. This is your master password for the virtual appliance. + +.. warning:: + + This password is not often used, so it’s easy to forget. As in all Unix-like systems, there is no way to recover a lost ``root`` password, so ensure it is stored in a safe place. + +.. _Step 4.4: + +Step 4.4. Configure a Public IP for vOneCloud +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -In the third step, you need to define a **root password.** You won't be using this very often, so write it down somewhere safe. It's your master password to the appliance. +In the Control Console, press ``4`` to select the FQDN or public IP address that will serve as the endpoint for accessing the FireEdge GUI. -This password can be used to access the OpenNebula command line interface; for that, you need to SSH to vOneCloud using the `root` account and password. In OS X and Linux environments, simply use `ssh` to log in to the root account of vOneCloud's IP. For Windows environments you can use software like `PuTTY `__ or even SFTP clients like `WinSCP `__. Alternatively, open the console of the vOneCloud VM in vCenter and change the tty (Ctrl + Alt + F2). +At this point, the vOneCloud appliance is configured and ready to be accessed through the FireEdge GUI. -As the last step, you need to configure a public-facing address that will be used to access your vOneCloud instance by end-users. Enter the fully qualified domain name, hostname valid within your network, or the IP address. +.. important:: -.. image:: /images/control-console-fe-endpoint.png + Bear in mind that in this evaluation version, FireEdge is listening on unencrypted HTTP over a public IP address. + +Step 5. Access the OpenNebula Front-end through the FireEdge GUI +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Open a web browser (Firefox or Chrome) and enter the public IP or FQDN you defined as the FireEdge endpoint in :ref:`Step 4.4 `. For example, ``http://10.0.1.176``. + +You should be greeted by the FireEdge login screen: + +.. image:: /images/6.10-fireedge_login.png :align: center + :scale: 50% -Step 3. Check access to the Sunstone GUI --------------------------------------------------------------------------------- +| -After opening the Sunstone interface (``http://:2616`` with oneadmin credentials), you are now ready to add computing clusters to OpenNebula and start launching your first Virtual Machines! +In the **Username** field, type ``oneadmin``. In the **Password** field, enter the password you defined for the OpenNebula user in :ref:`Step 4.2 `. -.. image:: /images/sunstone-dashboard.png +FireEdge should display the Dashboard: + +.. image:: /images/6.10-sunstone_dashboard.png :align: center + :scale: 50% + +| + +Congratulations — you have deployed and fully configured an OpenNebula Front-end on your VMware infrastructure. At this point, you are ready to add computing clusters to OpenNebula and launch virtual machines. + +.. note:: + + If you get an error message from FireEdge when attempting to log in, it means the public endpoint for FireEdge is not properly configured. + + .. image:: /images/sunstone-fe-error.png + :align: center + :scale: 70% + + Return to the Control Console and configure a public IP or FQDN (see :ref:`Step 4.4 ` above). + +.. _advanced_login: + +Accessing the Linux CLI in the Virtual Appliance +================================================ + +If wish to access the Linux OS running on the virtual appliance, you can do so in one of two ways: + + * Using SSH: + - Connect to vOneCloud’s public IP address or FQDN. For example: ``ssh root@10.0.1.176``. + (If connecting from Windows, you can use a program such as `PuTTY `__ or `WinSCP `__.) + * Using vCenter: + - When connected to the Control Console, change to tty2 by pressing ``Ctrl+Alt+F2``. Then, log in to the system as ``root`` with the password you defined in :ref:`Step 4.3 `. Next Steps ========== -If you want to try out instead OpenNebula public resource infrastructure provisioning, we recommend following the :ref:`Operations Guide ` from Quick Start after finishing this guide to add computing power to your shiny new OpenNebula cloud. +Want to try out automatic resource provisioning on public infrastructure? Follow the :ref:`Operations Guide ` to deploy an Edge Cluster on AWS — in under 10 minutes — and add computing power to your OpenNebula cloud.