Вы просматриваете документацию по Apigee Edge.
Перейдите к
документации по Apigee X. info
В этой теме объясняется, как запустить Edge Microgateway в контейнере Docker. Для выполнения описанных в этой статье действий необходимо иметь базовые знания о Docker, командах Docker, а также о настройке и конфигурации Edge Microgateway. Дополнительную информацию можно найти в документации по Docker и Edge Microgateway.
Требования
Прежде чем запускать Edge Microgateway в контейнере Docker, необходимо выполнить следующие задачи:
Настройте Edge Microgateway для организации или среды Apigee:
edgemicro configure -o your_org -e your_env -u your_username
Подробные сведения о настройке приведены в разделе Часть 1. Настройка Edge Microgateway.
После выполнения действий по настройке найдите файл конфигурации. Местоположение по умолчанию здесь:
$HOME/.edgemicro/your_org-your_env-config.yaml
где
your_orgиyour_env– организация и среда, которые вы использовали при выполнении командыedgemicro config. Этот файл понадобится вам при запуске Edge Microgateway в контейнере Docker.Убедитесь, что у вас есть ключ и секретные учетные данные, которые были возвращены при выполнении команды
edgemicro config. Пример:The following credentials are required to start edge micro key: d9c34e1aff68ed969273c016699eabf48780e4f652242e72fc88a43e21252cb0 secret: 3bc95a71c86a3c8ce04537fbcb788158731t51dfc6cdec13b7c05aa0bd969430Прежде чем запускать Edge Microgateway в контейнере Docker, необходимо создать (или иметь созданные) объекты Apigee Edge, которые требуются для выполнения аутентифицированных вызовов прокси-сервера API. К ним относятся прокси-сервер, поддерживающий Edge Microgateway, продукт API, разработчик и приложение разработчика. Подробные инструкции приведены в статье Как создавать объекты в Apigee Edge.
Запуск Edge Micro в качестве контейнера Docker
Скачайте образ Docker для Edge Microgateway:
docker pull gcr.io/apigee-microgateway/edgemicro:latest
Прежде чем переходить к следующим шагам, убедитесь, что вы выполнили все действия, описанные в разделе Подготовка.
Выполните следующую команду, чтобы закодировать в Base64 файл конфигурации Edge Microgateway, расположенный в
$HOME/.edgemicro:export EDGEMICRO_CONFIG=`base64 $HOME/.edgemicro/your_org-your_env-config.yaml`
где
your_orgиyour_env– организация и среда, которые вы использовали при выполнении командыedgemicro config.Не забудьте заключить команду в обратные кавычки (`). Пример:
export EDGEMICRO_CONFIG=`base64 $HOME/.edgemicro/docs-test-config.yaml`
Запустите Edge Microgateway в качестве контейнера. Команда задает несколько переменных среды, которые используются средой выполнения контейнера для запуска Edge Microgateway:
chown -R 100:101 ~/.edgemicro/ \ docker run -P -p 8000:8000 -d --name edgemicro \ -v /var/tmp:/opt/apigee/logs \ -e EDGEMICRO_PROCESSES=1 \ -e EDGEMICRO_ORG=your_org \ -e EDGEMICRO_ENV=your_env \ -e EDGEMICRO_KEY=your_key \ -e EDGEMICRO_SECRET=your_secret \ -e "EDGEMICRO_CONFIG=$EDGEMICRO_CONFIG" \ -e "LOG_CONSOLE_OUTPUT_TO_FILE=false" \ -e SERVICE_NAME=edgemicro \ --security-opt=no-new-privileges \ --cap-drop=ALL \ gcr.io/apigee-microgateway/edgemicro:latest
Параметры
<tr> <td><code>SERVICE_NAME</code></td> <td>If you are on Kubernetes, this parameter is auto-populated. Otherwise, you can set it to anything you wish. If you specify nothing, the service name is set to <code>default</code>.</td> </tr> <tr> <tr> <td><code>DEBUG</code></td> <td>Set to <code>*</code> to enable debugging. </td> </tr> <tr> <td><code>HTTP_PROXY</code> <code>HTTPS_PROXY</code></td> <td>Use when Edge Microgateway is running behind a firewall and the gateway cannot communicate with Apigee Edge. For more information, see <a href="operation-and-configuration-reference-edge-microgateway#settingupedgemicrogatewaybehindacompanyfirewall">Setting up Edge Microgateway behind a company firewall</a>. <p>For example: <code>HTTP_PROXY=http://10.203.0.1:5187/</code></p></td> </tr> <tr> <td><code>NO_PROXY</code></td> <td>A comma delimited list of domains that Edge Microgateway should not proxy to. For more information, see <a href="operation-and-configuration-reference-edge-microgateway#settingupedgemicrogatewaybehindacompanyfirewall">Setting up Edge Microgateway behind a company firewall</a>. <p>For example: <code>localhost,127.0.0.1,localaddress,.localdomain.com</code></p></td> </tr> <tr> <tr> <tr> <td><code>NODE_EXTRA_CA_CERTS</code></td> <td>(Optional) Use this parameter if you are using a CA that's not trusted by default by Node.js. Set the value of this parameter to the path to a file containing one or more trusted certificates in PEM format. For details, see <a href="#tls_certificates">TLS certificates</a>.</td> </tr> <tr> <td><code>--security-opt</code></td> <td>(Optional) Sets desired Docker security options. See <a href="https://docs.docker.com/engine/reference/run/#security-configuration">Security configuration</a> in the Docker documentation.</td> </tr> <tr> <td><code>--cap-drop</code></td> <td>(Optional) Sets limits on Linux capabilities permitted in the container. See <a href="https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities">Runtime privilege and Linux capabilities</a> in the Docker documentation.</td> </tr> </tbody>Параметр Описание -PОпубликовать все открытые порты на хосте. См. также справочную информацию по команде docker run. -pЯвно сопоставьте один порт или диапазон портов. См. также справочную информацию по команде docker run. -dЗапустите в автономном режиме. См. также справочную информацию по команде docker run. -v, -- volumeУказывает точку монтирования тома. Обратите внимание, что если вы настроите Edge Microgateway на использование TLS в контейнере Docker, то при монтировании каталога файлов журнала вам нужно будет открыть порт 8443. См. также VOLUME [shared filesystems]. Подробнее об использовании TLS в контейнере Docker… -w, -- workdir(Необязательно.) Указывает путь к каталогу, в котором должны быть созданы файлы edgemicro.sockиedgemicro.pid. Нельзя изменить корень названия файлаedgemicro. По умолчанию используется путь к текущему рабочему каталогу.Пример:
docker run -P -p 8000:8000 -d -w /tmp --name edgemicro
...EDGEMICRO_ORGНазвание организации Apigee, которое вы использовали для настройки Edge Microgateway. EDGEMICRO_ENVНазвание среды Apigee, которую вы использовали для настройки Edge Microgateway. EDGEMICRO_PROCESSESКоличество процессов, которые нужно запустить. EDGEMICRO_KEYКлюч, возвращенный при настройке Edge Microgateway. EDGEMICRO_SECRETСекретный ключ, возвращенный при настройке Edge Microgateway. EDGEMICRO_CONFIGПеременная, содержащая файл конфигурации Edge Microgateway в кодировке Base64. LOG_CONSOLE_OUTPUT_TO_FILE(Логическое значение) Позволяет указать, куда отправляются выходные данные журнала. Подробнее о настройке параметров файла журнала… Пример:
chown -R 100:101 ~/.edgemicro/
docker run -P -p 8000:8000 -d --name edgemicro
-v /var/tmp:/opt/apigee/logs
-e EDGEMICRO_PROCESS=1
-e EDGEMICRO_ORG=docs
-e EDGEMICRO_ENV=test
-e EDGEMICRO_KEY=d9c34e1aff68ed969273b016699eabf48780e4f652242e72fc88a23e21252cb0
-e EDGEMICRO_SECRET=3bc95a71c86a3c8ce04137fbcb788158731t51dfc6cdec13b7c05aa0bd969430
-e "EDGEMICRO_CONFIG=$EDGEMICRO_CONFIG"
-e SERVICE_NAME=edgemicro
--security-opt=no-new-privileges
--cap-drop=ALL
gcr.io/apigee-microgateway/edgemicroЧтобы проверить, работает ли контейнер, выполните следующие действия:
docker ps
Вы должны получить примерно такой результат:
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 8b92e082ea9c edgemicro "/tmp/entrypoint.sh" 12 minutes ago Up 12 minutes 0.0.0.0:8000->8000/tcp, 0.0.0.0:32775->8443/tcp edgemicro
Указание параметров вывода файла журнала
Параметр конфигурации Edge Microgateway to_console позволяет отправлять информацию журнала в стандартный вывод, а не в файл журнала. Если вы выполните инструкции по запуску Edge Microgateway в контейнере Docker, контейнер по умолчанию будет перенаправлять stdout и вывод ошибок в файл, расположенный в контейнере по адресу
${APIGEE_ROOT}/logs/edgemicro.log.Чтобы запретить отправку информации из журналов в
edgemicro.log, используйте переменнуюLOG_CONSOLE_OUTPUT_TO_FILEпри запуске контейнера.В таблице ниже описано, как выводятся журналы при использовании
LOG_CONSOLE_OUTPUT_TO_FILEсto_console.to_console: trueLOG_CONSOLE_OUTPUT_TO_FILE=false- Журналы не будут отправляться в файл журнала Edge Microgateway, как описано в разделе Управление файлами журналов.
- Журналы не будут отправляться в файл
edgemicro.log.
to_console: trueLOG_CONSOLE_OUTPUT_TO_FILE=true- Журналы не будут отправляться в файл журнала Edge Microgateway, как описано в разделе Управление файлами журналов.
- Журналы будут отправлены в файл
edgemicro.log.
to_console: falseLOG_CONSOLE_OUTPUT_TO_FILE=true- Журналы будут отправлены в файл журнала Edge Microgateway, как описано в разделе Управление файлами журналов.
- Журналы будут отправлены в файл
edgemicro.log.
Тестирование вызова API
После запуска Edge Microgateway в контейнере вы можете выполнять вызовы API. Например, если базовый путь вашего API –
/hello:http://localhost:8000/hello
Пример результата:
{"error":"missing_authorization","error_description":"Missing Authorization header"}Если вы видите этот ответ, значит Edge Microgateway успешно обработал вызов API. Однако по умолчанию для аутентификации Edge Microgateway требуется ключ API. В следующем разделе вы протестируете API с действительным ключом API.
Как протестировать API с действительным ключом API
В интерфейсе Edge перейдите к созданному ранее приложению разработчика. На странице Developer App (Приложение разработчика) найдите и скопируйте идентификатор клиента. Это значение и есть ключ API. Этот ключ будет использоваться для аутентификации вызовов API.
Вызовите API с заголовком
x-api-key, как показано ниже. Значение идентификатора клиента, которое вы скопировали из Developer App, – это ключ API. По умолчанию Edge Microgateway ожидает, что вы передадите ключ в заголовке с именемx-api-key, например:curl -i http://localhost:8000/hello -H "x-api-key:apikey"
Пример:
curl -i http://localhost:8000/hello -H "x-api-key:PydUKRDGIXRqF2xh4usn1FLHbhGKVIz"
Подробнее о том, как выполнять аутентифицированные вызовы API через Edge Microgateway с помощью ключей API и токенов OAuth, рассказывается в части 4.
Остановка Edge Microgateway
Чтобы остановить Edge Microgateway, используйте следующую команду Docker:
docker stop edgemicroПерезапуск Edge Microgateway
После остановки Edge Microgateway вы можете перезапустить его с помощью следующей команды Docker:
docker start edgemicroИспользование TLS в контейнере Docker
В этом разделе объясняется, как настроить TLS для Edge Microgateway, работающего в контейнере Docker. Вы можете настроить сервер Edge Microgateway на использование TLS для входящих запросов (северное направление), а также настроить Edge Microgateway в качестве клиента TLS для исходящих запросов к целевым конечным точкам (южное направление).
Где хранить файлы сертификатов
Контейнер Docker, в котором запущен Edge Microgateway, имеет точку подключения на
/opt/apigee/.edgemicro. При настройке Edge Microgateway для использования сертификатов TLS вы можете сделать файлы сертификатов доступными в этой точке подключения и ссылаться на них в файле конфигурации Edge Microgateway. Обычно этот файл конфигурации находится в каталоге$HOME/.edgemicroи называетсяyour_org-your_env-config.yaml. Пример:... edgemicro: ssl: key: /opt/apigee/.edgemicro/southbound/tls.key cert: /opt/apigee/.edgemicro/southbound/tls.crt ...Использование ЦС, не являющегося доверенным для Node.js
Если вы используете центр сертификации (ЦС), который по умолчанию не считается доверенным в Node.js (например, в случае с самозаверяющим сертификатом), при запуске контейнера используйте параметр
NODE_EXTRA_CA_CERTS.Укажите в этом параметре путь к файлу, содержащему один или несколько доверенных сертификатов в формате PEM. Чтобы узнать, как используется этот параметр, ознакомьтесь с примерами Как настроить TLS для исходящего трафика и Как настроить TLS для входящего трафика.
Пример:
chown -R 100:101 ~/.edgemicro/ \ docker run -P -p 8443:8443 -d --name edgemicro \ -v $HOME/.edgemicro:/opt/apigee/.edgemicro \ -v $HOME/.edgemicro:/opt/apigee/logs \ -e NODE_EXTRA_CA_CERTS=/opt/apigee/.edgemicro/rootca.pem \ -e EDGEMICRO_PORT=8443 \ -e EDGEMICRO_ORG=docs \ -e EDGEMICRO_ENV=test \ -e EDGEMICRO_KEY=ac36574905fb54fdae65fc5433e831bec2680efb98220a355f2e917e52973c \ -e EDGEMICRO_SECRET=aac81dff6c326eaa222d53c15c8841fa78ea863bf4472568c9ce2d80a3bc56 \ -e "EDGEMICRO_CONFIG=$EDGEMICRO_CONFIG" \ --link helloworld:helloworld gcr.io/apigee-microgateway/edgemicroТакже ознакомьтесь со статьей Как запустить Edge Micro в качестве контейнера Docker.
Отключение проверки TLS
Хотя это и не рекомендуется, в некоторых случаях вы можете отключить проверку TLS для Edge Microgateway, работающего в контейнере. Возможность отключения TLS не встроена в контейнер Edge Microgateway Docker по умолчанию. Для выполнения задачи необходимо создать настроенный образ Docker для Edge Microgateway. Ниже приведены общие инструкции по созданию собственного образа и отключению проверки TLS.
Клонируйте или скачайте репозиторий Edge Microgateway с сайта
https://github.com/apigee-internal/microgateway.cdв каталогmicrogateway/kubernetes/docker/edgemicroв каталоге исходного кода.Пример:
cd $HOME/git/microgateway/kubernetes/docker/edgemicroОткройте файл
entrypoint.shи измените код, чтобы он принимал переменную средыNODE_TLS_REJECT_UNAUTHORIZED. Позже, когда вы запустите контейнер, вы укажете значение для этой переменной.Создайте контейнер Docker:
docker build -t edgemicro .При запуске контейнера укажите параметр
-e NODE_TLS_REJECT_UNAUTHORIZED = 1. Пример:
chown -R 100:101 ~/.edgemicro/ \ docker run -P -p 8443:8443 -d --name edgemicro \ -v $HOME/.edgemicro:/opt/apigee/.edgemicro \ -v $HOME/.edgemicro:/opt/apigee/logs \ -e NODE_TLS_REJECT_UNAUTHORIZED = 1 \ -e EDGEMICRO_PORT=8443 \ -e EDGEMICRO_ORG=docs \ -e EDGEMICRO_ENV=test \ -e EDGEMICRO_KEY=ac36574905fb54fdae65fc5433e831bec2680efb98220a355f2e917e52973c \ -e EDGEMICRO_SECRET=aac81dff6c326eaa222d53c15c8841fa78ea863bf4472568c9ce2d80a3bc56 \ -e "EDGEMICRO_CONFIG=$EDGEMICRO_CONFIG" \ --link helloworld:helloworld gcr.io/apigee-microgateway/edgemicroПример: как настроить TLS для исходящего трафика
В этом разделе объясняется, как настроить северное (входящее) TLS-соединение на сервере Edge Microgateway. Northbound TLS позволяет клиентам использовать HTTPS при вызовах API к Edge Microgateway. В примере ниже используются самозаверяющие сертификаты.
1. Этапы начальной настройки
- Найдите файл
openssl.cnfв системе. Пример:/etc/ssl/openssl.cnf. - Откройте файл
opensssl.cnfдля редактирования. Убедитесь, что в файле конфигурации есть
req_extensions. Например, в вашем файле должна быть информация, похожая на следующую:[ req ] ... req_extensions = v3_req ... [ v3_req ] extendedKeyUsage = serverAuth, clientAuth, codeSigning, emailProtection basicConstraints = CA:FALSE keyUsage = nonRepudiation, digitalSignature, keyEnciphermentЧтобы сгенерировать правильные атрибуты SNI, добавьте в
openssl.cnfследующую строфу:[ alt_names ] DNS.1 = www.example.com DNS.2 = example.com DNS.3 = localhost DNS.4 = localhost.localdomain DNS.5 = 127.0.0.1 DNS.6 = ::1 DNS.7 = fe80::1Пример файла
opensssl.cnf:[ req ] distinguished_name = req_distinguished_name attributes = req_attributes req_extensions = v3_req [ v3_req ] extendedKeyUsage = serverAuth, clientAuth, codeSigning, emailProtection basicConstraints = CA:FALSE keyUsage = nonRepudiation, digitalSignature, keyEncipherment [ req_distinguished_name ] countryName = Country Name (2 letter code) countryName_min = 2 countryName_max = 2 stateOrProvinceName = State or Province Name (full name) localityName = Locality Name (eg, city) 0.organizationName = Organization Name (eg, company) organizationalUnitName = Organizational Unit Name (eg, section) commonName = Common Name (eg, fully qualified host name) commonName_max = 64 emailAddress = Email Address emailAddress_max = 64 [ req_attributes ] challengePassword = A challenge password challengePassword_min = 4 challengePassword_max = 20 [ alt_names ] DNS.1 = www.example.com DNS.2 = example.com DNS.3 = localhost DNS.4 = localhost.localdomain DNS.5 = 127.0.0.1 DNS.6 = ::1 DNS.7 = fe80::1Если вы ещё не инициализировали и не настроили Edge Microgateway, выполните инструкции из раздела Требования. После этого у вас должны быть созданы прокси-сервер с поддержкой Edge Microgateway, продукт API, разработчик и приложение разработчика. Кроме того, вы должны выполнить команду
edgemicro configureи получить ключ и секретный код.
2. Как создать самозаверяющие сертификаты
Затем создайте сертификаты и ключи, необходимые для настройки TLS:
cdв каталог$HOME/.edgemicro.Создайте следующий скрипт bash. Название может быть любым. Пример:
keygen.sh.#!/bin/bash # generate ca openssl genrsa -out rootca.key 2048 openssl req -x509 -new -nodes -key rootca.key -sha256 -days 1024 -out rootca.pem # generate key openssl genrsa -out tls.key 2048 openssl req -new -key tls.key -out tls.csr # sign cert openssl x509 -req -in tls.csr -CA rootca.pem -CAkey rootca.key -CAcreateserial -out tls.crt -days 1024 -sha256 -extensions 'v3_req' -extfile path/openssl.cnf
Убедитесь, что в файле bash указан правильный путь к файлу
openssl.cnf.Выполните файл bash. Вам будет предложено ввести информацию о сертификате. В качестве общего имени укажите
localhost.Убедитесь, что созданы следующие файлы:
rootca.keyrootca.pemtls.keytls.csrrootca.srltls.crt
3. Измените файл конфигурации Edge Microgateway
Откройте файл конфигурации Edge Micro в редакторе. Пример:
vi $HOME/.edgemicro/myorg-test-config.yamlИзмените строфу
edgemicro, как показано ниже. Обратите внимание, что вы вносите изменения в атрибутыportиssl:edge_config: ... edgemicro: port: 8443 max_connections: 1000 config_change_poll_interval: 600 ssl: key: /opt/apigee/.edgemicro/tls.key cert: /opt/apigee/.edgemicro/tls.crt passphrase: admin123 rejectUnauthorized: true requestCert: false logging: ...Выполните следующую команду, чтобы закодировать файл конфигурации Edge Microgateway, расположенный в
$HOME/.edgemicro, в формате Base64:export EDGEMICRO_CONFIG=`base64 $HOME/.edgemicro/your_org-your_env-config.yaml`
где
your_orgиyour_env– организация и среда, которые вы использовали при выполнении командыedgemicro config.Не забудьте заключить команду в обратные кавычки (`). Пример:
export EDGEMICRO_CONFIG=`base64 $HOME/.edgemicro/docs-test-config.yaml`
Также ознакомьтесь со статьей Как запустить Edge Micro в качестве контейнера Docker.
4. Запуск контейнера
Выполните следующую команду, чтобы запустить контейнер Docker с Edge Microgateway:
chown -R 100:101 ~/.edgemicro/ \ docker run -P -p 8443:8443 -d --name edgemicro \ -v path_to_your_edgemicro_dir:/opt/apigee/.edgemicro \ -v path_to_your_logs_dir:/opt/apigee/logs \ -e NODE_EXTRA_CA_CERTS=/opt/apigee/.edgemicro/rootca.pem \ -e EDGEMICRO_PORT=8443 \ -e EDGEMICRO_ORG=$EDGEMICRO_ORG \ -e EDGEMICRO_ENV=$EDGEMICRO_ENV \ -e EDGEMICRO_KEY=$EDGEMICRO_KEY \ -e EDGEMICRO_SECRET=$EDGEMICRO_SECRET \ -e "EDGEMICRO_CONFIG=$EDGEMICRO_CONFIG" \ gcr.io/apigee-microgateway/edgemicro:latest
Обратите внимание на следующие параметры, используемые в команде. Они отличаются от базовой команды, описанной в разделе Запуск Edge Micro в качестве контейнера Docker.
- Для параметра
portзадано значение8443. - Для подключения файлов ключа и сертификата используется точка монтирования.
- Переменная
NODE_EXTRA_CA_CERTSиспользуется для добавления собственного ЦС (например, в случае с самозаверяющими сертификатами).
- Для параметра
5. Проверьте конфигурацию TLS
Чтобы проверить настройки, выполните следующую команду cURL. Подставьте в команду свой базовый путь и ключ API. В следующем примере предполагается, что вы находитесь в каталоге, где расположен файл
rootca.pem, а созданный вами прокси-сервер имеет базовый путь/hello:curl -v https://localhost:8443/hello --cacert rootca.pem \ -H "x-api-key: Az82fdnfONVCOOE4NKhajxAboDgA3FAo"В подробных выходных данных cURL показан каждый шаг подтверждения TLS. Если вы видите ответ HTTP 200, значит настройка выполнена успешно:
* Trying ::1...ey:Az82fdnfONVCOOE4NKhajxAboDgA3FAo" * TCP_NODELAY set * Connected to localhost (::1) port 8443 (#0) * ALPN, offering h2 * ALPN, offering http/1.1 * Cipher selection: ALL:!EXPORT:!EXPORT40:!EXPORT56:!aNULL:!LOW:!RC4:@STRENGTH * successfully set certificate verify locations: * CAfile: rootca.pem CApath: none * TLSv1.2 (OUT), TLS handshake, Client hello (1): * TLSv1.2 (IN), TLS handshake, Server hello (2): * TLSv1.2 (IN), TLS handshake, Certificate (11): * TLSv1.2 (IN), TLS handshake, Server key exchange (12): * TLSv1.2 (IN), TLS handshake, Server finished (14): * TLSv1.2 (OUT), TLS handshake, Client key exchange (16): * TLSv1.2 (OUT), TLS change cipher, Client hello (1): * TLSv1.2 (OUT), TLS handshake, Finished (20): * TLSv1.2 (IN), TLS change cipher, Client hello (1): * TLSv1.2 (IN), TLS handshake, Finished (20): * SSL connection using TLSv1.2 / ECDHE-RSA-AES128-GCM-SHA256 * ALPN, server accepted to use http/1.1 * Server certificate: * subject: C=US; ST=CO; L=Boulder; O=Docs; OU=Docs; CN=localhost; emailAddress=docs@apigee.com * start date: Dec 14 22:35:28 2018 GMT * expire date: Oct 3 22:35:28 2021 GMT * common name: localhost (matched) * issuer: C=US; ST=CO; L=Boulder; O=Docs; OU=Docs; CN=localhost; emailAddress=docs@apigee.com * SSL certificate verify ok. > GET /hello HTTP/1.1 > Host: localhost:8443 > User-Agent: curl/7.54.0 > Accept: */* > x-api-key:Az82fdnfaONVCOE4NKhajxAboDA3FAo > < HTTP/1.1 200 OK < x-powered-by: Apigee < access-control-allow-origin: * < x-frame-options: ALLOW-FROM RESOURCE-URL < x-xss-protection: 1 < x-content-type-options: nosniff < content-type: text/plain; charset=utf-8 < etag: W/"d-GHB1ZrJKk/wdVTdB/jgBsw" < date: Fri, 14 Dec 2018 22:43:13 GMT < via: 1.1 google < alt-svc: clear < x-response-time: 1325 < Connection: keep-alive < Transfer-Encoding: chunked < * Connection #0 to host localhost left intact Hello, Guest!
Пример. Как настроить TLS для нисходящего трафика
В этом разделе объясняется, как настроить исходящее TLS-подключение между сервером Edge Microgateway и целевым приложением. В примере ниже используются самозаверяющие сертификаты.
1. Первоначальная настройка
- Найдите файл
openssl.cnfв системе. Пример:/etc/ssl/openssl.cnf. - Откройте файл
opensssl.cnfдля редактирования. Убедитесь, что в файле конфигурации есть
req_extensions. Например, в вашем файле должна быть информация, похожая на следующую:[ req ] ... req_extensions = v3_req ... [ v3_req ] extendedKeyUsage = serverAuth, clientAuth, codeSigning, emailProtection basicConstraints = CA:FALSE keyUsage = nonRepudiation, digitalSignature, keyEnciphermentЧтобы сгенерировать правильные атрибуты SNI, добавьте в
openssl.cnfследующую строфу:[ alt_names ] DNS.1 = helloworld DNS.2 = localhost DNS.3 = localhost.localdomain DNS.4 = 127.0.0.1 DNS.5 = ::1 DNS.6 = fe80::1Пример файла
opensssl.cnf:[ req ] distinguished_name = req_distinguished_name attributes = req_attributes req_extensions = v3_req [ v3_req ] extendedKeyUsage = serverAuth, clientAuth, codeSigning, emailProtection basicConstraints = CA:FALSE keyUsage = nonRepudiation, digitalSignature, keyEncipherment [ req_distinguished_name ] countryName = Country Name (2 letter code) countryName_min = 2 countryName_max = 2 stateOrProvinceName = State or Province Name (full name) localityName = Locality Name (eg, city) 0.organizationName = Organization Name (eg, company) organizationalUnitName = Organizational Unit Name (eg, section) commonName = Common Name (eg, fully qualified host name) commonName_max = 64 emailAddress = Email Address emailAddress_max = 64 [ req_attributes ] challengePassword = A challenge password challengePassword_min = 4 challengePassword_max = 20 [ alt_names ] DNS.1 = helloworld DNS.2 = localhost DNS.3 = localhost.localdomain DNS.4 = 127.0.0.1 DNS.5 = ::1 DNS.6 = fe80::1Выполните команду
edgemicro configure:edgemicro configure -o your_org -e your_env -u your_username
Подробные сведения о настройке приведены в разделе Часть 1. Настройка Edge Microgateway.
Скопируйте ключ и секретные учетные данные, возвращенные из
edgemicro configure. Эти значения понадобятся вам для запуска контейнера. Пример:The following credentials are required to start edge micro key: d9c34e1aff68ed969273c016699eabf48780e4f652242e72fc88a43e21252cb0 secret: 3bc95a71c86a3c8ce04537fbcb788158731t51dfc6cdec13b7c05aa0bd969430
2. Создание целевого приложения Node.js
cdв каталог.edgemicro.Создайте следующий скрипт bash. Название может быть любым. Пример:
keygen.sh.#!/bin/bash # generate ca openssl genrsa -out rootca.key 2048 openssl req -x509 -new -nodes -key rootca.key -sha256 -days 1024 -out rootca.pem # generate key openssl genrsa -out tls.key 2048 openssl req -new -key tls.key -out tls.csr # sign cert openssl x509 -req -in tls.csr -CA rootca.pem -CAkey rootca.key -CAcreateserial -out tls.crt -days 1024 -sha256 -extensions 'v3_req' -extfile path/openssl.cnf
Убедитесь, что в файле bash указан правильный путь к файлу
openssl.cnf.Выполните файл bash. Вам будет предложено ввести информацию о сертификате. В качестве общего имени укажите
hellworld.Убедитесь, что созданы следующие файлы:
rootca.keyrootca.pemtls.keytls.csrrootca.srltls.crt
Создайте файл с названием
server.js.'use strict'; const express = require('express'); const https = require('https'); const fs = require('fs'); const options = { key: fs.readFileSync("tls.key"), cert: fs.readFileSync("tls.crt") }; // Constants const PORT = 9443; const HOST = '0.0.0.0'; // App const app = express(); app.get('/', (req, res) => { res.send('Hello world\n'); }); https.createServer(options, app).listen(PORT);Создайте файл
package.jsonв том же каталоге, где хранится файлserver.js. Пример:{ "name": "helloworld", "version": "1.0.0", "description": "", "main": "server.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1", "start": "node server.js" }, "author": "", "license": "ISC", "dependencies": { "express": "^4.16.4", "fs": "0.0.1-security", "https": "^1.0.0" } }Чтобы получить зависимости, выполните команду
npm install.Создайте новый файл Dockerfile в том же каталоге, что и
server.js, гдеWORKDIR– путь к корневому каталогу приложения Node.js:FROM node:8-alpine WORKDIR path-to-your-node-app COPY package*.json ./ RUN npm install COPY . . EXPOSE 9443 CMD [ "npm", "start" ]
Создайте образ Docker:
docker build -t helloworld .Запустите пример приложения:
docker run -P -p 9443:9443 --name helloworld helloworld
3. Создание объектов в Apigee Edge
Создайте прокси-сервер, поддерживающий Edge Microgateway, с указанными ниже настройками. Подробнее о том, как создать прокси-сервер API с поддержкой Edge Microgateway в Edge…
- Название прокси-сервера:
edgemicro_local - Проверка аккаунта:
1 - Базовый путь:
/local - Цели:
https://helloworld:9443
- Название прокси-сервера:
Создайте продукт API. Подробнее о том, как создать продукт…
Создайте разработчика. Подробнее о том, как создать разработчика…
4. Запуск контейнера
Откройте файл конфигурации Edge Micro в редакторе. Пример:
vi $HOME/.edgemicro/myorg-test-config.yamlИзмените строфу
edgemicro, как показано ниже. Обратите внимание, что вы вносите изменения в атрибутыportиssl:edge_config: ... edgemicro: port: 8443 max_connections: 1000 config_change_poll_interval: 600 ssl: key: /opt/apigee/.edgemicro/tls.key cert: /opt/apigee/.edgemicro/tls.crt passphrase: admin123 rejectUnauthorized: true requestCert: false logging: ...Выполните следующую команду, чтобы закодировать файл конфигурации Edge Microgateway, расположенный в
$HOME/.edgemicro, в формате Base64:export EDGEMICRO_CONFIG=`base64 $HOME/.edgemicro/your_org-your_env-config.yaml`
где
your_orgиyour_env– организация и среда, которые вы использовали при выполнении командыedgemicro config.Не забудьте заключить команду в обратные кавычки (`). Пример:
export EDGEMICRO_CONFIG=`base64 $HOME/.edgemicro/docs-test-config.yaml`
Чтобы запустить Edge Microgateway в контейнере Docker, выполните следующую команду:
chown -R 100:101 ~/.edgemicro/ \ docker run -P -p 8443:8443 -d --name edgemicro \ -v path_to_your_edgemicro_dir:/opt/apigee/.edgemicro \ -v path_to_your_logs_dir:/opt/apigee/logs \ -e EDGEMICRO_PORT=8443 \ -e EDGEMICRO_ORG=$EDGEMICRO_ORG \ -e EDGEMICRO_ENV=$EDGEMICRO_ENV \ -e EDGEMICRO_KEY=$EDGEMICRO_KEY \ -e EDGEMICRO_SECRET=$EDGEMICRO_SECRET \ -e "EDGEMICRO_CONFIG=$EDGEMICRO_CONFIG" \ --link helloworld:helloworld gcr.io/apigee-microgateway/edgemicro
5. Проверьте конфигурацию TLS
Чтобы проверить настройки, выполните следующую команду cURL. Замените базовый путь, который вы использовали в прокси-сервере с поддержкой микрошлюза, и ключ API, полученный из приложения Developer, созданного вами в Apigee Edge. Пример:
curl https://localhost:8443/local -k -H "x-api-key: xxxx" -vВы увидите следующее сообщение об ошибке:
... * subject: C=CA; ST=Ontario; L=Toronto; O=Google Canada; OU=Google Cloud Platform; CN=edgemicro; emailAddress=srinandans@google.com * start date: Dec 10 02:12:22 2018 GMT * expire date: Sep 29 02:12:22 2021 GMT * issuer: C=CA; ST=Ontario; L=Toronto; O=Google Canada; OU=Google Cloud Platform; CN=edgemicro; emailAddress=srinandans@google.com * SSL certificate verify result: unable to get local issuer certificate (20), continuing anyway. > GET /local HTTP/1.1 > Host: localhost:8443 > User-Agent: curl/7.54.0 > Accept: */* > x-api-key: 9fVC65pFj8LrmlPmVyxFjx4KgAHTxqSd > < HTTP/1.1 502 Bad Gateway < Date: Wed, 12 Dec 2018 05:25:01 GMT < Connection: keep-alive < Content-Length: 93 < * Connection #0 to host localhost left intact {"message":"unable to verify the first certificate","code":"UNABLE_TO_VERIFY_LEAF_SIGNATURE"}Перезапустите Edge Microgateway, но на этот раз добавьте переменную
NODE_EXTRA_CA_CERTS.chown -R 100:101 ~/.edgemicro/ \ docker run -P -p 8443:8443 -d --name edgemicro \ -v path_to_your_edgemicro_dir:/opt/apigee/.edgemicro \ -v path_to_your_logs_dir:/opt/apigee/logs \ -e NODE_EXTRA_CA_CERTS=/opt/apigee/.edgemicro/rootca.pem \ -e EDGEMICRO_PORT=8443 \ -e EDGEMICRO_ORG=$EDGEMICRO_ORG \ -e EDGEMICRO_ENV=$EDGEMICRO_ENV \ -e EDGEMICRO_KEY=$EDGEMICRO_KEY \ -e EDGEMICRO_SECRET=$EDGEMICRO_SECRET \ -e "EDGEMICRO_CONFIG=$EDGEMICRO_CONFIG" \ --link helloworld:helloworld gcr.io/apigee-microgateway/edgemicro
Выполните следующую команду cURL. Замените базовый путь и ключ API, как и ранее. Пример:
curl https://localhost:8443/local -k -H "x-api-key: xxxx" -vПроверьте результат. В случае успеха вы получите ответ со статусом HTTP 200:
... > GET /local HTTP/1.1 > Host: localhost:8443 > User-Agent: curl/7.54.0 > Accept: */* > x-api-key: 9fVC65pFj8LrmlPmVyxFjx4KgAHTxqSd > < HTTP/1.1 200 OK < x-powered-by: Express < content-type: text/html; charset=utf-8 < etag: W/"c-M6tWOb/Y57lesdjQuHeB1P/qTV0" < date: Wed, 12 Dec 2018 05:49:28 GMT < x-response-time: 421 < Connection: keep-alive < Transfer-Encoding: chunked < Hello world
Как добавить собственный плагин
Вы можете добавлять в микрошлюз новые функции и возможности, создавая собственные плагины. Специальные плагины позволяют программно взаимодействовать с запросами и ответами, которые проходят через микрошлюз.
Вы можете развернуть плагины в экземпляре Edge Microgateway, запущенном в контейнере Docker, двумя способами:
В оставшейся части этого раздела предполагается, что вы знакомы с написанием и настройкой плагинов для стандартной настройки Edge Microgateway. Если нет, ознакомьтесь с разделом Разработка собственных плагинов.
Вариант А. Подключите каталог плагинов к тому
(Добавлено в версии 2.5.27) Добавление плагинов через подключение тома выполняется так же, как и добавление любого другого плагина в Edge Microgateway. При запуске контейнера Docker вы можете подключить каталог плагинов в локальной системе (том) к точке подключения контейнера, которая называется
/opt/apigee/plugins. Затем укажите каталог локального тома в файле конфигурации Edge Microgateway.Ниже показано, как использовать точку подключения Docker для добавления собственных плагинов.
Остановите Edge Microgateway:
edgemicro stopСоздайте каталог для собственных плагинов. Например, создайте
$HOME/edgemicro/custom/pluginsДобавьте каталог пользовательских плагинов в файл конфигурации Edge Microgateway. Пример:
plugins: dir: $HOME/edgemicro/custom/plugins sequence: - oauth - response-uppercase ````Напишите и протестируйте плагин, следуя инструкциям в статье Как написать простой плагин. Убедитесь, что код плагина размещен в правильной структуре каталогов. Пример:
custom | |-- plugins | |- response-uppercase | |- index.js | |- package.json |- request-headers | | - index.js | - package.jsonЗапустите контейнер Docker с помощью команды, похожей на приведенную ниже. В ней используется параметр
-v, чтобы подключить каталог плагинов к тому Docker. В примере команды ниже каталог плагинов$HOME/edgemicro/custom/plugins(где находится пользовательский плагин) сопоставляется с точкой подключения контейнера/opt/apigee/plugins:chown -R 100:101 ~/.edgemicro/ \ docker run -P -p 8000:8000 -d --name edgemicro \ -v /var/tmp:/opt/apigee/logs \ -v $HOME/edgemicro/custom/plugins:/opt/apigee/plugins \ -e EDGEMICRO_PROCESSES=1 \ -e EDGEMICRO_ORG=jdoe \ -e EDGEMICRO_ENV=test \ -e EDGEMICRO_KEY=39c4b561100cd7f258768d1072f3e1d7c17b5f36a18fe89972bb5c9ce7e58fb \ -e EDGEMICRO_SECRET=f5f9e239a38b4e6cc99c2aa067716a84aebdcff9580a7925fc500e402b1a5fa \ -e "EDGEMICRO_CONFIG=$EDGEMICRO_CONFIG" \ -e SERVICE_NAME=edgemicro \ --security-opt=no-new-privileges \ --cap-drop=ALL gcr.io/apigee-microgateway/edgemicro:latestВызовите API, чтобы протестировать плагин.
Подробнее о VOLUME [общие файловые системы]…
Вариант Б. Встройте плагины в контейнер
В этом случае вы встраиваете плагины в контейнер.
1. Упаковка плагинов
Напишите и протестируйте плагин, следуя инструкциям в статье Как написать простой плагин.
Разместите код плагина в правильной структуре каталогов. Каталоги плагинов должны иметь определенную структуру. Ниже показана структура, которой необходимо придерживаться.
response-uppercaseиrequest-headers– это названия папок, содержащих код пользовательских плагинов (эти названия приведены только в качестве примера, ваши папки могут называться иначе).plugin | |-- plugins | |- response-uppercase | |- index.js | |- package.json |- request-headers | | - index.js | - package.jsoncdв папкуplugin.В папке
pluginзаархивируйте всю папкуplugins:zip -r plugins.zip plugins/
2. Создайте образ Docker
Затем создайте файл Dockerfile, чтобы добавить код плагина в образ Edge Microgateway.
- В том же каталоге, где находится ZIP-файл, создайте новый файл с названием
Dockerfile. Добавьте в файл
Dockerfileследующий код и сохраните файл:FROM gcr.io/apigee-microgateway/edgemicro:latest USER root RUN apt-get update && \ apt-get install -y unzip && \ rm -rf /var/lib/apt/lists/* && \ mkdir /opt/apigee/customplugins && \ chown apigee:apigee /opt/apigee/customplugins COPY plugins.zip /opt/apigee/customplugins RUN su - apigee -c "unzip /opt/apigee/customplugins/plugins.zip -d /opt/apigee/customplugins" EXPOSE 8000 EXPOSE 8443 USER apigee ENTRYPOINT ["/opt/apigee/entrypoint.sh"]Создайте новый образ Docker для Edge Microgateway со своими плагинами:
docker build -t image-name .Пример:
docker build -t edgemicroplugins .
3. Обновите конфигурацию Edge Microgateway
Теперь, когда плагины упакованы, их нужно добавить в файл конфигурации Edge Microgateway.
Откройте файл конфигурации Edge Microgateway в редакторе:
$HOME/.edgemicro/org-env-config.yaml
Пример:
vi $HOME/.edgemicro/myorg-test-config.yaml
Добавьте каталог плагина в файл конфигурации. В следующем примере атрибут
dirуказывает местоположение кода плагина (которое вы указали в Dockerfile). Также необходимо указать название каталога плагина, которое в примере ниже выглядит какresponse-uppercase.edgemicro: ... plugins: dir: /opt/apigee/plugins sequence: - oauth - response-uppercase
4. Запустите микрошлюз
Наконец, запустите микрошлюз в контейнере.
Выполните следующую команду, чтобы закодировать в Base64 файл конфигурации Edge Microgateway, расположенный в
$HOME/.edgemicro:export EDGEMICRO_CONFIG=`base64 $HOME/.edgemicro/your_org-your_env-config.yaml`
где
your_orgиyour_env– организация и среда, которые вы использовали при выполнении командыedgemicro config.Не забудьте заключить команду в обратные кавычки (`). Пример:
export EDGEMICRO_CONFIG=`base64 $HOME/.edgemicro/docs-test-config.yaml`
Запустите Edge Microgateway в качестве контейнера. Команда задает несколько переменных среды, которые используются средой выполнения контейнера для запуска Edge Microgateway:
docker run -P -p 8000:8000 -d --name edgemicroplugins \ -e EDGEMICRO_PLUGIN_DIR=/opt/apigee/customplugins/plugins \ -e EDGEMICRO_ORG=your_org \ -e EDGEMICRO_ENV=your_env \ -e EDGEMICRO_KEY=your_key \ -e EDGEMICRO_SECRET=your_secret \ -e "EDGEMICRO_CONFIG=$EDGEMICRO_CONFIG" \ -e SERVICE_NAME=edgemicroplugins image_name
Пример:
docker run -P -p 8000:8000 -d --name edgemicroplugins \ -e EDGEMICRO_PLUGIN_DIR=/opt/apigee/customplugins/plugins \ -e EDGEMICRO_ORG=docs \ -e EDGEMICRO_ENV=test \ -e EDGEMICRO_KEY=d9c34e1aff68ed969273b016699eabf48780e4f652242e72fc88a23e21252cb0 \ -e EDGEMICRO_SECRET=3bc95a71c86a3c8ce04137fbcb788158731t51dfc6cdec13b7c05aa0bd969430 \ -e "EDGEMICRO_CONFIG=$EDGEMICRO_CONFIG" \ -e SERVICE_NAME=edgemicroplugins edgemicroplugins
Вызовите API, чтобы протестировать плагин:
Проверьте выполнение кода плагина, вызвав API и убедившись, что выходные данные соответствуют ожидаемым:
curl -i http://localhost:8000/hello -H "x-api-key:apikey"
Например, плагин
response-uppercaseможет вернуть такой ответ:curl -i http://localhost:8000/hello -H "x-api-key:PydUKRDGIXRqF2xh4usn1FLHbhGKVIz" HELLO, WORLD!