Vim YAML მხარდაჭერით Kubernetes-ისთვის

Შენიშვნა. თარგმნა: ორიგინალური სტატია დაიწერა ჯოშ როსომ, VMware-ის არქიტექტორმა, რომელიც ადრე მუშაობდა ისეთ კომპანიებში, როგორიცაა CoreOS და Heptio და ასევე არის Kubernetes alb-ingress-კონტროლერის თანაავტორი. ავტორი იზიარებს პატარა რეცეპტს, რომელიც შეიძლება ძალიან სასარგებლო იყოს „ძველი სკოლის“ ოპერაციების ინჟინრებისთვის, რომლებიც უპირატესობას ანიჭებენ vim-ს, თუნდაც გამარჯვებული ღრუბლის ეპოქაში.

YAML მანიფესტების დაწერა Kubernetes-ისთვის vim-ში? უთვალავი საათი გაატარეთ იმის გარკვევაში, თუ სად უნდა იყოს შემდეგი ველი ამ სპეციფიკაციაში? ან იქნებ დააფასებთ განსხვავების სწრაფ შეხსენებას args и command? კარგი ამბავია! Vim-თან დაკავშირება მარტივია yaml-ენის სერვერიავტომატური დასრულების, ვალიდაციის და სხვა მოხერხებულობის მისაღებად. ამ სტატიაში ვისაუბრებთ იმაზე, თუ როგორ უნდა დააყენოთ ენის სერვერის კლიენტი ამისათვის.

(ორიგინალური სტატიაც არის ვიდეო, სადაც ავტორი საუბრობს და აჩვენებს მასალის შინაარსს.)

ენის სერვერი

ენის სერვერები (ენის სერვერები) ისაუბრეთ პროგრამირების ენების შესაძლებლობებზე რედაქტორებსა და IDE-ებზე, რისთვისაც ისინი ურთიერთობენ ერთმანეთთან სპეციალური პროტოკოლის გამოყენებით - ენის სერვერის პროტოკოლი (LSP). ეს შესანიშნავი მიდგომაა, რადგან ის საშუალებას აძლევს ერთ განხორციელებას ერთდროულად მიაწოდოს მონაცემები ბევრ რედაქტორს/IDE-ს. მე უკვე წერდა შესახებ გოფლები - ენის სერვერი Golang-ისთვის - და როგორ შეიძლება მისი გამოყენება vim. Kubernetes-ისთვის YAML-ში ავტომატური დასრულების ნაბიჯები მსგავსია.

იმისათვის, რომ 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-server-ის ამოცნობის დაყენება

რომ 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 სქემა მითითებული URL-დან ეს მუდმივი. yaml.schemas შეიძლება გაფართოვდეს დამატებითი სქემების მხარდასაჭერად - დამატებითი დეტალებისთვის იხ შესაბამისი დოკუმენტაცია.

ახლა თქვენ შეგიძლიათ შექმნათ YAML ფაილი და დაიწყოთ ავტომატური შევსების გამოყენება. დაჭერით + სივრცე (ან vim-ში კონფიგურირებული სხვა კომბინაცია) უნდა აჩვენოს ხელმისაწვდომი ველები და დოკუმენტაცია მიმდინარე კონტექსტის მიხედვით:

აქ მუშაობს +space იმიტომ რომ კონფიგურაცია გავაკეთე inoremap <silent><expr> <c-space> coc#refresh(). თუ ეს არ გაგიკეთებიათ, ნახეთ coc.nvim README მაგალითად კონფიგურაციისთვის.

Kubernetes API ვერსიის შერჩევა

ამ დაწერის მომენტისთვის, 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 on instrumenta. Როგორც ჩანს garethr გადაერთო იქ დამხმარე სქემებზე.

იმის შესამოწმებლად, რომ ცვლილება შევიდა ძალაში, ნახეთ თუ არა ველი, რომელიც აქამდე არ იყო [Kubernetes-ის წინა ვერსიებში]. მაგალითად, K8s 1.14 დიაგრამაში არ იყო startupProbe:

რეზიუმე

იმედი მაქვს, რომ ეს შესაძლებლობა ისევე გაგახარებთ, როგორც მე. ბედნიერი YAMLing! დარწმუნდით, რომ შეამოწმეთ ეს საცავი, რომ უკეთ გაიგოთ სტატიაში ნახსენები კომუნალური საშუალებები:

• coc-vim: https://github.com/neoclide/coc.nvim;
• კოკ-იამლი: https://github.com/neoclide/coc-yaml.

PS მთარგმნელისგან

და ასევე არსებობს ვიკუბე, ვიმ-კუბერნეტები и ვიმკუბექტლი.

ასევე წაიკითხეთ ჩვენს ბლოგზე:

• «kubebox და სხვა ჭურვები Kubernetes-ისთვის";
• «კონსოლის დამხმარეები Kubernetes-თან მუშაობისთვის kubectl-ის საშუალებით".

წყარო: www.habr.com