Как настроить Эдж

Для настройки Edge после установки используется комбинация файлов .properties и утилит Edge. Например, для настройки TLS/SSL в пользовательском интерфейсе Edge необходимо отредактировать файлы .properties , чтобы задать необходимые свойства. Изменения в файлах .properties требуют перезапуска соответствующего компонента Edge.

В Apigee метод редактирования файлов .properties называется «код с конфигурацией» (иногда сокращённо CwC). По сути, код с конфигурацией — это инструмент поиска пар «ключ/значение» на основе настроек в файлах .properties . В коде с конфигурацией ключи называются токенами (tokens). Поэтому для настройки Edge необходимо задать токены в файлах .properties .

Код с конфигурацией позволяет компонентам Edge устанавливать значения по умолчанию, поставляемые вместе с продуктом, позволяет группе установщиков переопределять эти настройки на основе топологии установки, а затем позволяет клиентам переопределять любые свойства по своему выбору.

Если представить это в виде иерархии, то настройки располагаются следующим образом, где настройки клиента имеют наивысший приоритет и переопределяют любые настройки команды установщиков или Apigee:

1. Клиент
2. Установщик
3. Компонент

Определить текущую стоимость токена

Прежде чем задать новое значение токена в файле .properties , необходимо сначала определить его текущее значение с помощью следующей команды:

/opt/apigee/apigee-service/bin/apigee-service component_name configure -search token

Где component_name — имя компонента, а token — токен для проверки.

Эта команда просматривает иерархию файлов .properties компонента, чтобы определить текущее значение токена.

В следующем примере проверяется текущее значение токена conf_http_HTTPRequest.line.limit для маршрутизатора:

/opt/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_http_HTTPRequest.line.limit

Вы должны увидеть вывод, подобный следующему:

Found key conf_http_HTTPRequest.line.limit, with value, 4k, in /opt/apigee/edge-router/token/default.properties

Если значение токена начинается с символа # , оно закомментировано, и для его изменения необходимо использовать специальный синтаксис. Подробнее см. в разделе Установка токена, который в данный момент закомментирован .

Если вы не знаете полное имя токена, воспользуйтесь инструментом, например grep для поиска по имени свойства или ключевому слову. Подробнее см. в разделе «Нахождение токена» .

Файлы свойств

Файлы конфигурации компонентов бывают редактируемыми и нередактируемыми. В этом разделе они описаны.

Редактируемые файлы конфигурации компонентов

В следующей таблице перечислены компоненты Apigee и файлы свойств, которые можно редактировать для настройки этих компонентов:

Если вы хотите задать свойство в одном из этих файлов конфигурации компонента, но оно не существует, вы можете создать его в указанном выше месте.

Кроме того, необходимо убедиться, что файл свойств принадлежит пользователю «apigee»:

chown apigee:apigee /opt/apigee/customer/application/configuration_file.properties

Нередактируемые файлы конфигурации компонентов

Помимо редактируемых файлов конфигурации компонентов, существуют также файлы конфигурации, которые нельзя редактировать.

К информационным (нередактируемым) файлам относятся следующие:

/opt/apigee/token

/opt/apigee/component_name/conf

Установить значение токена

Изменять можно только файлы .properties в каталоге /opt/apigee/customer/application . У каждого компонента есть свой файл .properties в этом каталоге. Например, router.properties и management-server.properties . Полный список файлов свойств см. в разделе Расположение файлов .properties .

Чтобы создать файл .properties :

1. Создайте новый текстовый файл в редакторе. Имя файла должно соответствовать списку, представленному в таблице выше для файлов клиентов.
2. Измените владельца файла на «apigee:apigee», как показано в следующем примере:

   chown apigee:apigee /opt/apigee/customer/application/router.properties

   Если вы изменили пользователя, который запускает службу Edge, с пользователя «apigee», используйте chown для смены владельца на пользователя, который запускает службу Edge.

При обновлении Edge считываются файлы .properties в каталоге /opt/apigee/customer/application . Это означает, что при обновлении будут сохранены все заданные вами свойства компонента.

Чтобы установить значение токена:

