1. Documentation
2. 2024.1 (Latest) 2024.0 10.3 10.2 10.1 10.0 9.10 9.9 9.8 9.7 9.6 9.5 9.4 9.3 9.2 9.1 9.0 8.2 8.1 8.0 7.6
3. Hub
4. Manage Altair AI Hub

Manage Altair AI Hub

When managing Altair AI Hub, recall that configuration occurs at multiple levels:

1. The landing page

   From the landing page of Altair AI Hub, numerous configuration tools are available, described collectively in Admin Tools and, according to the topic, in the submenus, e.g. Users and Groups.

2. The platform's REST API

   The complete REST API documentation of Altair AI Hub is available as OpenApi 3.0 specification and is published on SwaggerHub.

3. The platform's environment file

   At the platform level, you can configure Altair AI Hub via the environment file for docker-compose.

   For each Docker image, the environment variables are discussed in detail within the Image Reference.

4. Within containers

   Before the arrival of a container-based architecture, AI Hub Server was a free standing entity; now it is packaged within a Docker image. Hence, to add to or modify the files within the home directory, you must first get access to the AI Hub Server container.

The landing page

The administration tools can be found under the following headings.

Identity and Security

Users and groups are managed via Keycloak.

Platform Administration

Platform Administration provides a user interface for the following tasks:

• Manage centrally defined coding environments (e.g. for Notebooks)
• Manage deployment ZIP files belonging to platform's scoring agent.

Projects

Here the admin can create, delete, and configure projects.

Executions and schedules

Here the admin can manage the job execution infrastructure.

Editing files within containers: the home directory

Frequently, this documentation will refer to the home directory, using a terminology such as <rapidminer-home> or <rapidminer-server-home>, to distinguish it from the home directory of the Job Agents. If you want to make changes to files within the home directory, you must first get access to it.

1. Find the container running aihub-backend:

    $ docker container ls | grep aihub-backend
   
    CONTAINER ID   IMAGE
    63b24f5fb5c9   rapidminer/rapidminer-aihub:10.1.0
   

2. Enter the running container:

    $ docker exec -it <CONTAINER_ID> bash
   

3. Within the container, find the home directory

    rapidminer@aihub-backend:/$ ls aihub/home
   
    config  data  log  resources  tmp
   

4. Edit the file of interest with an available editor, such as nano or vim.

5. Exit the container:

    rapidminer@aihub-backend:/$ exit
   

6. Restart aihub-backend:

    $ docker-compose restart aihub-backend
   

Similarly, the home directory of the Job Agents (<job-agent-home>) can be found in the aihub-job-agent container, under /jobagent/home.