อ่านเอกสารด้วย ansible-doc

คำสั่ง ansible-doc แสดงเอกสารโมดูลฉบับเต็มในเชลล์ของคุณโดยตรง คุณจึงไม่ต้องออกจากเทอร์มินัลเพื่อค้นหาข้อมูล

ส่งชื่อโมดูลเพื่ออ่านเอกสารของโมดูลนั้น ซึ่งจะมีตัวเลือกทุกตัว ประเภทของตัวเลือก และระบุว่าจำเป็นต้องใช้หรือไม่ นี่เป็นวิธีที่เร็วที่สุดในการเรียนรู้โมดูล

ผลลัพธ์จะแสดง ตัวเลือก แต่ละรายการพร้อมคำอธิบาย ค่าเริ่มต้น และค่าที่เลือกได้ ข้อมูลนี้บอกคุณอย่างชัดเจนว่าโมดูลยอมรับคีย์ใดบ้าง

เพิ่ม -s เพื่อพิมพ์ส่วนโค้ดตัวอย่างของอาร์กิวเมนต์โมดูลที่พร้อมคัดลอกไปใช้ นี่เป็นจุดเริ่มต้นที่เหมาะสำหรับงานใหม่

เรียกใช้พร้อม -l เพื่อแสดงโมดูลที่ติดตั้งทั้งหมดพร้อมสรุปแบบหนึ่งบรรทัด จากนั้นส่งผลลัพธ์ผ่าน grep เพื่อค้นหาสิ่งที่ต้องการ

จำชื่อไม่ได้ใช่ไหม ให้แสดงรายการโมดูลแล้วกรองตามหัวข้อ การค้นหาคำว่า บริการ จะพบโมดูลที่เกี่ยวข้องได้อย่างรวดเร็ว

เนื่องจาก ansible-doc อ่านโมดูลที่ติดตั้งอยู่ในเครื่อง เอกสารจึงตรงกับเวอร์ชันที่คุณใช้อย่างแม่นยำ และไม่มีความเสี่ยงจากหน้าเว็บออนไลน์ที่ล้าสมัย

เอกสารยังอธิบายสิ่งที่โมดูลส่งคืนด้วย เช่น changed หรือ stdout ซึ่งมีประโยชน์เมื่อคุณลงทะเบียนผลลัพธ์เพื่อนำไปใช้ภายหลัง

ใช้ -t เพื่ออ่านเอกสารของปลั๊กอินประเภทอื่น ไม่ใช่เฉพาะโมดูลเท่านั้น ตัวอย่างเช่น คุณสามารถค้นหาปลั๊กอินสำหรับค้นหาหรือกรองได้ด้วยวิธีเดียวกัน

ส่วนหัวของเอกสารจะแสดงชุดรวมของโมดูลและจุดประสงค์โดยย่อ เพื่อให้คุณทราบชื่อแบบครบถ้วนก่อนเขียนงาน

ก่อนเดาอาร์กิวเมนต์ ให้ตรวจสอบ ansible-doc ก่อน การค้นหาเพียงสิบวินาทีช่วยป้องกันการเรียกใช้ที่ล้มเหลวและข้อความข้อผิดพลาดที่ทำให้สับสน

คุณต้องการส่วนโค้ดตัวอย่างของอาร์กิวเมนต์โมดูลที่คัดลอกไปวางได้อย่างรวดเร็ว ไม่ใช่คู่มือฉบับเต็ม

ansible-doc นำเอกสารที่ตรงกับเวอร์ชันมาไว้ในเทอร์มินัลของคุณ: ค้นหาโมดูล ใช้ -s เพื่อรับส่วนโค้ดตัวอย่าง และใช้ -l เพื่อแสดงรายการและค้นหา 📚