Во введении к предыдущей главе мы уже примерно поняли Apache APISIX Основная конструкция и установка. На этот раз мы подробно объясним его настройку и покажем, как использовать администратор. API Выполните управление маршрутизацией.
01. Подробное объяснение конфигурации
Давайте возьмем конфигурацию APISIX ConfigMap из предыдущей главы, чтобы интерпретировать ее. Конфигурация APISIX называется файлом config.yaml, который обычно находится по адресу /usr/local/apisix/conf/config.yaml. Конфигурация ключей следующая:
apisix: # Универсальный Конфигурация node_listen: # APISIX Порт прослушивания, порт по умолчанию — 9080.
- 9080
enable_heartbeat: true # Включить проверку пульса
enable_admin: true # Включить управление API
enable_admin_cors: true # Разрешить управление запросами совместного использования ресурсов между источниками (CORS) API
enable_debug: false # Отключить режим отладки
enable_dev_mode: false # Если установлено значение правда, тогда nginx worker_processes установлен на 1
enable_reuseport: true # Если установлено значение правда, затем включите nginx из SO_REUSEPORT выключатель
enable_ipv6: true # давать возможность nginx IPv6 Поддержка парсинга
enable_http2: true # давать возможность HTTP/2
enable_server_tokens: true # лисуществовать Server Отображается в заголовке ответа APISIX номер версии
proxy_cache: # прокси-кэш Конфигурация
cache_ttl: 10s # Если восходящий поток не указывает время кэширования,тогда по умолчаниюиз Время кэширования
zones: # Область и параметры кэша
- name: disk_cache_one # Имя кэша,Администраторы могутпроходитьимясуществоватьуправлять API Укажите, какой кэш использовать в
memory_size: 50m # Размер общей памяти,Используется для хранения индекса кэша
disk_size: 1G # дискизразмер,Используется для хранения кэшированных данных
disk_path: "/tmp/disk_cache_one" # Хранить данные кэша по пути
cache_levels: "1:2" # Иерархическая структура кэша
router: # маршрутизация Конфигурация
http: radixtree_host_uri # Используйте деревья на основе системы счисленияизалгоритм,проходить host и uri Объединить для соответствия маршрутизации
ssl: 'radixtree_sni' # Используйте деревья на основе системы счисленияизалгоритм,проходить SNI (Server Name Indication) соответствовать SSL/TLS Запросить измаршрутизацию
proxy_mode: http # актерское мастерствомодель,установлен наhttp
stream_proxy: # TCP/UDP актерское мастерство
tcp: # TCP актерское список портов мастерства
- 9100
udp: # UDP актерское список портов мастерства
- 9200
ssl:
enable: false # лидавать возможность SSL Функция
listen:
- port: 9443 # SSL порт прослушивания
enable_http3: false # лидавать возможность HTTP/3
ssl_protocols: "TLSv1.2 TLSv1.3" # давать возможностьиз SSL Версия протокола
ssl_ciphers: "..." # поддерживатьиз Список наборов шифров
nginx_config:
error_log: "/dev/stderr" # Расположение вывода журнала ошибок
error_log_level: "warn" # Уровень журнала ошибок
worker_processes: "auto" # Количество рабочих процессов
enable_cpu_affinity: true # давать возможность CPU Близость
worker_rlimit_nofile: 20480 # Максимальное количество файловых дескрипторов для одного рабочего процесса
event:
worker_connections: 10620 # Максимальное количество клиентских подключений для одного рабочего процесса
http:
enable_access_log: true # давать Возможность Доступ к журналу
access_log: "/dev/stdout" # Доступ к месту вывода журнала
access_log_format: '...' # Формат журнала доступа
access_log_format_escape: default # Доступ к настройкам выхода журнала
keepalive_timeout: "60s" # Оставайтесь на связи даже при максимальном времени простоя
client_header_timeout: 60s # Тайм-аут чтения заголовка запроса клиента
client_body_timeout: 60s # Тайм-аут чтения тела запроса клиента
send_timeout: 10s # Тайм-аут отправки ответа
underscores_in_headers: "on" # Разрешить использование в заголовках запросов подчеркивания
real_ip_header: "X-Real-IP" # Используется для получения реального клиента IP из заголовка запроса
real_ip_from: # заслуживающий доверия IP список источников
- 127.0.0.1
- 'unix:'
deployment:
role: traditional # Определение роли развертывания в традиционном режиме обычно означает прямое подключение к хранилищу конфигурации (например, etcd).
role_traditional:
config_provider: etcd # Укажите данные конфигурации от провайдера,etcd используется здесь как центр конфигурации.
admin:
allow_admin:
- 127.0.0.1/24 # Разрешить доступ администратору из локальной сети из API。
- 0.0.0.0/0 # разрешено с любогоIPиздоступ,предположениесуществовать Ограничьте это в производственных средах.настраиватьдля улучшения безопасности。
admin_listen:
ip: 0.0.0.0 # Admin API прослушивания IP-адреса,0.0.0.0выражатьмониторвсеIPадрес。
port: 9180 # Admin APIмониторизпорт。
admin_key:
- name: "admin"
key: edd1c9f034335f136f87ad84b625c8f1 # Ключ администратора следует изменить в производственной среде для обеспечения безопасности.
role: admin # Роль администратора,Иметь полныйиз Административные разрешения。
- name: "viewer"
key: 4054f7cf07e344346cd3f287985e76a2 # Ключи средства просмотра следует менять в производственных средах для обеспечения безопасности.
role: viewer # Роль просмотра может только просматривать данные конфигурации.
etcd:
host:
- "http://apisix-etcd.apisix.svc.cluster.local:2379" # etcdСлужитьизадрес,поддерживать Конфигурация Несколькоадресдля достижения высокой доступности。
prefix: "/apisix" # etcdиспользуется для хранения вAPISIXКонфигурацияданныеизпрефикс。
timeout: 30 # Связь с etcd по таймауту,Единица измерения — секунды.
02. Маршрутизация управления API администратора
APISIX Admin API — это API-интерфейс для управления конфигурацией шлюза APISIX. Через API администратора мы можем динамически добавлять, изменять или удалять конфигурации маршрутизации, службы, потребителя и другие конфигурации без перезапуска службы. Это делает APISIX идеальным для использования в динамических средах, таких как непрерывное развертывание и архитектуры микросервисов.
Добавить маршрут
пройти Admin API Добавить маршрут, могу отправить POST просил /apisix/admin/routes. Ниже приведен пример запроса, определяющего маршрут, который маршрутизирует все /hello Перенаправить запрос указанной вышестоящей службе.
POST /apisix/admin/routes HTTP/1.1
Host: <Admin_API_Host>:9180
Content-Type: application/json
X-API-KEY: <Your_Admin_API_Key>
{
"uri": "/hello",
"methods": ["GET", "POST"], # позволятьпроходитьGETиPOSTметоддоступ
"upstream": {
"type": "roundrobin", # Используйте циклическую балансировку нагрузки
"nodes": {
"192.168.1.101:80": 1 # Адрес вышестоящего сервера и его вес
}
}
}
Изменить маршрут
Изменить Маршрутиз работает аналогично,Но вам нужно знать, чтобы изменить идентификатор измаршрутизации. первый,Можетпроходить GET Запрашивает список всех маршрутов, чтобы найти идентификатор определенного маршрута. После этого используйте PUT Запрашивает изменение маршрута с указанным идентификатором.
PUT /apisix/admin/routes/<route_id> HTTP/1.1
Host: <Admin_API_Host>:9180
Content-Type: application/json
X-API-KEY: <Your_Admin_API_Key>
{
"uri": "/hello",
"methods": ["GET"], # Измените, чтобы разрешить только метод GET.
"upstream": {
"type": "roundrobin",
"nodes": {
"192.168.1.100:80": 2,
"192.168.1.101:80": 8 # Добавить новый восходящий узел
}
}
}
Комментарий
03. Резюме
Хорошо, в этой главе мы узнали о настройке и управлении маршрутизацией APISIX. В следующей главе мы проведем более глубокое исследование APISIX на реальных примерах, так что следите за обновлениями~.