-
Notifications
You must be signed in to change notification settings - Fork 351
GSoC25: Add proposal for Rucio WebUI project #1650
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
--- | ||
project: Rucio | ||
layout: default | ||
logo: RUCIO-logo.png | ||
description: | | ||
[Rucio](https://rucio.cern.ch/) is an open-source software framework that provides functionality to scientific collaborations to organize, manage, monitor, and access their distributed data and dataflows across heterogeneous infrastructures. Rucio was originally developed to meet the requirements of the high-energy physics experiment ATLAS, and is continuously enhanced to support diverse scientific communities. | ||
summary: | | ||
[Rucio](https://rucio.cern.ch/) is an open-source data management framework that enables scientific collaborations to efficiently organize, monitor, and access distributed data across diverse infrastructures. | ||
--- | ||
|
||
{% include gsoc_project.ext %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
--- | ||
title: Rucio WebUI Revamp | ||
layout: gsoc_proposal | ||
project: Rucio | ||
year: 2025 | ||
difficulty: medium | ||
duration: 350 | ||
mentor_avail: June-November | ||
organization: | ||
- CERN | ||
--- | ||
|
||
## Description | ||
|
||
[Rucio](https://rucio.cern.ch) is an open-source software framework that provides functionality to scientific collaborations to organize, manage, monitor, and access their distributed data and dataflows across heterogeneous infrastructures. Originally developed to meet the requirements of the high-energy physics experiment ATLAS, Rucio has been continuously enhanced to support diverse scientific communities. Since 2016, Rucio has orchestrated multiple exabytes of data access and data transfers globally. | ||
|
||
The [Rucio WebUI](https://github.com/rucio/webui) is a Next.js application utilized by various users within collaborating communities to access, monitor, and manage their distributed data. Key features of the Rucio WebUI include: | ||
|
||
- **SDK for Streaming:** Facilitates seamless data streaming from the Rucio server to page components, ensuring a responsive user interface. | ||
- **Typed in TypeScript with Generics:** Strict typing ensures code integrity and enhances development efficiency. | ||
- **Accessibility and Responsiveness:** Designed with accessibility and responsiveness in mind, ensuring usability across various devices. | ||
- **Testing and Stability:** Extensive testing ensures robustness and reliability in all components. | ||
- **Feature Toggles:** Dynamic feature toggles provide flexibility in enabling or disabling specific functionalities as needed. | ||
- **Component Library:** Utilizes Storybook and TailwindCSS to enhance development speed and consistency. | ||
|
||
## Tasks | ||
|
||
1. **Upgrade to Next.js 15, React 19, TailwindCSS 4.x:** | ||
- Migrate the existing codebase to Next.js 15 to leverage the latest features and performance improvements. | ||
- Utilize Server Side Rendering and React Query in Client Side Components to enhance data-fetching capabilities. | ||
- Migrate `tailwind.config.js` to new CSS based configuration for TailwindCSS 4.x. | ||
|
||
2. **Enhance User Experience for Site Administrators and Operators:** | ||
- Currently the WebUI focusses on List/Get views with the exception of allowing users to Create Rules. Add features to Create/Edit resources for site administrators and operational experts. | ||
- Investigate legacy views in the previous [Flask application]() and migrate them to the new WebUI. | ||
maany marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
- Redesign these views to be more user-friendly, incorporating feedback from site administrators and operators. | ||
|
||
3. **Migrate Authentication to NextAuth (Auth.js):** | ||
- Transition existing x509 and user/password authentication mechanisms to NextAuth. | ||
- Ensure compatibility with various authentication flows, including OAuth and OpenID Connect. | ||
- Develop an RBAC system to ensure users have access only to functionalities relevant to their roles, enhancing security and usability. | ||
|
||
4. **Transition to a Monorepo Structure:** | ||
- Migrate the Rucio WebUI to a monorepo structure to improve code organization and facilitate the sharing of common components across different projects. | ||
|
||
## Requirements | ||
|
||
**Mandatory:** | ||
- Proficiency in React.js and Next.js | ||
- Experience with TailwindCSS | ||
- Strong knowledge of JavaScript (ECMAScript 6) and TypeScript | ||
- Familiarity with Python 3 and Flask | ||
- Proficiency with Linux, Git, and Docker | ||
|
||
**Good to Have:** | ||
- Understanding of NX Monorepos | ||
- Experience with AGGrid Data Tables | ||
- Experience with GitHub Actions | ||
- Knowledge of HTTP REST APIs | ||
- Familiarity with OpenID Connect and x509 protocols | ||
|
||
## Expected Results | ||
|
||
By the end of GSoC 2025, we expect to have a revamped Rucio WebUI that: | ||
- Is upgraded to Next.js 15 with integrated React Query. | ||
- Utilizes both client and server-side components as per React 19's stable features. | ||
- Supports TailwindCSS 4.0 for a modern design system. | ||
- Offers enhanced user experiences tailored for site administrators and operators. | ||
- Employs NextAuth for streamlined authentication processes. | ||
- Implements a robust RBAC system. | ||
- Adopts a monorepo structure for improved code organization and component sharing. | ||
|
||
## Mentors | ||
|
||
- **[Mayank Sharma](mailto:[email protected])** (University of Michigan, Ann Arbor) | ||
- [Martin Barisits](mailto:[email protected]) (CERN) | ||
|
||
## Links | ||
|
||
1. [Rucio GitHub Repository](https://github.com/rucio/rucio) | ||
2. [Rucio UI Presentation](https://docs.google.com/presentation/d/1mXw8Xo3bknO8Ahyd6RvKlNP0OwgXdKJxz6fWiuLYOdI/edit?usp=sharing) | ||
3. [Rucio Documentation](https://rucio.readthedocs.io/en/latest/) | ||
4. [Rucio System Overview Journal Article (Springer)](https://doi.org/10.1007/s41781-019-0026-3) | ||
5. [Rucio Operational Experience Article (IEEE Computer Society)](http://sites.computer.org/debull/A20mar/p9.pdf) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,6 +8,8 @@ layout: plain | |
## Full Mentor List (Name, Email, Org) | ||
* Andy Buckley [[email protected]](mailto:[email protected]) UofGlasgow | ||
* Chris Gutschow [[email protected]](mailto:[email protected]) UCLondon | ||
* Martin Barisits [[email protected]](mailto:[email protected]) CERN | ||
* Mayank Sharma [[email protected]](mailto:[email protected]) UMich | ||
* Stephan Lachnit [[email protected]](mailto:[email protected]) DESY | ||
* Serguei Linev [[email protected]](mailto:[email protected]) GSI | ||
* Giacomo Parolini [[email protected]](mailto:[email protected]) CERN) | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.