Как настроить Edge

Edge for Private Cloud 4.19.01

Чтобы настроить Edge после установки, используйте файлы .properties и утилиты Edge. Например, чтобы настроить TLS/SSL в Edge UI, нужно изменить файлы .properties и задать необходимые свойства. Чтобы изменения в файлах .properties вступили в силу, необходимо перезапустить затронутый компонент Edge.

В Apigee редактирование файлов .properties называется кодом с конфигурацией. По сути, код с конфигурацией – это инструмент поиска ключей и значений на основе настроек в файлах .properties. В коде с конфигурацией ключи называются токенами. Поэтому для настройки 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 и файлы свойств, которые можно редактировать для настройки этих компонентов.

Компонент Название компонента Редактируемый файл конфигурации
Cassandra apigee-cassandra /opt/apigee/customer/application/cassandra.properties
Интерфейс Edge edge-ui /opt/apigee/customer/application/ui.properties
Система единого входа Edge apigee-sso /opt/apigee/customer/application/sso.properties
Сервер управления edge-management-server /opt/apigee/customer/application/management-server.properties
Message Processor edge-message-processor /opt/apigee/customer/application/message-processor.properties
apigee-monit apigee-monit /opt/apigee/customer/application/monit.properties
Новый пользовательский опыт apigee-management-ui Недоступно (используйте файл конфигурации установки)
OpenLDAP apigee-openldap /opt/apigee/customer/application/openldap.properties
Сервер Postgres edge-postgres-server /opt/apigee/customer/application/postgres-server.properties
База данных PostgreSQL apigee-postgresql /opt/apigee/customer/application/postgressql.properties
Сервер Qpid edge-qpid-server /opt/apigee/customer/application/qpid-server.properties
Qpidd apigee-qpidd /opt/apigee/customer/application/qpidd.properties
Маршрутизатор edge-router /opt/apigee/customer/application/router.properties
Смотритель зоопарка apigee-zookeeper /opt/apigee/customer/application/zookeeper.properties

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

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

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

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

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

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

Владелец Название файла или каталога
Установка 
/opt/apigee/token
Компонент 
/opt/apigee/component_name/conf

где component_name – идентификатор компонента. Некоторые возможные значения:

  • apigee-cassandra (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)
  • edge-ui (классический интерфейс)

Как задать значение токена

Вы можете изменять только файлы .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 (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)
    • 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 в Message Processor, сначала 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+. Это местоположение и название файла конфигурации, содержащего свойство, за которым следует "+".

После перезапуска Message Processor проверьте файл /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