Skip to content

Commit

Permalink
style(docs): fix trailing whitespace in several files (#582)
Browse files Browse the repository at this point in the history
  • Loading branch information
pespin authored Dec 16, 2024
1 parent 44cfbf6 commit 3c747b2
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 25 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,11 +209,11 @@ go generate -v ./cmd/...
Sometimes during this step you may see errors like:
```
running "swag": exec: "swag": executable file not found in $PATH
```
```

Make sure that `swag` was successfuly installed(step 1) and path to swag binary is in the PATH environment variable.
Make sure that `swag` was successfuly installed(step 1) and path to swag binary is in the PATH environment variable.

Usually GO Path is supposed to already be on the PATH environment variable.
Usually GO Path is supposed to already be on the PATH environment variable.
Use `export PATH=$(go env GOPATH)/bin:$PATH` otherwise and repeat current step again.


Expand Down
6 changes: 3 additions & 3 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ In addition to prometheus metrics the eUPF API provides a set of endpoints for m

[PUT] Example request body:

{
{
"gate_status_ul": 0,
"gate_status_dl": 0,
"qfi": 0,
Expand Down Expand Up @@ -65,7 +65,7 @@ In addition to prometheus metrics the eUPF API provides a set of endpoints for m

| 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` |
| `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:
Expand Down Expand Up @@ -109,7 +109,7 @@ To explore and test the API, you can use the Swagger API documentation. To acces

- GET /swagger/index.html

## API docs generation
## API docs generation
(Reference documentation)[https://github.com/swaggo/gin-swagger]
```bash
go install github.com/swaggo/swag/cmd/[email protected]
Expand Down
2 changes: 1 addition & 1 deletion docs/docs-ru_ru/Configuration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Конфигурация UPF

## Описание
## Описание

В настоящее время UPF имеет несколько параметров конфигурации, показанных ниже.<br>Параметры можно настроить через интерфейс командной строки, файлы конфигурации (YAML, JSON) или переменные среды.

Expand Down
12 changes: 6 additions & 6 deletions docs/docs-ru_ru/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ networks:
```
</details>
### Укажите конфигурационные параметры eUPF
### Укажите конфигурационные параметры eUPF
Смотрите [configuration guide](Configuration.md)
Expand Down Expand Up @@ -141,9 +141,9 @@ docker-compose up -d
kubelet_node_config_extra_args:
allowedUnsafeSysctls:
- "net.ipv4.ip_forward"
```
```
</p>
</details>
</details>
## Маршрутизация подсетей UE
Expand Down Expand Up @@ -202,7 +202,7 @@ UE может отправить пакет в Интернет и получи

<b>Ожидаемый результат:</b>

успешное выполнение команды ping
успешное выполнение команды ping

# Поддержка

Expand Down Expand Up @@ -232,7 +232,7 @@ sergo@edgecom:~$ sudo cat /sys/kernel/debug/tracing/trace_pipe
```

</p>
</details>
</details>

## Подключение журналы компонентов:
<details><summary>Успешные соединения eUPF в выводе журналов (stdout)</summary>
Expand Down Expand Up @@ -512,7 +512,7 @@ traceroute to www.google.com (74.125.205.99), 30 hops max, 46 byte packets
</p>
</details>

## Отключите UE
## Отключите UE

<details><summary>Отключение UERANSIM UE:</summary>
<p>
Expand Down
12 changes: 6 additions & 6 deletions docs/docs-ru_ru/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ eUPF был протестирован с тремя различными ядр
Быстрый и простой способ — загрузить и запустить наш докер-образ. Будет запущен автономный eUPF с конфигурацией по умолчанию.:
```bash
sudo docker run -d --rm --privileged \
-v /sys/fs/bpf:/sys/fs/bpf \
-v /sys/fs/bpf:/sys/fs/bpf \
-v /sys/kernel/debug:/sys/kernel/debug:ro \
-p 8080 -p 9090 --name your-eupf-def \
ghcr.io/edgecomllc/eupf:main
Expand Down Expand Up @@ -60,7 +60,7 @@ sudo docker run -d --rm --privileged \

```bash
sudo docker run -d --rm -v --privileged \
-v /sys/fs/bpf:/sys/fs/bpf \
-v /sys/fs/bpf:/sys/fs/bpf \
-v /sys/kernel/debug:/sys/kernel/debug:ro \
-p 8081 -p 9091 --name your-eupf-custom \
-e UPF_INTERFACE_NAME=[eth0,n6] -e UPF_XDP_ATTACH_MODE=generic \
Expand Down Expand Up @@ -93,7 +93,7 @@ eUPF полагается на маршрутизацию ядра при при

### Краткое описание функций

#### Поддержка FAR
#### Поддержка FAR

eUPF поддерживает правила FAR в PDR. Поддерживается только одно правило FAR для каждого PDR.

Expand All @@ -105,7 +105,7 @@ eUPF поддерживает правила QER в PDR. В настоящее

eUPF может применять фильтры SDF в PDR. В настоящее время поддерживается только один фильтр SDF для каждого туннеля GTP.

#### Управление GTP
#### Управление GTP

eUPF поддерживает отправку запросов GTP Echo к соседним узлам GTP. Каждый соседний узел GTP должен быть явно настроен с использованием параметра конфигурации `gtp_peer`.

Expand Down Expand Up @@ -216,9 +216,9 @@ go generate -v ./cmd/...
При выполнении команды может возникнуть ошибка:
```
running "swag": exec: "swag": executable file not found in $PATH
```
```

В этом случае нужно убедиться, что утилита `swag` была успешно установлена на шаге 1. Кроме того, нужно убедиться, что путь к исполняемому файлу `swag`` прописан в переменной окружения PATH.
В этом случае нужно убедиться, что утилита `swag` была успешно установлена на шаге 1. Кроме того, нужно убедиться, что путь к исполняемому файлу `swag`` прописан в переменной окружения PATH.

Обычно путь к исполняемым файлам Go уже прописан в PATH. Если это не так, то его можно прописать командой `export PATH=$(go env GOPATH)/bin:$PATH` и повторить текущй шаг.

Expand Down
12 changes: 6 additions & 6 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Native mode is suppored in most modern clouds and VM NICs:

#### Drivers supporting XDP offload

Only Netronome NICs at the moment
Only Netronome NICs at the moment

# Deploy with docker-compose

Expand Down Expand Up @@ -141,9 +141,9 @@ In our environments, we use one node K8s cluster deployed by means of [kubespray
kubelet_node_config_extra_args:
allowedUnsafeSysctls:
- "net.ipv4.ip_forward"
```
```
</p>
</details>
</details>
## UE subnets routing
Expand All @@ -160,9 +160,9 @@ This solution is suitable for single instance eUPF deployment.
### Use static routes
To use scalable eUPF deployment (more the one eUPF replica) downlink route to specific UE have to pass the UPF with corresponding PDU-session.
To use scalable eUPF deployment (more the one eUPF replica) downlink route to specific UE have to pass the UPF with corresponding PDU-session.
As a proof-of-concept, simple route utility is provided. The utility reads active PDU-sessions for every UPF via API and updates node's routing table. For each UE's PDU-session there is a static route via corresponding UPF.
As a proof-of-concept, simple route utility is provided. The utility reads active PDU-sessions for every UPF via API and updates node's routing table. For each UE's PDU-session there is a static route via corresponding UPF.
## Examples
Expand Down Expand Up @@ -233,7 +233,7 @@ sergo@edgecom:~$ sudo cat /sys/kernel/debug/tracing/trace_pipe
```

</p>
</details>
</details>

## Components logs then successfully connected:
<details><summary>eUPF successfull connections log output (stdout)</summary>
Expand Down

0 comments on commit 3c747b2

Please sign in to comment.