Installing IBM UrbanCode Velocity with Docker Compose

Install IBM® UrbanCode Velocity into the Docker Compose container orchestrator.

Before you begin

The ID that you use to install the product must be able to make changes to the host environment. The tools required by all installation scenarios include the following items:

Docker installed on the host system.
Note: If you use Docker for Windows, make sure Docker is using Linux-type containers. IBM UrbanCode Velocity does not support Windows-type containers.
Internet connection. During installation, files and container images are retrieved from remote locations. If you are unable to access the internet during installation, you can download the files beforehand and perform an offline installation. IBM UrbanCode Velocity supports the following browsers: Chrome, Firefox, and Edge.
Note: The installation files used for offline installation are not the same as those used for internet-connected installation. Ensure that you download the right file for you installation environment.

In addition to the requirements for all installation scenarios, the following items are required for Docker Compose systems:

Docker Compose version 17.09.0-ce, build afdb6d4 and later
CPU with 4+ cores.
8GB RAM
8GB storage
If you are using offline installation, you need 4GB free in your /tmp or \temp directory.
If you are installing the product on Red Hat Enterprise Linux, you need RHEL 7 or later.

Note: On Linux, the Docker daemon runs as the root user. If you do not want to use sudo with the docker command, create a Linux group called docker. Make sure that the user who installs the product is a member of that group. See the Docker documentation for more information about managing Docker as the non-root user.

Get a key. The key enables you to complete installation. Visit the UrbanCode Velocity web portal to obtain your key. After completing the form, you can copy the access key. Store the key in a readily-available location; you use it during installation.

Note: Make sure that you select a key for the product version that you want to install. Keys for the Standard Edition do not work with the Community Edition and vice-versa.

About this task

The installation instructions describe installing the product on all supported operating systems. The downloaded executable file steps you through the installation process and sets your installation parameters.

Note: IBM UrbanCode Velocity is also available as a hosted service. In this case, IBM hosts the server for you. For more information, see the IBM Marketplace.

Procedure

Download the installation file for your environment.
Note: For macOS and Linux installations, set the appropriate permissions before running the file: sudo chmod +x.
Access the URL for internet-connected installations, and then select the file appropriate for you environment:
- Linux: velocity-se-ibm-install-latest-linux
- Windows: velocity-se-ibm-install-latest-win.exe
- Mac OS: velocity-se-ibm-install-latest-macos
You can use a shell command to download the file. For example, if you are installing the product on Linux, you can download the file with a command like this one:
```
wget https://public.dhe.ibm.com/software/products/UrbanCode/Veloc
ity/latest/velocity-se-ibm-install-latest-linux
```
If you are performing an offline installation, access the URL for offline installation files, and then select the file appropriate for you environment:
- Linux: velocity-se-ibm-offline-install-<version>-linux
- Windows: velocity-se-ibm-offline-install-<version>-win.exe
- Mac OS: velocity-se-ibm-offline-install-<version>-macos
Run the downloaded executable file. For example, on Linux use the following shell command:
```
./velocity-se-ibm-install-latest-linux
```
Complete installation by responding to the prompts described in the following steps. When the script starts, you are prompted to accept the license. You can explicitly accept the license without viewing it by appending the following parameter to the command:
```
./<velocity-installation-file> --license=accept
```
1. At the Please enter your Velocity access key prompt, enter your SE version access key. If you previously installed an SE version, the already-configured key is the default value.
  Note: Make sure that you enter the key for the right version.
2. At the Choose the platform prompt, select Docker Compose.
3. At the Enter the location where the Velocity files will be installed prompt, enter the location where you want to install the product files. Files are copied to the specified directory in a subdirectory named product_version_number.
4. At the Please enter the hostname where you will run Velocity prompt, enter the host name where users can access the Web UI. The default value is localhost.
  The host name must resolve to a name on your DNS server, or in the server's hosts file. On Linux, the file location is etc/hosts; on Windows, the location is C:\Windows\System32\drivers\etc\hosts.
5. At the Enter the desired port where Velocity will run prompt, enter the port number for the Web UI. The default value is 443.
6. Optional: If you are performing an off-line installation, at the Choose how to receive offline docker images for velocity prompt, select one of the following options.
  - Local File System. Copy images to the file system and manually load them into the local Docker registry.
  - Local Docker Registry. Load images into the local Docker registry. This requires the Docker client on the host where the installation script is running.
  - Remote Docker Registry. Load images into the local Docker registry, and then tag the images and push them to a remote Docker registry. This requires the Docker client on the host where the installation script is running.
The images are loaded on the local host.
Complete installation by changing to the directory where you installed the product, and start Docker Compose. For example:
```
~/projects/velocity-se/ docker-compose up -d
```
The IBM UrbanCode Velocity images are pulled from Docker Hub and configured for Docker Compose.

What to do next

Access the IBM UrbanCode Velocity Web UI. The URL is https://hostname:port, where hostname and port are the values that you set during installation. The initial user name is admin and the default password is admin.

Installation properties are stored in the [installation_folder]/docker-compose/.env file. You can edit the properties appropriate for your environment. The env file contains a description for all installation properties, including the following properties:

Access_Key: The product access key obtained earlier.
NGINX_HOST: The domain of the URL the users will use to access Velocity. The value is usually the hostname of the virtual machine where Docker Compose is running.

To complete installation, replace the supplied SSL public certificate and private key with your own copies. You can use OpenSSL to generate your own key with a command similar to the following example:

openssl req -newkey rsa:2048 -nodes -keyout key.pem -x509 -days 365 -out certifcate.pem

Place your self-generated key and certificate in the [velocity-install-folder/product_version_number/conf/ssl folder.

After you purchase the product, you receive a permanent access key, and a license key.

Feedback