EnginFrame Web portal

CCME embeds an easy-to-use web interface with EnginFrame. The URL to reach the web portal is https://ALB_URL/CLUSTERNAME/portal, with:

  • ALB_URL: the DNS name of the ALB or CCME_DNS if you specify it

  • CLUSTERNAME: the name of the ParallelCluster cluster you launched

Features

  • Set EnginFrame logo with the CCME/custom/logo.png file.

  • Load EnginFrame services from a *ef-services.zip file present in CCME/custom/: if a CLUSTERNAME.ef-services.zip file exists, then it is used, otherwise CCME checks for the existence of ef-services.zip. This allows to have different configurations for each CCME cluster that you launch.

  • All shared file systems (e.g., FSx for Lustre/NetApp ONTAP…) are displayed in the Files view.

  • All users belonging to the CCME_EF_ADMIN_GROUP OS group are automatically added as administrators of EnginFrame. Group membership is updated every minute, so if a user is added to/removed from the CCME_EF_ADMIN_GROUP group, please wait 1 minute to see the update.

  • Support for aarch64 architectures.

  • Various fixes to allow EnginFrame to work properly in a Cloud environment and with users in an Active Directory.

  • Management of EnginFrame and DCV session proxying through the ALB.

  • Windows DCV Fleet management (see Windows).

Configuration variables

  • CCME_EF_PLUGIN: configures the EnginFrame landing page. Allowed values: applications (for HPC jobs and VDI sessions) or vdi (only for VDI sessions).

  • CCME_EF_ADMIN_GROUP: OS group name or ID to elect users of this group as administrators of EnginFrame. Enginframe will check with getent group "${CCME_EF_ADMIN_GROUP}", please check with Group Name or ID which one returns the list of users.

  • CCME_EFADMIN_SUDOER: if true, then the efadmin user will be a sudoer.

  • CCME_EFADMIN_USER: name of the EnginFrame administrator user. Default value is efadmin.

  • CCME_EFADMIN_ID: set efadmin user UID and GID (default is 4001) (note, the efadmin user is created as a local user).

  • CCME_EFADMIN_PASSWORD: ARN of an AWS Secret to specify the password of the efadmin user.

  • CCME_EFNOBODY_ID: set efnobody user UID and GID (default is 4002) (note, the efnobody user is created as a local user).

  • CCME_EF_MAX_UPLOAD_SIZE: set the maximum size allowed for uploaded files, in bytes (default is 1024 * 1024 * 1024 * 40 (40GB): 4294967296) (note: if the size of any uploaded file is greater than this size, EnginFrame will throw an exception: IllegalStateException visible in ef.log)

EnginFrame services automatic import

You can export services in EnginFrame from the service manager (export button). If you put the exported tarball copy it to CCME/custom/ef-services.zip in your CCME S3 bucket, it will then be automatically imported in EnginFrame when a new cluster is created (not during an update), and published to all users.