https://github.com/sap-docs/abap-platform-trial-image

End user documentation for ABAP Platform Trial image
https://github.com/sap-docs/abap-platform-trial-image

abap docker

Last synced: 3 months ago
JSON representation

End user documentation for ABAP Platform Trial image

• Host: GitHub
• URL: https://github.com/sap-docs/abap-platform-trial-image
• Owner: SAP-docs
• License: cc-by-4.0
• Created: 2023-07-20T08:24:27.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-07T11:26:24.000Z (3 months ago)
• Last Synced: 2024-10-10T02:23:49.570Z (3 months ago)
• Topics: abap, docker
• Size: 249 KB
• Stars: 23
• Watchers: 4
• Forks: 8
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        

- [**Important**:](#important)

- [Before you pull the image](#before-you-pull-the-image)

- [Requirements](#requirements)

  - [Linux](#linux)

  - [Windows](#windows)

  - [macOS](#macos)

- [How to pull the Docker image](#installation)

- [How to create the Docker container](#run)

    - [GNU/Linux](#gnulinux)

    - [Other](#other)

    - [Troubleshooting](#run-troubleshooting)

    - [Stop](#stop)

    - [Start again](#start-again)

- [How to update the Licenses - IMPORTANT](#licenses)

- [How to connect](#connection)

    - [SAPGUI](#sapgui)

    - [User and Passwords](#user-and-passwords)

    - [Browser](#browser)

    - [SAP Cloud Connector](#sap-cloud-connector)

- [Additional Information](#additional-information)

    - [abapGit](#abapgit)

- [Known Issues; Notes](#known-issues)

    - [Slow initial start of many functions / applications](#slow-start-no-load)

    - [Error: Shell command for retrieving PID of process bound to SCC port failed](#error-scc-shell-command-failed)

    - [Error: Stopping Cloud Connector since port 8443](#error-scc-stop)

    - [Creating a new container](#creating-a-new-container)

- [Primary contacts](#primary-contacts)

Important
 

To pull the image, click on the tab **Tags** and choose the correct Docker command from there.

**DO NOT** attempt to pull the image from this page (Overview).


Before you pull the image


- You understand the principles of docker container technology

- You know the entities docker image / docker container and their relationship

- You know the basic commands to work with images and containers

Requirements


**_Please note: We highly recommend 32GB RAM to run the ABAP Platform Trial image. The following requirements only cover the resources needed for the Docker environment itself._**

Linux


- 4 CPUs

- 16GB RAM

- 150GB Disk

macOS

Previously, ABAP Platform Trial ran on both Intel and M* processors. Since then, Apple has upgraded its iOS. Thus, on the newest iOS version, ABAP Cloud Developer Trial runs only on a Mac with an Intel processor. This is not a SAP-specific issue. So for now, you have two options:


Run Docker Desktop with a MacBook that has an Intel processor.

Use the UTM app to emulate an AMD64 Linux distro via Apple QEMU.

Many many thanks to Community member [dylan-drummond](https://community.sap.com/t5/user/viewprofilepage/user-id/197587) for researching this. Dylan has written an exhaustive guide to this: 

[M-series Apple Chip MacBooks and Abap Platform Trial containers using Docker and Podman ](https://community.sap.com/t5/technology-blogs-by-members/m-series-apple-chip-macbooks-and-abap-platform-trial-containers-using/ba-p/13593215)

This is Community content, so consume at your own risk; however, this could be very helpful to many Mac users.

Also, make sure you have assigned enough resources to your Desktop Docker because your Docker runs in a VM which contains GNU/Linux and that underlying VM does not share hardware resources with the host machine without explicit assignment:

- 4 CPUs for Docker Desktop

- 16GB for Docker Desktop

- 170GB disk for Docker Desktop

Windows

The 2022 version of ABAP Cloud Developer Trial, runs on [Windows Subsystem for Linux 2 (WSL 2)](https://learn.microsoft.com/en-us/windows/wsl/). This allows you to run a Linux environment directly on Windows, unmodified, without the overhead of a virtual machine. That is, when you install Docker for Desktop:


1.	Choose "WSL", not "Hyper-V". 

2.	Create a file, **`.wslconfig`**, and save it to your **< User >** folder, e.g. `C:\Users\MyUser`. Then enter the following:

    ```

    [wsl2]

    memory=20GB

    localhostForwarding=true

    ```

  > **IMPORTANT**: By default, Docker assigns itself only half the available memory. Therefore, you need to specify enough memory in **`.wslconfig`**; we recommend **20GB**.

    

3. In order to activate the changes, you need to shut down the WSL subsystem using the following command: 

    ```bash

    wsl --shutdown

    ```

4. Now restart Docker Desktop for Windows.

Also, make sure you have assigned enough resources to your Desktop Docker:

- 4 CPUs for Docker Desktop

- 16GB for Docker Desktop = 32GB total (recommended)

- 170GB disk for Docker Desktop

 

How to pull the Docker image


1. To be able to start the system you must agree to SAP DEVELOPER License which will be presented to you when you start the docker container.

2. Make sure you have assigned enough disk space to your Docker set up. The image has around 23GB of size when compressed and >53GB after decompressing. It would be frustrating to lose time downloading the image to only find out docker does not have enough disk space to unpack the image.

3. To be able to successfully run the system, it's necessary to assign at least 16GB RAM **to Docker Desktop**.

4. The image is not available to anonymous users and therefore you must have an account in [Docker Hub](https://hub.docker.com/). To be able to pull the image you must run the command `docker login` or login via Docker Desktop at first.

5. Finally you can run the command:

    ```bash

    docker pull sapse/abap-cloud-developer-trial:

    ```

How to create a Docker container


The system expects host name be *vhcala4hci*, all other host names will prevent the system from starting.

Use the following command and watch the output carefully:

GNU/Linux


```bash

docker run --stop-timeout 3600 -it --name a4h -h vhcala4hci sapse/abap-cloud-developer-trial:

```

Other


```bash

docker run --stop-timeout 3600 -i --name a4h -h vhcala4hci -p 3200:3200 -p 3300:3300 -p 8443:8443 -p 30213:30213 -p 50000:50000 -p 50001:50001 sapse/abap-cloud-developer-trial: -skip-limits-check

```

By default, Docker takes only 10 seconds to shut down. Therefore, we start the container in interactive mode (*-i*), so that we can stop the system gracefully using the key stroke Ctrl-C. However, we also use the parameter `--stop-timeout` which causes that Docker will give the SAP HANA database (HDB) enough time to write its In-Memory database onto disk upon shutdown request.

We name the container *a4h* for easier reference in future commands.

If you plan to stop and start the container to keep your changes in the system, we recommend that you also use the parameter **_-agree-to-sap-license_**. The parameter will make sure **you will not need to manually accept the license agreement**.

> After all the services are successfully started, it is a good idea to wait until the CPU load goes down and the amount of used Memory stops from growing before you attempt to logon to the system.

Troubleshooting


The init process of the container run checks for the correct hostname and for the Linux kernel limits.

In the case you want to skip the Linux kernel limits check, add the parameter `-skip-limits-check` to *docker run* command line you can find above.

If you used the docker run command several lines above on this page and the container exited with the following error message:

```bash

Cannot continue because of insufficient system limits configuration!

```

If you want to continue without recommended limits,

run again with the parameter -skip-limits-check

Appending the parameter `-skip-limits-check` to the run command and executing the run command again will most probably lead to a container name collision error with the following symptoms:

```bash

Error response from daemon: Conflict. The container name "/a4h" is already in use by container XYZ. You have to remove (or rename) that container to be able to reuse that name..

```

That's because the first command started a container named *a4h* which immediately exited but docker didn't remove it and now you are trying to start another container with the same name. Correct, that's what we advised you to do. However, to be able to start the container again you must remove the previous instance using the command `docker rm -f a4h` and only then you can issue the enhanced docker run command again.

The following limits are checked:

```bash

- kernel.shmmax (allowed for docker run --sysctl) > 21474836480

- kernel.shmmni (allowed for docker run --sysctl) > 32768

- kernel.shmall (allowed for docker run --sysctl) > 5242880

- kernel.msgmni (allowed for docker run --sysctl) > 1024

- kernel.sem (allowed for docker run --sysctl) > 1250 256000 100 8192 

- Number of Opened File descriptors (RLIMIT_NOFILE, ulimit -n, docker run --ulimit nofile=1048576:1048576) > 1048576

- vm.max_map_count (must be set on the host via sysctl on GNU/Linux) > 2147483647

- fs.file-max (must be set on the host via sysctl on GNU/Linux) > 20000000

- fs.aio-max-nr (must be set on the host via sysctl on GNU/Linux) > 18446744073709551615

```

The limits enabled by Docker can be passed on the *docker run* command line as: 

```bash

*--sysctl kernel.shmmax=21474836480 --sysctl kernel.shmmni=32768 --sysctl kernel.shmall=5242880 --sysctl kernel.msgmni=1024 --sysctl kernel.sem="1250 256000 100 8192" --ulimit nofile=1048576:1048576*

```

The `sysctl` parameters which are not enabled for modification by Docker must be changed on the Docker host (on the machine where you enter the docker commands). Unfortunately only Linux users can do so and therefore **Mac and Windows users must always use the parameter _-skip-limits-check_**. We apologize for not mentioning this pseudo-requirement sooner, but we wanted to make sure you are fully aware of the fact that there are some limits which were not met and it may have negative effects.

If you want to skip the hostname check, add the parameter `-skip-hostname-check` to *docker run* command line.

Stop


We must make sure SAP HANA has enough time to write all its data into files on your disk.

To stop the container gracefully, hit Ctrl-C in the command window where you started the container, or run the following command:

```bash

docker stop -t 7200 a4h

```

There is also an issue if you just shut down your laptop without running the appropriate `docker stop`. You can, however, avoid lost work by shutting down the docker container using Group Policy Editor, as described by André Fischer in his blog post:

[How to gracefully shutdown your SAP ABAP Platform Developer Edition ...](https://community.sap.com/t5/technology-blogs-by-sap/how-to-gracefully-shutdown-your-sap-abap-platform-developer-edition-when/ba-p/13506947)

Start again


You can start a stopped container via the command *docker start*. 

```bash

docker start -ai a4h

```

- `-i` = We must start it in the interactive mode to be able to respond to the possible start problems 

- `-a` = we must "attach" to the container to be able  to see text output

How to update the licenses


**_ABAP Platform (AS ABAP)_**

You can check the expiry date of your ABAP license in the transaction **SLICENSE** in SAPGUI. You may wish to set a reminder to update your license, since it is easier to do so before expiry.

**Updating the license via SAPGUI (SLICENSE)** 

The ABAP license supplied with the Docker image lasts only three months. Therefore, you should download and import the demo license as follows:

1. Logon to your ABAP system with the user SAP*, client 000, same password as for DEVELOPER (DEVELOPER , client 001, is locked).

2. Start transaction SLICENSE; copy the hardware key.

3. Get the license from the following site, choosing the system A4H:

   [SAP Licenses for Preview, Evaluation, and Demo Systems - "minisap"](https://go.support.sap.com/minisap/#/minisap)

5. Back in your ABAP System, start SLICENSE again, then choose **Install**.

6. Log off, then log on with the user DEVELOPER, client 001.

7. Start SLICENSE again; remove the old invalid licenses. (sap* is not allowed to delete licenses).

**Updating the license via Docker**

The image contains a script which is able to update the AS ABAP license from the file you bind mount or copy to the container. Just save the text file onto your local file system and push it to the container at the path */opt/sap/ASABAP_license*. The hardware key necessary for creation of the license file is printed out during start up phase of the container. 

**Updating via Docker: New container**:  Update the *docker run* command with `-v :/opt/sap/ASABAP_license`. Please, make sure the *-v* parameter is on your command line before the Docker image name (*sapse/abap-cloud-developer-trial:*) because the parameter belongs to *docker run* and everything behind the image name is passed to  programs inside the container.

 

**Updating via Docker: Existing container**:  Copy the key file to the container with the command `docker cp  a4h:/opt/sap/ASABAP_license`. If the container was stopped, the file will be applied when you start the container again. If the container is running, you can either stop and start the container or you can trigger the license update functionality via `docker exec -it a4h /usr/local/bin/asabap_license_update`.

If you run into trouble with the AS ABAP license update script, you can prevent the container from executing this functionality by passing the parameter *-no-asabap-license-update* or by creating the file */opt/sap/.no_ASABAP_license_update* in the container.

**_HDB_**

The image is shipped with a valid HDB license; it's not necessary to re-apply this until just before it expires. You can check the expiry date of your HDB license in **DBA Cockpit > System Information > License**. You may wish to set a reminder to update your license, since it is easier to do so before expiry.

The image contains a script which is able to update the HDB license from the file you bind mount or copy to the container. So, if you run into the need to update HDB license, just save the text file onto your local file system and push it to the container at the path */opt/sap/HDB_license*. The hardware key necessary for creation of the license file is printed out during start up phase of the container. 

**New container**:  Update the *docker run* command with `-v :/opt/sap/HDB_license`.  Please, make sure the *-v* parameter is on your command line before Docker image name (*sapse/abap-cloud-developer-trial:*) because the parameter belongs to to *docker run* and everything behind the image name is passed to programs inside the container.

**Existing container**:  Copy the key file to the container with the command `docker cp  a4h:/opt/sap/HDB_license`. If the container was stopped, the file will be applied when you start the container again. If the container is running, you can either stop and start the container or you can trigger the license update functionality via `docker exec -it a4h /usr/local/bin/hdb_license_update`.

If you run into troubles with the license update script, you can prevent the container from executing this functionality by passing the parameter *-no-asabap-license-update* or by creating the file */opt/sap/.no_HDB_license_update* in the container.

**Open Source Legal Notices** 

[Open Source Legal Notice](https://support.sap.com/content/dam/launchpad/en_us/osln/osln/73554900100900008093_20240117061308.pdf)

How to connect


The following list defines ports used by the container:

- 3200: SAPGUI Instance 00

- 3300: RFC Instance 00

- 8443: SAP Cloud Connector

- 30213: SAP HANA MDC Database

- 50000: AS ABAP HTTP

- 50001: AS ABAP HTTPS

If you need to access the container outside the docker host (from a different machine or a VM) or you are not lucky enough to run GNU/Linux, please expose the ports using the parameter *-p* (the lower case p, case matters) (e.g. for SAPGUI add the following to docker run command: `-p 3200:3200`).

For your convenience, here is the string exposing all relevant ports which you can copy and paste to your docker run command:

`-p 3200:3200 -p 3300:3300 -p 8443:8443 -p 30213:30213 -p 50000:50000 -p 50001:50001`

If you run into the need to expose too many ports, you can consider using `--net=host` instead of exposing ports one by one but the option will cause that all container's port will be available outside the docker host and you will not be able to start another such container. Unfortunately, it appears that this option is available to GNU/Linux users only.

Please, do not use the parameter *-P* (the capitalized P, case matters) because that exposes container ports on random host ports and many SAP clients requires exact ports which cannot be changed (e.g. if the container's port 3200 is exposed as the port 54356, as far as we know you will not be able to configure SAPGUI for Windows to connect to that port).

In the case you are on Windows and you want to connect to the containers IP directly without the need to expose the ports with the parameter *-p*, you may need to update their IP routes to get their TCP/IP packets correctly routed from their host machine to the docker container (which is running in a virtualized GNU/Linux). Self-study materials:

- https://docs.docker.com/docker-for-windows/networking/

- https://github.com/docker/for-win/issues/221

Mac users must always publish the required ports because of the know Docker for Mac limitations:

- https://docs.docker.com/docker-for-mac/networking/#known-limitations-use-cases-and-workarounds

In the case you want run more than 1 container and you do not use GNU/Linux you can play with publish port numbers. For example you can expose the container's port 3200 as the port 3201 (*-p 3201:3200*) and then you can connect to SAPGUI with the instance number 01 instead of the default 00.

SAPGUI


1. Add a custom-specified system with the Application Server ``or *localhost* if you exposed the port 3200 (i.e. `-p 3200:3200`) or *vhcala4hci* if you updated your *hosts* file. 

2. Finally use Instance `00` and SID `A4H`.

User and Passwords


The user name is **DEVELOPER**.

The client is either **001** for development or **000** for some admin tasks.

The password is:

- ABAP Cloud Developer Trial 2022, SP01:              *`ABAPtr2022#01`*

- ABAP Cloud Developer Trial 2022:              *`ABAPtr2022#00`*

- ABAP Platform Trial 1909, SP01:               *`ABAPtr1909`* - Note that we have withdrawn this version

This is also predefined (same password) for client 000, client 001:  SAP* , DDIC.

Browser


Accessing the port HTTP or HTTPS services via an internet browser does not have any special requirements as long as you use the port 50000 for HTTP or the port 50001 for HTTPS and the correct host.

The host value depends on the way how you started the container.  If you exposed all the required ports, then you can use *localhost*. If your Operating System allows you to configure IP routing the way that you can reach out the container's IP directly, you can use ``.

When you get redirected to your browser from SAPGUI, the URL will have host set to `vhcala4hci` which will not be reachable unless you modify your **hosts** file ([Hosts file](https://en.wikipedia.org/wiki/Hosts_(file))).  It is necessary to add a new entry which will make sure your Operating System will be able to translate the hostname *vhcala4hci* to an IP address. Contents of the new entry depends on how you started the container. 

**Manually exposed ports or --net=host** - append the line `127.0.0.1  vhcala4hci`

**No explicit port exposure** - append the line `  vhcala4hci`

SAP Cloud Connector


To be able to use SAP Cloud Connector, you must start an additional service via the following commands:

```bash

docker exec -it a4h bash

/usr/local/sbin/rcscc_daemon start

```

SAP Cloud Connector status can be checked by:

```bash

docker exec -it a4h bash

/usr/local/sbin/rcscc_daemon status

```

The last command will start a daemon process which must be stopped before you can leave the container. Please, use the following command:

```bash

/usr/local/sbin/rcscc_daemon stop

exit

```

You can connect to the instance of SAP Cloud Connector at:

`https://:8443`

with the user *Administrator* and the password *manage*.

Additional Information


Stop


We must make sure SAP HANA has enough time to write all its data into files on your disk.

To stop the container gracefully, hit Ctrl-C in the command window where you started the container, or run the following command:

```bash

docker stop -t 7200 a4h

```

There is also an issue if you just shut down your laptop without running the appropriate `docker stop`. You can, however, avoid lost work by shutting down the docker container using Group Policy Editor, as described by André Fischer in his blog post:

[How to gracefully shutdown your SAP ABAP Platform Developer Edition ...](https://community.sap.com/t5/technology-blogs-by-sap/how-to-gracefully-shutdown-your-sap-abap-platform-developer-edition-when/ba-p/13506947)

Start again


You can start a stopped container via the command *docker start*. 

```bash

docker start -ai a4h

```

- `-i` = We must start it in the interactive mode to be able to respond to the possible start problems 

- `-a` = we must "attach" to the container to be able  to see text output

Known Issues; Notes


Slow initial start of many functions / applications


For technical reasons, we have delivered this initial shipment of SAP Cloud Developer Trial without the Load. Thus, the Load must be started on the fly. Thus, the initial start of many transactions and applications will be slower. 

Error when starting SAP Cloud Connector (SCC): shell command for retrieving PID of process bound to SCC port failed


```bash

ERROR: shell command for retrieving PID of process bound to SCC port failed

```

The error message does not affect the functionality of SAP Cloud Connector (SAP CC) and will be removed in a future version of SCC.



stopping Cloud Connector since port 8443 appears to be used by another process


Very rarely, you may get a second error:

```bash

ERROR: shell command for retrieving PID of process bound to SCC port failed — com. sap. SCC. util. ShellComm and$ExecutionException: Command lsof -i :8443 failed, caused by java.io.IOException: Cannot run lsof - execvpe failed (E NOENT - No such file or directory) 

```

If so, SAP Cloud Connector may not start correctly. If this happens, simply restart SAP CC; then it should work.

Creating a new container 


Do not omit the following parameter: 

```bash

-agree-to-sap-license 

```

The script asks for the agreement, if it's missing, but you may be asked again when you stop and start the container again.

abapGit


abapGit is already installed in version 1.126.0. The program is named **`ZABAPGIT_STANDALONE`**.

If you want to upgrade to the most recent version of abapGit, follow the abapGit documentation:

[abapGit Upgrade](https://docs.abapgit.org/user-guide/getting-started/upgrade.html)

Primary contacts


- [Julie Plummer](mailto:[email protected])

- [Ralf Henning](mailto:[email protected])

- [Jakub Filak](mailto:[email protected])