diff --git a/docs/index.md b/docs/index.md index 47b56f83..cd3807fa 100644 --- a/docs/index.md +++ b/docs/index.md @@ -108,6 +108,8 @@ If you cannot find the information that you need in the documentation, help is a [:octicons-arrow-right-24: FirecREST API](services/firecrest.md) + [:octicons-arrow-right-24: HPC Console](services/hpc-console.md) + [:octicons-arrow-right-24: CI/CD for external projects](services/cicd.md) [:octicons-arrow-right-24: JupyterLab](services/jupyterlab.md) diff --git a/docs/services/hpc-console.md b/docs/services/hpc-console.md new file mode 100644 index 00000000..7388aeb2 --- /dev/null +++ b/docs/services/hpc-console.md @@ -0,0 +1,45 @@ +[](){#hpc-console} +# HPC Console + +HPC Console is a web application designed to provide essential functionalities for interacting with [FirecREST API v2 backend][ref-firecrest]. +HPC Console is a web application that provides users with a modern web-based environment to interact with HPC resources such as clusters, job schedulers, and filesystems. + +## Features + + +- Dashboard – shows cluster availability and basic system status. +- Jobs – allows creating, submitting, and monitoring jobs. Users can provide job name, script, and resource requirements. +- File Navigator – supports browsing directories, uploading, downloading, and deleting files. Editing files inline is not supported. + +## Supported version + +Starting early 2025, CSCS has introduced a new version of the API: [FirecREST version 2](https://eth-cscs.github.io/firecrest-v2). + +This web interface is available and runs on the FirecREST API v2 backend, FirecREST API v1 is not supported. + +## Alps platforms + +HPC console is currently available on three [Alps platforms][ref-alps-platforms]. + +| Platform | URL | Clusters | +|----------------|----------------------|--------------------------------------------------------------------------| +| HPC Platform | [https://my.hpcp.cscs.ch/](https://my.hpcp.cscs.ch/) | [Daint][ref-cluster-daint], [Eiger][ref-cluster-eiger] | +| ML Platform | [https://my.mlp.cscs.ch/](https://my.mlp.cscs.ch/) | [Bristen][ref-clsuter-bristen], [Clariden][ref-cluster-clariden] | +| CW Platform | [https://my.cwp.cscs.ch/](https://my.cwp.cscs.ch/) | [Santis][ref-cluster-santis] | + +## Access and prerequisites + +- Access requires a valid CSCS account and authentication through the institutional login system. +- Supported browsers: recent versions of Chrome, Firefox, and Safari are recommended. +- Sessions automatically expire after a period of inactivity. + +## Feedback + +We welcome your feedback to help us improve HPC Console. +If you encounter issues or have suggestions, please [let us know][ref-get-in-touch]. + +## Further information + +* [FirecREST UI documentation](https://eth-cscs.github.io/firecrest-ui) +* [FirecREST UI repository](https://github.com/eth-cscs/firecrest-ui) +* [FirecREST documentation](https://eth-cscs.github.io/firecrest-v2) \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 3f4bde45..9406bdd0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -96,6 +96,7 @@ nav: - 'Services': - services/index.md - 'FirecREST': services/firecrest.md + - 'HPC Console': services/hpc-console.md - 'CI/CD': services/cicd.md - 'JupyterLab': services/jupyterlab.md - 'Running Jobs':