diff --git a/source/images/aws_cluster_images_datastore.png b/source/images/aws_cluster_images_datastore.png index f5d8b6ecc1..0ce41a816a 100644 Binary files a/source/images/aws_cluster_images_datastore.png and b/source/images/aws_cluster_images_datastore.png differ diff --git a/source/images/edge_cluster.png b/source/images/edge_cluster.png index 23e3c0f880..1888aaaa51 100644 Binary files a/source/images/edge_cluster.png and b/source/images/edge_cluster.png differ diff --git a/source/images/edge_datastore.png b/source/images/edge_datastore.png index c478f31137..39a9c4358b 100644 Binary files a/source/images/edge_datastore.png and b/source/images/edge_datastore.png differ diff --git a/source/images/edge_host.png b/source/images/edge_host.png index b95939d477..316b2731dd 100644 Binary files a/source/images/edge_host.png and b/source/images/edge_host.png differ diff --git a/source/images/edge_private_net.png b/source/images/edge_private_net.png index b03b9bfc93..f0f3117c9b 100644 Binary files a/source/images/edge_private_net.png and b/source/images/edge_private_net.png differ diff --git a/source/images/edge_public_net.png b/source/images/edge_public_net.png index 8c23c637cc..961cd5ae7c 100644 Binary files a/source/images/edge_public_net.png and b/source/images/edge_public_net.png differ diff --git a/source/images/hosted_nodes.png b/source/images/hosted_nodes.png index d2db4d99fc..0bb528db48 100644 Binary files a/source/images/hosted_nodes.png and b/source/images/hosted_nodes.png differ diff --git a/source/images/kubernetes-qs-add-sans.png b/source/images/kubernetes-qs-add-sans.png index e9c457d7d4..b8dca9a781 100644 Binary files a/source/images/kubernetes-qs-add-sans.png and b/source/images/kubernetes-qs-add-sans.png differ diff --git a/source/images/kubernetes-qs-enable-ingress.png b/source/images/kubernetes-qs-enable-ingress.png index 846dfef21a..995ef329b7 100644 Binary files a/source/images/kubernetes-qs-enable-ingress.png and b/source/images/kubernetes-qs-enable-ingress.png differ diff --git a/source/images/kubernetes-qs-marketplace.png b/source/images/kubernetes-qs-marketplace.png index 14f375735a..eec23ca633 100644 Binary files a/source/images/kubernetes-qs-marketplace.png and b/source/images/kubernetes-qs-marketplace.png differ diff --git a/source/images/kubernetes-qs-pick-networks-private.png b/source/images/kubernetes-qs-pick-networks-private.png new file mode 100644 index 0000000000..9e16cd29e8 Binary files /dev/null and b/source/images/kubernetes-qs-pick-networks-private.png differ diff --git a/source/images/kubernetes-qs-pick-networks-public.png b/source/images/kubernetes-qs-pick-networks-public.png new file mode 100644 index 0000000000..4127962e24 Binary files /dev/null and b/source/images/kubernetes-qs-pick-networks-public.png differ diff --git a/source/images/kubernetes-qs-pick-networks.png b/source/images/kubernetes-qs-pick-networks.png deleted file mode 100644 index 0898bf5763..0000000000 Binary files a/source/images/kubernetes-qs-pick-networks.png and /dev/null differ diff --git a/source/images/kubernetes_aws_dns.png b/source/images/kubernetes_aws_dns.png new file mode 100644 index 0000000000..f1ae7eeed1 Binary files /dev/null and b/source/images/kubernetes_aws_dns.png differ diff --git a/source/images/kubernetes_aws_private_network.png b/source/images/kubernetes_aws_private_network.png new file mode 100644 index 0000000000..4a1bb47a0a Binary files /dev/null and b/source/images/kubernetes_aws_private_network.png differ diff --git a/source/images/kubernetes_aws_private_network_address_range.png b/source/images/kubernetes_aws_private_network_address_range.png new file mode 100644 index 0000000000..e625b29dc7 Binary files /dev/null and b/source/images/kubernetes_aws_private_network_address_range.png differ diff --git a/source/images/kubernetes_service_start.png b/source/images/kubernetes_service_start.png new file mode 100644 index 0000000000..42e9541a07 Binary files /dev/null and b/source/images/kubernetes_service_start.png differ diff --git a/source/images/select_aws_cluster_public_network.png b/source/images/select_aws_cluster_public_network.png index 7598c0b595..d605d78f23 100644 Binary files a/source/images/select_aws_cluster_public_network.png and b/source/images/select_aws_cluster_public_network.png differ diff --git a/source/images/sunstone-change-view.png b/source/images/sunstone-change-view.png new file mode 100644 index 0000000000..089548bb54 Binary files /dev/null and b/source/images/sunstone-change-view.png differ diff --git a/source/images/sunstone-dashboard.png b/source/images/sunstone-dashboard.png index 7b5140a3b8..6a603b698e 100644 Binary files a/source/images/sunstone-dashboard.png and b/source/images/sunstone-dashboard.png differ diff --git a/source/images/sunstone_change_password.png b/source/images/sunstone_change_password.png new file mode 100644 index 0000000000..65c438461d Binary files /dev/null and b/source/images/sunstone_change_password.png differ diff --git a/source/images/wordpress_marketplace.png b/source/images/wordpress_marketplace.png index 7f9e02ea5e..e8e0c7f4e1 100644 Binary files a/source/images/wordpress_marketplace.png and b/source/images/wordpress_marketplace.png differ diff --git a/source/quick_start/deployment_basics/try_opennebula_hosted.rst b/source/quick_start/deployment_basics/try_opennebula_hosted.rst index db418dab5d..2c2134564c 100644 --- a/source/quick_start/deployment_basics/try_opennebula_hosted.rst +++ b/source/quick_start/deployment_basics/try_opennebula_hosted.rst @@ -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:: @@ -26,7 +25,7 @@ Request a PoC In order to request a PoC, you have to fill the following `form `_. -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:: @@ -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| @@ -100,13 +99,13 @@ You can provision KVM clusters on different public cloud providers (AWS and Equi You can follow this :ref:`guide ` 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 ` 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 ` 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 ` 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 diff --git a/source/quick_start/deployment_basics/try_opennebula_on_kvm.rst b/source/quick_start/deployment_basics/try_opennebula_on_kvm.rst index b163f9e65d..e5a5ec4dea 100644 --- a/source/quick_start/deployment_basics/try_opennebula_on_kvm.rst +++ b/source/quick_start/deployment_basics/try_opennebula_on_kvm.rst @@ -21,7 +21,7 @@ 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): @@ -29,7 +29,7 @@ If you don't have a server available with the above characteristics, we recommen - 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 `__. +- 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 `__. |aws_security_groups| @@ -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. @@ -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 ` 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. @@ -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 ` 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 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 8c4dee58bd..4593b5a8df 100644 --- a/source/quick_start/deployment_basics/try_opennebula_on_vmware.rst +++ b/source/quick_start/deployment_basics/try_opennebula_on_vmware.rst @@ -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://`` 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://: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 diff --git a/source/quick_start/operation_basics/operating_edge_cluster.rst b/source/quick_start/operation_basics/operating_edge_cluster.rst index 66f599c83d..008d29a009 100644 --- a/source/quick_start/operation_basics/operating_edge_cluster.rst +++ b/source/quick_start/operation_basics/operating_edge_cluster.rst @@ -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 ================================================================================ @@ -58,7 +58,7 @@ Check :ref:`this link ` 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| diff --git a/source/quick_start/operation_basics/provisioning_edge_cluster.rst b/source/quick_start/operation_basics/provisioning_edge_cluster.rst index e3703baf08..3fe64a1843 100644 --- a/source/quick_start/operation_basics/provisioning_edge_cluster.rst +++ b/source/quick_start/operation_basics/provisioning_edge_cluster.rst @@ -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 `. 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 `. @@ -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 `__ 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 `__ 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 diff --git a/source/quick_start/usage_basics/running_kubernetes_clusters.rst b/source/quick_start/usage_basics/running_kubernetes_clusters.rst index 315aece09e..93aa7b4ec1 100644 --- a/source/quick_start/usage_basics/running_kubernetes_clusters.rst +++ b/source/quick_start/usage_basics/running_kubernetes_clusters.rst @@ -13,7 +13,7 @@ This guide assumes that you have deployed the OpenNebula front-end following the Step 1. Download the OneFlow Service from the Marketplace ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Log in to Sunstone as oneadmin. Go to the ``Storage --> Apps`` tab and search for ``OneKE``. Select the ``Service OneKE 1.27`` and click on the icon with the cloud and the down arrow inside (two positions to the right from the green ``+``). +Log in to Sunstone as oneadmin. Go to the ``Storage --> Apps`` tab and search for ``OneKe 1.27``. Select the ``Service OneKE 1.27`` and click on the icon with the cloud and the down arrow inside. |kubernetes-qs-marketplace| @@ -24,21 +24,29 @@ Now you need to select a datastore. Select the ``aws-edge-cluster-image`` Datast The Appliance will be ready when the image in ``Storage --> Images`` switches to ``READY`` from its ``LOCKED`` state. This process may take significant amount of time based on the networking resources available in your infrastructure (Kubernetes 1.27 amounts to a total of 52GB). .. |kubernetes-qs-marketplace| image:: /images/kubernetes-qs-marketplace.png -.. |kubernetes-qs-marketplace-datastore| image:: /images/kubernetes-qs-marketplace-datastore.png +.. |kubernetes-qs-marketplace-datastore| image:: /images/aws_cluster_images_datastore.png Step 2. Instantiate private network ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ During the AWS Edge Cluster provisioning a private network template was created, we need to instantiate it first and assign a range to it. To do so, go to the ``Network --> Network Templates``, open the ``aws-edge-cluster-private`` Virtual Network Template and click on the instantiate button. -We need to first put the name, e.g. ``aws-private`` and then add an address range, click ``+ Address Range`` and put a private IPv4 range, e.g. ``172.20.0.1``, for size we can put ``100``. +First we need to give the network a name, e.g. ``aws-private`` -Last thing you need to add to the network is a DNS server, click the ``Context`` tab under Network configuration and put a DNS server, e.g. ``8.8.8.8`` or ``1.1.1.1``. +|kubernetes-aws-private-network| -|kubernetes-qs-create-ar| +Then hit ``Next`` & click ``+ Address Range`` and select a private IPv4 range, e.g. ``172.20.0.1``, for size we can use ``100``. + +|kubernetes-aws-private-network-range| + +Last thing you need to add to the network is a DNS server, click the ``Context`` tab and add a DNS server, e.g. ``8.8.8.8`` or ``1.1.1.1``. + +|kubernetes-aws-dns| Now you are ready to start the Kubernetes Service. -.. |kubernetes-qs-create-ar| image:: /images/kubernetes-qs-create-ar.png +.. |kubernetes-aws-private-network| image:: /images/kubernetes_aws_private_network.png +.. |kubernetes-aws-private-network-range| image:: /images/kubernetes_aws_private_network_address_range.png +.. |kubernetes-aws-dns| image:: /images/kubernetes_aws_dns.png Step 3. Instantiate the Kubernetes Service ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -47,60 +55,69 @@ Step 3. Instantiate the Kubernetes Service You may want to adjust the VM templates before you progress further - go to ``Templates --> VMs``, click on the ``Service OneKE 1.27`` and blue button ``Update`` at the top. -Proceed to the ``Templates --> Services`` tab and select the ``Service OneKE 1.27`` Service Template. Click on ``+`` and then ``Instantiate``. +Proceed to the ``Templates --> Service Templates`` tab and select the ``Service OneKE 1.27`` Service Template. Click on the ``Instantiate`` button (next to Update). + +Then we can give our service a name and the number of instances to instantiate, for this example we will use ``OneKE 1.27`` and start ``1`` instance of it. -A required step is clicking on ``Network`` and selecting the ``aws-edge-cluster-public`` network for public network. +|kubernetes-qs-service-start| -And for private network we will use the ``aws-private`` we instantiated before. +Then we hit ``Next`` until we reach the ``Network`` step. Under which we select the ``aws-edge-cluster-public`` network, for the public network ID -|kubernetes-qs-pick-networks| +|kubernetes-qs-pick-networks-public| + +and ``aws-private`` for the private network ID. + +|kubernetes-qs-pick-networks-private| You will most likely want to add a custom domain to Kubernetes SANs, so the ``kubectl`` command could be used from "outside" of the cluster. |kubernetes-qs-add-sans| -You can either use a public DNS server or local ``/etc/hosts`` file, for example: +You can either use a public DNS server or your local ``/etc/hosts`` file, for example: .. prompt:: text $ auto 127.0.0.1 localhost 1.2.3.4 k8s.yourdomain.it -.. important:: To make the kubeconfig file work with custom SANs you will need to modify the ``clusters[0].cluster.server`` variable inside the YAML payload (for example: ``server: https://k8s.yourdomain.it:6443``) which can be find in the file a path to which is a value of the $KUBECONFIG variable on the k8s master node (the details on how to log in to that node are given below in :ref:`Step 4. Provisining an Edge Cluster `). +.. important:: To make the kubeconfig file work with custom SANs you will need to modify the ``clusters[0].cluster.server`` variable inside the YAML payload (for example: ``server: https://k8s.yourdomain.it:6443``) which can be found in the file whose path is a value of the $KUBECONFIG variable on the k8s master node (the details on how to log in to that node are given below in :ref:`Step 4. Provisining an Edge Cluster `). To be able to expose an example application you should enable OneKE's Traefik / HAProxy solution for ingress traffic: |kubernetes-qs-enable-ingress| -Now click on the instantiate button in Sunstone web-GUI, go to ``Instances --> Services`` or via command line interface (CLI) +Now click on the instantiate button in the Sunstone web-GUI, go to ``Instances --> Services`` or via command line interface (CLI) .. prompt:: bash $ auto [oneadmin@FN]$ oneflow list -and wait for the new Service to get into ``RUNNING`` state. You can also check in the Sunstone the VMs being deployed in ``Instances --> VMs`` or via CLI: +and wait for the new Service to get into ``RUNNING`` state. You can also check the VMs being deployed in Sunstone under the ``Instances --> VMs`` tab or via the CLI: .. prompt:: bash $ auto [oneadmin@FN]$ onevm list -.. note:: The **public** IP address (AWS elastic IP) should be consulted in OpenNebula after the VNF instance is successfully provisioned. Go to ``Instances --> VMs`` and check the IP column to see what IP has OpenNebula assigned the VNF instance or via CLI: +.. note:: The **public** IP address (AWS elastic IP) should be consulted in OpenNebula after the VNF instance is successfully provisioned. Go to ``Instances --> VMs`` and check the IP column to see what IP OpenNebula has assigned the VNF instance, or via the CLI: .. prompt:: bash $ auto [oneadmin@FN]$ onevm show -j |jq -r .VM.TEMPLATE.NIC[0].EXTERNAL_IP -.. important:: This is specific to AWS deployments. One needs to add a corresponding inboud rule into AWS security group (SG) with AWS elastic IP of VNF node for 5030 port and apply updated SG against AWS FN node. +.. important:: This is specific to AWS deployments. One needs to add a corresponding inboud rule into AWS security group (SG) with AWS elastic IP of VNF node for 5030 port and apply the updated SG against the AWS FN node. -If OneFlow service stuck in DEPLOYING state, please, check :ref:`OneFlow service is stuck in DEPLOYING ` +If the OneFlow service is stuck in DEPLOYING state, please, check :ref:`OneFlow service is stuck in DEPLOYING ` -After the OneFlow service is deployed you can also **scale up** the worker nodes - the template will start only one - to add more follow onto the tab ``Roles``, click on ``worker`` and green button ``Scale``. +After the OneFlow service is deployed you can also **scale up** the worker nodes - the template will start only one - to add more follow onto the tab ``Roles``, click on ``worker`` and then the green button ``Scale``. .. note:: Even though Sunstone shows the VNC console button, VNC access to VMs running in Edge Clusters has been deemed insecure and as such OpenNebula filters this traffic. This means that the VNC access won't work for VMs running in Edge Clusters. -.. |kubernetes-qs-pick-networks| image:: /images/kubernetes-qs-pick-networks.png + +.. |kubernetes-qs-service-start| image:: /images/kubernetes_service_start.png +.. |kubernetes-qs-pick-networks-public| image:: /images/kubernetes-qs-pick-networks-public.png +.. |kubernetes-qs-pick-networks-private| image:: /images/kubernetes-qs-pick-networks-private.png .. |kubernetes-qs-add-sans| image:: /images/kubernetes-qs-add-sans.png .. |kubernetes-qs-enable-ingress| image:: /images/kubernetes-qs-enable-ingress.png @@ -235,28 +252,28 @@ recover such a broken instance, it must be recreated. .. important:: But before you recreate it, please make sure your environment - has good connection to the public Internet and in general its performance is not impaired.' + has good connection to the public Internet and in general its performance is not impaired. -The stuck in DEPLOYING state OneFlow service can not be terminated via 'delete' operation. In order to do so one needs to use the following command: +The stuck in DEPLOYING state for a OneFlow service can not be terminated via the 'delete' operation. In order to do so, one needs to use the following command: .. prompt:: bash $ auto [oneadmin@FN]$ oneflow recover --delete -Another issue you might face with is VNF node can't contact OneGate server on FN. In that case there are messages in the ``/var/log/one/oneflow.log`` file as below: +Another issue you might face is the VNF node can't contact the OneGate server on FN. In that case there are messages in the ``/var/log/one/oneflow.log`` file like this: .. code-block:: text [EM] Timeout reached for VM [0] to report -In such case there is only VNF node is deployed and running but no k8s ones. It is needed to ssh to the VNF node and run as root +In such a case, only the VNF node will be deployed and no k8s ones. Thus you must SSH into the VNF node and run as root: .. prompt:: bash $ auto [root@VNF]$ onegate vm show -to check if VNF is able to contact OneGate server on FN. In case of success the response should look like below: +to check if the VNF is able to contact the OneGate server on FN. A successful response should look like the one below: .. code-block:: text @@ -273,10 +290,10 @@ and in case of failure: Timeout while connected to server (Failed to open TCP connection to :5030 (execution expired)). Server: :5030 -Check on the VNF node if ONEGATE_ENDPOINT is set to AWS elastic IP address of FN: +Check on the VNF node if ONEGATE_ENDPOINT is set to the AWS elastic IP address of FN: .. code-block:: text [root@VNF]$ grep ONEGATE -r /run/one-context* -Make sure a corresponding inboud rule in AWS security group (SG) with AWS elastic IP for 5030 port is present and modifications were applied to AWS FN node. +Make sure a corresponding inboud rule exists in the AWS security group (SG) with AWS elastic IP on port 5030 and modifications have been applied to AWS FN node. diff --git a/source/quick_start/usage_basics/running_virtual_machines.rst b/source/quick_start/usage_basics/running_virtual_machines.rst index e12498b460..04f514e0be 100644 --- a/source/quick_start/usage_basics/running_virtual_machines.rst +++ b/source/quick_start/usage_basics/running_virtual_machines.rst @@ -13,11 +13,11 @@ We are going to assume the Edge Cluster naming schema "metal-kvm-aws-cluster". Step 1. Download the image from the Marketplace ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Log in to Sunstone as oneadmin. Go to the ``Storage --> Apps`` tab and search for WordPress. Select it and click on the icon with the cloud and the down arrow inside (two positions to the left from the green "+"). +Log in to Sunstone as oneadmin. Go to the ``Storage --> Apps`` tab and search for WordPress. Select it and click on the icon with the cloud and the down arrow inside. |wordpress_marketplace| -Now you need to select a datastore. For efficiency, and taking into account we are only going to run this appliaction in the OpenNebula cluster created in "Operations Basics", select the aws-cluster-Images Datastore. +Click ``Next`` in the first step and then select a datastore. For efficiency sake, and taking into account we are only going to run this appliaction in the OpenNebula cluster created in "Operations Basics", select the aws-cluster-images Datastore. |aws_cluster_images_datastore| @@ -31,7 +31,7 @@ Step 2. Instantiate the VM Proceed to the ``Templates --> VMs`` tab and select the "Service WordPress - KVM" VM Template (that should one of two available, along with the default CentOS 7 pulled from the Marketplace by miniONE). Click on Instantiate. -Feel free to modify the capacity and input data to configure the WordPress service. A required step is clicking on Network and selecting the aws-cluster-public network. +Feel free to modify the capacity and input data to configure the WordPress service. A required step is clicking on the ``Network`` tab and attaching the aws-cluster-public network. |select_aws_cluster_public_network|