Connecting to HPE OneSphere for the first time

Last updated 8 October, 2018

Downloading HPE OneSphere Connect and adding a private cloud zone

Use the following procedure to add a zone in HPE OneSphere to connect to your existing private VMware vSphere or KVM environment. You can then deploy virtual machines from HPE OneSphere to a VMware vCenter cluster or KVM hypervisor(s) in a specified region.

Prerequisites

The administrator configured a VMware vCenter or KVM environment for use with HPE OneSphere.

For detailed configuration and prerequisites information, see Network configuration for HPE OneSphere Connect, Network configuration for KVM servers, and the HPE OneSphere Support Matrix.

Procedure
  1. Launch the HPE OneSphere URL in a supported web browser.

    The HPE OneSphere URL and login information is provided in an email sent by Hewlett Packard Enterprise after your account has been created. If you do not have this information, contact your Hewlett Packard Enterprise representative.

  2. Enter the username provided by Hewlett Packard Enterprise to log in to your HPE OneSphere account. For more information, see Setting up your account and managing users.
  3. From the HPE OneSphere main menu, select Providers.
  4. From the Providers screen, select Private Zones.
  5. From the Private Zones screen, click the green plus icon.
  6. Click the following option on the Create Zone panel.

    Create from existing Virtualized Environment

    Connect existing VMware clusters or KVM servers that are already in use outside of HPE OneSphere.

  7. Click Download Connect for Windows or Download Connect for Mac.
  8. Save the HPE OneSphere Connect file for Windows (HPE-OneSphere-Connect-1.0.0-(x)-win.zip) or Mac OS X (HPE-OneSphere-Connect-1.0.0-(x)-mac.zip). The size of the zip file is approximately 32 MB.
  9. After saving the HPE OneSphere Connect file, you can use it to connect to your VMware vSphere private cloud or connect to your KVM private cloud.

Connecting HPE OneSphere

Connecting to your VMware vSphere or KVM environment allows you to configure the initial connection between HPE OneSphere and your environment. Once the connection has been made, you can deploy virtual machines from HPE OneSphere to a VMware vCenter cluster  or KVM server in a specified region and zone, and for VMware vCenter, collect cost and usage information about your private cloud.

Using HPE OneSphere Connect to connect to your VMware vSphere private cloud

Use the following procedure to connect HPE OneSphere to an existing VMware vSphere cluster.

Prerequisites

The administrator:

  • Downloaded the HPE OneSphere Connect .zip file on the Create Zone screen in the HPE OneSphere web portal, and extracted the .exe or .app file.

  • Ensured that the name of the ESXi datastore does not contain any special characters, for example: (), <>={}(),";&.

  • Deleted any existing VMware private cloud zones that are using Nova networking. Upgrading a VMware zone from Nova networking to Neutron networking is not supported.
Procedure
  1. Launch the HPE OneSphere Connect .exe or .app file.

    HPE OneSphere Connect is downloaded from the HPE OneSphere Create Zone screen.

  2. Click Get Started.
  3. In HPE OneSphere Account, enter the HPE OneSphere portal URL provided by Hewlett Packard Enterprise, then click Continue.

    Example: https://[your-account].hpeonesphere.com

  4. Sign in using the username and password for your HPE OneSphere Account.
  5. On the Infrastructure Location in HPE OneSphere screen:
    1. Click the Region drop-down list and select an existing region.
    2. Click the Type of Zone drop-down list and select the zone type.
    3. Click the Private Zone drop-down list and select the existing zone.

    Or, create a new region by selecting Create New Region, then enter the following details.

    1. Enter a name for the region where your VMware environment is located, for example, US-Denver.

      NOTE:

      The region name cannot contain spaces, and it cannot contain more than 18 characters.

    2. Drag the dot on the map to the approximate location of your private cloud.
    3. Click the Type of Zone drop-down list and select the zone type, such as vCenter.
    4. Enter a name for the name of the zone, for example, ESXi-US-Zone.

      NOTE:

      The zone name cannot contain underscores and spaces, and it cannot contain more than 18 characters.

  6. Click Continue.
  7. On the vCenter Sign-In screen, enter the vCenter hostname or IP address and the vCenter login credentials for the account that manages your VMware ESXi private cloud platform. If you plan to connect multiple datacenters, then specify datacenter Administrator credentials. 

    See Required permissions for VMware vSphere user accounts and ensure that the vCenter administrator or datacenter administrator account is assigned the required permissions.

    NOTE:

    Ensure that the vCenter cluster is created outside of a folder in vSphere. If the cluster is already created inside of a folder, move the cluster outside of the folder before enabling the cluster. (You enable the cluster after connecting it to HPE OneSphere.)

    HPE OneSphere currently supports connecting to a vCenter Server that is configured with port 443 only.

  8. Click Sign In.
  9. On the vCenter VM Location screen, enter a name for the HPE OneSphere Controller virtual machine instance to be deployed, and select the cluster, shared datastore, and network where the virtual machine instance will be deployed.

    Hewlett Packard Enterprise recommends connecting the HPE OneSphere Controller virtual machine to a VMware vSphere Distributed Switch (VDS)-based port group network that has connectivity to the Internet and the vCenter server, and is isolated from the port group network used for deployment of virtual machines. This virtual machine establishes a secure https communication channel between your vCenter private cloud platform and the HPE OneSphere cloud management service.

  10. On the vCenter vSphere Data Network screen, select vSphere Distributed Switch from the drop-down list and select the vSphere Distributed Switch that is connected to all hosts within a vCenter datacenter. The port groups on the selected VDS are imported as networks in HPE OneSphere and will be used for VM deployments. 

    NOTE:

    HPE OneSphere Connect lists all the vSphere Distributed Switches available in the vCenter. Log in to vCenter and note the name of the VDS for the specified datacenter before selecting it on the vCenter VM Location screen.

  11. Click Continue.
  12. On the HPE OneSphere Controller screen, configure the network settings of the virtual machine so that the virtual machine in the vCenter can communicate with HPE OneSphere.
    1. Click the IP address assignment drop-down list and select the IP address assignment type (DHCP or Static) depending on your requirements. If you select Static, enter the network details including IP address, Subnet mask, Gateway, and DNS server.
    2. Enter a proxy to establish a connection between the vCenter and HPE OneSphere. (Do not enter the system proxy, which is configured from your local Windows client PC to other networks.)
  13. Click Continue.
  14. On the HPE Private Cloud Infrastructure Connection Summary screen, review the connection details.
    1. To change any information, click Back (green return icon at the top left corner) of the Summary screen and edit the information before connecting.
    2. If the displayed information on the Summary screen is correct, click Connect.

      NOTE:

      Do not close the Connect screen during this operation.

