SmartDocs ইনস্টল করুন

আপনি যখন টেস্ট দ্য ইন্সটল- এ বর্ণিত ইনস্টলেশন টেস্ট স্ক্রিপ্টগুলি ইনস্টল এবং রান করেন তখন SmartDocs স্বয়ংক্রিয়ভাবে ইনস্টল হয়ে যায়। পরীক্ষার স্ক্রিপ্ট চালানোর অংশ হিসাবে, আপনি নিম্নলিখিত কমান্ডগুলি চালান:

/opt/apigee/apigee-service/bin/apigee-service apigee-validate install
/opt/apigee/apigee-service/bin/apigee-service apigee-validate setup -f configFile

যেখানে configFile একই কনফিগারেশন ফাইল যা আপনি এজ ইনস্টল করতে ব্যবহার করেছিলেন। আরো জন্য একটি নোডে এজ উপাদান ইনস্টল দেখুন.

এই কমান্ডটি পরীক্ষা চালানোর অংশ হিসাবে SmartDocs ইনস্টল করে।

ইনস্টলেশন সম্পূর্ণ করতে:

  1. smartdocs.zip ফাইলটি নিম্নলিখিত ডিরেক্টরিতে অবস্থিত তা নিশ্চিত করে পরীক্ষা করুন যে SmartDocs ইনস্টল করা হয়েছে:

    /opt/apigee/apigee-validate/bundles/

    অথবা ম্যানেজমেন্ট সার্ভার নোডে নিম্নলিখিত API কল চালান:

    curl -v -u adminEmail:adminPword 0:8080/v1/o/validate/apis

    SmartDocs ইনস্টল করা থাকলে এই কমান্ডটি নিম্নলিখিতটি ফেরত দেবে:

    [ "smartdocs", "passthrough" ]
  2. এজ UI থেকে, "smartdocs_whitelist" নামে একটি KVM তৈরি করুন এবং আপডেট করুন , যেমনটি নীচের চিত্রে দেখানো হয়েছে। যে প্রতিষ্ঠান এবং পরিবেশে স্মার্টডকস প্রক্সি বর্তমানে স্থাপন করা হয়েছে সেখানে KVM তৈরি করা উচিত।

    দ্রষ্টব্য : নিশ্চিত করুন যে এনক্রিপ্ট করা বাক্সটি চেক করা নেই।

    • "is_whitelist_configured" নামের একটি কী যোগ করুন, যেখানে মানটি "হ্যাঁ"।
    • "allowed_hosts" নামে একটি দ্বিতীয় কী যোগ করুন, যেখানে মানগুলি হল স্পেস বিভক্ত হোস্টনাম বা IP ঠিকানা যা SmartDocs থেকে ডাকা হয়৷ "অনুমতিপ্রাপ্ত_হোস্ট"-এর মানটিতে SmartDocs-এ যোগ করা OpenAPI স্পেক্সে অন্তর্ভুক্ত যেকোনো হোস্ট অন্তর্ভুক্ত করা উচিত। উদাহরণস্বরূপ, যদি আপনার কাছে একটি OpenAPI স্পেক থাকে যা mocktarget.apigee.net কল করে, তাহলে আপনাকে mocktarget.apigee.net যোগ করতে হবে "alllowed_hosts" মানতে। যদি একটি হোস্ট কেভিএম-এ অন্তর্ভুক্ত না করা হয়, তাহলে SmartDocs প্রতিক্রিয়া হবে 400 Bad Request সাথে একটি বিষয়বস্তু পেলোডের সাথে Bad Request-Hostname not permitted
    KVM তৈরির ইন্টারফেস দ্রষ্টব্য : আপনি যদি এই KVM যোগ না করেন এবং কনফিগার না করেন, তাহলে প্রক্সি হোয়াইটলিস্টিং বলবৎ করবে না। এর ফলে আপনার হোস্ট এবং IP ঠিকানাগুলিতে অননুমোদিত অ্যাক্সেস হতে পারে। SmartDocs-এর সাথে নথিভুক্ত API এন্ডপয়েন্টগুলির শুধুমাত্র হোস্টনাম এবং IP ঠিকানাগুলিকে "অনুমতিপ্রাপ্ত_হোস্ট" মানগুলিতে অন্তর্ভুক্ত করা উচিত৷