Skip to main content
Outside service Partner
Hitachi Vantara Knowledge

Quick start to using the deployment manager

The deployment manager walks you through the steps of preparing a new VMware vCenter environment for installing Hitachi Unified Compute Platform (UCP) Advisor for a UCP hyperconverged appliance.

It automatically discovers all the nodes in your environment, and then filters them to only those available for your hyperconverged appliance. You select which nodes you want to enable, and then supply all the general, network, and system settings required to set up the configuration. Then the configuration is deployed to the environment. When completed, you can install UCP Advisor.

Use this guide to install the deployment manager. This involves preparing a PC or laptop with a Linux VM, installing and configuring a Docker engine and container, and setting up the deployment manager. After completing the setup, you can run the deployment manager from a browser within the VM.

System architecture

Installation workflow

Prerequisites and system requirements

Make sure your system meets all the prerequisites and requirements before you install the deployment manager.

  • Prepare a PC or laptop that meets the following minimum system requirements:
    • 20 GB free disk space
    • 8 GB memory available for sharing
    • Internet connection for downloading files
    • IPv6 protocol support
    • IPv4 address for communicating with the IPv4 address on the ESXi host (kvm0)
    • Connection to the management switch
  • Verify that the IPv6 protocol is enabled on the management switch connected to the BMC port (1 GB) and on the Compute switch ports (10 GB) connected to the UCP HC servers.
  • Collect all the required settings specified in the Deployment Manager Settings Worksheet, which is available here: Settings worksheet for using deployment manager.

Step 1: Prepare a PC or laptop

Prepare your PC or laptop according to the operating system of your machine. For this step the PC or laptop does not need to be connected to the management switch.

For Windows OS

First install and configure an Oracle VM VirtualBox, and then install Ubuntu Server on the virtual box.

Before you begin

Procedure

  1. Download and install Oracle VM VirtualBox from:

    https://www.oracle.com/technetwork/server-storage/virtualbox/downloads/index.html
  2. Create an Ubuntu server VM within the Oracle VM VirtualBox:

    1. Launch the Oracle VM VirtualBox Manager.

    2. Click New.

    3. Enter a name for the new Ubuntu server VM.

    4. Select the following:

      • Type: Linux
      • Version: Ubuntu (64-bit). If this option is not available, enable virtualization support in the BIOS settings.
      • Memory size: 8 GB (8192 MB)
      • Hard disk: Create a virtual hard disk now.
    5. Click Create.

    6. Specify a file location, and then select the following:

      • File size: 40.00 GB
      • Hard disk file type: VDI (VirtualBox Disk Image)
      • Storage on physical hard disk: Dynamically allocated
    7. Click Create.

    8. In the Oracle VM VirtualBox Manager window, select the VM you just created, and then click Settings.

    9. Click Storage > Storage Devices > Controller > <optical drive>.

    10. In the Attributes panel, set the optical drive location to the Ubuntu Server ISO image file you downloaded earlier.

    11. Click Network > Adapter 1, and then select the following for each adapter:

      • Attached to: NAT Adapter
      • Name: Select a name for your network card.
    12. Click OK.

  3. In the Oracle VM VirtualBox Manager window, click Start, and then follow the prompts, accepting all the default values highlighted in green.

  4. When prompted to confirm destructive action (reformat the disk), select Continue, and then create a user profile by entering the following:

    • Your name
    • Your server's name: The name the Ubuntu server VM uses when it communicates with other computers.
    • Pick a username: Enter a user name. Use this user name to log in to the Ubuntu server VM. This user is granted administrator permissions.
    • Choose a password: Enter a password. Use this password to log in to the Ubuntu server VM.
  5. Select Done, and then follow the prompts, accepting all the default values highlighted in green to complete the installation.

  6. Log on to the Ubuntu server VM using the profile username and password you just created.

  7. Verify that the IP address can communicate with the ESXi host (kvm0).

  8. If DHCP is not available, assign the IP address, netmask, and gateway you listed in the Deployment Manager Settings Worksheet.

Linux OS

