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

Забележка. превод: Оригиналната статия е написана от Джош Росо, архитект във VMware, който преди това е работил в компании като CoreOS и Heptio и също така е съавтор на Kubernetes alb-ingress-controller. Авторът споделя малка рецепта, която може да бъде много полезна за оперативните инженери от „старата школа“, които предпочитат vim дори в ерата на победоносния роден облак.

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

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

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

Езикови сървъри (езикови сървъри) говорете за възможностите на езиците за програмиране на редактори и IDE, за които те взаимодействат помежду си, използвайки специален протокол - Протокол за езиков сървър (LSP). Това е страхотен подход, защото позволява една реализация да предоставя данни на много редактори/IDE едновременно. Вече имам написах за gopls - езиков сървър за Golang - и как може да се използва в Vim. Стъпките за получаване на автоматично довършване в YAML за Kubernetes са подобни.

За да може vim да работи по описания начин, ще трябва да инсталирате езиков сървър клиент. Двата метода, които познавам, са LanguageClient-неовим и 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-сървърът) ще изисква инсталиран node.js:

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

Когато coc.vim конфигуриран, инсталирайте разширението на сървъра coc-yaml от vim:

:CocInstall coc-yaml

И накрая, най-вероятно ще искате да започнете с конфигурацията coc-vim, представени като пример. По-специално, той активира комбинацията +интервал за извикване на автоматично довършване.

Настройване на откриване на yaml-език-сървър

Че coc може да използва yaml-language-сървър, трябва да бъде помолен да зареди схемата от 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 <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 на instrumenta. Изглежда че garethr премина към поддържащи вериги там.

За да проверите дали промяната е влязла в сила, вижте дали се появява поле, което не е било там преди [в предишни версии на Kubernetes]. Например в диаграмата за K8s 1.14 нямаше startupProbe:

Обобщение

Надявам се тази възможност да ви зарадва толкова, колкото и мен. Честит YAMLing! Не забравяйте да проверите тези хранилища, за да разберете по-добре помощните програми, споменати в статията:

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

PS от преводача

И също така има викубе, вим-кубернетес и vimkubectl.

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

• «kubebox и други обвивки за Kubernetes»;
• «Конзолни помощници за работа с Kubernetes чрез kubectl".

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