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 হল সেই একই কনফিগারেশন ফাইল যা আপনি Edge ইনস্টল করতে ব্যবহার করেছেন। আরও জানতে নোডে Edge কম্পোনেন্ট ইনস্টল করা দেখুন।

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

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

  1. SmartDocs ইনস্টল করা হয়েছে কিনা তা নিশ্চিত করতে, smartdocs.zip ফাইলটি নিম্নলিখিত ডিরেক্টরিতে আছে কিনা তা চেক করুন:

    /opt/apigee/apigee-validate/bundles/

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

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

    SmartDocs ইনস্টল করা থাকলে এই কমান্ডের মাধ্যমে নিম্নলিখিত তথ্য পাওয়া যাবে:

    [ "smartdocs", "passthrough" ]
  2. Edge UI থেকে, নিচে দেখানো ছবির মতো “smartdocs_whitelist” নামের KVM তৈরি ও আপডেট করুন। KVM সেইসব সংস্থা ও পরিবেশে তৈরি করতে হবে যেখানে SmartDocs প্রক্সি বর্তমানে ডেপ্লয় করা আছে।

    মনে রাখবেন: এনক্রিপ্ট করা বক্সে টিকচিহ্ন দেওয়া নেই কিনা তা ভালভাবে দেখে নিন।

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