กับดักการเยื้องบรรทัดใน YAML ที่พบบ่อย

ใน YAML ช่องว่างไม่ใช่เพียงการตกแต่ง การเยื้องเป็นตัวกำหนดเพียงอย่างเดียวว่าสิ่งใดซ้อนอยู่ใต้สิ่งใด ดังนั้นช่องว่างที่ผิดเพียงหนึ่งตำแหน่งอาจเปลี่ยนโครงสร้างแมนนิเฟสต์ทั้งหมดของคุณได้ 😬

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

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

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

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

ข้อผิดพลาดที่พบบ่อยคือ indent ไม่ได้เพิ่มบรรทัดใหม่ไว้ข้างหน้า ทำให้บรรทัดแรกติดกับคีย์ YAML ของคุณ ปัญหานี้ทำให้เอกสารเสียหายโดยไม่แสดงข้อผิดพลาด

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

ช่องว่างหน้า {{ ในซอร์สของคุณส่งผลต่อบรรทัดที่แอ็กชันจะแสดงผล ควบคุมแอ็กชันต่าง ๆ ให้อยู่ในระดับความลึกที่ผลลัพธ์ควรอยู่

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

ข้อผิดพลาดด้านการเยื้องมองไม่เห็นในซอร์ส แต่เห็นได้ชัดในผลลัพธ์ ให้เรนเดอร์ชาร์ตแล้วตรวจดู YAML ดิบเพื่อหาบล็อกที่จัดแนวไม่ตรงกันได้อย่างรวดเร็ว 👀

เรียกใช้ helm lint เพื่อค้นหาปัญหา YAML และการเยื้องจำนวนมาก ก่อนที่คุณจะลองติดตั้งชาร์ตบนคลัสเตอร์เสียอีก

บล็อกที่คุณแทรกยังคงต่อรวมเข้ากับคีย์ YAML ที่อยู่ด้านบน

ตอนนี้คุณสามารถหลีกเลี่ยงกับดักคลาสสิกได้แล้ว ได้แก่ ห้ามใช้แท็บ ใช้ nindent สำหรับบล็อกที่จัดรูปแบบอย่างเรียบร้อย และเรนเดอร์หรือใช้ lint เพื่อตรวจสอบ YAML เสมอ 🎯