🥇Vim med YAML-stöd för Kubernetes

Obs. övers.: Den ursprungliga artikeln skrevs av Josh Rosso – en arkitekt från VMware, som tidigare arbetat för företag som CoreOS och Heptio, och även är medförfattare till Kubernetes alb-ingress-controller. Författaren delar med sig av ett litet recept som kan vara mycket användbart för ingenjörer från "gammal skola" som föredrar vim även i en era av segrande cloud native.

Skriver du YAML-manifest för Kubernetes i vim? Har du tillbringat otaliga timmar med att försöka förstå var nästa fält ska vara i denna specifikation? Kanske skulle du vara glad att få en snabb påminnelse om skillnaden args och command? Есть хорошие новости! Vim легко привязать к yaml-language-server, för att få automatisk komplettering, validering och andra bekvämligheter. I artikeln kommer vi att prata om hur man ställer in klienten för språkservern för detta.

(Den ursprungliga artikeln har också en video, där författaren förklarar och demonstrerar innehållet.)

Språkserver

Språkservrar (language servers) berättar om möjligheterna hos programmeringsspråk till redaktörer och IDE:er, vilket gör att de interagerar nedan via ett speciellt protokoll — Language Server Protocol (LSP). Det är en fantastisk metod: eftersom den tillåter en implementation att tillhandahålla data till flera redaktörer/IDE:er. Jag har redan skrev om gopls – språkservern för Golang – och hur den kan användas i vim. Åtgärderna för att få automatisk komplettering i YAML för Kubernetes är desamma.

För att vim ska fungera som beskrivs ovan, behöver du installera klienten för språkservern. Två kända sätt jag känner till är LanguageClient-neovim och coc.vim. I artikeln kommer jag att diskutera coc.vim – det populäraste tillägget för tillfället. Du kan installera det via vim-plug:

" Använd release-grenen (Rekommenderas)
Plug 'neoclide\/coc.nvim', {'branch': 'release'}

" Eller bygg från källkod med hjälp av yarn: https://yarnpkg.com
Plug 'neoclide\/coc.nvim', {'do': 'yarn install --frozen-lockfile'}

För att köra coc (och därmed servern yaml-language-server) krävs att node.js är installerat:

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

När coc.vim konfigurerad, installera servertillägget coc-yaml från vim:

:CocInstall coc-yaml

Slutligen vill du förmodligen börja med konfigurationen coc-vim, som presenteras som exempel. I synnerhet aktiverar den kombinationen +mellanrum för att kalla på automatisk komplettering.

Konfigurera upptäckten av yaml-language-server

För att coc för att kunna använda yaml-language-server måste du be den att ladda schemat från Kubernetes när du redigerar YAML-filer. Det görs genom att redigera coc-config:

:CocConfig

I konfigurationen måste ytterligare information läggas till kubernetes för alla filer yaml. Jag använder dessutom en språkserver för golang, därför ser min övergripande konfiguration ut så här:

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

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

kubernetes — ett reserverat fält som informerar språkservern om att ladda Kubernetes-schemat via en URL som specificeras i denna konstant. yaml.schemas kan utökas med stöd för ytterligare scheman — se mer i den relevanta dokumentationen.

Nu kan vi skapa en YAML-fil och börja använda autocompletion. Tryck på +mellanrum (eller en annan kombination som är inställd i vim) för att visa tillgängliga fält och dokumentation i enlighet med det aktuella sammanhanget:

Här fungerar +mellanslag, eftersom jag har konfigurerat inoremap coc#refresh(). Om du inte har gjort det — se coc.nvim README för ett exempel på konfiguration.

Val av version av Kubernetes API

Vid tidpunkten för skrivande levereras yaml-language-server med scheman för Kubernetes 1.14.0. Jag har inte funnit något sätt att dynamiskt välja schema, så jag öppnade den relevanta GitHub-issue. Som tur är, eftersom språkservern är skriven i typescript, är det ganska enkelt att manuellt ändra versionen. För att göra detta, hitta bara filen server.ts.

För att hitta den på din maskin, öppna helt enkelt YAML-filen med vim och leta efter processen med 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

För oss är processen 2380 relevant: det är den som vim använder när det redigerar YAML-filen.

Som lätt kan ses ligger filen i /Users/joshrosso/.config/coc/extensions/node_modules/coc-yaml/node_modules/yaml-language-server/out/server/src/server.js. Det räcker att redigera den och ändra värdet KUBERNETES_SCHEMA_URL, till exempel till version 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";

Beroende på vilken version av koden som används kan coc-yaml platser för variabeln i koden vara olika. Observera också att jag ändrat lagret från garethr till instrumenta. Tycks ha garethr övergått till att stödja scheman där.

För att kontrollera att ändringen trätt i kraft, se om fältet som tidigare [i tidigare versioner av Kubernetes] inte fanns. startupProbe:

Sammanfattning

Jag hoppas att denna möjlighet gladde dig lika mycket som mig. Glad YAML’ing! Glöm inte att kolla in dessa repositorier för att förstå verktygen som nämns i artikeln bättre: