تکالیف «هدف‌های میزبانی‌شده»

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

لغو استقرار پراکسی «هدف‌های میزبانی‌شده»

وقتی یک پراکسی Edge را که شامل برنامه «هدف‌های میزبانی‌شده» است لغو استقرار می‌کنید، برنامه «هدف‌های میزبانی‌شده» مرتبط لغو استقرار می‌شود، اما تصویر برنامه زیرین حذف نمی‌شود. اگر کارگزار را دوباره مستقر کنید، برنامه «هدف‌های میزبانی‌شده» دوباره مستقر می‌شود.

حذف پراکسی «هدف‌های میزبانی‌شده»

پس‌از حذف کردن پراکسی «هدف‌های میزبانی‌شده»، نمونه‌های زمان اجرای زیربنایی ظرف مدت زمانی متوقف خواهند شد. بااین‌حال، کد برنامه باقی خواهد ماند.

دسترسی به فایل‌های گزارش

فایل‌های گزارش برای اشکال‌زدایی و عیب‌یابی مفید هستند. می‌توانید دو نوع فایل گزارش برای استقرار «هدف‌های میزبانی‌شده» مشاهده کنید:

  • گزارش ساخت - برونداد مربوط به استقرار و ساخت برنامه «هدف‌های میزبانی‌شده» را نشان می‌دهد.
  • گزارش زمان اجرا - برونداد مربوط به برنامه «هدف‌های میزبانی‌شده» درحال اجرا را نشان می‌دهد. گزارش‌های زمان اجرا محدوده محیط را دربرمی‌گیرد و اطلاعات گزارش را برای نسخه بازبینی پراکسی که درحال‌حاضر مستقر شده است نشان می‌دهد.

دسترسی به گزارش‌ها از واسط کاربر Edge

  1. به این نشانی بروید: apigee.com/edge
  2. اعتبارنامه ورود به سیستم خود را وارد کنید و روی ورود به سیستم کلیک کنید.
  3. در منو پیمایش کناری، توسعه > پراکسی‌های API را انتخاب کنید.
  4. پراکسی موردنظرتان را برای مشاهده گزارش‌ها انتخاب کنید.
  5. روی برگه توسعه کلیک کنید.
  6. برای دیدن گزارش ساخت، روی گزارش‌های ساخت کلیک کنید.
  7. برای دیدن گزارش زمان اجرا، روی گزارش‌های زمان اجرا کلیک کنید.

دسترسی به گزارش‌ها با API

همچنین می‌توانید از Edge API برای بازیابی گزارش‌های «هدف‌های میزبانی‌شده» استفاده کنید. برای جزئیات، دریافت گزارش‌های Node.js ذخیره‌شده در حافظه نهان را ببینید.

استفاده از مخزن خصوصی npm

این بخش توضیح می‌دهد که چگونه در مواردی که از مخزن خصوصی NPM در محیط توسعه خود استفاده می‌کنید، کارگزار نیابتی Node.js را در «هدف‌های میزبانی‌شده» مستقر کنید.

آنچه باید درباره استفاده از مخزن خصوصی بدانید

وقتی برنامه Node.js را در Edge مستقر می‌کنید، همه وابستگی‌های پروژه شما به‌طور خودکار به‌عنوان بخشی از فرایند استقرار وارد می‌شوند. اساساً، «هدف‌های میزبانی‌شده» هنگام استقرار کد شما، npm install را روی آن اجرا می‌کند. بااین‌حال، اگر در محیط توسعه خود از مخزن خصوصی NPM استفاده کنید، وابستگی‌های خصوصی در Cloud قابل‌حل نیستند. در این مورد، راه‌حل این است که هنگام استفاده از ابزار استقرار apigeetool از گزینه --bundled-dependencies استفاده کنید. همچنین ببینید استقرار Node.js از سیستم در Edge.

وقتی از پرچم --bundled-dependencies در apigeetool استفاده می‌کنید، برنامه Node.js شما در «هدف‌های میزبانی‌شده» بارگذاری می‌شود و هر فایل محلی/خصوصی که در آرایه bundledDependencies در package.json فهرست شده است فشرده و همراه با بسته بارگذاری می‌شود.

اگرچه این وضعیت رایج نیست، اما توجه داشته باشید که اگر مخزن عمومی NPM را به‌صورت داخلی قرینه‌سازی کنید، استقرار شما درصورتی‌که بسته استقرار شما شامل فایل .npmrc یا package-lock.json باشد که به قرینه خصوصی شما اشاره می‌کند، با شکست مواجه خواهد شد. در این مورد، حتماً .npmrc یا package-lock.json را از بسته پراکسی که می‌خواهید مستقر کنید حذف کنید.

استقرار با مخزن خصوصی NPM

برای استفاده از واحدهای ارائه‌شده از مخزن خصوصی NPM، این مراحل را دنبال کنید:

  1. به سیستم npm وارد شوید:
    npm login
  2. دریافت نمودار اصالت‌سنجی npm:
    1. .npmrc را پیدا کنید (باید در ~/.npmrc باشد).
    2. در .npmrc، نشان را در انتهای خطی که شبیه این است یادداشت کنید:

      //registry.npmjs.org/:_authToken=****
    3. یا از فرمان‌های npm token <list | create | revoke> برای فهرست کردن، ایجاد کردن، یا باطل کردن کد اصالت‌سنجی استفاده کنید. برای جزئیات بیشتر، مستندات npm-token را ببینید.
  3. همان‌طور که در زیر توضیح داده شده است، به صفحه پیکربندی «نقشه‌های مقدار کلید» دسترسی پیدا کنید.

    Edge

    برای دسترسی به صفحه پیکربندی «نقشه‌های مقدار کلید» بااستفاده از «واسط کاربر Edge»:

    1. به سیستم apigee.com/edge وارد شوید.
    2. در نوار پیمایش سمت راست، سرپرست > محیط‌ها > نقشه‌های مقدار کلید را انتخاب کنید.

    Classic Edge (ابر خصوصی)

    برای دسترسی به صفحه پیکربندی «نقشه‌های مقدار کلید» بااستفاده از «واسط کاربر Edge کلاسیک»:

    1. به سیستم http://ms-ip:9000 وارد شوید، که در آن ms-ip نشانی IP یا نام ساناد گره «سرور مدیریت» است.
    2. در نوار پیمایش بالا، واسط‌های برنامه‌سازی کاربردی > پیکربندی محیط > نقشه‌های مقدار کلید را انتخاب کنید.
  4. روی + نقشه مقدار کلید کلیک کنید.
  5. در چارگوش گفتگوی «نقشه مقدار کلید جدید»، نامی وارد کنید و رمزگذاری‌شده را انتخاب کنید.
  6. روی افزودن کلیک کنید.
  7. نشانه اصالت‌سنجی را که قبلاً پیدا کرده‌اید یا ساخته‌اید به‌عنوان ورودی جدیدی در هریک از KVMهایی که به‌تازگی ساخته‌اید اضافه کنید.
  8. در فایل app.yaml ورودی‌ای اضافه کنید که به KVM و کلید مرتبط با نماد اصالت‌سنجی npm ارجاع دهد. باید چیزی شبیه به این باشد:
  9. env:
    - name: NPM_TOKEN
     valueRef:
       name: npm_store
       key: private_token

    مکان:

    • ویژگی سطح بالا نام با نام متغیر محیطی که ایجاد خواهد شد مطابقت دارد.
    • نام زیر valueRef با KVM که قبلاً ایجاد کرده‌اید مطابقت دارد.
    • ویژگی کلید با کلیدی که به نماد npm شما اضافه‌شده به KVM نگاشت می‌شود مطابقت دارد.
  10. فایل .npmrc را در همان دایرکتوری package.json ایجاد کنید. این فایل باید شبیه این باشد:
    //registry.npmjs.org/:_authToken=${NPM_TOKEN}
    یا اگر از registry.npmjs.org استفاده نمی‌کنید می‌توانید محدوده را در فایل .npmrc تنظیم کنید با افزودن خطی مانند این @myscope:registry=https://mycustomregistry.example.org همچنین مستندات npmrc را ببینید.
  11. کارگزار پراکسی Node.js خود را با فایل .npmrc و فایل‌های app.yaml بارگذاری یا به‌روزرسانی کنید.
  12. مطمئن شوید پراکسی جدید یا به‌روزشده شما با واحد مخزن خصوصی موردنظر مستقر و کار می‌کند.
  13. اگر پراکسی مستقر نمی‌شود، گزارش‌های ساخت را بررسی کنید تا ببینید آیا در نصب واحد npm خصوصی ناموفق بوده است یا نه. اگر این‌طور است:
    1. در برگه توسعه، مطمئن شوید که .npmrc موجود باشد.
    2. مطمئن شوید کد شما معتبر است (با کد موجود در kvm، واحد را به‌صورت محلی نصب کنید).
    3. اگر از محدوده سفارشی استفاده می‌کنید، مطمئن شوید که تنظیم شده باشد.

مشخص کردن نسخه NPM برای وابستگی‌های دسته‌بندی‌شده

