PracticU

הערות בקובץ YML

בלי כתוביותעם כתוביות
PracticU › קורס DevOps - Ansible › הערות בקובץ YML
מילון מושגים:
הערה - טקסט בקוד שמסביר אותו לבני אדם ואינו מבוצע על ידי המחשב.
סקריפט - קובץ המכיל רצף פקודות שמבוצעות על ידי מפרש, לרוב כדי להפוך משימות לאוטומטיות.
לוג - רישום מתועד של אירועים ופעולות שמתרחשים במערכת או בתוכנה, המשמש למעקב ולאיתור תקלות.
תיקייה - מכל במערכת הקבצים שמשמש לארגון קבצים ותיקיות אחרות בתוך מבנה היררכי.

הערות בקובץ YML
הערות בקובץ YAML עוזרות להבין מה כל משימה עושה, גם אחרי זמן רב וגם למי שיפתח את הסקריפט אחרינו.
למה לכתוב הערות
1. זיכרון: אחרי שבועיים או חודשיים אי אפשר תמיד לזכור למה הכנסנו משימה מסוימת לסקריפט, גם אם הסקריפט עובד מצוין.
2. עבודה של אחרים: סקריפט אוטומציה עלול להיות מופעל או משונה על ידי מישהו אחר, והערות עוזרות לו להבין מה קורה בו.
3. שם המשימה קצר: השם מופיע על המסך בזמן ההרצה, ולכן הוא צריך להיות קצר. ההערה מאפשרת לפרט.
איך כותבים
4. סולמית: הערה מתחילה בסולמית #, וכתובה מעל המשימה שאליה היא מתייחסת.
5. תוכן ההערה: בדוגמה נכתב מה המשימה עושה, למשל העתקת קובץ לוגים לתיקייה החדשה לסינון מאוחר יותר, ומתי הקובץ ימחק.
6. הרצה: ההערות לא מופיעות בפלט של ההרצה, והן נכתבות לקריאה מאוחרת.
השיעור הבא בקורס: USER MODULE

פרקי ההרצאה: הערות בקובץ YML

  1. 00:00

    למה להוסיף הערות לסקריפט

  2. 00:41

    כשחוזרים לסקריפט אחרי חודשים

  3. 01:36

    כתיבת הערה עם סולמית

  4. 02:34

    הערה מול name: מה מופיע על המסך

תמלול ההרצאה: הערות בקובץ YML

הטקסט המלא של הדקות הראשונות בהרצאה «הערות בקובץ YML» בקורס הווידאו של PracticU – כתוביות בעברית עם זמן התחלה לכל פסקה. כך תוכלו לקרוא ולחפש את הנושאים לפני שמתחילים ללמוד.

  1. 00:02

    עכשיו שכבר התחלתם לכתוב סקריפטים, יאמל אנסיבל, יאמל פיילס, עם פייל והקופי מוד'ולס, כבר ממש יש לכם איזשהו סקריפט שממש עושה משהו, יוצר תיקייה, מעתיק אליה קבצים וכן הלאה.

  2. 00:19

    חשוב מאוד שמעכשיו תתחילו ליישם הוספה של נוטס, של הערות, בתוך הסקריפט שלכם. כמו שאתם יכולים לראות בתמונה, תראו איזה יופי זה נראה כשיש לי מידע מעל הטאסק, ממש מעל הטאסק, אני כותב מה בדיוק אני עומד לעשות בטאסק הזה, ואפילו למה. למה זה חשוב מאוד? יש כמה סיבות. סיבה מספר אחת,

  3. 00:41

    אנחנו ברוב המקרים לא זוכרים למה הכנסנו טאסק כזה או אחר בסקריפט שלנו, במיוחד אם אתם חוזרים לסקריפט שלכם אחרי מספר שבועות או חודשים.

  4. 00:51

    מי מכם שיצר כבר סקריפטים כמובן מקבל את מה שאני אומר, ואני בטוח שקרה גם לכם. מי מכם שעוד לא כתב סקריפטים, תאמינו לי, אחרי שבועיים שלוש שיצרתם סקריפט ארוך, אתם לא תמיד זוכרים את כל הסיבות לכל הפקודות שהכנסתם.

  5. 01:07

    כמה שזה לא היה גאוני באותו יום, אחרי חודשיים אתם לא זוכרים למה עשיתם משהו מסוים. למרות שזה עובד נפלא. אז עבורכם אתם חייבים שיהיה לכם no-צערות בתוך הסקריפט, כדי שמאוחר יותר, כשתיגשו לסקריפט שלכם, אתם תבינו למה עשיתם מה שעשיתם, למה הפקודה הזו נמצאת פה וכן הלאה וכן הלאה. מאוד מאוד חשוב.

  6. 01:31

    סיבה מספר אחרת, למה אתם רוצים שיהיו לכם הערות, ושימו לב את ההערה, אנחנו כותבים על ידי זה שבהתחלה אנחנו שמים סולמית. ממש כמו כל סקריפט אחר, דרך אגב, זה לא משהו מיוחד פה.

  7. 01:42

    אז הסיבה השנייה זה שכשאנחנו כותבים אוטומיישן, זה לא תמיד רק בשבילנו. אנחנו יוצרים איזשהו סקריפט אוטומיישן בארגון שמבצע פעולה, למשל, מתקין פאצ'ים, פאצ'ס, על לינוקס סרוורס, על כל הווב סרוורס, כל יום שישי או שבת בלילה.

  8. 02:01

    והסקריפט הזה עושה כל מיני פעולות, ומישהו אחר יכול מאוד להיות שהוא צריך להריץ את הסקריפט, או מישהו אחר משתמש בסקריפט הזה, וכשהוא יפתח את הסקריפט כדי להבין מה אומר הסקריפט, אנחנו רוצים לעזור לו להבין מה קורה שם, במיוחד כשרוצים לשנות ולהוסיף דברים לסקריפט הזה.

  9. 02:22

    בקיצור יש חשיבות עליונה כמה שזה נשמע טריוויאלי אבל יש חשיבות עליונה להוסיף הערות שוליים בתוך הסקריפט שלכם. עכשיו אתם אולי שואלים למה אני צריך לרשום הערות אם יש לי פה את ה-Name של ה-Task למה אני צריך לרשום הערות חברים ה-Name הזה זה מה שיופיע על המסך כשה-Ansible יתחיל לרוץ אנחנו לא יכולים לרשום שם סיפור

  10. 02:48

    ארוך כן חשוב להגיד מה זה ה-Task הזה

לקורס המלא: קורס DevOps ו‑Ansible אונליין

ההרצאה הקודמת: COPY MODULE WITH ITEMS

ההרצאה הבאה: USER MODULE

הרצאות קשורות מקורסים אחרים

  • שמירת מידע בקובץ JSON - קורס NodeJS

קורסים נוספים במסלול

  • קורס AWS - ניהול מכונה וירטואלית בענן
  • קורס Terraform - DevOps - Azure & AWS
  • קורס קוברנטיקס - Kubernetes
  • קורס Docker - עם Swarm Cluster
  • קורס PowerShell
  • קורס Git ו-GitHub עם Visual Studio