قراءة الوثائق باستخدام ansible-doc

يعرض الأمر ansible-doc الوثائق الكاملة للوحدات مباشرةً في الصدفة، لذلك لن تحتاجوا إلى مغادرة الطرفية للبحث عن المعلومات.

مرّروا اسم الوحدة لقراءة وثائقها: كل خيار، ونوعه، وما إذا كان مطلوبًا. هذه أسرع طريقة لتعلّم الوحدة.

يسرد الناتج كل خيار مع وصفه، وقيمته الافتراضية، والقيم المسموح بها. يخبركم ذلك بالمفاتيح التي تقبلها الوحدة بدقة.

أضيفوا -s لطباعة مقتطف جاهز للنسخ من معاملات الوحدة. وهو نقطة بداية مثالية لمهمة جديدة.

شغّلوا الأمر مع -l لسرد جميع الوحدات المثبّتة مع ملخص من سطر واحد لكل منها. ويمكنكم تمرير الناتج إلى grep للعثور على ما تحتاجون إليه.

ألستم متأكدين من الاسم؟ اسردوا الوحدات وفلتروا النتائج حسب الموضوع. سيُظهر البحث عن service بسرعة الوحدات ذات الصلة.

لأن ansible-doc يقرأ الوحدات المثبّتة محليًا، تتطابق الوثائق دائمًا مع الإصدار المحدد لديكم. ولا يوجد خطر الاعتماد على صفحات قديمة على الإنترنت.

تصف الوثائق أيضًا ما تعيده الوحدة، مثل changed أو stdout. ويساعدكم ذلك عند تسجيل النتائج لاستخدامها لاحقًا.

استخدموا -t لقراءة وثائق أنواع الإضافات الأخرى، وليس الوحدات فقط. فعلى سبيل المثال، يمكنكم البحث عن إضافة lookup أو filter بالطريقة نفسها.

يوضح رأس الوثيقة مجموعة الوحدة والغرض المختصر منها، لكي تعرفوا اسمها المؤهل بالكامل قبل كتابة المهمة.

قبل التخمين بشأن إحدى الوسائط، تحقّقوا من ansible-doc أولًا. فالبحث الذي يستغرق عشر ثوانٍ يوفر عليكم تشغيلًا فاشلًا ورسالة خطأ مربكة.

تريدون مقتطفًا سريعًا من معاملات الوحدة لنسخه ولصقه، وليس الدليل الكامل.

يجلب ansible-doc وثائق مطابقة للإصدار إلى طرفيتكم: ابحثوا عن وحدة، واستخدموا -s للحصول على مقتطف، و-l للسرد والبحث. 📚