Installing SAP HANA, express edition Server + Apps, with Docker
- How to install SAP HANA, express edition on your preferred Docker setup
This tutorial will show you how to install an installation of SAP HANA, express edition with XSA 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.
Note:
These instructions useopenSUSE
and Docker Enterprise Edition as an example. However, any of the supported operating systems listed above are compatible. Use the operating system and Docker installation that fits your needs best.
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
overlay2
is recommended as the storage driver, withext4
orxfs
as the backend file system. The minimum volume size of the backend file system mounting is 100G. If your current disk size is less than 100G, please resize it.To use
overlay2
, create or edit the file/etc/docker/daemon.json
to include the following:bashCopy{ "storage-driver": "overlay2" }
Restart the Docker service.
For example, on
SuSE
:sudo systemctl restart docker.service
devicemapper
is an available alternative storage driver for valid Docker versions. Keep in mind,devicemapper
is no longer being supported by Docker.For more information on the storage driver, visit the Docker storage drivers documentation page.
- Step 3
To log into your Docker account, run:
bashCopysudo docker login
Follow the prompts and provide your Docker ID and password.
- Step 4
Test your Docker installation by running the “Hello World” container application. Run the following command from your Docker-enabled command prompt:
bashCopysudo 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 containerhelloWorld
, and ran the commandecho
with an input parameter ofhello
.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:
bashCopysudo docker image rm alpine -f
- Step 5
Go to https://hub.docker.com/r/saplabs/hanaexpressxsa.
Copy the Docker pull address. Here’s an example:
bashCopysudo docker pull store/saplabs/hanaexpressxsa:2.00.040.00.20190729.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:
bashCopysudo docker images
The SAP HANA, express edition image will be listed as
hanaexpressxsa
.Note:
You may have to log into your Docker account to pull the image. From your Docker-enabled command line, rundocker login
and follow the prompts to enter your Docker ID and password. Once you have logged in, try the pull command again. - Step 6
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.bashCopyfs.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=60000 65535
To edit the
sysctl.conf
file, use thevi
command to open the file and pressi
to switch to interactive mode. Edit the file as necessary, hit theesc
key, and type and enter:wq!
to write and save the changes.Load the changes by running:
bashCopysudo /sbin/sysctl -p
- Step 7
The
hxehost
IP address is private to the installation. In order for applications to accesshxehost
, add thehxehost
IP address to your machine’s hostname map. The hostname map is your machine’s/etc/hosts
file. You must edit/etc/hosts
if you want to access any XS Advanced applications or use HANA Cockpit from your machine.Use the following command:
bashCopysudo sh -c 'echo <hxehost_IP_address> hxehost >> /etc/hosts'
- Step 8
Create a directory for the SAP HANA, express edition container and grant it the proper permissions.
bashCopymkdir -p /data/<directory_name> chown <hxeadm userID or name>:<sapsys groupID or name> /data/<directory_name>
For example:
bashCopymkdir -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 9
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:bashCopyvi <file_name>.json
Press
i
to start editing and use one of the following formats to create the file:bashCopy{ "master_password" : "<password>" }
or:
bashCopy{ "system_user_password" : "<password>", "default_tenant_system_user_password" : "<second_password>" }
Here is an example:
{ "master_password" : "SAPhxe123" }
Press
esc
and then enterwq!
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:bashCopysudo chmod 600 /data/<directory_name>/<file_name>.json sudo chown <hxeadm userID or name>:<sapsys groupID or 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 10
Use the SAP HANA, express edition image to create a container.
bashCopysudo 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 readStartup 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
, substitutefile://<path_to_json_file>
withfile:///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 theJSON
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 thenet.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. Rundocker rm <container_name>
to remove the container. Additionally, you will need to delete the files created in the/data/directory_name/
directory. - Step 11
To start your SAP HANA, express edition container, run the following command:
bashCopysudo docker exec -it <container_name> bash
Example:
sudo docker exec -it express_edition bash
- Step 12
When you are logged into the SAP HANA, express edition container, you can test your installation by entering the following:
bashCopywhoami
You should be logged in as
hxeadm
, the default SAP HANA, express edition user.You can also enter the following:
bashCopyHDB info
And you should see the following services running:
hdbnameserver
hdbcompileserver
hdbdiserver
hdbwebdispatcher
- Step 13
You can log into the system database with the following command:
bashCopyhdbsql -i 90 -d <system_database> -u SYSTEM -p <password>
You can log into your tenant database with the following command:
bashCopyhdbsql -i 90 -d <tenant_database> -u SYSTEM -p <password>
JDBC
To log into your system database via JDBC, use the following command:
bashCopyjdbc:sap://<ip_address>:39013/?databaseName=<database_name>
To log into your tenant database via JDBC, use the following command:
bashCopyjdbc:sap://<ip_address>:39015/?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
andhxehost
is the container host name:bashCopyALTER 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, andhxehost
is the container host name:bashCopyALTER 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 14
After you have logged in, view the list of XSA applications. Enter:
bashCopyxs apps
Note:
When you run thexs apps
command for the first time, it may take 1-2 minutes for the system to return the list of XSA applications.Check that the application
webide
showsSTARTED
in the list of XSA applications, and has 1/1 instances. (If the list shows 0/1 in the instance column, the application is not started.)Note:
Normally it only takes a few minutes for XSA services to start. However. depending on your machine, it can take over 30 minutes for XSA services to begin. If the service doesn’t showSTARTED
and doesn’t show1/1
instances, keep waiting until the service is enabled.Make a note of the URL for
webide
.Note:
The commandxs apps | grep webide
returns thewebide
row only.Test your Web IDE connection. Enter the URL for Web IDE in a web browser.
Example: https://hxehost:53075
Log on to Web IDE using the
XSA_DEV
user and the password you made during installation.If you are prompted to change your password, follow the instructions.
- Step 15
Set the root password and login.
bashCopydocker exec -it -u root <container_name> bash
bashCopypassswd
Check the update utility. It can be found in the
<sid>adm/bin
directory. UseHXECheckUpdate_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 files will behxe.tgz
andhxexsa.tgz
.Extract the contents of the packages.
Example:
bashCopytar -zxf <downloaded_path>/hxe.tgz tar -zxf <downloaded_path>/hxexsa.tgz
Navigate to the directory where you extracted the packages:
bashCopycd <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:
bashCopysudo ./hxe_upgrade.sh
Follow the prompts to complete the server update.
- Step 16
The following is a list of options available for the
sudo docker run store/saplabs/hanaexpressxsa
command.docker run store/saplabs/hanaexpressxsa:2.00.040.00.20190729.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>"} --proxy-host Proxy host name --proxy-host Proxy port number --no-proxy Comma separated list of hosts/domains that do not need proxy --agree-to-sap-license Indicates you agree to the SAP Developer Center Software Developer License Agreement.
- Install Docker
- Manage Storage System
- Log Into Docker
- (Optional) Test Your Docker Installation
- Download the SAP HANA, express edition Image from the Docker Library
- Edit the host sysctl.conf file
- Edit the /etc/hosts file
- (Optional) Create a Directory to Persist SAP HANA, express edition Data Outside of the Container
- Set Up Password for SAP HANA, express edition
- Start SAP HANA, express edition Container
- Log into SAP HANA, express edition Container
- (Optional) Test the Container
- (Optional) Log Into System or Tenant Database
- (Optional) Test SAP Web IDE
- (Optional) Update Your Docker Image
- -Help Command