

This is version 2.18 of the AWS Elemental Server documentation. This is the latest version. For prior versions, see the *Previous Versions* section of [AWS Elemental Conductor File and AWS Elemental Server Documentation](https://docs.aws.amazon.com/elemental-server/).

# Installing AWS Elemental Server Node-locked Licenses on a Virtual Machine (VM)
<a name="install-vm-srvr-ig"></a>

This section is for IT administrators who perform the first-time installation of AWS Elemental Server software on a VM (virtual machine).

**VM Guest Requirements**  
AWS Elemental software can run only on a virtual machine generated by VMware virtualization software. You must use VMware vCenter Server to create the VM. The vSphere client by itself will not work. 

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

**Phase 1 Setup**  
This section explains how to perform the following on each blade:
+ Create a virtual machine and install the AWS Elemental OVA.
+ Install the licenses.
+ Install the AWS Elemental Server software.
+ Configure eth0 as the management interface on each virtual machine.

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

The procedure for installing any version of AWS Elemental Server is the same; only the version number in the file name changes. In this procedure, we show how to install version 2.18.3.12345 of the software.

Installation consists of four parts: 

1.  Downloading files from AWS Elemental

1.  Installing the host operating system (OS)

1.  Installing the AWS Elemental software

1. Setting up licensing

**Topics**
+ [

# Step A: Prepare Hardware and Download Files
](install-vm-srvr-ig-prep.md)
+ [

# Step B: Deploy the VM
](install-vm-srvr-ig-install-vm.md)
+ [

# Step C: Install the AWS Elemental Software
](install-vm-srvr-ig-install-sw.md)
+ [

# Step D: Set-up Licensing
](install-vm-srvr-ig-licensing.md)
+ [

# Step E: Complete Node Configuration
](install-vm-srvr-ig-complete.md)

# Step A: Prepare Hardware and Download Files
<a name="install-vm-srvr-ig-prep"></a>

## Prepare Hardware and Network
<a name="install-vm-srvr-ig-prep-hw"></a>

To prepare your hardware and network, make sure you have done the following:
+ Physically installed the hardware unit.
+ 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-srvr-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-srvr-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 Server Software](detailed-dl-srvr-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_server_2.18.3.44452.run`.

     Make sure that you download the right version of software for the processing architecture that you need, either CPU-only or GPU-enabled.

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

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

Perform these steps from your workstation.

1. Place the OVA image in a convenient location 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 configure these settings later in the AWS Elemental Server 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 of the VM instances.

# Step C: Install the AWS Elemental Software
<a name="install-vm-srvr-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. Use the *elemental* user credentials.

1. From the VMware vSPhere client, choose **Open Console** and access the virtual machine with the *elemental* user credentials.

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

1. Run the installer as follows. Use the actual filename of your .run file, rather than 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_server_2.18.0.123456.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-server/latest/installguide/install-vm-srvr-ig-install-sw.html)

   The software is installed. This message confirms:

   ```
   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 AWS Elemental Server web interface by typing the following:

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

   Make sure the web interface displays.

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

Install a valid license file for each AWS Elemental system using the following steps described in the following table. Detailed instructions for each step follow.


****  

| Step | Where to Perform Step | Start Step With | Finish Step With | 
| --- | --- | --- | --- | 
| Step a: Retrieve Activation Code | Your workstation | Activation email | Activation code | 
| Step b: Generate License Activation Key File | The keygen utility available on the VM | Activation code | Key file (.key ) | 
| Step c: Download Licenses from the AWS Elemental User Community | Your workstation | Key file (.key ) | Tarball file (.tgz) | 
| Step d: Install the License Files | Your workstation | Unlicensed software with limited functionality | Fully licensed, full-feature software | 

# Step a: Retrieve Activation Code
<a name="install-vm-srvr-ig-licensing-ret-act"></a>

You should have received an email containing an activation code. If you're installing software for more than one VM guest, you will have received a separate code for each one.

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

# Step b: Generate a License Activation Key File
<a name="install-vm-srvr-ig-licensing-gen-lic"></a>

The operating system that you installed on your virtual machine (VM) has a utility you can use to generate an activation key file. 

**To generate an activation key file**

1. From the VMware vSphere client, choose **Open Console** and access the desired VM, using the *elemental* user credentials. 

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

1. Enter this command.

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

1. At the prompt, enter the activation code for the first VM, including the dashes. The following file is created in the home directory: `activation_<hostname of the system>.key `

1. Copy the activation key file from the VM to your workstation using SCP.

   Use the *elemental* user credentials.

1. Repeat these steps for each VM. 
   + Make sure to repeat step 1 for each activation key file that you want to generate: each key file must contain the hostname of the individual VM.
   + Make sure to use a different activation code on each VM.

# Step c: Download Licenses from the AWS Elemental User Community
<a name="install-vm-srvr-ig-licensing-dl-lic"></a>

1. Follow the instructions in [Downloading AWS Elemental Server Software](detailed-dl-srvr-ig.md) to get to the **Order Detail** page on the [AWS Elemental Support Center Activations](https://console.aws.amazon.com/elemental-appliances-software/home?region=us-east-1#/activations).

1. Hover over the three-bar icon on the right of the screen to bring up a small menu. Choose **License(s)**.  
![\[Three-bar icon with dropdown menu showing "License(s)" and "Download" options.\]](http://docs.aws.amazon.com/elemental-server/latest/installguide/images/install-licorderdetail-shared-png.png)

1. On the **License Information** page, choose **Generate**.  
![\[Generate button highlighted on a License Information page interface.\]](http://docs.aws.amazon.com/elemental-server/latest/installguide/images/install-licinfo-shared-png.png)

1. On the **Generate Licenses** page, select **Choose File** to browse to and select your `.key` file.

1. This returns you to the **Generate Licenses** page, with your `.key` file selected. Choose **Upload License Key**.  
![\[File upload interface with "Choose File" button and "UPLOAD LICENSE KEY" option highlighted.\]](http://docs.aws.amazon.com/elemental-server/latest/installguide/images/install-genlic-shared-png.png)

1. This takes you to the **View Licenses** page, where you can download a `.tgz` file. This is a compressed, aggregated file that contains all the license files that you need for this system.  
![\[View Licenses page showing license details and download options.\]](http://docs.aws.amazon.com/elemental-server/latest/installguide/images/install-viewlic-shared-png.png)

1. Save the `.tgz` file to a place accessible to the AWS Elemental system that will be using this license, for example, a directory on your workstation called “licenses”. Make a note of the path. 

   The files are named `lic-download-<hostname>.tgz`.

1. Repeat these steps for each virtual machine that will have AWS Elemental software.

# Step d: Install the License Files
<a name="install-vm-srvr-ig-licensing-lic-files"></a>

Now that you have a `.tgz` compressed license file for each instance of the software you are running, you must point the software to it.

From your workstation, perform the following steps for each newly installed AWS Elemental system.

1. Navigate to the directory where you saved the `.tgz` file and unpack it.

1. Bring up the web interface for the AWS Elemental Server system. From the main menu, select **Settings** > **Licenses**. The Licenses screen appears.

1. Select **Choose File** and navigate to the directory where you placed the license files. Select the file name with the hostname portion matching the hostname of this node.  
![\[Settings page showing Standalone License section with no license uploaded and instructions for assistance.\]](http://docs.aws.amazon.com/elemental-server/latest/installguide/images/install-installlic-shared-png.png)

1. Back on the Licenses screen, choose **Update**. The license file is installed. 

1. Repeat steps 1 through 4 on each VM guest.

# Step E: Complete Node Configuration
<a name="install-vm-srvr-ig-complete"></a>

You have now installed and performed basic configuration of AWS Elemental Server. To complete the configuration, refer to the following:


****  

| Scenario | Guide | 
| --- | --- | 
| AWS Elemental Server in a stand-alone configuration. AWS Elemental Server is not managed by AWS Elemental Conductor File. | [AWS Elemental Server Configuration Guide](https://docs.aws.amazon.com/elemental-server/latest/configguide/) | 
| AWS Elemental Server being controlled by AWS Elemental Conductor File. In other words, AWS Elemental Server is in a Conductor File cluster. | [AWS Elemental Conductor File Configuration Guide](https://docs.aws.amazon.com/elemental-cf2/latest/configguide/) | 