FirecREST UI is a web application providing the basic functionnalities to interact with a FirecREST API backend.
FirecREST provides a REST API through which developers can interact with HPC resources (Schedulers, Filesystems, etc.). In addition FirecREST provides methods to authenticate and authorize, execution of jobs through, file-system operations, and access to accounting or status information.
📖 See the Remix docs and the Remix Vite docs for details on supported features.
To simplify running FirecREST locally we provide a set of local Docker environments that already contain all required dependencies. Please make sure Docker is installed and running on your machine.
Please ensure that the FirecREST Docker Compose environment is running. To connect the UI with the backend, you need to create a .env file (refer to the provided env_example file for guidance).
The FirecREST environment includes a set of default access configurations (Keycloak settings) that enable the UI to authenticate with an IDM.
The requirements for the web app development are node and yarn.
node --version
yarn --version
Once the libraries are available
yarn install
yarn run dev
Open the UI on http://localhost:3000/, a login page (Keycloak) should show up.
Authenticate with the follwing credentials:
client: fireuser
secret: password
Our repository includes a dedicated Helm Chart Repository for deploying firecrest-ui using Helm.
For detailed instructions on how to add our Helm repository and install the chart, please refer to the Helm Chart Repository README.