The page navigates to Connecting all the bits for your HPE Private Cloud. The progress bar provides the percentage of time taken to establish a connection between vCenter and HPE OneSphere.

If any errors occur during this onboarding process, see the log file for more information.  In Windows, the HPE OneSphere Connect log file is located in C:\Users\<windowsLoginusername>\hpeConnect. In macOS, the log file is located in %userprofile%\HPEconnect\HPEconnect.log.

After a successful connection, You're all set! screen appears. Click Take me there to proceed to the HPE OneSphere application log in screen; otherwise, click Connect another environment to establish a new connection.

Using HPE OneSphere Connect to connect to your KVM private cloud 

Use the following procedure to connect to an existing KVM environment.

Prerequisites

The administrator:

Procedure
  1. Launch the HPE OneSphere Connect .exe or .app file.

    HPE OneSphere Connect is downloaded from the HPE OneSphere Create Zone screen.

  2. Click Get Started.
  3. In HPE OneSphere Account, enter the HPE OneSphere web portal URL provided by Hewlett Packard Enterprise, then click Continue.

    Example: your-account.hpeonesphere.com

  4. Sign in using the administrator username and password for your HPE OneSphere Account.
  5. On the Infrastructure Location in HPE OneSphere screen, click the Region drop-down list and create a new region by selecting Create New Region, then enter the following details.
    1. Enter a name for the region where your KVM hypervisor is located, or use an existing region. For example: US-Denver.

      NOTE:

      Region name cannot contain spaces. It cannot be more than 18 characters.

    2. Drag the dot on the map to the approximate location of your private cloud region.
    3. Click the Type of Zone drop-down list and select the zone type, such as KVM.
    4. Enter a name for the name of the zone, for example, KVM-US-Zone.

      NOTE:

      Zone name cannot contain underscore and spaces. It cannot be more than 18 characters.

    5. Click Continue.
  6. On the KVM Sign-In screen, enter the following details.
    1. Enter the KVM hostname or IP address and the KVM login credentials for the account that manages your KVM private cloud platform.
    2. Enter the proxy details to establish a connection between the KVM hypervisor and HPE OneSphere.

      NOTE:

      Do not enter the system proxy, which is configured from your local Windows client PC to other networks.

  7. Click Sign In.
  8. On the HPE Private Cloud Infrastructure Connection Summary screen, review the connection details.
    1. To change any information, click Back (green return icon at the top left corner) of the Summary screen and edit the information before connecting.
    2. If the displayed information on the Summary screen is correct, click Connect.

      NOTE:

      Do not close the Connect screen during this operation.

The page navigates to Connecting all the bits for your HPE Private Cloud. The progress bar provides the percentage of time taken to establish a connection between KVM hypervisor and HPE OneSphere.

If any errors occur during this onboarding process, see the log file for more information.  In Windows, the HPE OneSphere Connect log file is located in C:\Users\<windowsLoginusername>\hpeConnect. In macOS, the log file is located in %userprofile%\HPEconnect\HPEconnect.log.

After a successful connection, You're all set! screen appears. Click Take me there to proceed to the HPE OneSphere application log in screen; otherwise, click Connect another environment to establish a new connection.

Results of running HPE OneSphere Connect

