Skip to content
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

docs: api documentation #463

Merged
merged 9 commits into from
Nov 1, 2023
Merged

docs: api documentation #463

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
c510ab3
refactor: api documentation
Oct 23, 2023
e2ddc1c
refactor: api documentation
Oct 23, 2023
267e60d
Merge branch 'main' of https://github.com/edgecomllc/eupf into 455-up…
Oct 24, 2023
560f4f0
refactor: api documentation
Oct 24, 2023
9daabc8
refactor: api documentation
Oct 24, 2023
143de94
Merge branch 'main' of https://github.com/edgecomllc/eupf into 455-up…
Oct 25, 2023
5b3d9df
Merge branch 'main' of https://github.com/edgecomllc/eupf into 455-up…
Oct 27, 2023
5bb803e
docs: api documentation
Oct 27, 2023
048f9ae
docs: api documentation
Oct 27, 2023
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
10 changes: 5 additions & 5 deletions cmd/core/api.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,18 @@ func CreateApiServer(bpfObjects *ebpf.BpfObjects, pfcpSrv *PfcpConnection, forwa
v1.GET("upf_pipeline", ListUpfPipeline(bpfObjects))
v1.GET("xdp_stats", DisplayXdpStatistics(forwardPlaneStats))
v1.GET("packet_stats", DisplayPacketStats(forwardPlaneStats))
config := v1.Group("config")

config := v1.Group("config")
{
config.GET("", DisplayConfig())
config.POST("", EditConfig)
}
pdrMap := v1.Group("uplink_pdr_map")

pdrMap := v1.Group("uplink_pdr_map")
{
pdrMap.GET(":id", GetUplinkPdrValue(bpfObjects))
pdrMap.PUT(":id", SetUplinkPdrValue(bpfObjects))
}
}

qerMap := v1.Group("qer_map")
{
Expand Down
109 changes: 94 additions & 15 deletions docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,104 @@ In addition to prometheus metrics the eUPF API provides a set of endpoints for m

## Endpoints

- **GET /api/v1/upf_pipeline**: Lists the UPF pipeline.
- Returns contents of upf pipeline (loaded ebpf programs)
- Example: `GET /api/v1/upf_pipeline`
| Method | URL | Description | Example |
|--------|----------------------------------|---------------------------------------------------------------------------------|----------------------------------|
| `GET` | `/api/v1/upf_pipeline` | Lists the UPF pipeline. Returns contents of upf pipeline (loaded ebpf programs) | `/api/v1/upf_pipeline` |
| `GET` | `/api/v1/xdp_stats` | Displays the XDP statistics. Returns an object of `XdpStats` | `/api/v1/xdp_stats` |
| `GET` | `/api/v1/packet_stats` | Displays the PACKET statistics. Returns an object of `PacketStats` | `/api/v1/packet_stats` |

- **GET /api/v1/qer_map**: Lists the QER map content.
- Returns a list of `QerMapElement`.
- Example: `GET /api/v1/qer_map`

- **GET /api/v1/pfcp_associations**: Lists the PFCP associations.
- Returns an object of `NodeAssociationMap`.
- Example: `GET /api/v1/pfcp_associations`
#### - QER map

- **GET /api/v1/config**: Displays the configuration.
- Returns an object of `UpfConfig`.
- Example: `GET /api/v1/config`
| Method | URL | Description | Example |
|--------|---------------------------------|---------------------------------------------------------------------------------|---------------------|
| `GET` | `/api/v1/qer_map` | Lists the QER map content. Returns a list of `QerMapElement` | `/api/v1/qer_map` |
| `GET` | `/api/v1/qer_map/:id` | Get QER map element by id. Returns an object of `QerMapElement` | `/api/v1/qer_map/1` |
| `PUT` | `/api/v1/qer_map/:id` | Set values for QER map element by id. Returns a list of `QerMapElement` | `/api/v1/qer_map/1` |

- **GET /api/v1/xdp_stats**: Displays the XDP statistics.
- Returns an object of `XdpStats`.
- Example: `GET /api/v1/xdp_stats`
[PUT] Example request body:

{
"gate_status_ul": 0,
"gate_status_dl": 0,
"qfi": 0,
"max_bitrate_ul": 200000000,
"max_bitrate_dl": 100000000
}

#### - Config

| Method | URL | Description | Example |
|--------|----------------------------------|---------------------------------------------------------------------------------|------------------------|
| `GET` | `/api/v1/config` | Displays the configuration. Returns an object of `UpfConfig` | `/api/v1/config` |
| `POST` | `/api/v1/config` | Set configuration values | `/api/v1/config` |

[POST] Example request body:

{
"interface_name": [
"eth0",
"eth1"
],
"xdp_attach_mode": "generic",
"api_address": "8080",
"pfcp_address": "10.100.200.14:8805",
"pfcp_node_id": "10.100.200.14",
"metrics_address": ":9090",
"n3_address": "10.100.200.14",
"qer_map_size": 1024,
"far_map_size": 1024,
"pdr_map_size": 1024,
"resize_ebpf_maps": false,
"heartbeat_retries": 3,
"heartbeat_interval": 5,
"heartbeat_timeout": 5,
"logging_level": "info"
}



#### - Uplink PDR

| Method | URL | Description | Example |
|--------|----------------------------------|---------------------------------------------------------------------------------|----------------------------|
| `GET` | `/api/v1/uplink_pdr_map/:id` | Get Uplink PDR values by id. Returns an object of `PdrElement` | `/api/v1/uplink_pdr_map/1` |
| `PUT` | `/api/v1/uplink_pdr_map/:id` | Set Uplink PDR values by id. Returns a new object of `PdrElement` | `/api/v1/uplink_pdr_map/1` |

[PUT] Example request body:

{
"outer_header_removal": 0,
"far_id": 0,
"qer_id": 0
}

#### - FAR map

| Method | URL | Description | Example |
|--------|---------------------------------|---------------------------------------------------------------------------------|---------------------|
| `GET` | `/api/v1/far_map/:id` | Get FAR map element by id. Returns an object of `FarMapElement` | `/api/v1/far_map/1` |
| `PUT` | `/api/v1/far_map/:id` | Set values for FAR map element by id. Returns a new object of `FarMapElement` | `/api/v1/far_map/1` |

[PUT] Example request body:

{
"action": 0,
"outer_header_creation": 0,
"teid": 0,
"remote_ip": 0,
"local_ip": 0,
"transport_level_marking": 0
}


#### - PFCP associations

| Method | URL | Description | Example |
|--------|----------------------------------|---------------------------------------------------------------------------------|----------------------------------|
| `GET` | `/api/v1/pfcp_associations` | Lists the PFCP associations. Returns an object of `NodeAssociationMap` | `/api/v1/pfcp_associations` |
| `GET` | `/api/v1/pfcp_associations/full` | Lists the full PFCP associations. Returns an object of `NodeAssociationMap` | `/api/v1/pfcp_associations/full` |
| `GET` | `/api/v1/pfcp_sessions` | Lists the PFCP sessions content. Returns a list of `Session` | `/api/v1/pfcp_sessions` |

## Swagger API Documentation

Expand Down