Vim עם תמיכת YAML עבור Kubernetes

הערה. תרגום: המאמר המקורי נכתב על ידי ג'וש רוסו, ארכיטקט ב-VMware שעבד בעבר בחברות כמו CoreOS ו-Heptio, והוא גם מחבר שותף של Kubernetes alb-ingress-controller. המחבר חולק מתכון קטן שיכול להיות שימושי מאוד למהנדסי תפעול "אולד סקול" שמעדיפים vim אפילו בעידן של יליד הענן המנצח.

כותבים מניפסטים של YAML עבור Kubernetes in vim? ביליתי אינספור שעות בניסיון להבין היכן צריך להיות השדה הבא במפרט הזה? או אולי תעריך תזכורת מהירה להבדל args и command? יש חדשות טובות! קל לקשר אל Vim yaml-language-serverכדי לקבל השלמה אוטומטית, אימות ושאר נוחות. במאמר זה נדבר על איך להגדיר לקוח שרת שפה בשביל זה.

(גם המאמר המקורי האם יש סרטון, שבו המחבר מדבר ומדגים את תוכן החומר.)

שרת שפה

שרתי שפה (שרתי שפה) לדבר על היכולות של שפות תכנות לעורכים ו-IDE, שעבורם הם מקיימים אינטראקציה זה עם זה באמצעות פרוטוקול מיוחד - פרוטוקול שרת שפות (LSP). זוהי גישה מצוינת מכיוון שהיא מאפשרת למימוש אחד לספק נתונים לעורכים/IDE רבים בבת אחת. יש לי כבר כתבתי про gopls - שרת שפה עבור Golang - וכיצד ניתן להשתמש בו מֶרֶץ. השלבים לקבלת השלמה אוטומטית ב-YAML עבור Kubernetes דומים.

כדי ש-vim יעבוד בצורה המתוארת, תצטרך להתקין לקוח שרת שפה. שתי השיטות שאני מכיר הן LanguageClient-neovim и coc.vim. במאמר אשקול coc.vim - זהו התוסף הפופולרי ביותר כרגע. אתה יכול להתקין אותו באמצעות vim-plug:

" Use release branch (Recommend)
Plug 'neoclide/coc.nvim', {'branch': 'release'}

" Or build from source code by use yarn: https://yarnpkg.com
Plug 'neoclide/coc.nvim', {'do': 'yarn install --frozen-lockfile'}

להתחלה coc (ולכן yaml-language-server) ידרוש התקנה של node.js:

curl -sL install-node.now.sh/lts | bash

כאשר coc.vim מוגדר, התקן את תוסף השרת coc-yaml מאת vim:

:CocInstall coc-yaml

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

הגדרת זיהוי שרת yaml-language

כי coc יכול להשתמש ב-yaml-language-server, יש לבקש ממנו לטעון את הסכימה מ-Kubernetes בעת עריכת קבצי YAML. זה נעשה על ידי עריכה coc-config:

:CocConfig

בתצורה תצטרך להוסיף kubernetes עבור כל הקבצים yaml. אני משתמש בנוסף בשרת שפה עבור golangאז התצורה הכללית שלי נראית כך:

{
  "languageserver": {
      "golang": {
        "command": "gopls",
        "rootPatterns": ["go.mod"],
        "filetypes": ["go"]
      }
  },

  "yaml.schemas": {
      "kubernetes": "/*.yaml"
  }
}

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

כעת תוכל ליצור קובץ YAML ולהתחיל להשתמש בהשלמה אוטומטית. לחיצה +רווח (או שילוב אחר שהוגדר ב-vim) אמור להציג את השדות והתיעוד הזמינים בהתאם להקשר הנוכחי:

עובד כאן +רווח כי הגדרתי inoremap <silent><expr> <c-space> coc#refresh(). אם לא עשית זאת, ראה coc.nvim README לתצורה לדוגמה.

בחירת גרסת ה-API של Kubernetes

נכון לכתיבת שורות אלה, yaml-language-server נשלח עם סכימות Kubernetes 1.14.0. לא מצאתי דרך לבחור באופן דינמי סכימה, אז פתחתי בעיית GitHub מתאימה. למרבה המזל, מכיוון ששרת השפה כתוב בכתב כתיבה, די קל לשנות את הגרסה באופן ידני. כדי לעשות זאת, פשוט מצא את הקובץ server.ts.

כדי לזהות אותו במחשב שלך, פשוט פתח את קובץ YAML עם vim ומצא את התהליך עם yaml-language-server.

ps aux | grep -i yaml-language-server

joshrosso         2380  45.9  0.2  5586084  69324   ??  S     9:32PM   0:00.43 /usr/local/Cellar/node/13.5.0/bin/node /Users/joshrosso/.config/coc/extensions/node_modules/coc-yaml/node_modules/yaml-language-server/out/server/src/server.js --node-ipc --node-ipc --clientProcessId=2379
joshrosso         2382   0.0  0.0  4399352    788 s001  S+    9:32PM   0:00.00 grep -i yaml-language-server

התהליך הרלוונטי עבורנו הוא תהליך 2380: בו משתמש vim בעת עריכת קובץ YAML.

כפי שאתה יכול לראות בקלות, הקובץ ממוקם ב /Users/joshrosso/.config/coc/extensions/node_modules/coc-yaml/node_modules/yaml-language-server/out/server/src/server.js. פשוט ערוך אותו על ידי שינוי הערך KUBERNETES_SCHEMA_URL, לדוגמה, עבור גרסה 1.17.0:

// old 1.14.0 schema
//exports.KUBERNETES_SCHEMA_URL = "https://raw.githubusercontent.com/garethr/kubernetes-json-schema/master/v1.14.0-standalone-strict/all.json";
// new 1.17.0 schema in instrumenta repo
exports.KUBERNETES_SCHEMA_URL = "https://raw.githubusercontent.com/instrumenta/kubernetes-json-schema/master/v1.17.0-standalone-strict/all.json";

תלוי בגרסה שבה נעשה שימוש coc-yaml מיקום המשתנה בקוד עשוי להשתנות. שימו לב גם ששיניתי את המאגר מ garethr על instrumenta. נראה כי garethr עבר למעגלים תומכים שם.

כדי לבדוק שהשינוי נכנס לתוקף, ראה אם ​​מופיע שדה שלא היה שם קודם [בגרסאות קודמות של Kubernetes]. לדוגמה, בתרשים עבור K8s 1.14 לא היה startupProbe:

תקציר

אני מקווה שההזדמנות הזו תשמח אותך כמוני. YAMLing שמח! הקפד לבדוק את המאגרים האלה כדי להבין טוב יותר את כלי השירות המוזכרים במאמר:

• coc-vim: https://github.com/neoclide/coc.nvim;
• coc-yaml: https://github.com/neoclide/coc-yaml.

נ.ב מהמתרגם

ויש vikube, vim-kubernetes и vimkubectl.

קרא גם בבלוג שלנו:

• «kubebox וקונכיות אחרות עבור Kubernetes";
• «עוזרי מסוף לעבודה עם Kubernetes באמצעות kubectl".

מקור: www.habr.com