আপনি যখন ইনস্টলেশন টেস্ট করুন-এ বর্ণিত ইনস্টলেশন টেস্ট স্ক্রিপ্ট ইনস্টল এবং রান করেন তখন 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 ইনস্টল করে।
ইনস্টলেশন সম্পূর্ণ করতে:
SmartDocs ইনস্টল করা আছে কিনা তা পরীক্ষা করতে,
smartdocs.zipফাইলটি নিম্নলিখিত ডিরেক্টরিতে আছে কিনা তা কনফার্ম করুন:/opt/apigee/apigee-validate/bundles/
অথবা ম্যানেজমেন্ট সার্ভার নোডে নিম্নলিখিত API কল রান করুন:
curl -v -u adminEmail:adminPword 0:8080/v1/o/validate/apis
SmartDocs ইনস্টল করা থাকলে এই কমান্ডের মাধ্যমে নিম্নলিখিত ফলাফল পাওয়া যাবে:
[ "smartdocs", "passthrough" ]
- Edge UI থেকে, নিচে দেখানো ছবির মতো, “smartdocs_whitelist” নামে KVM তৈরি ও আপডেট করুন।
যে সংস্থা ও পরিবেশে বর্তমানে SmartDocs প্রক্সি ডিপ্লয় করা আছে, সেখানে KVM তৈরি করতে হবে।
মনে রাখবেন: এনক্রিপ্ট করা বিকল্পের পাশে থাকা বক্সে টিকচিহ্ন দেওয়া নেই তা ভাল করে দেখে নিন।
- “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 যোগ ও কনফিগার না করলে, প্রক্সি হোয়াইটলিস্টিং এনফোর্স করবে না। এর ফলে
আপনার হোস্ট ও IP অ্যাড্রেসে অননুমোদিত অ্যাক্সেস হতে পারে। SmartDocs-এর সাথে ডকুমেন্ট করা API এন্ডপয়েন্টের
শুধুমাত্র হোস্টনেম ও IP অ্যাড্রেস "allowed_hosts" ভ্যালুতে অন্তর্ভুক্ত করতে হবে।