استفاده از Docker برای Edge Microgateway

درحال مشاهده اسناد Apigee Edge هستید.
به اسناد Apigee X بروید.
اطلاعات

این موضوع نحوه اجرای 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

    برای جزئیات بیشتر درباره پیکربندی، بخش ۱: پیکربندی 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-aware، یک محصول API، یک توسعه‌دهنده، و یک برنامه توسعه‌دهنده است. برای دستورالعمل‌های کامل، به ایجاد نهادها در Apigee Edge مراجعه کنید.

اجرای Edge Micro به‌عنوان محفظه Docker

  1. تصویر Docker را برای Edge Microgateway بارگیری کنید:

    docker pull gcr.io/apigee-microgateway/edgemicro:latest
  2. قبل‌از رفتن به مراحل بعدی، مطمئن شوید همه مراحل بخش پیش‌نیازها را انجام داده‌اید.

  3. فرمان زیر را اجرا کنید تا فایل پیکربندی 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`
  4. 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 را ببینید.
    -p یک درگاه یا گستره‌ای از درگاه‌ها را به‌طور صریح نگاشت کنید. همچنین مرجع اجرای Docker را ببینید.
    -d اجرا در حالت جداشده. همچنین مرجع اجرای Docker را ببینید.
    -v, -- volume یک سوار کردن حجم را مشخص می‌کند. توجه داشته باشید که اگر Edge Microgateway را برای استفاده از TLS در محفظه Docker پیکربندی کنید، درصورت نصب دایرکتوری فایل گزارش، باید درگاه ۸۴۴۳ را آشکار کنید. همچنین 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

    1. برای بررسی اینکه محفظه درحال اجرا است:

      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 دنبال کنید، محتوی به‌طور پیش‌فرض خروجی استاندارد و خروجی خطا را به فایلی در محتوی در این مکان هدایت می‌کند: ${APIGEE_ROOT}/logs/edgemicro.log.

    برای جلوگیری از ارسال اطلاعات گزارش به edgemicro.log، هنگام اجرای محفظه از متغیر LOG_CONSOLE_OUTPUT_TO_FILE استفاده کنید.

    جدول زیر رفتار خروجی گزارش را هنگام استفاده از LOG_CONSOLE_OUTPUT_TO_FILE با to_console شرح می‌دهد:

    to_console: true

    LOG_CONSOLE_OUTPUT_TO_FILE=false

    • همان‌طور که در مدیریت فایل‌های گزارش شرح داده شده است، هیچ گزارشی به فایل گزارش Edge Microgateway ارسال نخواهد شد.
    • گزارش‌ها به فایل edgemicro.log ارسال نخواهد شد.
    to_console: true

    LOG_CONSOLE_OUTPUT_TO_FILE=true

    • همان‌طور که در مدیریت فایل‌های گزارش شرح داده شده است، هیچ گزارشی به فایل گزارش Edge Microgateway ارسال نخواهد شد.
    • گزارش‌ها به فایل edgemicro.log ارسال خواهد شد.
    to_console: false

    LOG_CONSOLE_OUTPUT_TO_FILE=true

    • گزارش‌ها به فایل گزارش Edge Microgateway ارسال خواهد شد، همان‌طور که در مدیریت فایل‌های گزارش شرح داده شده است.
    • گزارش‌ها به فایل edgemicro.log ارسال خواهد شد.

    درحال آزمایش فراخوانی میانای برنامه‌سازی کاربردی

    پس‌از راه‌اندازی Edge Microgateway در محفظه، می‌توانید فراخوانی‌های میانای برنامه‌سازی کاربردی را به آن انجام دهید. برای مثال، اگر مسیر پایه میانای برنامه‌سازی کاربردی شما /hello باشد:

    http://localhost:8000/hello

    نمونه برونداد:

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

    اگر این پاسخ را می‌بینید، یعنی Edge Microgateway با موفقیت فراخوانی API را مدیریت کرده است. بااین‌حال، Edge Microgateway به‌طور پیش‌فرض برای اصالت‌سنجی به کلید میانای برنامه‌سازی کاربردی نیاز دارد. در بخش بعدی، میانای برنامه‌سازی کاربردی را با کلید میانای برنامه‌سازی کاربردی معتبر آزمایش خواهید کرد.

    آزمایش کردن میانای برنامه‌سازی کاربردی با کلید میانای برنامه‌سازی کاربردی معتبر

    در میانای کاربر Edge، به «برنامه توسعه‌دهنده» که قبلاً ایجاد کرده‌اید بروید. در صفحه Developer App، کلید مصرف‌کننده را نشان دهید و آن را کپی کنید. این مقدار کلید میانای برنامه‌سازی کاربردی است. از این کلید برای برقراری تماس‌های API اصالت‌سنجی‌شده استفاده خواهید کرد.

    با سرصفحه x-api-key به‌صورت زیر با میانای برنامه‌سازی کاربردی تماس بگیرید. مقدار «کلید مصرف‌کننده» که از «برنامه توسعه‌دهنده» کپی کردید، کلید میانای 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 بیشتر بدانید، بخش ۴: ایمن‌سازی Edge Microgateway را ببینید.

    درحال توقف Edge Microgateway

    از فرمان Docker زیر برای توقف Edge Microgateway استفاده کنید:

    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
    ...
    

    استفاده کردن از CA که Node.js به آن اعتماد ندارد

    اگر از «مرجع صدور گواهینامه» (CA) استفاده می‌کنید که به‌طور پیش‌فرض توسط 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 ارائه شده است.

    1. مخزن منبع Edge Microgateway را از https://github.com/apigee-internal/microgateway همسانه‌سازی یا بارگیری کنید.

    2. cd به فهرست راهنمای microgateway/kubernetes/docker/edgemicro در فهرست راهنمای کد منبع.

      برای مثال:

      cd $HOME/git/microgateway/kubernetes/docker/edgemicro
      
    3. فایل entrypoint.sh را باز کنید و کد را اصلاح کنید تا متغیر محیطی NODE_TLS_REJECT_UNAUTHORIZED را بپذیرد. بعداً، وقتی محفظه را اجرا می‌کنید، مقداری برای این متغیر مشخص خواهید کرد.

    4. محتوی Docker را بسازید:

      docker build -t edgemicro .
      
    5. هنگام اجرای محفظه، گزینه -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 به مشتریان اجازه می‌دهد هنگام برقراری تماس‌های API با Edge Microgateway از HTTPS استفاده کنند. نمونه زیر از گواهی‌های خودامضا استفاده می‌کند.

    ۱. مراحل راه‌اندازی اولیه

    1. فایل openssl.cnf را در سیستم خود پیدا کنید. برای مثال، /etc/ssl/openssl.cnf.
    2. فایل opensssl.cnf را برای ویرایش باز کنید.
    3. مطمئن شوید req_extensions در فایل پیکربندی شما وجود داشته باشد. برای مثال، باید اطلاعاتی مشابه موارد زیر در فایل خود داشته باشید:

      [ req ]
      ...
      req_extensions          = v3_req
      ...
      
      [ v3_req ]
      extendedKeyUsage = serverAuth, clientAuth, codeSigning, emailProtection
      basicConstraints = CA:FALSE
      keyUsage = nonRepudiation, digitalSignature, keyEncipherment
      
    4. برای تولید مشخصه‌های 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
      
    5. اگر قبلاً این کار را نکرده‌اید، مراحل ارائه‌شده در بخش پیش‌نیازها را برای مقداردهی اولیه و پیکربندی Edge Microgateway دنبال کنید. پس‌از تکمیل، باید یک پراکسی آگاه از Edge Microgateway، یک محصول API، یک توسعه‌دهنده، و یک برنامه توسعه‌دهنده ایجاد کرده باشید. علاوه‌براین، باید فرمان edgemicro configure را اجرا کرده باشید و یک کلید و رمز دریافت کرده باشید.

    ۲. تولید گواهینامه‌های خودامضا

    سپس، گواهینامه‌ها و کلیدهایی را که برای ایجاد TLS نیاز دارید تولید کنید:

    1. cd به فهرست راهنمای $HOME/.edgemicro.
    2. اسکریپت 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
      
    3. در فایل bash، مطمئن شوید که مسیر فایل openssl.cnf درست است.

    4. فایل bash را اجرا کنید. اطلاعات گواهی از شما درخواست می‌شود. حتماً از localhost برای «نام مشترک» استفاده کنید.

    5. بررسی کنید که فایل‌های زیر ایجاد شده باشند:

      • rootca.key
      • rootca.pem
      • tls.key
      • tls.csr
      • rootca.srl
      • tls.crt

    ۳. فایل پیکربندی Edge Microgateway را ویرایش کنید

    1. فایل پیکربندی Edge Micro را در ویرایشگر باز کنید. برای مثال:

      vi $HOME/.edgemicro/myorg-test-config.yaml
      
    2. بند 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:
      ...
      
    3. فرمان زیر را اجرا کنید تا فایل پیکربندی 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 را ببینید.

    ۴. اجرای محفظه

    1. فرمان زیر را برای اجرای محفظه 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
      
    2. به پارامترهای زیر که در فرمان استفاده شده‌اند توجه کنید؛ این پارامترها با فرمان پایه‌ای که در اجرای Edge Micro به‌عنوان محفظه Docker شرح داده شده است تفاوت دارند.

      • port روی 8443 تنظیم شده است.
      • از نصب حجم برای نصب فایل‌های کلید و گواهی استفاده می‌شود.
      • متغیر NODE_EXTRA_CA_CERTS برای افزودن CA سفارشی (درصورت نیاز در گواهی‌های خودامضا) استفاده می‌شود.

    ۵. آزمایش پیکربندی «امنیت لایه انتقال» (TLS)

    1. برای آزمایش راه‌اندازی، فرمان cURL زیر را اجرا کنید. مسیر پایه و کلید میانای API خود را در فرمان جایگزین کنید. مثال زیر فرض می‌کند که شما در دایرکتوری‌ای هستید که rootca.pem در آن قرار دارد و پراکسی‌ای که ایجاد کرده‌اید دارای مسیر پایه /hello است:

      curl -v https://localhost:8443/hello --cacert rootca.pem \
      -H "x-api-key: Az82fdnfONVCOOE4NKhajxAboDgA3FAo"
      
    2. خروجی پرجزئیات 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.
    2. فایل opensssl.cnf را برای ویرایش باز کنید.
    3. مطمئن شوید req_extensions در فایل پیکربندی شما وجود داشته باشد. برای مثال، باید اطلاعاتی مشابه موارد زیر در فایل خود داشته باشید:

      [ req ]
      ...
      req_extensions          = v3_req
      ...
      
      [ v3_req ]
      extendedKeyUsage = serverAuth, clientAuth, codeSigning, emailProtection
      basicConstraints = CA:FALSE
      keyUsage = nonRepudiation, digitalSignature, keyEncipherment
      
    4. برای تولید مشخصه‌های 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
      
    5. فرمان edgemicro configure را اجرا کنید:

      edgemicro configure -o your_org -e your_env -u your_username

      برای جزئیات بیشتر درباره پیکربندی، بخش ۱: پیکربندی Edge Microgateway را ببینید.

    6. کلید و اطلاعات اعتباری رمز را که از edgemicro configure برگردانده شده است کپی کنید. برای اجرای محتوی به این مقادیر نیاز خواهید داشت. برای مثال:

      The following credentials are required to start edge micro
        key: d9c34e1aff68ed969273c016699eabf48780e4f652242e72fc88a43e21252cb0
        secret: 3bc95a71c86a3c8ce04537fbcb788158731t51dfc6cdec13b7c05aa0bd969430
      

    ۲. ایجاد کردن برنامه هدف Node.js

    1. cd به فهرست راهنمای .edgemicro.

    2. اسکریپت 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
      
    3. در فایل bash، مطمئن شوید که مسیر فایل openssl.cnf درست است.

    4. فایل bash را اجرا کنید. اطلاعات گواهی از شما درخواست می‌شود. حتماً از hellworld برای «نام مشترک» استفاده کنید.

    5. بررسی کنید که فایل‌های زیر ایجاد شده باشند:

      • rootca.key
      • rootca.pem
      • tls.key
      • tls.csr
      • rootca.srl
      • tls.crt
    6. فایل جدیدی به‌نام 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);
      
    7. فایل 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"
        }
      }
      
    8. برای دریافت وابستگی‌ها، npm install را اجرا کنید.

    9. 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" ]
      
    10. تصویر Docker را بسازید:

      docker build -t helloworld . 
      
    11. برنامه نمونه را شروع کنید:

      docker run -P -p 9443:9443 --name helloworld helloworld
      

    ۳. ایجاد نهادها در Apigee Edge

    1. با این تنظیمات، پراکسی Edge Microgateway-aware ایجاد کنید. برای اطلاعات بیشتر، ایجاد پراکسی میانای برنامه‌سازی کاربردی Edge Microgateway-aware در Edge را ببینید.

      • نام پراکسی: edgemicro_local
      • بازبینی: 1
      • مسیر پایه: /local
      • هدف: https://helloworld:9443
    2. محصول میانای برنامه‌سازی کاربردی ایجاد کنید. برای جزئیات، ایجاد محصول را ببینید.

    3. توسعه‌دهنده‌ای ایجاد کنید. برای جزئیات، ایجاد توسعه‌دهنده را ببینید.

    4. برنامه توسعه‌دهنده ایجاد کنید. برای جزئیات، به ایجاد برنامه توسعه‌دهنده مراجعه کنید

    ۴. اجرای محفظه

    1. فایل پیکربندی Edge Micro را در ویرایشگر باز کنید. برای مثال:

      vi $HOME/.edgemicro/myorg-test-config.yaml
      
    2. بند 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:
      ...
      
    3. فرمان زیر را اجرا کنید تا فایل پیکربندی 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`
    4. فرمان زیر را اجرا کنید تا 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
      

    ۵. آزمایش پیکربندی «امنیت لایه انتقال» (TLS)

    1. برای آزمایش راه‌اندازی، فرمان cURL زیر را اجرا کنید. مسیر پایه‌ای را که در پراکسی آگاه از microgateway استفاده کردید و کلید میانای برنامه‌سازی کاربردی را که از برنامه «توسعه‌دهنده» ایجادشده در 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"}
      
    2. 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
      
    3. فرمان cURL زیر را اجرا کنید. مسیر پایه و کلید میانای API خود را مانند قبل جایگزین کنید. برای مثال:

      curl https://localhost:8443/local -k -H "x-api-key: xxxx" -v
      
    4. برونداد را بررسی کنید. درصورت موفقیت، پاسخ وضعیت 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 آشنا هستید. اگر نه، توسعه افزایه‌های سفارشی را ببینید.

    گزینه الف: سوار کردن دایرکتوری افزایه‌ها روی یک جلد

    (در نسخه ۲.۵.۲۷ اضافه شده است) مراحل افزودن افزایه‌ها ازطریق نصب حجم مشابه مراحل لازم برای افزودن هر افزایه سفارشی به Edge Microgateway است. وقتی محفظه Docker را اجرا می‌کنید، می‌توانید دایرکتوری افزایه‌ها را در سیستم محلی‌تان (درایو) در نقطه نصب محفظه که /opt/apigee/plugins است نصب کنید. سپس فهرست راهنمای حجم محلی را در فایل پیکربندی Edge Microgateway مشخص می‌کنید.

    مراحل زیر نحوه استفاده از نقطه نصب Docker را برای گنجاندن افزونه‌های سفارشی نشان می‌دهد.

    1. توقف Edge Microgateway:

      edgemicro stop
      
    2. فهرست راهنمایی برای افزونه‌های سفارشی‌تان ایجاد کنید. برای مثال، ایجاد کردن

      $HOME/edgemicro/custom/plugins
      
    3. فهرست راهنمای افزونه سفارشی را به فایل پیکربندی Edge Microgateway اضافه کنید. برای مثال:

        plugins:
          dir: $HOME/edgemicro/custom/plugins
          sequence:
            - oauth
            - response-uppercase
        ````
      
    4. افزونه‌تان را طبق دستورالعمل‌های نوشتن افزونه ساده بنویسید و آزمایش کنید. حتماً کد افزونه‌تان را در ساختار دایرکتوری مناسب قرار دهید. برای مثال:

      custom
        |
        |-- plugins
          |
          |- response-uppercase
          |     |- index.js
          |     |- package.json
          |- request-headers
          |     | - index.js
                | - package.json
      
    5. محتوی 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
      
    6. برای آزمایش کردن افزونه، میانای برنامه‌سازی کاربردی‌تان را فراخوانی کنید.

    برای اطلاعات بیشتر، VOLUME [shared filesystems]‎ را ببینید.

    گزینه ب: ساختن افزایه‌ها در ظرف

    در این گزینه، افزایه‌ها را در محفظه خود می‌سازید.

    ۱. بسته‌بندی افزایه‌ها

    1. افزونه‌تان را طبق دستورالعمل‌های نوشتن افزونه ساده بنویسید و آزمایش کنید.

    2. کد افزونه‌تان را در ساختار دایرکتوری مناسب قرار دهید. دایرکتوری‌های افزونه باید از ساختار مجموعه‌ای پیروی کنند. مثال زیر ساختاری را نشان می‌دهد که باید دنبال کنید، که در آن response-uppercase و request-headers نام پوشه‌های حاوی کد افزونه سفارشی هستند (این نام‌ها فقط مثال هستند، نام پوشه‌های شما ممکن است متفاوت باشد):

      plugin
        |
        |-- plugins
          |
          |- response-uppercase
          |     |- index.js
          |     |- package.json
          |- request-headers
          |     | - index.js
                | - package.json
      
    3. cd به پوشه plugin.

    4. در پوشه plugin، کل پوشه plugins را فشرده کنید:

      zip -r plugins.zip plugins/

    ۲. ایجاد کردن تصویر Docker

    سپس، Dockerfile ایجاد کنید تا کد افزایه‌تان را به تصویر Edge Microgateway اضافه کنید.

    1. در همان دایرکتوری که فایل zip قرار دارد، فایل جدیدی به‌نام Dockerfile ایجاد کنید.
    2. کد زیر را به 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"]
      
    3. تصویر Docker جدیدی از Edge Microgateway با افزایه‌هایتان ایجاد کنید:

      docker build -t image-name .

      برای مثال:

      docker build -t edgemicroplugins .

    ۳. به‌روزرسانی پیکربندی Edge Microgateway

    اکنون که افزایه‌ها بسته‌بندی شده‌اند، باید آن‌ها را به فایل پیکربندی Edge Microgateway اضافه کنید.

    1. فایل پیکربندی Edge Microgateway را در ویرایشگر باز کنید:

      $HOME/.edgemicro/org-env-config.yaml
      

      برای مثال:

      vi $HOME/.edgemicro/myorg-test-config.yaml
    2. فهرست راهنمای افزونه را به فایل پیکربندی اضافه کنید. در مثال زیر ویژگی dir مکان کد افزونه را مشخص می‌کند (که شما در Dockerfile مشخص کرده‌اید). همچنین باید نام دایرکتوری افزونه را مشخص کنید که در مثال زیر response-uppercase است.

      edgemicro:
        ...
        plugins:
          dir: /opt/apigee/plugins
          sequence:
            - oauth
            - response-uppercase
      

    ۴. راه‌اندازی ریزدروازه

    درنهایت، باید ریزدروازه را در محفظه شروع کنید.

    1. فرمان زیر را اجرا کنید تا فایل پیکربندی 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`
    2. 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
    3. برای آزمایش افزونه، میانای برنامه‌سازی کاربردی خود را فراخوانی کنید:

      با فراخوانی میانای برنامه‌سازی کاربردی و تأیید اینکه خروجی طبق انتظار است، آزمایش کنید که کد افزونه اجرا می‌شود:

      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!