به‌طور پیش‌فرض، از NPM v4 برای نصب وابستگی‌های دسته‌ای در محیط «هدف‌های میزبانی‌شده» استفاده می‌شود. بااین‌حال، اگر می‌خواهید از نسخه دیگری از NPM استفاده کنید، می‌توانید آن را در متغیر محیطی NPM_VERSION مشخص کنید. می‌توانید این متغیر را در فایل مانیفست برنامه تنظیم کنید. برای جزئیات بیشتر، عناصر فایل مانیفست را ببینید.

اگر از وابستگی‌های دسته‌ای استفاده می‌کنید و اگر NPM_VERSION را مشخص نکنید، «هدف‌های میزبانی‌شده» به‌طور پیش‌فرض از NPM v4 استفاده می‌کند. اگر از وابستگی‌های دسته‌ای استفاده نمی‌کنید، از نسخه NPM که در زمان اجرای Node.js مشخص‌شده شما گنجانده شده است استفاده می‌شود.

نمونه وابستگی‌های دسته‌ای

برای نمونه‌ای که ویژگی وابستگی‌های دسته‌ای را با «هدف‌های میزبانی‌شده» نشان می‌دهد، به نحوه ایجاد برنامه Node.js با «توابع میزبانی‌شده» بااستفاده از واحدهای سفارشی مراجعه کنید.

افزودن نقطه پایانی بررسی سلامت

می‌توانید نقطه پایانی بررسی سلامت را برای برنامه Node.js خود پیاده‌سازی کنید. وقتی برنامه Node.js شما شروع به بررسی می‌کند که برنامه در این ظرف درحال اجرا است، Apigee از این نقطه پایانی استفاده می‌کند.

به‌طور پیش‌فرض، نقطه‌پایانی که Apigee انتظار دارد /health است. می‌توانید نقطه پایانی پیش‌فرض را با مشخص کردن نقطه پایانی در متغیر محیطی به‌نام HOSTED_TARGET_HEALTH_CHECK_PATH تغییر دهید. می‌توانید این متغیر را در فایل مانیفست برنامه تنظیم کنید. برای جزئیات بیشتر، عناصر فایل مانیفست را ببینید.

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

  • اگر برنامه شما زمانی که Apigee به نقطه پایانی می‌رسد از آن خارج شود، برنامه طبق انتظار راه‌اندازی نخواهد شد.
  • اگر نقطه پایانی شما وضعیت HTTP «۴۰۴ پیدا نشد» را برگرداند مشکلی نیست. از /health یا HOSTED_TARGET_HEALTH_CHECK_PATH فقط برای بررسی اینکه آیا برنامه شما درحال اجرا است یا نه استفاده می‌شود. پاسخ واقعی نادیده گرفته می‌شود.

تغییر مکان حافظه نهان NPM

نسخه‌های جدیدتر Node.js از نسخه NPM استفاده می‌کنند که از /root/.npm برای حافظه نهان NPM استفاده می‌کند. این مکان برای «هدف‌های میزبانی‌شده» مشکل ایجاد می‌کند زیرا مکان دایرکتوری فقط خواندنی است چون زمان اجرای «هدف میزبانی‌شده» از سیستم فایل tmpfs استفاده می‌کند که فقط /tmp در آن نوشتنی است. برای دور زدن این مشکل می‌توانید متغیر محیطی npm_config_cache را در فایل app.yamlبرنامه (فایل مانیفست) روی فهرست راهنمایی در /tmp تنظیم کنید. برای مثال:

  runtime: node
  application: my-express-app
  env:
    - name: npm_config_cache
      value: /tmp/.npm
    - name: NODE_ENV
      value: production
    - name: LOG_LEVEL
      value: 3
  

اجرای برنامه بدون NPM

به‌طور پیش‌فرض، «هدف‌های میزبانی‌شده» از npm start برای اجرای برنامه «هدف میزبانی‌شده» شما استفاده می‌کند. اما در تکلیف قبلی، درباره مشکلی دراستفاده از NPM بحث کردیم زیرا نسخه‌های جدیدتر تلاش می‌کنند از /root/.npm برای حافظه نهان NPM استفاده کنند که غیرقابل‌نوشتن است و باعث می‌شود «هدف میزبانی‌شده» شما راه‌اندازی نشود. اگرچه کار قبلی این مشکل را حل می‌کند، گزینه دیگر این است که برنامه‌تان را بدون NPM اجرا کنید. برای انجام این کار، می‌توانید از مقادیر command و args در app.yamlفایل برنامه (فایل مانیفست) برای اجرای مستقیم «هدف میزبانی‌شده» بااستفاده از node index.js استفاده کنید. برای مثال:

  runtime: node
  application: my-express-app
  command: node
  args:
    - index.js
  env:
    - name: NODE_ENV
      value: production
    - name: LOG_LEVEL
      value: 3
  
البته، می‌توانید از هر فرمانی که مناسب می‌دانید استفاده کنید و node index.js فقط یک مثال است.