

# Installing Conductor Live on a virtual machine (VM)
<a name="install-vm-cl3-ig"></a>

This section is for IT administrators who perform the first-time installation of AWS Elemental Conductor Live software on a VM .

**VM guest requirements**  
AWS Elemental software can run only on a virtual machine (VM) generated by VMware virtualization software. You must use VMware vCenter Server to create the VM. The vSphere client by itself doesn't work. 

For version and system requirements and other information about VMware, see [System requirements for virtual machines (VMs)](vm-req.md).

**Prerequisite knowledge**  
To complete this process, you must have the following knowledge:
+  A basic understanding of server virtualization.
+  Installing and using VMware Center and the VMware vSphere client interface, including Open Console.
+  Moving files from a VM guest to other systems over the network. We recommend using a utility such as SCP.
+  Locating recently downloaded files.

**Note**  
In the following steps, we show how to install version 3.25.5 of the software. Modify the commands to specify the version that you are installing. 

**Topics**<a name="topiclist"></a>
+ [Step A: Prepare the hardware and download files](install-vm-cl3-ig-prep.md)
+ [Step B: Deploy the VM](install-vm-cl3-ig-install-vm.md)
+ [Step C: Install the AWS Elemental Software](install-vm-cl3-ig-install-sw.md)
+ [Step D: Set up licenses](install-vm-cl3-ig-licensing.md)
+ [Step E: Complete cluster configuration](install-vm-cl3-ig-complete.md)

# Step A: Prepare the hardware and download files
<a name="install-vm-cl3-ig-prep"></a>

## Install the hardware units
<a name="install-vml-cl3-install-hardware"></a>

Install the Hypervisors according to the procedures for your organization.

**Important**  
All the hypervisor hardware for one Conductor Live cluster must be installed in the same physical location. This means that the hardware that hosts the Conductor Live VM guest or guests, and that hosts the AWS Elemental Live guests must all be in the same physical location. 

## Prepare the hardware and network
<a name="install-vm-cl3-ig-prep-hw"></a>

To prepare your hardware and network, make sure you have done the following:
+ Physically installed the appliance.
+ Set up the unit as a node on your network.
+ Configured network cards and ensured that they're able to reach other machines on the network.
+ Set up a method, such as SCP, for transferring files from your workstation to the VM guest.

## Note Your Activation Code
<a name="install-vm-cl3-ig-prep-act"></a>

You should have received an email with your activation code. You need this number for the installation. 

If you're installing AWS Elemental software on more than one system, you received an activation code for each system. Decide and note which activation code you will use for each unit. The codes are not tied ahead of time to any specific system, but you cannot use the same code on more than one.

## Download Files
<a name="install-vm-cl3-ig-prep-dl"></a>

Download the installation files for each unique AWS Elemental product that you're using.

**To download installation files**

1. Log in to [AWS Elemental Support Center Activations](https://console.aws.amazon.com/elemental-appliances-software/home?region=us-east-1#/activations). For detailed steps to download installation files, see [Downloading AWS Elemental Conductor Live software](detailed-dl-cl3-ig.md).

1. Download your files.

   You need the following files for each unique piece of AWS Elemental software that you're installing. 
   + A kickstart (`.ova`) file for creating a VM instance. For example, `centos-20161028T12270-production-usb.ova`. 

     You will use this file to put a preconfigured installation of your operating system on your VM.
   + An installation (`.run`) file for the AWS Elemental software itself. For example, `elemental_production_conductor_live247_3.25.5.12345.run`.

    For example, if you're installing Conductor Live on two systems and AWS Elemental Live on five systems, you need to download two `.iso` files and two `.run` files. 

# Step B: Deploy the VM
<a name="install-vm-cl3-ig-install-vm"></a>

Perform these steps from your workstation.

1. Place the OVA image in a location convenient and accessible to the VM host.

1. Start the VMware vSphere client and choose the option that lets you run the OVF Deploy wizard.

1. Complete the fields in the wizard. Pay special attention to the following settings:
   + For the *source*, enter the location where you saved the OVA file.
   + Ensure that the *hostname* that you assign to the VM guest is unique across all of your AWS Elemental products.
   + For *network settings*, such as DNS servers and eth configuration, leave the fields blank. You will configure these settings later in the Conductor Live installation and configuration process.

   When you finish and save your inputs, the OVA is installed, the guest is created, and the eth0 is configured as specified.

1. Before you proceed, take a snapshot of the VM as described in the VMware vSphere help text.

1. Repeat these steps to install the OVA on all VM instances.

# Step C: Install the AWS Elemental Software
<a name="install-vm-cl3-ig-install-sw"></a>

1. Use SCP to move each AWS Elemental software installer (`.run` file) to the `/home/elemental` directory on the appropriate virtual machine (VM). Use the *elemental* user credentials.

1. From the VMware vSPhere client, choose **Open Console** and access the VM with the elemental username and default password.

   You are logged in at the home directory (/home/elemental).

1. Run the installer as follows. When you do this use the actual file name of your `.run` file, rather than the file name in the example below.

   ```
   [elemental@hostname ~]$ sudo sh ./<product> -xeula -l -z
   ```

   Where:
   + *<product>* is the file name of the file that you downloaded. For example, `elemental_production_conductor_live247_3.25.5.12345.run`.
   + -l is a letter, not a number. 

1. You are prompted as described in the table below.  
****    
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/elemental-cl3/latest/installguide/install-vm-cl3-ig-install-sw.html)

   The software is installed. This message confirms both installation and configuration are complete:

   ```
   Installation and configuration complete!
   Please open a web browser and point it to https://xxx.xxx.xxx.xxx to get to the web interface.
   Enjoy!
   ```

