Skip to content

Commit f4f0796

Browse files
authored
feat: adding rucio-extension authentication docs (#34)
Also bumping Docusaurus version to 3.8.0
1 parent 9a16fa5 commit f4f0796

File tree

4 files changed

+52
-5
lines changed

4 files changed

+52
-5
lines changed
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Authentication workflow
2+
3+
The following files are responsible for the authentication workflow:
4+
5+
```
6+
.
7+
├── rucio_jupyterlab
8+
│ ├── handlers
9+
│ │ ├── auth_config.py
10+
│ │ ├── handlers.py
11+
│ ├── rucio
12+
│ │ ├── authenticators.py
13+
├── src
14+
│ ├── components
15+
│ │ ├── @Settings
16+
│ │ │ ├── OIDCAuth.tsx
17+
│ │ │ ├── SettingsTab.tsx
18+
│ │ │ ├── UserPassAuth.tsx
19+
│ │ │ ├── X509Auth.tsx
20+
│ │ │ └── X509ProxyAuth.tsx
21+
│ ├── types.ts
22+
│ ├── utils
23+
│ │ ├── Actions.tsx
24+
│ │ ├── ApiRequest.ts
25+
```
26+
Below is an example of the authentication workflow:
27+
28+
![image](../../../static/img/auth-workflow.png)
29+
30+
---
31+
32+
:::tip[Improving credentials validation]
33+
Please look at: [jupyterlab-extension!71](https://github.com/rucio/jupyterlab-extension/pull/71)
34+
```
35+
Validation and authentication improvements, logging enhancements:
36+
37+
- Refactoring of the request URL construction in the API request function.
38+
- Addition of OIDC token validation with related UI and API handling.
39+
- Improved logging and error handling in authentication and handler modules.
40+
41+
```
42+
:::

package.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414
"write-heading-ids": "docusaurus write-heading-ids"
1515
},
1616
"dependencies": {
17-
"@docusaurus/core": "3.7.0",
18-
"@docusaurus/preset-classic": "3.7.0",
19-
"@docusaurus/theme-live-codeblock": "^3.7.0",
17+
"@docusaurus/core": "3.8.0",
18+
"@docusaurus/preset-classic": "3.8.0",
19+
"@docusaurus/theme-live-codeblock": "^3.8.0",
2020
"@fortawesome/fontawesome-free": "^6.7.2",
2121
"@mdx-js/react": "^3.0.0",
2222
"clsx": "^2.0.0",
@@ -25,8 +25,8 @@
2525
"react-dom": "^18.0.0"
2626
},
2727
"devDependencies": {
28-
"@docusaurus/module-type-aliases": "3.7.0",
29-
"@docusaurus/types": "3.7.0"
28+
"@docusaurus/module-type-aliases": "3.8.0",
29+
"@docusaurus/types": "3.8.0"
3030
},
3131
"browserslist": {
3232
"production": [

sidebars.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,11 @@ const sidebars = {
6363
type: 'doc',
6464
label: 'Monitoring',
6565
id: 'extensions/rucio-jupyterlab/monitoring',
66+
},
67+
{
68+
type: 'doc',
69+
label: 'Authentication workflow',
70+
id: 'extensions/rucio-jupyterlab/authentication',
6671
}
6772
],
6873

static/img/auth-workflow.png

175 KB
Loading

0 commit comments

Comments
 (0)