Skip to content

Commit 9f008be

Browse files
authored
added deprecation notice for v1 (#100)
1 parent c47e3ae commit 9f008be

File tree

1 file changed

+14
-17
lines changed

1 file changed

+14
-17
lines changed

docs/services/firecrest.md

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33

44
FirecREST is a RESTful API for programmatically accessing High-Performance Computing resources, developed at CSCS.
55

6-
Users can make use of FirecREST to automate access to HPC, enabling [CI/CD pipelines](https://github.com/eth-cscs/firecrest/tree/master/examples/CI-pipeline), [workflow managers](https://github.com/eth-cscs/firecrest/tree/master/examples/airflow-operators), and other tools against HPC resources.
6+
Users can make use of FirecREST to automate access to HPC, enabling [CI/CD pipelines](https://eth-cscs.github.io/firecrest-v2/use_cases/CI-pipeline/), [workflow managers](https://github.com/eth-cscs/firecrest/tree/master/examples/airflow-operators), and other tools against HPC resources.
77

8-
Additionally, scientific platform developers can integrate FirecREST into [web-enabled portals](https://firecrest-ui-hpc.cscs.ch) and [applications](https://github.com/eth-cscs/firecrest/tree/master/examples/UI-client-credentials), allowing them to securely access authenticated and authorized CSCS services such as job submission and data transfer on HPC systems.
8+
Additionally, scientific platform developers can integrate FirecREST into [web-enabled portals](https://my.hpcp.cscs.ch) and [applications](https://github.com/eth-cscs/firecrest/tree/master/examples/UI-client-credentials), allowing them to securely access authenticated and authorized CSCS services such as job submission and data transfer on HPC systems.
99

1010
Users can make HTTP requests to perform the following operations:
1111

@@ -17,18 +17,17 @@ Users can make HTTP requests to perform the following operations:
1717

1818
Starting early 2025, CSCS has introduced a new version of the API: [FirecREST version 2](https://eth-cscs.github.io/firecrest-v2).
1919

20-
Version 2 is faster, easier to use, and more efficient in resource management than its predecessor, therefore, if you are new to FirecREST start directly using **version 2** (if available for your platform).
20+
Version 2 is faster, easier to use, and more efficient in resource management than its predecessor, therefore, if you are new to FirecREST start directly using **version 2**.
2121

22-
If you're using **version 1**, we recommend you to port your applications to use the new version.
22+
!!! warning "Deprecation notice"
23+
If you're using **version 1**, we recommend you to port your applications to use the new version.
24+
We will communicate soon the exact date of the decomission of version 1 (not before Quarter 4 of 2025).
2325

2426
=== "Version 2"
2527

26-
!!!Warning
27-
Documentation for version 2 is still work in progress
28-
2928
For a full feature set, have a look at the latest [FirecREST version 2 API specification](https://eth-cscs.github.io/firecrest-v2/openapi) deployed at CSCS.
3029

31-
Please refer to the [FirecREST-v2 documentation](https://eth-cscs.github.io/firecrest-v2/use) for detailed documentation.
30+
Please refer to the [FirecREST-v2 documentation](https://eth-cscs.github.io/firecrest-v2/user_guide/) for detailed documentation.
3231

3332
=== "Version 1"
3433

@@ -136,7 +135,7 @@ Back on the Subscription Management page, you can review your active subscriptio
136135

137136
![FirecREST subscription management](../images/firecrest/f7t-api-subscriptions-management.png)
138137

139-
To use your Application to access FirecREST, follow the [API documentation](https://firecrest-docs.v1.svc.cscs.ch/).
138+
To use your Application to access FirecREST, follow the [API documentation](https://eth-cscs.github.io/firecrest-v2/openapi).
140139

141140
## Getting Started
142141

@@ -444,14 +443,12 @@ A staging area is used for external transfers and downloading/uploading a file f
444443

445444
## Further Information
446445

447-
* [FirecREST UI for HPC Platform](https://firecrest-ui-hpc.cscs.ch)
448-
* [FirecREST OpenAPI Specification Version 1](https://firecrest.readthedocs.io/en/latest/reference.html)
449-
* [FirecREST OpenAPI Specification Version 2](https://eth-cscs.github.io/firecrest-v2/openapi)
450-
* [FirecREST Docs Version 1](https://firecrest.readthedocs.io/)
451-
* [FirecREST Docs Version 2](https://eth-cscs.github.io/firecrest-v2)
452-
* [Documentation of pyFirecREST (v1/v2)](https://pyfirecrest.readthedocs.io/)
453-
* [FirecREST repository Version 1](https://github.com/eth-cscs/firecrest)
454-
* [FirecREST repository Version 2](https://github.com/eth-cscs/firecrest-v2)
446+
* [FirecREST UI for HPC Platform](https://my.hpcp.cscs.ch)
447+
* [FirecREST UI for ML Platform](https://my.mlp.cscs.ch)
448+
* [FirecREST OpenAPI Specification](https://eth-cscs.github.io/firecrest-v2/openapi)
449+
* [FirecREST Official Docs](https://eth-cscs.github.io/firecrest-v2)
450+
* [Documentation of pyFirecREST](https://pyfirecrest.readthedocs.io/)
451+
* [FirecREST repository](https://github.com/eth-cscs/firecrest-v2)
455452
* [What are JSON Web Tokens](https://jwt.io/introduction)
456453
* [Python Requests](https://requests.readthedocs.io/en/master/user/quickstart)
457454
* [Python Async API Calls](https://docs.aiohttp.org/en/stable/)

0 commit comments

Comments
 (0)