1. Отредактируйте файл .properties компонента.
2. Добавьте или измените значение токена. В следующем примере значение свойства conf_http_HTTPRequest.line.limit задаётся равным «10k»:

   conf_http_HTTPRequest.line.limit=10k

   Если токен принимает несколько значений, разделяйте каждое значение запятой, как показано в следующем примере:

   conf_security_rbac.restricted.resources=/environments,/environments/*,/environments/*/virtualhosts,/environments/*/virtualhosts/*,/pods,/environments/*/servers,/rebuildindex,/users/*/status,/myuri/*

   Чтобы добавить новое значение в список, подобный этому, обычно вы добавляете новое значение в конец списка.

3. Перезапустите компонент:

   /opt/apigee/apigee-service/bin/apigee-service component_name restart

   Где component_name — одно из следующих:

   • apigee-cassandra (Кассандра)
   • apigee-openldap (OpenLDAP)
   • apigee-postgresql (база данных PostgreSQL)
   • apigee-qpidd (Qpidd)
   • apigee-sso (Edge SSO)
   • apigee-zookeeper (ZooKeeper)
   • edge-management-server (Сервер управления)
   • edge-management-ui (новый пользовательский интерфейс Edge)
   • edge-message-processor (процессор сообщений)
   • edge-postgres-server (сервер Postgres)
   • edge-qpid-server (сервер Qpid)
   • edge-router (Edge Router)
   • edge-ui (классический пользовательский интерфейс)

   Например, после редактирования router.properties перезапустите маршрутизатор:

   /opt/apigee/apigee-service/bin/apigee-service edge-router restart

4. (Необязательно) Убедитесь, что значение токена соответствует вашему новому значению, используя опцию configure -search . Например:

   /opt/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_http_HTTPRequest.line.limit

   Дополнительную информацию о configure -search см. в разделе Определение текущего значения токена .

Найдите токен

В большинстве случаев необходимые токены указаны в этом руководстве. Однако, если вам нужно переопределить значение существующего токена, полное имя или местоположение которого вы не знаете, используйте grep для поиска в source каталоге компонента.

Например, если вы знаете, что в предыдущей версии Edge вы установили свойство session.maxAge и хотите узнать значение токена, использованное для его установки, то grep для свойства в каталоге /opt/apigee/edge-ui/source :

grep -ri "session.maxAge" /opt/apigee/edge-ui/source

Вы должны увидеть результат в следующем виде:

/opt/apigee/component_name/source/conf/application.conf:property_name={T}token_name{/T}

В следующем примере показано значение токена session.maxAge пользовательского интерфейса:

/opt/apigee/edge-ui/source/conf/application.conf:session.maxAge={T}conf_application_session.maxage{/T}

Строка между тегами {T}{/T} — это имя токена, которое можно задать в файле .properties пользовательского интерфейса.

Установить токен, который в данный момент закомментирован

Некоторые токены закомментированы в файлах конфигурации Edge. При попытке установить токен, закомментированный в файле установки или конфигурации компонента, ваши настройки будут проигнорированы.

Чтобы задать значение токена, закомментированного в файле конфигурации Edge, используйте специальный синтаксис в следующей форме:

conf/filename+propertyName=propertyValue

Например, чтобы задать свойство с именем HTTPClient.proxy.host в обработчике сообщений, сначала grep для свойства, чтобы определить его токен:

grep -ri /opt/apigee/edge-message-processor/ -e "HTTPClient.proxy.host"

Команда grep возвращает результаты, содержащие имя токена. Обратите внимание, что имя свойства закомментировано, на что указывает префикс # :

source/conf/http.properties:#HTTPClient.proxy.host={T}conf_http_HTTPClient.proxy.host{/T}
token/default.properties:conf_http_HTTPClient.proxy.host=
conf/http.properties:#HTTPClient.proxy.host=

Чтобы задать значение этого свойства, отредактируйте /opt/apigee/customer/application/message-processor.properties , но используйте специальный синтаксис, как показано в следующем примере:

conf/http.properties+HTTPClient.proxy.host=myhost.name.com

В этом случае необходимо добавить к имени свойства префикс conf/http.properties+ . Это местоположение и имя файла конфигурации, содержащего свойство, за которым следует «+».

После перезапуска обработчика сообщений проверьте файл /opt/apigee/edge-message-processor/conf/http.properties :

cat /opt/apigee/edge-message-processor/conf/http.properties

В конце файла вы увидите набор свойств в форме:

conf/http.properties:HTTPClient.proxy.host=myhost.name.com

Настройте пересылку прокси-сервера для запросов из раздела «Отправить запросы» интерфейса Trace UI.

В этом разделе объясняется, как настроить переадресацию прокси-сервера для запросов из раздела «Отправка запросов» интерфейса Trace с дополнительными учётными данными прокси-сервера. Чтобы настроить переадресацию прокси-сервера:

1. Отредактируйте файл /opt/apigee/customer/application/ui.properties и убедитесь, что владельцем файла является apigee:apigee .
2. Добавьте следующие переопределения (изменяя значения в соответствии с вашей конкретной конфигурацией прокси-сервера):

   conf_application_http.proxyhost=proxy.example.com
   conf_application_http.proxyport=8080
   conf_application_http.proxyuser=apigee
   conf_application_http.proxypassword=Apigee123!

3. Сохраните и перезапустите классический пользовательский интерфейс.

Добавить пользовательский формат журнала в Apigee Router/Nginx

В некоторых случаях может потребоваться изменить формат журнала Apigee Router/Nginx по умолчанию или добавить переменные. Чтобы обновить конфигурацию формата журнала Apigee Router/Nginx по умолчанию:

1. Создайте файл router.properties , если он не существует, по указанному ниже пути:

   /opt/apigee/customer/application/router.properties

2. Добавьте следующее содержимое в файл router.properties , чтобы создать новую конфигурацию log_format с именем router_new :

   conf_load_balancing_load.balancing.driver.nginx.global.http.parameters.template.extra=log_format router_new 'time_iso8601\\\\thostname\\\\tremote_addr:remote_port\\\\t'\\\\n\\n 'upstream_addr\\\\trequest_time\\\\t-\\\\t-\\\\t'\\\\n\\n 'status\\\\tupstream_status\\\\trequest_length\\\\t'\\\\n\\n 'body_bytes_sent\\\\t'\\\\n\\n 'request\\\\tupstream_http_x_apigee_message_id\\\\t'\\\\n\\n 'http_user_agent\\\\thost\\thostname-pid-connection-connection_requests\\\\tmy_nginx_var_xff\\t'\\\\n\\n 'upstream_http_x_apigee_fault_flag\\\\tupstream_http_x_apigee_fault_source\\\\tupstream_http_x_apigee_fault_code\\\\t'\\\\n\\n 'upstream_http_x_apigee_fault_policy\\tupstream_http_x_apigee_fault_flow\\tupstream_http_x_apigee_fault_revision\\t'\\\\n\\n 'upstream_http_x_apigee_dp_color\\\\tmy_x_apigee_target_latency\\\\t'\\\\n\\n 'upstream_http_x_apigee_proxy\\\\tupstream_http_x_apigee_proxy_basepath\\\\t'\\\\n\\n 'self_region\\\\tself_pod\\\\tself_color\\\\tssl_protocol\\\\tssl_client_verify\\\\tssl_session_id\\\\tssl_session_reused\\\\tupstream_pod\\\\tupstream_region';\\\\n\\n\n
   conf_load_balancing_load.balancing.driver.nginx.access.log={conf_load_balancing_load.balancing.driver.nginx.log.dir}/{org}~{env}.{port}_access_log router_new

   При необходимости обновите переменные в приведенных выше командах. Значения конфигурации по умолчанию для log_format можно найти в файле ниже:

   /opt/apigee/edge-router/conf/load_balancing.properties

   Список переменных Nginx можно найти по адресу http://nginx.org/en/docs/varindex.html .

3. Перезагрузите маршрутизатор, чтобы применить новую конфигурацию:

   apigee-service edge-router restart

4. Проверьте, добавлена ли новая конфигурация log_format ( router_new ) в файл /opt/nginx/conf.d/0-default.conf :

       
   cat /opt/nginx/conf.d/0-default.conf | grep router_new -A 10

5. Отправьте несколько API-запросов к API-прокси и проверьте новый формат журнала в файле.

   /opt/apigee/var/log/edge-router/nginx/${org}~${env}.${port}_access_log file