Local Cluster Simulator Deployment

The following text describes how to deploy HEAppE Middleware and connect it to the Local HPC Simulator of the HPC. The Local HPC Simulator runs at Docker container and consists of the scripts that simulate the HPC environment to test the HEAppE Middleware.

Step 1: HEAppE environment setup - Prerequisites

  1. Local Environment (deploy on user machine)

    For running a test instance of HEAppE Middleware is necessary to have an operating system with Docker support and the computer must have at least 2 GB of free RAM.

    Software installation

2. HEAppE environment setup

These steps do as sudo user (recommended). In case of a misunderstanding of folder structure, please move to the end of this chapter and see folder validation scheme.

HEAppE Middleware installation procedure

This script will guide you through the entire HEAppE Middleware setup process with Local HPC Simulator of HPC. If you prefer to go through the process manually, follow the steps at Local HPC Simulator Deployment Expert Guide.

The script can be downloaded here: HEAppE-local-setup.sh

To run the script, execute the following commands in your console as a sudo user:

$ chmod +x HEAppE-local-setup.sh
$ ./HEAppE-local-setup.sh

Note

You can also run the script with the -p / --project parameter to specify the project name. The project name is used to create the project directory structure. If you do not specify the project name, the default project name is LocalHPCSimulatorHEAppE or simply don’t use the parameter.

If you want to run script without any user interaction, you can use the -d / --defaults parameter to use the default values in the configuration files.

Script actions:

  1. Creation of the directory structure for the HEAppE Middleware.

  2. Preparation of the .env file for docker containers.

  3. Preparation of the docker-compose.override.yml file for docker containers.

  4. Acquisition of the release of the HEAppE Middleware official repository and copy docker-compose files.

  5. Creation of the appsettings.json file.

  6. Creation of the appsettings-data.json file.

  7. Creation of the seed.njson file.

  8. Credentials Vault initialization and unsealing procedure.

  9. Inicialization the docker containers.

Note

The script creates the following directory structure:

/opt/heappe
├── confs
└── projects
    └── LocalHPCSimulatorHEAppE
        ├── app
        │   ├── keys
        │   ├── logs
        │   └── confs
        ├── heappe-core
        ├── ssh_agent
        │   └── keys
        └── docker_configurations
            ├── docker-compose.override.yml
            └── .env

Warning

The script will ask you to provide the SA password for the SQL Server - which is deyployed in the docker container and HEAppE Middleware will use it to connect to the database. Please check the password policy of the Microsoft SQL Server. The password must meet the requirements of the SQL Server password policy.

Note

If everything is successfully deployed, HEAppE is available at http://localhost:5000 (Swagger at http://localhost:5000/swagger/index.html).

Local HPC simulator container is deployed at localhost:49005.

And you can authenticate with the default credentials: admin/admin via the UserAndLimitationManagement/AuthenticateUserPassword endpoint.