Skip to Content

Installing SAP HANA, express edition with Docker

Install SAP HANA, express edition with Docker.
You will learn
  • How to install SAP HANA, express edition on your preferred Docker setup

This tutorial will show you how to install a server-only installation of SAP HANA, express edition on your Docker installation. This version of SAP HANA, express edition does not contain XSC.

If you wish to install SAP HANA, express edition on a different virtual machine, or you want a custom setup on your Linux machine, see the Virtual Machine or Binary Method installation guides.

Before you begin, ensure your proxy settings have been properly set up. See HTTP/HTTPS proxy in the Docker documentation.

SAP HANA, express edition is a streamlined version of the SAP HANA platform which enables developers to jump-start application development in the cloud or personal computer to build and deploy modern applications that use up to 32GB memory. SAP HANA, express edition includes the in-memory data engine with advanced analytical data processing engines for business, text, spatial, and graph data - supporting multiple data models on a single copy of the data.

The software license allows for both non-production and production use cases, enabling you to quickly prototype, demo, and deploy next-generation applications using SAP HANA, express edition without incurring any license fees. Memory capacity increases beyond 32GB are available for purchase at the SAP Store.

SAP HANA, express edition for Docker has been tested on the following Linux operating system versions:

Linux OS OS Version Docker Editions
SLES 12.2, 12.3, 12.4 Community

This installation does not support Docker for Windows or Docker for Mac.