Procedure

  1. Log on to the PC or laptop as a user with administrator permissions.

  2. If DHCP is not available, assign the IP address, netmask, and gateway you listed in the Deployment Manager Settings Worksheet.

  3. Verify that the IP address can communicate with the ESXi host (kvm0).

Step 2: Install and configure Docker

Prepare the Docker environment on the Ubuntu server for installing the deployment manager. This involves installing a repository and then installing Docker Community Edition (CE).

  1. From the Docker website, the follow procedure, "Install using the repository":

    https://docs.docker.com/install/linux/docker-ce/ubuntu/#install-using-the-repository
  2. From the Docker website, follow the procedure, "Install Docker Compose on Linux systems":

    https://docs.docker.com/compose/install/#install-compose

Step 3: Set up the deployment manager

Set up the deployment manager on the Ubuntu server VM.

Before you begin

  • Download the UCP_Advisor_deployment_manager ISO image from the Hitachi Support Connect portal. A Hitachi login credential is required.
  • Copy theUCP_Advisor_deployment_manager ISO image to the Ubuntu server VM.
  • Note the IP address for the Ubuntu server VM.

Procedure

  1. On the Ubuntu server VM console, create a temporary directory for mounting the UCP_Advisor_deployment_manager ISO image.

     sudo mkdir /mnt/UCPADM_ISO
  2. Mount the UCP_Advisor_deployment_manager ISO image to the temporary directory.

    sudo mount -o loop UCP_Advisor_deployment_manager.iso /mnt/UCPADM_ISO
  3. Copy the ucpadm directory to the home directory on the Ubuntu server VM.

    sudo cp -r /mnt/UCPADM_ISO/ucpadm
  4. Change the directory to ucpadmin, and then set up and start the deployment manager.

    cd ucpadm
    sudo ./setup.sh
    sudo ./start.sh
    sudo docker ps
    NoteDo not run the ./setup command from the /mnt/UCPADM_ISO directory. You must copy the entire ucpadm directory in the ISO image to a writable directory, such as the home directory, to execute setup.sh and start.sh commands.
  5. Verify that there are four containers running:

    • nginx
    • web
    • worker
    • rabbittmq
  6. Stop the deployment manager.

    sudo ./stop.sh
  7. Verify that no containers are still running.

    sudo docker ps

Step 4: Run the deployment manager

Start the deployment manager in the data center environment.

Before you begin

In the data center environment, verify that your PC or laptop is physically connected to the management switch.

Procedure

  1. Reset the Ubuntu server VM network card setting (Windows OS only):

    1. On your PC or laptop, open the Oracle VM VirtualBox Manager.

    2. Select the Ubuntu server VM, and then click Settings.

    3. Click Network > Adapter 1, and then select the following for each adapter:

      • Attached to: Bridged Adapter
    4. Click OK.

  2. Log on to the Ubuntu server VM using the same user name and password you used when setting up the deployment manager.

  3. Enter the following commands:

    cd ucpadmin
    sudo ./start.sh
    sudo docker ps
  4. Verify that there are four containers running:

    • nginx
    • web
    • worker
    • rabbittmq
  5. In the address bar of a browser, enter the IP address for the Ubuntu server VM.

  6. Click Get Started, and then follow the prompts to enter the settings you prepared on the Deployment Manager Settings Worksheet.

Next steps

After setting up your environment with the deployment manager, configure the VLAN IDs on the Compute switch ports connected to the 10-GB interfaces on the UCP HC servers.

Your environment is now ready for installing UCP Advisor.

REST API support

The functionality of the deployment manager is also available using API commands. For details of each command, click the API Documentation link at the bottom of the deployment manager window. When prompted, enter your deployment manager user name and password.

  • auth

    Takes a refresh type JSON web token and returns an access type JSON web token if the refresh token is valid.

  • autodiscover

    Returns a list of all discovered hardware.

  • install

    Starts the installation.

  • log

    Returns logs for the installation or autodiscover task.

  • profile

    Changes the password for the logged in user.

  • workflow

    Returns the requested workflow or a list of all workflows.