When you finish entering information about your on-premises environment in the HPE OneSphere Connect application and you click Connect, the application:

  • Connects the machine on which HPE OneSphere Connect is running (the jump server) to the HPE OneSphere management service.

  • For VMware vCenter environments:

    • Downloads the HPE OneSphere Controller image to the jump server. This image is a Linux virtual machine appliance OVA file with default credentials. 

      IMPORTANT:

      HPE strongly recommends that you change the default credentials. See Managing the HPE OneSphere Controller.

    • Deploys the HPE OneSphere Controller OVA file to the newly created zone in the vCenter cluster.

    • Boots the HPE OneSphere Controller and pairs it with the HPE OneSphere management service.

    • Enables the target VMware ESXi cluster.

    • Discovers vSphere VM templates on the shared datastore (if they exist) and imports metadata into the HPE OneSphere Catalog.

  • For KVM environments:

    • Downloads a script to configure KVM nodes as KVM compute nodes.

    • Connects to each server and executes the script that downloads an RPM/deb for installing agents.

When the cluster or server is connected and enabled, any existing virtual machines running on the cluster, as well as existing vSphere Distributed Switch (VDS)-based networks and datastores (for ESXi) associated with the cluster or server are discovered automatically and become part of your HPE OneSphere environment. 

NOTE:

You enable the cluster after connecting it to HPE OneSphere. See "Updating a zone" in Managing private cloud providers.

The administrator can now configure VM network IP address management (DHCP or HPE OneSphere static range of IP addresses).

Managing the HPE OneSphere Controller

Connecting HPE OneSphere to a vCenter Server using HPE OneSphere Connect deploys a new Linux virtual machine as an Open Virtual Appliance (OVA) in the vCenter Server. This appliance is called the HPE OneSphere Controller (sometimes called the HPE VMware Gateway Appliance). The HPE OneSphere Controller is configured to connect your vSphere infrastructure and the HPE OneSphere management service.

The management services running in the HPE OneSphere Controller are fully monitored and managed by HPE OneSphere using a secure https channel communication agent that is included with the OVA. The HPE OneSphere Controller is completely stateless and allows HPE OneSphere to restart it if required. A stateless appliance means:

  • If the HPE OneSphere Controller is unavailable, the vSphere cluster continues running under the management of the vCenter servers. End users cannot deploy new resources through HPE OneSphere, because HPE OneSphere is no longer able to communicate with the on-premises vSphere infrastructure. However, new VMs can still be deployed and made available using vCenter/vSphere, and they will later be discovered by HPE OneSphere.
  • If the HPE OneSphere Controller needs to be restarted or even redeployed, no metadata will be lost because they do not persist in the HPE OneSphere Controller. The restarted or redeployed appliance will rediscover the current infrastructure and run normally.

High availability of the HPE OneSphere Controller is provided using the vSphere HA feature, because the appliance is deployed as an OVA in a vSphere cluster. This means that if the ESXi host on which the HPE OneSphere Controller is running goes down, the HPE OneSphere Controller will automatically be restarted on another ESXi host (if the HPE OneSphere Controller is deployed on a shared datastore).

Status updates from the virtual machines will not be visible on the HPE OneSphere portal if the HPE OneSphere Controller is down. However, HPE monitors the status of the appliance and will inform customers if connectivity is lost for several hours.

NOTE:

The customer is responsible for documented manual configuration changes, including changing the HPE OneSphere Controller default password. Updating and patching the operating system on the HPE OneSphere Controller is performed by HPE Support.

Do not install additional software in the HPE OneSphere Controller unless it is documented by HPE.

IMPORTANT:

HPE recommends that you change the HPE OneSphere Controller default password before performing any configuration on the appliance.

Changing the HPE OneSphere Controller password

Before performing any configuration changes on the HPE OneSphere Controller, HPE recommends that you contact HPE Support to change the default password, depending on your organization's security policies.

Procedure
  1. Contact HPE support to establish a remote or local session with your environment.

    HPE support will log in to the HPE OneSphere Controller in your environment using the default password, and will enter the change password command.

  2. Change the password to a new value.

    IMPORTANT:

    Be sure to securely retain the new password. If the password is lost, it cannot be reset. The HPE OneSphere Controller will need to be removed from your environment and redeployed.

See also "Validating and updating VMware vCenter credentials stored in the HPE OneSphere Controller" in Managing private cloud providers.

Validating the connection

After connecting HPE OneSphere to your private cloud, validate that the connection was successful.

Procedure
  1. Monitor the progress of the OVA file download or KVM script in the HPE OneSphere Connect application or by viewing the log file.

    In Windows, the HPE OneSphere Connect log file is located in C:\Users\<windowsLoginusername>\hpeConnect. In macOS, the log file is located in %userprofile%\HPEconnect\HPEconnect.log.

  2. (VMware vCenter only) As the file downloads, log in to vCenter and monitor the creation of the instance in the Datastore specified when you connected HPE OneSphere to your vCenter environment.
  3. Click Take me there from the HPE OneSphere Connect application or use a supported browser to access HPE OneSphere.
  4. Log in using the credentials provided by Hewlett Packard Enterprise.
  5. From the HPE OneSphere main menu, select Providers.
  6. Click Private Zones.
  7. Select the newly created zone, then click Update Zone.
  8. Verify that Connect All Available Clusters is enabled.