fixed README file
This commit is contained in:
parent
80076aa469
commit
84274bc0fd
|
|
@ -4,26 +4,24 @@
|
||||||
|
|
||||||
## Параметры
|
## Параметры
|
||||||
|
|
||||||
|
Все параметры имеют значения по-умолчанию (указаны в скобках). Поддерживаемые значения перечислены в {таких скобках}
|
||||||
|
|
||||||
| Параметр | Описание |
|
| Параметр | Описание |
|
||||||
| -------- | -------- |
|
| -------- | -------- |
|
||||||
| server_port | Начальный порт, на котором работает STCP-server
|
| server_port | Начальный порт, на котором работает STCP-server (5006)
|
||||||
| links_number | Количество линков агрегации
|
| links_number | Количество линков агрегации (8)
|
||||||
| link_start_ip_addr | Начальный адрес линков
|
| link_start_ip_addr | Начальный адрес линков (192.168.56.2)
|
||||||
| link_ip_mask | Маска линков
|
| link_ip_mask | Маска линков (255.255.255.252)
|
||||||
| internal_links_name | Шаблон имени линка
|
| ext_iface | Внешний интерфейс (eth0)
|
||||||
| ext_iface | Внешний интерфейс
|
| stcp_mode | Режим работы STCP-сервера {tun, tap, (tuntap)}
|
||||||
| stcp_mode | Режим работы STCP-сервера {tun, tap}
|
|
||||||
| stcp_runas | Имя пользователя, от которого запускается сервер
|
| stcp_runas | Имя пользователя, от которого запускается сервер
|
||||||
| use_auth | Использование аутентификации {yes, no}
|
| run_stcp | Стартовать ли сервер после деплоя {(yes), no}
|
||||||
| use_client_logging | Использование логирования подключений {yes, no}
|
| use_auth | Использование аутентификации {yes, (no)}
|
||||||
| en_tap_iface | Включение TAP-интерфейса {yes, no}
|
| use_client_logging | Использование логирования подключений {(yes), no}
|
||||||
| tap_iface_name | Имя TAP-интерфейса
|
| tap_iface_ip_addr | IP-адрес TAP-интерфейса (10.10.1.1)
|
||||||
| tap_iface_ip_addr | IP-адрес TAP-интерфейса
|
| tap_iface_ip_mask | IP-маска TAP-интерфейса (255.255.255.0)
|
||||||
| tap_iface_ip_mask | IP-маска TAP-интерфейса
|
| tun_iface_ip_addr | IP-адрес TUN-интерфейса (10.11.1.1)
|
||||||
| en_tun_iface | Включение TUN-интерфейса {yes, no}
|
| tun_iface_ip_mask | IP-маска TUN-интерфейса (255.255.255.0)
|
||||||
| tun_iface_name | Имя TUN-интерфейса
|
|
||||||
| tun_iface_ip_addr | IP-адрес TUN-интерфейса
|
|
||||||
| tun_iface_ip_mask | IP-маска TUN-интерфейса
|
|
||||||
|
|
||||||
В директории defaults/ содержится ряд дополнительных параметров. В основном это пути расположения исполняемого файла STCP-сервера, скриптов запуска и т.п., а также настройки сервера по умолчанию, их можно переопределить:
|
В директории defaults/ содержится ряд дополнительных параметров. В основном это пути расположения исполняемого файла STCP-сервера, скриптов запуска и т.п., а также настройки сервера по умолчанию, их можно переопределить:
|
||||||
```
|
```
|
||||||
|
|
@ -53,56 +51,27 @@ split_tcp_sessions: 2
|
||||||
|
|
||||||
## Применение
|
## Применение
|
||||||
|
|
||||||
Пример ansible playbook, использующего эту роль приведён ниже. В данном случае создаётся два инстанса STCP-сервера в режиме TUN c указаными параметрами.
|
Пример ansible playbook, использующего эту роль приведён ниже. В данном случае создаётся два инстанса STCP-сервера в режиме TUNTAP c указаными параметрами.
|
||||||
|
|
||||||
```
|
```
|
||||||
- name: Install fully worked (I hope) STCP server
|
- name: Install fully worked (I hope) STCP server
|
||||||
hosts: test
|
hosts: 127.0.0.1
|
||||||
|
connection: local
|
||||||
become: yes
|
become: yes
|
||||||
|
|
||||||
roles:
|
roles:
|
||||||
- role: install-stcp
|
- role: install-stcp
|
||||||
server_port: 5006
|
server_port: 5006
|
||||||
links_number: 8
|
|
||||||
link_start_ip_addr: 192.168.56.34
|
link_start_ip_addr: 192.168.56.34
|
||||||
link_ip_mask: 255.255.255.252
|
|
||||||
internal_links_name: stcp-5006-
|
|
||||||
ext_iface: eth0
|
ext_iface: eth0
|
||||||
stcp_mode: tun
|
|
||||||
stcp_runas: root
|
|
||||||
use_auth: no
|
use_auth: no
|
||||||
use_client_logging: yes
|
use_client_logging: yes
|
||||||
#stcp_tuntaps
|
|
||||||
en_tap_iface: no
|
|
||||||
tap_iface_name: 'tap_{{ stcp_instance_name }}'
|
|
||||||
tap_iface_ip_addr: 10.10.1.1
|
|
||||||
tap_iface_ip_mask: 255.255.255.0
|
|
||||||
|
|
||||||
en_tun_iface: yes
|
stcp_mode: tuntap
|
||||||
tun_iface_name: 'tun_{{ stcp_instance_name }}'
|
|
||||||
tun_iface_ip_addr: 10.11.1.1
|
tun_iface_ip_addr: 10.11.1.1
|
||||||
tun_iface_ip_mask: 255.255.255.0
|
tun_iface_ip_mask: 255.255.255.0
|
||||||
|
tap_iface_ip_addr: 10.10.1.1
|
||||||
- role: install-stcp
|
|
||||||
server_port: 4998
|
|
||||||
links_number: 8
|
|
||||||
start_ip_addr: 192.168.56.2
|
|
||||||
internal_links_name: stcp-4998-
|
|
||||||
ext_iface: eth0
|
|
||||||
stcp_mode: tun
|
|
||||||
stcp_runas: root
|
|
||||||
use_auth: no
|
|
||||||
use_client_logging: yes
|
|
||||||
#stcp_tuntaps
|
|
||||||
en_tap_iface: no
|
|
||||||
tap_iface_name: 'tap_{{ stcp_instance_name }}'
|
|
||||||
tap_iface_ip_addr: 10.10.0.1
|
|
||||||
tap_iface_ip_mask: 255.255.255.0
|
tap_iface_ip_mask: 255.255.255.0
|
||||||
|
|
||||||
en_tun_iface: yes
|
|
||||||
tun_iface_name: 'tun_{{ stcp_instance_name }}'
|
|
||||||
tun_iface_ip_addr: 10.11.0.1
|
|
||||||
tun_iface_ip_mask: 255.255.255.0
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Зависимости
|
## Зависимости
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue