Как развернуть Edge Microgateway в качестве прокси-сервера sidecar

Вы просматриваете документацию по Apigee Edge.
Перейдите к документации по Apigee X.
Информация

Введение

В этой статье рассказывается, как запустить Edge Microgateway в кластере Kubernetes в качестве прокси-сервера типа "сайдкар". Развернуть контейнер можно двумя способами: вручную или автоматически. В этой статье описаны оба варианта.

Подробнее о микрошлюзе Edge в Kubernetes…

Подготовка

Выполните инструкции из раздела Требования.

Как развернуть тестовый сервис

Разверните простой сервис "hello" и проверьте развертывание:

  1. Разверните пример:

    kubectl apply -f samples/helloworld/helloworld.yaml --namespace=default
  2. Убедитесь, что сервис запущен. Возможно, вам придется подождать несколько минут, пока контейнер не будет запущен:

    kubectl get pods --namespace=default

    Примеры результатов:

    NAME                          READY     STATUS    RESTARTS   AGE
    helloworld-569d6565f9-lwrrv   1/1       Running   0          17m
    
  3. Удалите развертывание тестового сервиса. Вы переустановите его позже, после того как включите внедрение сайдкара:

     kubectl delete -f samples/helloworld/helloworld.yaml --namespace=default

Как вручную внедрить контейнер Sidecar

Из двух вариантов внедрения контейнера manual sidecar injection – более простой и понятный подход, который можно реализовать с помощью одной команды kubectl.

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

Следующая команда настраивает Edge Microgateway для организации Apigee и развертывает прокси-сервер edgemicro-auth.

  1. Выполните следующую команду:

    edgemicro configure -o [org] -e [env] -u [username]

    Где:

    • org – название организации Edge (требуются права администратора организации).

    • env – среда в вашей организации (например, тестовая или производственная).

    • username – адрес электронной почты, связанный с вашим аккаунтом Apigee.

    Пример

    edgemicro configure -o myorg -e test -u jdoe@example.com

    Выходные данные (пример ниже) сохраняются в файле:

    $HOME/.edgemicro/org_name-env_name-config.yaml
    .

    current nodejs version is v6.9.1
    current edgemicro version is 2.5.25
    password:
    file doesn't exist, setting up
    Give me a minute or two... this can take a while...
    App edgemicro-auth deployed.
    checking org for existing KVM
    KVM already exists in your org
    configuring host edgemicroservices.apigee.net for region us-west1
    
    saving configuration information to: /Users/jdoe/.edgemicro/myorg-test-config.yaml
    
    vault info:
     -----BEGIN CERTIFICATE-----
    MIICpDCCAYwCCQCV9eBcO9a5WzANBgkqhkiG9w0BAQsFADAUMRIwEAYDVQQDDAls
    b2NhbGhvc3QwHhcNMagwODA5MDAzMDEzWhcNMTgwODEwMDAzMDEzWjAUMRIwEAYD
    VQQDDBlsb2NhbGhvc3QwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDh
    nAHT7JHX/WvWHRFb8FLm53SPIDld5LyPOUfINdEyhSIEeXoOUKg4EPweJPVSC9Vm
    Hw4ZMtEqWJM/XsQWvLe8ylRJa5wgmzmFCqAsuzs9+rmc9KvJqjpOh2uRTUf7KKfT
    iXL2UEseprcI5g8zNyqKyEf/ecWIwz3AkkPAZebVTsrdDfIDHvkyhhvlAHZAB9kn
    GtqP3N8kOlv4KQto9Gr7GYUGUIDugt7gM1F611+RBS+fYRi32GUAq/UQDkhYL8cp
    oIJiF7UYkk2+9t9CdOCDuIUCvJioHJQd0xvDpkC9f6LvwjwnCwku+4F2Q63+av5I
    mJoZJQPvW5aP53Qkk+kHAgMBAAEwDKYJKoZIhvcNAQELBQADggEBALyUBolXUFN8
    1bf268nR+gS8MOFDTxO1bUz+bKuT/g3K1PuNUJTueT+0L1H2OiZUzazAqwn2sqzN
    lQuvLg6LjxjlNkqTJGiJvGDcYVq45dv7UyxAZxhqxTxhlQ+Yu5R9pbQnzujezHpH
    6gtCoCkSt/QqiJ3YsmsVu5is+HpIJepMt0CyMh5tK9j87hl46QhHklaVfQ3ycMVm
    /wNPR/pjizg1FDUeq4nj/7DBVbMf9net/BDaZLeSW1HJ1vcsCXIcSZfQd4QymGFn
    8ADrND7ydVjwO/s23soPDTy0g4yLIZvky2tpT8d7YahNqSv2n7sXsLxruzcyCoQ4
    w+e3Z3F7IKI=
    -----END CERTIFICATE-----
    
    The following credentials are required to start edge micro
      key: 1a3b2754c7f20614817b86e09895825ecc252d34df6c4be21ae24356f09e6eb4
      secret: 16ad2431de73f07f57a6d44048f08d93b63f783bf1f2ac4221182aa7289c7cef
    
    edgemicro configuration complete!
    

Как внедрить Edge Microgateway в качестве дополнительного контейнера

Чтобы вручную внедрить Edge Microgateway в под сервиса в качестве прокси-сервера, выполните следующую команду:

kubectl apply -f <(edgemicroctl -org=your_org -env=your_env -key=your_key -sec=your_secret -conf=config_file_path -svc=service_deployment_file)

где:

  • your_org – организация Apigee, указанная в команде edgemicro configure.
  • your_env – среда, указанная в команде edgemicro configure.
  • your_key – ключ, возвращенный командой edgemicro configure.
  • your_secret – секрет, возвращенный командой edgemicro configure.
  • config_file_path – путь к файлу конфигурации Edge Micro, возвращенный командой edgemicro configure.
  • service_deployment_file – путь к файлу развертывания сервиса, для пода которого будет создан дополнительный контейнер. Пример: samples/helloworld/helloworld.yaml.

Пример:

kubectl apply -f <(edgemicroctl -org=myorg -env=test-key=0e3ecea28a64099410594406b30e54439af5265f8 -sec=e3919250bee37c69cb2e5b41170b488e1c1d -conf=/Users/jdoe/.edgemicro/myorg-test-config.yaml -svc=samples/helloworld/helloworld.yaml)

Как проверить конфигурацию

  1. Проверьте развертывания сервисов:

    kubectl get services -n default

    Примеры результатов:

    NAME         TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)          AGE
    helloworld   NodePort    10.15.254.163   <none>        8081:32401/TCP   56s
    kubernetes   ClusterIP   10.15.240.1     <none>        443/TCP          41m
    
  2. Теперь вы можете протестировать развертывание Edge Microgateway в качестве дополнительного контейнера. Подробные инструкции приведены в разделе Как проверить прокси-сервер.

Как использовать автоматическую вставку контейнеров

На следующих шагах вы настроите автоматическую вставку контейнеров-компаньонов для кластера Kubernetes. Эта конфигурация позволяет внедрить Edge Microgateway в Kubernetes в качестве дополнительного прокси-сервера.

Как установить инжектор сайдкара

  1. Установите ConfigMap, который позволяет внедрять контейнер Edge Microgateway:

    kubectl apply -f install/kubernetes/edgemicro-sidecar-injector-configmap-release.yaml
  2. Выполните следующий скрипт, чтобы установить сервис webhook. Для автоматического внедрения контейнера Sidecar требуется сервис веб-перехватчика:

    ./install/kubernetes/webhook-create-signed-cert.sh \
        --service edgemicro-sidecar-injector \
        --namespace edgemicro-system \
        --secret sidecar-injector-certs
    
  3. Добавьте пакет сертификатов ЦС в файл установки веб-перехватчика. Сервер API Kubernetes использует этот файл для вызова веб-перехватчика:

    cat install/kubernetes/edgemicro-sidecar-injector.yaml | \
         ./install/kubernetes/webhook-patch-ca-bundle.sh > \
         install/kubernetes/edgemicro-sidecar-injector-with-ca-bundle.yaml
    
  4. Установите веб-перехватчик инжектора Edge Microgateway:

    kubectl apply -f install/kubernetes/edgemicro-sidecar-injector-with-ca-bundle.yaml
    

    Примеры результатов:

    service "edgemicro-sidecar-injector" created
    serviceaccount "edgemicro-sidecar-injector-service-account" created
    deployment "edgemicro-sidecar-injector" created
    mutatingwebhookconfiguration "edgemicro-sidecar-injector" created
    
  5. Убедитесь, что веб-перехватчик инжектора Edge Microgateway работает:

    kubectl -n edgemicro-system get deployment -ledgemicro=sidecar-injector
    

    Примеры результатов:

    NAME                         DESIRED   CURRENT   UP-TO-DATE   AVAILABLE   AGE
    edgemicro-sidecar-injector   1         1         1            1           12m
    
  6. Убедитесь, что в кластере запущен контейнер для внедрения дополнительных контейнеров. В пространстве имен edgemicro-system установлены системные сервисы, в том числе контроллер Ingress, HTTP-сервер по умолчанию и инжектор sidecar:

    kubectl get pods -n edgemicro-system

    Примеры результатов:

    NAME                                            READY     STATUS    RESTARTS   AGE
    default-http-backend-55c6c69b88-gfnfd           1/1       Running   0          1h
    edgemicro-ingress-controller-64444469bf-jhn8b   1/1       Running   3          1h
    edgemicro-sidecar-injector-7d95698fbf-cq84q     1/1       Running   0          3m
    

Как настроить и внедрить Edge Microgateway

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

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

    ./install/kubernetes/webhook-edgemicro-patch.sh

    Информацию о входных параметрах можно найти в справочнике.

    Примеры входных данных:

    1. Namespace to deploy application [default]:

      Нажмите Ввод.

    2. Authenticate with OAuth Token ("n","Y") [N/y]

      Введите n.

    3. Apigee username [required]:

      Введите имя пользователя Apigee (адрес электронной почты). Пример: jdoe@google.com.

    4. Apigee password [required]:

      Введите пароль Apigee.

    5. Apigee organization [required]:

      Введите название организации Apigee.

    6. Apigee environment [required]:

      Введите название среды для своей организации. Пример: "test".

    7. Virtual Host [default]:

      Нажмите Ввод.

    8. Is this Private Cloud ("n","y") [N/y]:

      Если вы используете общедоступное облако, введите n.

    9. Edgemicro Key. Press Enter to generate:

      Нажмите Ввод.

    10. Edgemicro Secret. Press Enter to generate:

      Нажмите Ввод.

    11. Edgemicro org-env-config.yaml. Press Enter to generate:

      Нажмите Ввод.

      Примеры результатов:

      current nodejs version is v6.9.1
      current edgemicro version is 2.5.25
      config initialized to /Users/jdoe/.edgemicro/default.yaml
      Configure for Cloud
      ******************************************************************************************
      Config file is Generated in /Users/jdoe/Work/GITHUB/microgateway_2.5.25_Darwin_x86_64/config directory.
      
      Please make changes as desired.
      *****************************************************************************************
      
    12. Do you agree to proceed("n","y") [N/y]:

      Введите y.

      Примеры результатов:

      Configuring Microgateway with
      
      key:daacf75dd660d160b801c9117fb1ec0935896615479e39dbbae88be81a2d84
      secret:a60fd57c1db9f3a06648173fb541cb9c59188d3b6037a76f490ebf7a6584b0
      config:~/.edgemicro/jdoe-test-config.yaml
      
      ********************************************************************************************************
      kubectl apply -f install/kubernetes/edgemicro-config-namespace-bundle.yaml
      ********************************************************************************************************
      
  2. Выполните команду, указанную в последней строке вывода. Эта команда kubectl внедряет сгенерированный профиль конфигурации Edge Microgateway в Kubernetes:

    kubectl apply -f install/kubernetes/edgemicro-config-namespace-bundle.yaml
  3. Просмотр статуса внедрения веб-перехватчика Сейчас она отключена:

    kubectl get namespace -L edgemicro-injection

    Примеры результатов:

    NAME               STATUS    AGE       EDGEMICRO-INJECTION
    default            Active    1d
    edgemicro-system   Active    1d
    kube-public        Active    1d
    kube-system        Active    1d
    
  4. Чтобы включить внедрение веб-перехватчика для веб-перехватчика, выполните следующую команду:

    kubectl label namespace default edgemicro-injection=enabled
  5. Повторно проверьте статус внедрения веб-перехватчика. Обратите внимание, что теперь функция включена:

    kubectl get namespace -L edgemicro-injection

    Примеры результатов:

    NAME               STATUS    AGE       EDGEMICRO-INJECTION
    default            Active    1d        enabled
    edgemicro-system   Active    1d
    kube-public        Active    1d
    kube-system        Active    1d
    

Разверните тестовый сервис

Затем повторно разверните тестовый сервис. Edge Microgateway будет автоматически внедрен в контейнер сервиса.

kubectl apply -f samples/helloworld/helloworld.yaml --namespace=default

Убедитесь, что Edge Microgateway был внедрен в контейнер вместе с тестовым сервисом:

kubectl get pods --namespace=default --watch

Примеры результатов:

NAME                          READY     STATUS            RESTARTS   AGE
helloworld-6987878fc4-pkw8h   0/2       PodInitializing   0          12s
helloworld-6987878fc4-pkw8h   2/2       Running           0         26s

Когда статус изменится на Running, нажмите ctrl-c, чтобы выйти из команды.

Теперь вы можете протестировать автоматическое развертывание Edge Microgateway в качестве дополнительного контейнера. Подробные инструкции приведены в разделе Как проверить прокси-сервер.

Как проверить прокси-сервер

