Skip to content
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

F OpenNebula/one#6430: Refactor QS guide #2959

Merged
merged 1 commit into from
Jul 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified source/images/aws_cluster_images_datastore.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/edge_cluster.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/edge_datastore.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/edge_host.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/edge_private_net.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/edge_public_net.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/hosted_nodes.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/kubernetes-qs-add-sans.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/kubernetes-qs-enable-ingress.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/kubernetes-qs-marketplace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed source/images/kubernetes-qs-pick-networks.png
Binary file not shown.
Binary file added source/images/kubernetes_aws_dns.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/kubernetes_aws_private_network.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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/kubernetes_service_start.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/select_aws_cluster_public_network.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-change-view.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-dashboard.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_change_password.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/wordpress_marketplace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 6 additions & 7 deletions source/quick_start/deployment_basics/try_opennebula_hosted.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,9 @@ This guide will walk you through the steps to request, setup and manage an OpenN

The OpenNebula Hosted service allows corporate users to try OpenNebula on **KVM** for the execution of virtual machines and Kubernetes clusters.

OpenNebula Hosted service provides two tools to create and manage resources and clusters:
OpenNebula Hosted service provides the following tool to create and manage resources and clusters:

- **Sunstone**, a web-based UI that can be used by both administrators and end users to manage in one central and uniform point all the resources
- **FireEdge**, a web-based UI that is used to provision OpenNebula Clusters on public cloud using different providers (AWS, Equinix) and on-premise resources.
- **Sunstone**, a web-based UI that can be used by both administrators and end users to manage and provision in one central and uniform point all the resources.

.. note::

Expand All @@ -26,7 +25,7 @@ Request a PoC

In order to request a PoC, you have to fill the following `form <https://opennebula.io/request-a-hosted-poc-with-opennebula>`_.

Once you fill the form, you will receive an email containing information on how to connect to **Sunstone** and **FireEdge** to manage your cloud environment and provision resources for running your workloads (Virtual Machines and/or Kubernetes Clusters).
Once you fill the form, you will receive an email containing information on how to connect to **Sunstone** to manage your cloud environment and provision resources for running your workloads (Virtual Machines and/or Kubernetes Clusters).

.. note::

Expand All @@ -41,7 +40,7 @@ First you need to login to Sunstone.

|sunstone_login|

Once you login with the credentials that you have received in your email, for security reasons change your password that you have received by email. To change the password you have to go to ``Settings`` Tab.
Once you login with the credentials that you have received in your email, for security reasons please update that password to something else. To change the password you have to go to the ``System`` tab and then under ``Users`` & select the user you want to update the password for.

|sunstone_change_password|

