You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In this PR:
- added `services/devportal` as documentation for the Developer Portal
(before attached to FirecREST docs)
- Updated list of github users as `CODEOWNERS` of `firecrest` and
`devportal`
- Moved images from `firecrest` to `services` with the prefix
`devportal-*`
https://docs.tds.cscs.ch/251/services/devportal/#creating-an-application
---------
Co-authored-by: jdorsch <[email protected]>
Copy file name to clipboardExpand all lines: docs/access/firecrest.md
+9-71Lines changed: 9 additions & 71 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,9 +3,9 @@
3
3
4
4
FirecREST is a RESTful API for programmatically accessing High-Performance Computing resources, developed at CSCS.
5
5
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.
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 orchestrators](https://eth-cscs.github.io/firecrest-v2/use_cases/workflow-orchestrator/), and other tools against HPC resources.
7
7
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.
8
+
Additionally, scientific platform developers can integrate FirecREST into [web-enabled portals](https://eth-cscs.github.io/firecrest-ui/home/) and [web UI applications](https://eth-cscs.github.io/firecrest-v2/use_cases/UI-client-credentials/), allowing them to securely access authenticated and authorized CSCS services such as job submission and data transfer on HPC systems.
9
9
10
10
Users can make HTTP requests to perform the following operations:
11
11
@@ -55,7 +55,7 @@ FirecREST is available for all three major [Alps platforms][ref-alps-platforms],
55
55
56
56
### Clients and access tokens
57
57
58
-
For authenticating requests to FirecREST, **client applications** use an **access token** instead of directly using the user's credentials.
58
+
For authenticating requests to FirecREST, [client applications][ref-devportal-application] use an **access token** instead of directly using the user's credentials.
59
59
The access token is a signed JSON Web Token ([JWT](https://jwt.io/introduction)) which contains user information and is only valid for a short time (5 minutes).
60
60
Behind the API, all commands launched by the client will use the account of the user that registered the client, inheriting their access rights.
61
61
@@ -65,77 +65,14 @@ Every client has a client ID (Consumer Key) and a secret (Consumer Secret) that
65
65
```
66
66
curl -s -X POST https://auth.cscs.ch/auth/realms/firecrest-clients/protocol/openid-connect/token\
67
67
--data "grant_type=client_credentials" \
68
-
--data "client_id=<your_client>" \
69
-
--data "client_secret=<your_secret>"
68
+
--data "client_id=<client_id>" \
69
+
--data "client_secret=<client_secret>"
70
70
```
71
71
72
72
You can manage your client application on the [CSCS Developer Portal][ref-devportal].
73
73
74
-
[](){#ref-devportal}
75
-
### CSCS Developer Portal
76
74
77
-
The [Developer Portal](https://developer.cscs.ch) facilitates CSCS users to manage subscriptions to an API at CSCS (such as FirecREST v1/v2).
78
-
79
-
Start by browsing to [developer.cscs.ch](https://developer.cscs.ch), then sign in by clicking the "SIGN-IN" button on the top right hand corner of the page.
80
-
81
-
Once logged in, you will see a list of APIs that are available to your user.
82
-
83
-
!!! Warning
84
-
You might not see version 1 or version 2 of some API. You will be able to see all the versions when you *subscribe* your Application to the API.
85
-
86
-
### Creating an Application
87
-
88
-
Click on the "Applications" button at the top of the screen to manage your Applications.
89
-
90
-

91
-
92
-
To create a new application, click on the "ADD NEW APPLICATION" button at the top of the Applications page, and complete the mandatory fields (marked with `*`).
93
-
Make sure to give the application a unique name and select the number of requests per minute.
94
-
When finished, click on the "Save" button.
95
-
96
-
!!! note
97
-
To subscribe to an API you need at least one application, for which it is possible to use the DefaultApplication.
98
-
99
-
!!! note
100
-
The quota of requests per minute will be shared by all subscribers to the Application over all APIs.
101
-
102
-
### Configuring Production Keys
103
-
104
-
Once the Application is created, create the Production Keys (`Client ID` and `Client Secret`) by clicking on "Production Keys"
105
-
106
-

107
-
108
-
109
-
Use this if this is your first FirecREST application, or if you wish to create new keys.
110
-
111
-
* click on the "Generate Keys" button at the bottom of the page
0 commit comments