При развертывании с использованием дополнительного контейнера прокси API для вашего сервиса создается автоматически. Вам не нужно создавать прокси, совместимый с Edge Microgateway.

Как получить IP-адрес Ingress

Используя внешний IP-адрес для Ingress, вы можете вызывать сервис извне кластера.

  1. Получите внешний IP-адрес контроллера Ingress:

    kubectl get ing -o wide

    Примеры результатов:

    NAME      HOSTS     ADDRESS        PORTS     AGE
    gateway   *         35.238.13.54   80        1m
    
  2. Скопируйте значение EXTERNAL-IP для Ingress и экспортируйте его в переменную. Вы можете задать переменную вручную:

    export GATEWAY_IP=external_ip

    Пример:

    export GATEWAY_IP=35.238.249.62

    Или используйте следующую команду:

    export GATEWAY_IP=$(kubectl describe ing gateway --namespace default | grep "Address" | cut -d ':' -f2 | tr -d "[:space:]")
  3. Убедитесь, что переменная была экспортирована. Пример:

    echo $GATEWAY_IP

    Примеры результатов:

    35.238.249.62
    
  4. Позвонить в сервис:

    curl $GATEWAY_IP

    Вывод:

    {"error":"missing_authorization","error_description":"Missing Authorization header"}
    

    Затем вы устраните ошибку отсутствия авторизации, настроив продукт API и приложение для разработчиков в Edge, чтобы получить действительный ключ API. Если добавить ключ в заголовок авторизации для вызова API, вызов будет выполнен успешно и эта ошибка не появится.

Как создать компоненты в Apigee Edge

Затем создайте продукт API и приложение для разработчиков в Apigee Edge.

Как создать продукт API

  1. Войдите в Apigee Edge.
  2. В меню навигации слева выберите Publish > API Products (Публикация > Продукты API).
  3. Нажмите + Продукт API. Откроется страница товара.
  4. Заполните страницу товара следующим образом: Для полей, не упомянутых ниже, можно использовать значения по умолчанию. Не нажимайте "Сохранить", пока не получите инструкции.

    Название hello-world-product
    Отображаемое название Edge Micro hello product
    Среда test

  5. В разделе "Путь" нажмите + Специальный ресурс.

  6. Добавьте путь /.

  7. Нажмите + Специальный ресурс ещё раз и добавьте путь /**.

  8. В разделе API Proxies (Прокси API) нажмите + API Proxy (+ Прокси API) и добавьте edgemicro-auth.

  9. Сохраните продукт API.

Создание приложения разработчика

  1. В меню навигации слева выберите Приложения.
  2. Нажмите + Приложение. Откроется страница приложения разработчика.
  3. Заполните страницу приложения разработчика следующим образом: Не нажимайте "Сохранить", пока не получите инструкции.

    Название hello-world-app
    Отображаемое название Edge Micro hello app
    Разработчик Выберите разработчика в раскрывающемся меню.
  4. В разделе "Учетные данные" нажмите + Продукт и выберите созданный вами продукт hello-world-product.

  5. Нажмите Сохранить.

  6. Вы вернетесь на страницу со списком приложений разработчика.

  7. Выберите созданное приложение hello-world-app.

  8. Нажмите Показать рядом с Ключом потребителя.

  9. Скопируйте значение ключа потребителя. Это ключ API, который вы будете использовать для безопасных вызовов API к сервису helloworld.

  10. Подождите несколько минут. Изменения, внесенные в Apigee Edge, синхронизируются с экземпляром Edge Microgateway, развернутым в кластере, в течение нескольких минут.

Вызов API

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

  1. Вызов API без ключа API. Вы увидите сообщение об ошибке, как показано ниже:

    curl $GATEWAY_IP

    Ожидаемый результат

    {"error":"missing_authorization","error_description":"Missing Authorization
    header"}
    

    Чтобы успешно выполнять вызовы API, вам понадобится ключ API.

  2. Получите идентификатор клиента из созданного вами приложения для разработчиков. Это ключ API, который нужен для вызова тестового прокси-сервера:

    curl -H 'x-api-key:your-edge-api-key'  $GATEWAY_IP

    Пример:

    curl -H "x-api-key:DeX2eEesYAdRJ5Gdbo77nT9uUfJZql19" $GATEWAY_IP

    Вывод:

    Hello world
    

    Ответ "Hello world" возвращается сервисом helloworld, развернутым в контейнере. Вызов этого сервиса сначала прошел через Edge Microgateway, где была выполнена аутентификация. Если вы видите ответ "Hello world", значит вы успешно настроили Edge Microgateway как прокси-сервер типа sidecar в поде сервиса helloworld.

Что дальше?

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