Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/tech-docs/cluster-setup/kubernetes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
> 🚧 May 2025: Under construction
1 change: 1 addition & 0 deletions docs/tech-docs/cluster-setup/openstack.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
> 🚧 May 2025: Under construction
8 changes: 3 additions & 5 deletions docs/tech-docs/home.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
# CERN VRE Technical Documentation


Welcome to the CERN Virtual Research Environment (VRE) technical documentation!

<center>
<div class="vre-cern-docs">
<img src="/img/vre-cern-docs.png" />
</div>
</center>

# CERN VRE Technical Documentation
Welcome to the CERN Virtual Research Environment (VRE) technical documentation!

In these pages you will be able to find detailed documentation of how the VRE infrastrucutre is set up. Please make use of the lateral sidebar to navigate through the different sections.
In these pages you will be able to find detailed documentation of how the VRE infrastructure is set up. Please make use of the lateral sidebar to navigate through the different sections.

If you are looking for the GitHub repository of VRE infrastructure visit this [page](https://github.com/vre-hub/vre). If you want to improve the content of this documentation and you are looking for the VRE documentation repository, click [here](https://github.com/vre-hub/vre-hub.github.io).

Expand Down
50 changes: 26 additions & 24 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -89,30 +89,32 @@ const config = {
to: '/team',
label: 'About us',
},

{
type: 'doc', // This is a preset regarding the type of document, please update if needed
docId: 'auth', // The ID of the corresponding document. This should match with what you wrote in the document header.
position: 'left',
label: 'AAI', // The title that will appear on the menu
},
{
type: 'doc', // This is a preset regarding the type of document, please update if needed
docId: 'rucio', // The ID of the corresponding document. This should match with what you wrote in the document header.
position: 'left',
label: 'Rucio', // The title that will appear on the menu
},
{
type: 'doc', // This is a preset regarding the type of document, please update if needed
docId: 'reana', // The ID of the corresponding document. This should match with what you wrote in the document header.
position: 'left',
label: 'REANA', // The title that will appear on the menu
},
{
type: 'doc', // This is a preset regarding the type of document, please update if needed
docId: 'notebook', // The ID of the corresponding document. This should match with what you wrote in the document header.
position: 'left',
label: 'JupyterHub', // The title that will appear on the menu
type: 'dropdown',
label: 'The VRE components', // The ID of the corresponding document. This should match with what you wrote in the document header.
position: 'left',
items: [
{
type: 'doc', // This is a preset regarding the type of document, please update if needed
docId: 'auth', // The ID of the corresponding document. This should match with what you wrote in the document header.
label: 'AAI', // The title that will appear on the menu
},
{
type: 'doc', // This is a preset regarding the type of document, please update if needed
docId: 'rucio', // The ID of the corresponding document. This should match with what you wrote in the document header.
label: 'Rucio', // The title that will appear on the menu
},
{
type: 'doc', // This is a preset regarding the type of document, please update if needed
docId: 'reana', // The ID of the corresponding document. This should match with what you wrote in the document header.
label: 'REANA', // The title that will appear on the menu
},
{
type: 'doc', // This is a preset regarding the type of document, please update if needed
docId: 'notebook', // The ID of the corresponding document. This should match with what you wrote in the document header.
label: 'JupyterHub', // The title that will appear on the menu
},
],
},
// {
// type: 'doc', // This is a preset regarding the type of document, please update if needed
Expand Down Expand Up @@ -146,7 +148,7 @@ const config = {
type: 'doc',
docId: 'tech-docs/home',
position: 'left',
label: 'Technical Documentation'
label: 'Dev Documentation'
}
],
},
Expand Down
6 changes: 3 additions & 3 deletions src/pages/LatestNews.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ const newsItems = [
title: 'Data discovery, analysis and reproducibility in Virtual Research Environments ', // this is what I would see indented below its parent contribution. NOT IMPORTANT !
authors: 'E. Garcia-Garcia, G. Guerrieri, et al.',
links: [{ text: 'CHEP 2024 proceedings', url: 'https://arxiv.org/abs/2503.02483/' }],
iconType: 'file',
iconType: 'book-open',
type: 'proceedings',
},
{
Expand All @@ -49,7 +49,7 @@ const newsItems = [
authors: 'E. Gazzarrini, E. Garcia Garcia, D. Gosein, and X. Espinal',
journal: 'EPJ Web of Conferences 295, 08023 (2024)',
links: [{ text: 'CHEP 2023 proceedings', url: 'https://doi.org/10.1051/epjconf/202429508023/' }],
iconType: 'file',
iconType: 'book-open',
type: 'proceedings',
},
{
Expand All @@ -74,7 +74,7 @@ const newsItems = [
title: 'The Virtual Research Environment: towards a comprehensive analysis platform',
authors: 'E. Gazzarrini, E. Garcia, D. Gosein, A. Vendrell Moya, A. Kounelis, and X. Espinal',
links: [{ text: 'ACAT 2022 proceedings', url: 'https://indico.cern.ch/event/1106990/papers/4991200/files/12795-The_VRE___ACAT22_Proceedings.pdf' }],
iconType: 'file',
iconType: 'book-open',
type: 'proceedings',
},
{
Expand Down
46 changes: 23 additions & 23 deletions src/pages/index.mdx
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
import LatestNews from './LatestNews'

**🟩 Experiencing issues? Check the [service uptime status page](https://vre-hub.github.io/status) 🟩**
<center>
<div class="vre-cern-docs">
<img src="/img/logo-vre-repo.png" />
</div>
</center>

# The Virtual Research Environment
![Dynamic YAML Badge](https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fvre-hub%2Fvre%2Frefs%2Fheads%2Fmain%2Finfrastructure%2Fcluster%2Fflux%2Fjhub%2Fjhub-release.yaml&query=%24.spec.chart.spec.version&label=JupyterHub%20release&color=%23e66a2d)
![Dynamic YAML Badge](https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fvre-hub%2Fvre%2Frefs%2Fheads%2Fmain%2Finfrastructure%2Fcluster%2Fflux%2Freana%2Freana-release.yaml&query=%24.spec.chart.spec.version&label=Reana%20release&color=%23fd3337)
![Dynamic YAML Badge](https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fvre-hub%2Fvre%2Frefs%2Fheads%2Fmain%2Finfrastructure%2Fcluster%2Fflux%2Frucio%2Frucio-servers.yaml&query=%24.spec.values.image.tag&label=Rucio%20release&color=%23474986)
![Dynamic YAML Badge](https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fvre-hub%2Fvre%2Frefs%2Fheads%2Fmain%2Finfrastructure%2Fcluster%2Fflux%2Frucio%2Frucio-servers.yaml&query=%24.spec.chart.spec.version&label=Rucio%20helm%20charts)

# The Virtual Research Environment

Access the VRE platform at https://jhub-vre.cern.ch!

The Virtual Research Environment is an analysis platform developed at **CERN** serving the needs of scientific communities involved in European Projects.
Expand All @@ -17,37 +20,34 @@ The platform's development is aimed at demonstrating how sciences spanning from

The Virtual Research Environment’s main components are:

![image](../../static/img/vre-bubble.png)

1. A federated and reliable **Authentication and Authorization** layer
2. A **federated distributed storage** solution (the ESCAPE Data Lake), providing functionalities for data injection and replication through a Data Management framework (Rucio)
3. A **computing** cluster supplying the processing power to run full analyses with Reana, a re-analysis software
4. An enhanced **notebook interface** with containerised environments to hide the infrastructure’s complexity from the user.
1. **[AAI](/docs/auth)**: A federated and reliable **Authentication and Authorization** layer
2. **[The Rucio Data Lake](/docs/rucio)**: A **federated distributed storage** solution (the ESCAPE Data Lake), providing functionalities for data injection and replication through a Data Management framework (Rucio)
3. **[Reana](/docs/reana)**: A **computing** cluster supplying the processing power to run full analyses with Reana, a re-analysis software
4. **[JupyterHub](/docs/notebook)**: An enhanced **notebook interface** with containerised environments to hide the infrastructure’s complexity from the user.

![image](../../static/img/VRE-diagram.png)

The deployment of the Virtual Research Environment is open-source and modular, in order to make it easily reproducible by partner institutions; it is publicly accessible and kept up to date by taking advantage of state of the art IT-infrastructure technologies.

The Science Projects which are using the VRE are described [here](https://escape2020.pages.in2p3.fr/virtual-environment/home/).
## Contact
To contact the CERN VRE team with questions, doubts, problems accessing the meetings Indico category or the monitoring dashboards, please join the **[Mattermost channel](https://mattermost.web.cern.ch/signup_user_complete/?id=zqaa9p5fqfd9bnnc64at4b5aye&md=link&sbr=su)**. <br/>
For more formal requests, i.e. conferences, webinars and events presentations, please email us at *escape-cern-ops 'at' cern.ch*.

If you are a scientist or a new user curious to use the above resources, please refer to the following documentation:
1. **[AAI](/docs/auth)**
2. **[Rucio Data Lake](/docs/rucio)**
3. **[Reana cluster](/docs/reana)**
4. **[Notebook service](/docs/notebook)**
## Join the community

## Developers
#### The ESCAPE Science projects repository
The Science Projects which are using the VRE are described [here](https://escape2020.pages.in2p3.fr/virtual-environment/home/).

If you want to deploy the VRE on your own infrastructure, or if you want to submit an issue to help us improve the platform, please follow the [developer documentation](https://vre-hub.github.io/docs/tech-docs/home#how-to-contribute).

## Contact
To contact the CERN VRE team with questions, doubts, problems accessing the meetings Indico category or the monitoring dashboards, please join the **[Mattermost channel](https://mattermost.web.cern.ch/signup_user_complete/?id=zqaa9p5fqfd9bnnc64at4b5aye&md=link&sbr=su)**. For more formal requests, i.e. conferences, webinars and events presentations, please email us at *escape-cern-ops 'at' cern.ch*.
#### The VRE coordination meeting
We have a recurrent meeting open to all scientists/researchers/developers interested in the VRE or who are supporting scientific infrastructures.

## Join the community
There are is a recurrent meetings open to all scientists/researchers/developers interested in the VRE.
**What do we discuss:**
- Latest news and updates on the VRE technical infrastructure and use cases
- Engagement with European projects and funding possibilities
- Design, support, and operation of VREs for communities involved in the ESCAPE Collaboration, and beyond!

- The **VRE working-group monthly meetings** are intended for developers and system administrators who are supporting scientific infrastructures. They constitute an informal space to stimulate discussion and keep all the members up to date with the latest news and hot topics on the development and deployment of tools and services within the broad field of scientific analysis platforms. Join [here](https://indico.cern.ch/category/17065/).
See [our meetings agenda](https://indico.cern.ch/category/17065/).

## Latest News
<LatestNews />

7 changes: 0 additions & 7 deletions src/pages/markdown-page.md

This file was deleted.

1 change: 1 addition & 0 deletions src/pages/team.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ const TeamPage = () => {
<Layout title="Team" description="Meet the team behind the project.">
<section className={styles.teamSection}>
<div className={styles.container}>
<img src={require('@site/static/img/vre-team.png').default} alt="VRE Team photo" />
<h1 className={styles.title}>The ESCAPE VRE Team</h1>
{teamMembers.map((person, idx) => (
<div key={idx} className={styles.personCard}>
Expand Down
Binary file modified static/img/VRE-diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/favicon.ico
Binary file not shown.
Binary file modified static/img/logo-vre-repo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/vre-cern-docs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/vre-team.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.