التعليقات والاقتباس في القوالب

يتيح المخطط طريقتين لكتابة الملاحظات: تعليقات YAML العادية وتعليقات القالب الخاصة. وتختلف طريقة تصرفهما كثيرًا وقت العرض.

السطر الذي يبدأ بعلامة الرقم هو تعليق YAML عادي. ويمر كما هو ويظل في الناتج المعروض ليتمكن أي شخص من قراءته.

لدى Helm تعليقات خاصة به تختفي تمامًا. ضعوا النص داخل {{/* */}}، وسيزيله المحرك قبل الإخراج.

استخدموا الرمز # لتوثيق ملف YAML المنشور. واستخدموا تعليق القالب لإضافة ملاحظات حول منطق القالب لا ينبغي للمستخدمين رؤيتها مطلقًا. 📝

تُعد تعليقات القوالب مفيدة لتعطيل التعليمات البرمجية. ضعوا إجراءً داخل {{/* */}}، وسيتخطاه Helm من دون تصيير أو أخطاء.

غالبًا ما يخمّن YAML أنواع القيم. فقد تتحول القيمة 1.10 إلى 1.1، وقد تتحول yes إلى true. ويجعل وضع علامات الاقتباس القيمة سلسلة نصية واضحة بدلًا من ذلك.

يوفر Helm الدالة quote التي تضع القيمة بين علامتي اقتباس مزدوجتين نيابةً عنكم، وبذلك يكون الحقل الناتج سلسلة نصية بلا أي التباس.

ستشاهدون عادةً كتابة quote كأنبوب في نهاية إجراء. وتُقرأ العبارة بصورة طبيعية: خذوا القيمة، ثم ضعوا علامات الاقتباس حولها.

من دون علامات الاقتباس، قد يفقد إصدار مثل 1.20 الصفر الأخير بصمت ويتحول إلى 1.2، مما يؤدي إلى إفساد مرجع الصورة. ويمنع وضع علامات الاقتباس ذلك. ⚠️

يريد Kubernetes أحيانًا الاحتفاظ بالرقم كنص، مثل منفذ في annotation. ويضمن تمرير القيمة عبر quote بقاءها سلسلة نصية بأمان.

يمكنكم أيضًا كتابة علامات الاقتباس الحرفية بأنفسكم في YAML. أما الدالة quote فتنجز ذلك برمجيًا عندما تأتي القيمة من قالب.

أضفتم ملاحظة لا ينبغي أن تظهر في ملف YAML المنشور.

يمكنكم الآن إخفاء الملاحظات باستخدام {{/* */}}، والإبقاء على الملاحظات الظاهرة باستخدام الرمز #، وفرض سلاسل نصية واضحة باستخدام الدالة quote. 🎯