Additional Information

  • Step 1

    Download and install the appropriate Docker Edition for your system. Visit the Docker Community Edition or Docker Enterprise Edition lists for more information and to download Docker for your machine.

    Note: Ensure your proxy settings have been properly set up. See HTTP/HTTPS proxy in the Docker documentation.

  • Step 2

    To log into your Docker account, run:

    bash
    Copy
    sudo docker login
    

    Follow the prompts and provide your Docker ID and password.

  • Step 3

    Test your Docker installation by running the “Hello World” container application. Run the following command from your Docker-enabled command prompt:

    bash
    Copy
    sudo docker run --name helloWorld alpine echo hello
    

    If successful, the following should display:

    Unable to find image 'alpine:latest' locally
    latest: Pulling from library/alpine
    88286f41530e: Pull complete
    Digest: sha256:<log_number>
    Status: Downloaded newer image for alpine:latest
    hello
    

    If hello is printed, you have successfully pulled the container image alpine (a demo Linux distribution), and ran the instance of the container helloWorld, and ran the command echo with an input parameter of hello.

    If you did not get this output, the Docker installation has not been completed or the Docker daemon can not connect to the internet. Review the process and check the Docker Documentation for more information in troubleshooting your Docker installation.

    Remove the alpine image with the following command:

    bash
    Copy
    sudo docker image rm alpine -f
    
  • Step 4

    Go to https://hub.docker.com/r/saplabs/hanaexpress.

    Copy the Docker pull address. Here’s an example:

    bash
    Copy
    sudo docker pull store/saplabs/hanaexpress:2.00.054.00.20210603.1
    

    Open your Docker-enabled command line and use the Docker pull address to download the image.

    This loads the SAP HANA, express edition image. To ensure that the image was loaded successfully, run:

    bash
    Copy
    sudo docker images
    

    The SAP HANA, express edition image will be listed as hanaexpress.

    Note:
    You may have to log into your Docker account to pull the image. From your Docker-enabled command line, run docker login and follow the prompts to enter your Docker ID and password. Once you have logged in, try the pull command again.

  • Step 5

    Before you can start the container, ensure that the following parameters are set in your host’s /etc/sysctl.conf file. The host can be a virtual machine, physical machine, or a cloud instance.

    bash
    Copy
    fs.file-max=20000000
    fs.aio-max-nr=262144
    vm.memory_failure_early_kill=1
    vm.max_map_count=135217728
    net.ipv4.ip_local_port_range=40000 60999
    

    To edit the sysctl.conf file, use the vi command to open the file and press i to switch to interactive mode. Edit the file as necessary, hit the esc key, and type and enter :wq! to write and save the changes.

  • Step 6

    Create a directory for the SAP HANA, express edition container and grant it the proper permissions.

    bash
    Copy
    mkdir -p /data/<directory_name>
    chown <hxeadm userID or name>:<sapsys groupID or name> /data/<directory_name>
    

    For example:

    bash
    Copy
    mkdir -p /data/mydirectory
    chown 12000:79 /data/mydirectory
    

    The name of this directory does not need to match the name you give to your SAP HANA, express edition container.

  • Step 7

    To make your system more secure, you specify your own password before you create your container. This is done by creating a json file as opposed to having a default password. The file can be stored locally or on another system accessible by URL. If the file is to be stored locally, store it in the /data/ directory you created earlier.

    Create the json file:

    bash
    Copy
    vi <file_name>.json
    

    Press i to start editing and use one of the following formats to create the file:

    bash
    Copy
    {
    "master_password" : "<password>"
    }
    

    or:

    bash
    Copy
    {
    "system_user_password" : "<password>",
    "default_tenant_system_user_password" : "<second_password>"
    }
    

    Here is an example:

    {
    "master_password" : "HXEHana1"
    }
    

    Press esc and then enter wq! to write and save the file.

    This file serves as the master password for your SAP HANA, express edition users. The password must comply with these rules:

    • At least 8 characters
    • At least 1 uppercase letter
    • At least 1 lowercase letter
    • At least 1 number
    • Can contain special characters, but not ` (backtick), $ (dollar sign), \ (backslash), ' (single quote), or " (double quotation marks).
    • Cannot contain dictionary words
    • Cannot contain simplistic or systemic values, like strings in ascending or descending numerical or alphabetical order

    You must then add permissions for this file to be readable by the hxeadm user in the container. Change permissions with:

    bash
    Copy
    sudo chmod 600 /data/<directory_name>/<file_name>.json
    sudo chown 12000:79 /data/<directory_name>/<file_name>.json
    

    Be sure to do this with each json file you use for your Docker containers.

    Make a note of the path to the json file. You will need this to load the SAP HANA, express edition container.

  • Step 8

    Use the SAP HANA, express edition image to create a container.

    bash
    Copy
    sudo docker run -p 49013:49013 -p 49015:49015 -p 49041-49045:49041-49045 -p 1138-1139:1128-1129 -p 59023-59024:59013-59014 -p 49030-49033:49030-49033 -p 51000-51060:51000-51060 -p 53075:53075 -h hxehost -v /data/hxe:/hana/mounts
    --ulimit nofile=1048576:1048576
    --sysctl kernel.shmmax=1073741824
    --sysctl net.ipv4.ip_local_port_range='60000 65535'
    --sysctl kernel.shmmni=524288
    --sysctl kernel.shmall=8388608
    --name <container_name>
    --agree-to-sap-license
    --passwords-url <file://<path_to_json_file>
    --proxy-host proxy.wdf.sap.corp
    --proxy-port 8080
    --no-proxy localhost,127.0.0.1,hxehost,hxehost.localdomain
    

    For information on the TCP/IP port ranges, see TCP/IP Ports of All SAP Products. Filter the list by “SAP Cloud Platform”.

    Example:

    sudo docker run -p 39013:39013 -p 39017:39017 -p 39041-39045:39041-39045 -p 1128-1129:1128-1129 -p 59013-59014:59013-59014 -v /data/express_edition:/hana/mounts \
    sudo docker run -p 49013:49013 -p 49015:49015 -p 49041-49045:49041-49045 -p 1138-1139:1128-1129 -p 59023-59024:59013-59014 -p 49030-49033:49030-49033 -p 51000-51060:51000-51060 -p 53075:53075 -h hxehost -v /data/hxe:/hana/mounts
    --ulimit nofile=1048576:1048576
    --sysctl kernel.shmmax=1073741824
    --sysctl net.ipv4.ip_local_port_range='60000 65535'
    --sysctl kernel.shmmni=524288
    --sysctl kernel.shmall=8388608
    --name hxexsa1 hanaexpressxsa:latest
    --agree-to-sap-license
    --passwords-url file:///hana/mounts/password.json
    --proxy-host proxy.wdf.sap.corp
    --proxy-port 8080
    --no-proxy localhost,127.0.0.1,hxehost,hxehost.localdomain
    

    This example creates the SAP HANA, express edition container with the name express_edition. This process will take several minutes. The prompt will read Startup finished once the container has been successfully running. This container starts in detached mode so you will need to open another command prompt to continue.

    Note:
    If you placed the password file in /data/<directory_name>/<file_name>.json, substitute file://<path_to_json_file> with file:///hana/mounts/<file_name>.json.

    Check if the password file /hana/mounts/<file_name>.json was deleted after the SAP HANA, express edition container starts. If not, you can manually delete it. If the JSON file you are using is an http or https URL, you can leave out the -v option.

    Still having problems? Check that the string containing the mount is an absolute path.

    Note:
    For Linux kernel versions earlier than 4, omit the net.ipv4.ip_local_port_range option.

    Note:
    If the Docker container fails to create an SAP HANA instance, you will need to remove the Docker container to try again. Run docker rm <container_name> to remove the container. Additionally, you will need to delete the files created in the /data/directory_name/ directory.

  • Step 9

    To start your SAP HANA, express edition container, run the following command:

    bash
    Copy
    sudo docker exec -it <container_name> bash
    

    Example:

    sudo docker exec -it express_edition bash
    
  • Step 10

    When you are logged into the SAP HANA, express edition container, you can test your installation by entering the following:

    bash
    Copy
    whoami
    

    You should be logged in as hxeadm, the default SAP HANA, express edition user.

    You can also enter the following:

    bash
    Copy
    HDB info
    

    And you should see the following services running:

    • hdbnameserver
    • hdbcompileserver
    • hdbdiserver
    • hdbwebdispatcher
  • Step 11

    You can log into the system database with the following command:

    bash
    Copy
    hdbsql -i 90 -d <system_database> -u SYSTEM -p <password>
    

    You can log into your tenant database with the following command:

    bash
    Copy
    hdbsql -i 90 -d <tenant_database> -u SYSTEM -p <password>
    

    JDBC


    To log into your system database via JDBC, use the following command:

    bash
    Copy
    jdbc:sap://<ip_address>:39017/?databaseName=<database_name>
    

    To log into your tenant database via JDBC, use the following command:

    bash
    Copy
    jdbc:sap://<ip_address>:39041/?databaseName=<tenant_name>
    

    For detailed information on the connection properties you can specify when connecting using JDBC, see JDBC Connection Properties in the SAP HANA Client Interface Programming Reference.

    Note: Are you trying to connect to SAP HANA, express edition on Docker from an application or command line on the host OS? You will need to make the IP of the container on the internal container network visible to the host.

    Example: Docker Machine on Windows - In this example, 192.168.99.100 is the external docker-machine vm and hxehost is the container host name:

    bash
    Copy
    ALTER SYSTEM ALTER CONFIGURATION ('global.ini', 'system') SET ('public_hostname_resolution', 'use_default_route') = 'name' WITH RECONFIGURE;
    ALTER SYSTEM ALTER CONFIGURATION ('global.ini', 'system') SET ('public_hostname_resolution', 'map_hxehost') = '192.168.99.100' WITH RECONFIGURE;
    

    Example: Docker Machine on Mac - In this example, localhost is the Docker daemon running on the Mac, and hxehost is the container host name:

    bash
    Copy
    ALTER SYSTEM ALTER CONFIGURATION ('global.ini', 'system') SET ('public_hostname_resolution', 'use_default_route') = 'name' WITH RECONFIGURE;
    ALTER SYSTEM ALTER CONFIGURATION ('global.ini', 'system') SET ('public_hostname_resolution', 'map_hxehost') = 'localhost' WITH RECONFIGURE;
    
  • Step 12

    You will need to repeat the previous steps of creating a directory and JSON password for each additional SAP HANA, express edition container you wish to create.

    bash
    Copy
    sudo docker run -p 10013:39013 -p 10017:39017 -p 10041-10045:39041-39045 -p 10028-10029:1128-1129 -p 19013-19014:59013-59014 -v /data/<additional_directory_name>:/hana/mounts \
    --ulimit nofile=1048576:1048576 \
    --sysctl kernel.shmmax=1073741824 \
    --sysctl net.ipv4.ip_local_port_range='40000 60999' \
    --sysctl kernel.shmmni=524288 \
    --sysctl kernel.shmall=8388608 \
    --name <additional_container_name> \
    store/saplabs/hanaexpress:2.00.054.00.20210603.1 \
    --passwords-url <file://<path_to_json_file> OR http/https://<url_to_json_file>>
    --agree-to-sap-license
    

    This process will take several minutes. The prompt will read Startup finished once the container has been successfully running. This container starts in detached mode so you will need to open another command prompt to continue.

  • Step 13

    Set the root password and login.

    bash
    Copy
    docker exec -it -u root <container_name> bash
    
    bash
    Copy
    passswd
    

    Check the update utility. It can be found in the <sid>adm/bin directory. Use HXECheckUpdate_linux.bin. Run this to check for, and download, the latest files. Follow the prompts to download the new files. By default, they will be downloaded to /usr/sap/<sid>/home/Downloads. The downloaded file will be hxe.tgz.

    Extract the contents of the packages.

    Example:

    bash
    Copy
    tar -zxf <downloaded_path>/hxe.tgz
    tar -zxf <downloaded_path>/hxexsa.tgz
    

    Navigate to the directory where you extracted the packages:

    bash
    Copy
    cd <extract_path>/HANA_EXPRESS_20/
    

    Note:
    If the update you are applying includes the Applications package, increase your allocated memory by 3GB and run ./hxe_gc.sh. Follow the prompts and then continue with the procedure.

    As the root user, run the upgrade script to update the server:

    bash
    Copy
    sudo ./hxe_upgrade.sh
    

    Follow the prompts to complete the server update.

  • Step 14

    The following is a list of options available for the sudo docker run store/saplabs/hanaexpress command.

    sudo docker run store/saplabs/hanaexpress:2.00.054.00.20210603.1 -h
    usage: [options]
    --dont-check-consistency Skip consistency check between mount points
    --dont-check-mount-points Skip check for allowed mount points
    --dont-check-version Skip compatibility check of current and last HANA version
    --dont-check-system Skip check for incompatible /proc/sys values
    --dont-exit-on-error Halt script on error to allow root cause analysis
    (MUST NOT be used in production)
    --license-url <url> URL for a license file (json)
    Format: {"landscape-id":"<8-4-4-4-12 GUID>", "license":"<license>"}
    --passwords-url <url> URL for a password file (json)
    Format:
    {"master_password":"<pwd>"}
    or
    {"system_user_password":"<pwd>","default_tenant_system_user_password":"<pwd>"}
    --print <print_option> Print and exit, options are:
    README
    hdb_version
    --agree-to-sap-license Indicates you agree to the SAP Developer Center Software Developer License Agreement.
    
Back to top