Expand Down Expand Up @@ -100,13 +99,13 @@ You can provision KVM clusters on different public cloud providers (AWS and Equi

You can follow this :ref:`guide <first_edge_cluster>` to provision your first edge cluster on AWS.

Once you create a cluster, you can manage it using the Sunstone GUI (https://poc.opennebula.cloud). Please follow this :ref:`guide <operating_edge_cluster>` that explains how to operate an Edge Cluster.
Once you create a cluster, you can manage it using the Sunstone GUI (https://poc.opennebula.cloud:2616). Please follow this :ref:`guide <operating_edge_cluster>` that explains how to operate an Edge Cluster.

Running Virtual Machines and Kubernetes Clusters
=================================================
Once you have provisioned resources, you can refer to :ref:`Usage Basics guide <usage_basics>` to run virtual machines and Kubernetes Clusters in your cloud environment.

.. |sunstone_login| image:: /images/sunstone-login.png
.. |sunstone_change_password| image:: /images/sunstone_settings.png
.. |sunstone_change_password| image:: /images/sunstone_change_password.png
.. |fireedge_login| image:: /images/fireedge_for_rns.png
.. |hosted_nodes| image:: /images/hosted_nodes.png
27 changes: 16 additions & 11 deletions source/quick_start/deployment_basics/try_opennebula_on_kvm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ You'll need a server to try out OpenNebula. The provided Host should have a fres
- privileged user access (`root`)
- openssh-server package installed
- operating system: RHEL/AlmaLinux 8 or 9, Debian 10 or 11, Ubuntu 20.04 or 22.0.4
- open ports: 22 (SSH), 80 (Sunstone), 2616 (FireEdge), 5030 (OneGate).
- open ports: 22 (SSH), 80 (Ruby Sunstone), 2616 (FireEdge), 5030 (OneGate).

If you don't have a server available with the above characteristics, we recommend using a the Amazon EC2 service to obtain a VM to act as the OpenNebula Front-end. A tested combination is the following (but is by no means the only one possible):

- Frankfurt region
- Ubuntu Server 20.04 LTS (HVM), SSD Volume Type
- t2.medium
- 80 GB hard disk (you need to edit the Storage tab before launching the instance; by default it comes with just 8GB)
- open ports 22 (SSH), 80 (Sunstone), 2616 (FireEdge), 5030 (OneGate) by editing the Security Groups as per the picture. This can also happen after launching the instance following `this guide <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/authorizing-access-to-an-instance.html>`__.
- open ports 22 (SSH), 80 (Ruby Sunstone), 2616 (FireEdge), 5030 (OneGate) by editing the Security Groups as per the picture. This can also happen after launching the instance following `this guide <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/authorizing-access-to-an-instance.html>`__.

|aws_security_groups|

Expand Down Expand Up @@ -94,7 +94,7 @@ Be patient, it should take only a few minutes to get the Host prepared. The main
user: oneadmin
password: lCmPUb5Gwk

.. note:: When running miniONE within an AWS instance, the reported IP may be a private address that's not reachable over the Internet. Use its public IP address to connect to the FireEdge and Sunstone services.
.. note:: When running miniONE within an AWS instance, the reported IP may be a private address that's not reachable over the Internet. Use its public IP address to connect to the FireEdge and Ruby Sunstone services.

The OpenNebula Front-end and local KVM node are now ready for evaluation.

Expand All @@ -103,23 +103,24 @@ The OpenNebula Front-end and local KVM node are now ready for evaluation.
Validation
==========

Point your browser to the Sunstone web URL provided in the deployment report above and log in as the user **oneadmin** with provided credentials.
Point your browser to the FireEdge web URL provided in the deployment report above and log in as the user **oneadmin** with provided credentials.

|images-sunstone-dashboard|

If the Host configured by **miniONE** is behind the firewall, the (default) Sunstone port 80 has to be enabled for the machine you are connecting from.
If the Host configured by **miniONE** is behind the firewall, the (default) FireEdge port 2616 has to be enabled for the machine you are connecting from.

.. |images-sunstone-dashboard| image:: /images/sunstone-dashboard.png
With the default Admin View you can do anything in OpenNebula. Switch to the Cloud View (top right-->Views-->cloud) to see how a final user will see OpenNebula.

With the default Admin View you can do anything in OpenNebula. Switch to the Cloud View (oneadmin-->Views-->cloud) to see how a final user will see OpenNebula.
|images-sunstone-change-view|

The Cloud View interface is much simpler and targeted at end users.
The :ref:`Cloud View <fireedge_cloud_view>` interface is much simpler and targeted at end users.

If you created a local KVM node with the front-end you can continue the validation with the following steps:

- Create a new Virtual Machine by clicking the ‘+’ button. Select the only available template and click ‘Create’.
- After clicking ‘Create’ you will be taken to the dashboard where you can see your running VMs.
- You can click on your VM and manage it: Save its state, Reboot it, etc:
- Create a new Virtual Machine by clicking ‘VMs’ button. This will take you to the instances/VMs tab.
- Press ‘+’ button and select the only available template. Continue through the instantiation dialog.
- After clicking ‘Finish’ your VM will be instantiated, and you should be able to see your running machine.
- You can click on your VM to manage it: Save it's state, Reboot it, etc:

.. note:: We know, these are very basic steps. If you want to try out real-life virtualization or kubernetes workloads with public IPs please continue to next section.

Expand All @@ -142,3 +143,7 @@ Next Steps
==========

if you want to continue the evaluation with physical resources for VMs and Kubernetes clusters or try out the automatic provisioning features for building multi-provider hybrid clouds, you can follow the :ref:`Operations Guide <operation_basics>` to add a remote Edge Cluster based on KVM using AWS bare-metal instances to your shiny new OpenNebula cloud!


.. |images-sunstone-dashboard| image:: /images/sunstone-dashboard.png
.. |images-sunstone-change-view| image:: /images/sunstone-change-view.png
Original file line number Diff line number Diff line change
Expand Up @@ -157,14 +157,9 @@ As the last step, you need to configure a public-facing address that will be use
Step 3. Check access to the Sunstone GUI
--------------------------------------------------------------------------------

After opening the Sunstone interface (``http://<appliance_ip>`` with oneadmin credentials), you are now ready to add computing clusters to OpenNebula and start launching your first Virtual Machines!
After opening the Sunstone interface (``http://<appliance_ip>:2616`` with oneadmin credentials), you are now ready to add computing clusters to OpenNebula and start launching your first Virtual Machines!

.. image:: /images/sunstone-main.png
:align: center

If Sunstone greets you with an error while connecting to the public FireEdge endpoint, return to Control Center in the previous step and configure a valid endpoint:

.. image:: /images/sunstone-fe-error.png
.. image:: /images/sunstone-dashboard.png
:align: center

Next Steps
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Operating an Edge Cluster
=========================

In this guide you will see all the resources created in OpenNebula as a part of the Edge Cluster. These resources have all been created using FireEdge OneProvision GUI in AWS.
In this guide you will see all the resources created in OpenNebula as a part of the Edge Cluster. These resources have all been created using the OneProvision GUI in AWS.

Cluster
================================================================================
Expand Down Expand Up @@ -58,7 +58,7 @@ Check :ref:`this link <datastores>` to get a sound overview of datastore managem
Virtual Networks: Public
================================================================================

A virtual network in OpenNebula basically resembles the physical network in the datacenter. Virtual Networks allow VMs to have connectivity between them and with the rest of the world. Each Edge Cluster has one public network with the number of the IPs chosen by the user (in FireEdge); this will allow VMs to have public connectivity so the user can connect to them.
A virtual network in OpenNebula basically resembles the physical network in the datacenter. Virtual Networks allow VMs to have connectivity between them and with the rest of the world. Each Edge Cluster has one public network with the number of the IPs chosen by the user (in Sunstone); this will allow VMs to have public connectivity so the user can connect to them.

|image_public_net|

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Provisioning an Edge Cluster
============================

In this section you can check all the steps needed to deploy an **Edge Cluster**. This involves the FireEdge OneProvision GUI and Sunstone to manage the resources created in OpenNebula. Each new provision in the OneProvision GUI creates a new OpenNebula cluster.
In this section you can check all the steps needed to deploy an **Edge Cluster**. This involves the OneProvision GUI and Sunstone to manage the resources created in OpenNebula. Each new provision in the OneProvision GUI creates a new OpenNebula cluster.

.. important:: This guide assumes that you have deployed the OpenNebula front-end following the :ref:`Deployment Basics guide <deployment_basics>`. Here we'll be creating a metal Edge Cluster with KVM hypervisor, suitable for deploying both Virtual Machines and K8s clusters in the following :ref:`Usage Basics section <usage_basics>`.

Expand All @@ -25,9 +25,9 @@ During the provision of the cluster all these resources and their corresponding
* An Internet Gateway to provide Internet access to the Host and VMs.
* A routing table for the previous elements.

.. note:: Take into account that FireEdge will request Elastic IPs for the public IPs you request. If you receive an error message about not being able to request more IPs when creating a provision, please check the `limits of your account <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html>`__ in your zone.
.. note:: Take into account that Sunstone will request Elastic IPs for the public IPs you request. If you receive an error message about not being able to request more IPs when creating a provision, please check the `limits of your account <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html>`__ in your zone.

We'll be using the FireEdge GUI in this guide, so please make sure you can log in to it using your Front-end IP and default port 2616, as well as your oneadmin credentials. If you require to log in as a user other than oneadmin, in order to use the provision interface the user must belong to the oneadmin group, otherwise the providers won't be shown in the wizard.
We'll be using the Sunstone GUI in this guide, so please make sure you can log in to it using your Front-end IP and default port 2616, as well as your oneadmin credentials. If you require to log in as a user other than oneadmin, in order to use the provision interface the user must belong to the oneadmin group, otherwise the providers won't be shown in the wizard.

.. prompt:: bash $ auto

Expand Down
Loading
Loading