1. Take a snapshot of the VM as described in the CentOS 7 Virtual Manager online help.

1. Start a web browser and start the Conductor Live web interface by typing:

   ```
   https://<hostname>
   ```

   Make sure the web interface displays.

# Step D: Set up licenses
<a name="install-vm-cl3-ig-licensing"></a>

At this point, the software is installed but it is not yet enabled. 

You must now generate and install the license file on each VM.

The license generation procedure works as follows: 
+ You receive an email with activation codes, one for each instance of the product (Conductor Live) that you purchased. At each Conductor Live VM, you use one activation code to generate a key file. The key file incorporates the specific activation code and the specific hostname of the VM. The key file works only with this activation code's product (Conductor Live) and with this VM. 
+ You copy the key file from the VM to your workstation. At your workstation, you open the AWS Elemental Support Center console and generate a license using each key file. Like the key file used to generate it, the license file is valid only for this product (Conductor Live) and this specific VM.
+ After you generate the license file, you copy it to the VM that it belongs to, and use the CLI to install the license.

**Topics**
+ [Organize your activation codes](#install-vm-cl3-license-retrieve)
+ [Generate a key file](#install-vm-cl3-license-generate)
+ [Generate a license](#install-vm-cl3-license-download)
+ [Install the license files](#install-vm-cl3-license-install)

## Organize your activation codes
<a name="install-vm-cl3-license-retrieve"></a>

**To organize the activation codes**

1. Locate the email you received from AWS Elemental. This email contains an activation code or codes, one for each Conductor Live software instance that you have purchased. The activation code looks like this:

   `CON-111-222-333`

   If you didn't receive this email or have lost it, contact AWS Elemental Support through the [AWS Elemental Support Center](https://console.aws.amazon.com/elemental-appliances-software/home?region=us-east-1#/supportcenter).

1. If you have more than one activation code, assign each code to a VM. You can assign any code to any Conductor Live VM. Make a note of the assignments. For example, you might assign as follows:

   `CON-111-222-333` with the appliance that has the hostname `SystemA`.

   `CON-111-222-444` with the appliance that has the hostname `SystemB`.

## Generate a key file
<a name="install-vm-cl3-license-generate"></a>

You must generate a key file using a utility that always exists on the operating system of the VM. 

**To generate a key file**

Perform this step at each Conductor Live VM.

1. From the VMware vSPhere client, choose **Open Console** and access the VM with the elemental username and default password. 

   You are logged in at the home directory (`/elemental`).

1. Enter this command:

   ```
   [elemental@hostname ~] ./keygen
   ```

1. At the prompt, enter the activation code that belongs to this VM. The following *key file* is created in the home directory: `activation_<hostname of the system>.key`.

   For example, `activation_SystemA.key`

1. Copy the key file from the VM to your workstation. We recommend that you copy all the key files to a specific folder on your workstation. Give the folder a suitable name such as `elemental_live_license_keys`. Make a note of the path because you will need it in [the next step](#install-vm-cl3-license-generate).

1. Repeat these steps for each Conductor Live VM. Make sure that you use a different activation code on each VM.

## Generate a license
<a name="install-vm-cl3-license-download"></a>

You must log on to the AWS Elemental Appliances & Software console, and use the key file to generate a license.

**Note**  
This procedure assumes that an administrator in your organization has set you up as an AWS IAM user, with the permissions that you need to generate licenses. For more information, see [AWS Elemental Appliances and Software Service Getting Started Guide](https://amzn.to/AWSElementalSerGSG).   
It also assumes that you have your IAM credentials (user name and password). If you don't have these credentials, speak to an administrator in your organization. AWS Elemental can't provide you with these credentials.

**To generate a license**

Perform this step at your workstation.

1. Open the AWS Elemental Appliances & Software console at [https://console.aws.amazon.com/elemental-appliances-software/](https://console.aws.amazon.com/elemental-appliances-software/). 

1. On the navigation pane of the AWS Elemental Appliances & Software home page, choose **Activations**. The **Activations List** page appears. Choose the **Ready to license** tab.

   The **Ready to license** tab shows one entry for each product that you purchased. Each product is identified by a product name and a unique activation code. The activation code is the code that you [received in the email](#install-vm-cl3-license-retrieve). Following from our example, you might see two lines:

   `CxxxPNL CON-111-222-333 Conductor product 2021-11-01`

   `CxxxPNL CON-111-222-444 Conductor product 2021-11-01`

1. Choose the **Generate license** button (at the top-right corner of the tab). The **Generate new license** page appears.

1. On the **Generate new license** page, choose the **Choose files** button, and navigate to the folder that you [copied the key files to](#install-vm-cl3-license-generate). For example, `/elemental_live_license_keys`.

   In the dialog box that appears, select all the key files that you generated, then choose **Open**.

   On the **Generate new license** page, one entry appears for each key file. For example:

   ```
   activation_systemA.key
   15.39 KB
   11/04/2021, 2:02:01 PM
   
   activation_systemB.key
   15.39 KB
   11/04/2021, 2:32:22 PM
   ```

1. Choose **Generate license**. A license is generated for each entry. After the **License generated** message appears, the product for each license moves to the **Activations** tab.

**Download the license files**

1. On the **Activations** tab, choose one of the entries you want to set up. The **Product details** page appears for this product. 

1. Choose the **Software** tab and look for the **License file** link.

1. Choose the **License file** link and follow the prompts to download the file. 

1. Repeat these steps to download all the license files that you generated.

1. Follow the procedure that applies to your browser to open the folder that contains the downloaded license files. Make a note of the folder where the license files are located. 

**About the License Files**

Each license file is named as follows: `lic-download-<hostname>.tgz`

For example: `lic-download-systemA.tgz`

Each `tgz` license file contains the main license for Conductor Live and licenses for all the add-on packs that you purchased.

The licenses work only with the specific product and the specific VM.

## Install the license files
<a name="install-vm-cl3-license-install"></a>

When you [downloaded the license files](#install-vm-cl3-license-download), you should have made a note of the folder where these files were downloaded to on your workstation. You must now transfer each file to its VM and install it.

**To transfer the license to the VM**
+ Use a method such as SCP to move the license file (the `.tgz` file) from your workstation to a location on the Conductor Live VM. We recommend that you copy the file to a folder with a name like `elemental_licenses`.

  Make sure that you put the correct license on each VM. The license only works on a specific VM.

**To install the license on the VM**

On each VM, you must set up Conductor Live to use the license file. 

1. Using an SSH client such as PuTTY, log in to the VM with the *elemental* user credentials.

   You are logged in at the home directory (`/home/elemental`).

1. Navigate to the directory that contains the license file, and extract the `.lic` files from the `.tgz` file. Place the `.lic` files in these folders:

   `/home/elemental`

   `/opt/elemental_se`

1. Enter the following command to restart the Conductor Live service:

   `[elemental@hostname ~]$ sudo service elemental_se restart`

# Step E: Complete cluster configuration
<a name="install-vm-cl3-ig-complete"></a>

You have now installed and performed basic configuration of Conductor Live. To complete the configuration of the Conductor Live nodes and all the worker nodes in the cluster, refer to the [AWS Elemental Conductor Live Configuration Guide](https://docs.aws.amazon.com/elemental-cl3/latest/configguide/).