🥇Vim с поддръжка на YAML за Kubernetes

Прим. прев.: оригиналната статия е написана от Josh Rosso – архитект от VMware, работил в компании като CoreOS и Heptio, а също така е съавтор на Kubernetes alb-ingress-controller. Авторът споделя малка рецепта, която може да бъде много полезна за „старомодните“ инженери по експлоатация, предпочитащи vim дори в епохата на облачните технологии.

Пишете YAML манифести за Kubernetes във vim? Прекарахте безброй часове, опитвайки се да разберете къде в тази спецификация трябва да е следвото поле? А може би ще се радвате на бързо напомняне за разликата args и command? Есть хорошие новости! Vim легко привязать к yaml-language-server, за да получите автоматично допълване, валидиране и други удобства. В статията ще разгледаме как да настроите клиента на езиковия сървър.

(Оригиналната статия също има видео, в което авторът разказва и демонстрира съдържанието на материала.)

Езиковият сървър

Езиковите сървъри (language servers) предоставят информация за възможностите на програмните езици на редакторите и IDE, като взаимодействат помежду си по специален протокол – Language Server Protocol (LSP). Това е чудесен подход: тъй като позволява една реализация да предоставя данни на множество редактори/IDE. Аз вече писах за gopls – езиков сървър за Golang – и как може да се използва в vim. Действията за получаване на автоматично допълване в YAML за Kubernetes са аналогични.

За да заработи vim по описания начин, е необходимо да инсталирате клиента на езиковия сървър. Два известни начина, които познавам, са LanguageClient-neovim и coc.vim. В статията ще разгледам coc.vim – това е най-популярният плъгин в момента. Можете да го инсталирате чрез vim-plug:

" Използвайте release branch (препоръчително)
Plug 'neoclide/coc.nvim', {'branch': 'release'}

" Или изградете от изходния код, използвайки 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) трябва да покаже наличните полета и документацията в зависимост от текущия контекст:

Тук работи +пробел, защото настроих inoremap coc#refresh(). Ако не сте го направили — вижте coc.nvim README за примерна конфигурация.

Избор на версия на Kubernetes API

Към момента на написване на тази статия yaml-language-server предлага схеми на Kubernetes 1.14.0. Не намерих начин за динамично избиране на схема, затова отворих съответстващия GitHub issue. За щастие, тъй като езиковият сървър е написан на typescript, е много лесно ръчно да промените версията. За целта просто намерете файла 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:

Резюме

Надявам се, тази възможност ви е зарадвала толкова, колкото и мен. Приятно YAML’ing! Не забравяйте да се запознаете с тези хранилища, за да разберете по-добре инструментите, споменати в статията:

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

P.S. от преводача

И още има vikube, vim-kubernetes и vimkubectl.

Прочетете също в нашия блог:

Източник: habr.com