Skip to content

Add information on EndPoint exposure strategy #37

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.

Sign up for GitHub

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

Open
freddidierRTE wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add information on EndPoint exposure strategy #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
29 changes: 29 additions & 0 deletions architecture/EndPointsExposureStrategy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Endpoints Exposure Strategy

The backend of the application is built on a micro-services architecture. To maintain control over external access, only a selected set of endpoints are exposed to the outside world and front-end applications.

## Principles

- All external connections are routed through a gateway, which serves as the sole entry point to the application. The gateway handles request routing and authentication.
- Only specific micro-services expose their endpoints via the gateway. These micro-services are responsible for enforcing user authorization.
- User authorization rules are defined in the User Admin Server for group definitions and in the Directory Server for access rights on resources (Read, Write, Manage), either by user or by group*.
- The exposed endpoints are consumed by both front-end applications and external clients (no separate gateway exists for external applications).
Comment thread
freddidierRTE marked this conversation as resolved.
- The endpoints of the form `/v<n>/supervision/**` are not accessible from outside; they are maintenance endpoints. The filtering is done in the gateway.

This strategy is not yet fully implemented, work is in progress.

*This is the current situation; it may be possible in the future to add new services for other business authorization needs.


## Micro-Services Exposed via the Gateway

- Case Import Server
- Config Notification Server
- Config Server
- Directory Notification Server
- Dynamic Mapping Server
- Explore Server
- Monitor Server
- Study Notification Server

@antoinebhs antoinebhs Sep 9, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

monitor notification server too

- Study Server
- User Admin Server
2 changes: 2 additions & 0 deletions architecture/MicroServices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ You can find here a diagram of the micro-services of the application. The diagra

Some of the micro-services used by gridsuite are PowSyBl micro-services.

Not all the micro-services are exposed to the outside world. Only a selected set of endpoints are exposed to the outside world and front-end applications. For more details, see [Endpoints Exposure Strategy](EndPointsExposureStrategy.md).

### PowSyBl micro-services

#### Network store server
Expand Down