Kubernetes에 대한 YAML을 지원하는 Vim

메모. 번역: 원본 기사는 이전에 CoreOS, Heptio 등의 회사에서 근무했으며 Kubernetes alb-ingress-controller의 공동 저자이기도 한 VMware의 설계자 Josh Rosso가 작성했습니다. 저자는 승리하는 클라우드 네이티브 시대에도 vim을 선호하는 "구식" 운영 엔지니어에게 매우 유용할 수 있는 작은 방법을 공유합니다.

vim에서 Kubernetes용 YAML 매니페스트를 작성하시나요? 이 사양에서 다음 필드가 어디에 있어야 하는지 알아내려고 셀 수 없이 많은 시간을 소비하셨나요? 아니면 차이점을 빠르게 상기시켜 주시면 감사하겠습니다. args и command? 좋은 소식이 있습니다! Vim은 연결하기 쉽습니다. yaml 언어 서버자동 완성, 유효성 검사 및 기타 편의를 얻으려면 이 기사에서는 이를 위해 언어 서버 클라이언트를 설정하는 방법에 대해 설명합니다.

(원본 기사도 마찬가지 비디오 있니?, 저자가 자료의 내용을 말하고 시연하는 곳입니다.)

언어 서버

언어 서버 (언어 서버) 특수 프로토콜을 사용하여 서로 상호 작용하는 편집자 및 IDE에 대한 프로그래밍 언어의 기능에 대해 이야기합니다. 언어 서버 프로토콜 (LSP). 이는 하나의 구현으로 여러 편집기/IDE에 동시에 데이터를 제공할 수 있다는 점에서 훌륭한 접근 방식입니다. 나는 이미 내가 쓴 약 고플 - Golang을 위한 언어 서버 - 그리고 그것이 어떻게 사용되는지 정력. Kubernetes용 YAML에서 자동 완성을 가져오는 단계는 비슷합니다.

vim이 설명된 방식으로 작동하려면 언어 서버 클라이언트를 설치해야 합니다. 제가 아는 두 가지 방법은 언어클라이언트-neovim и coc.vim. 기사에서 나는 고려할 것이다 coc.vim - 현재 가장 인기 있는 플러그인입니다. 다음을 통해 설치할 수 있습니다. vim 플러그:

" 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-언어-서버)에는 node.js가 설치되어 있어야 합니다.

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

언제 coc.vim 구성, 서버 확장 설치 coc-yaml vim에서:

:CocInstall coc-yaml

마지막으로 구성부터 시작하고 싶을 가능성이 높습니다. coc-vim, 제시 예로서. 특히, 조합을 활성화합니다. +스페이스 자동 완성을 호출합니다.

yaml-언어-서버 감지 설정

그 coc yaml-언어-서버를 사용할 수 있으면 YAML 파일을 편집할 때 Kubernetes에서 스키마를 로드하도록 요청해야 합니다. 이는 편집을 통해 이루어집니다. coc-config:

:CocConfig

구성에서 다음을 추가해야 합니다. kubernetes 모든 파일에 대해 yaml. 추가적으로 언어 서버를 사용합니다. golang내 일반적인 구성은 다음과 같습니다.

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

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

kubernetes — 다음에 정의된 URL에서 Kubernetes 스키마를 다운로드하도록 언어 서버에 지시하는 예약된 필드입니다. 이 상수. yaml.schemas 추가 구성표를 지원하도록 확장될 수 있습니다. 자세한 내용은 다음을 참조하세요. 관련 문서.

이제 YAML 파일을 생성하고 자동 완성 기능을 사용할 수 있습니다. 누르기 +스페이스 (또는 vim에 구성된 다른 조합)은 현재 컨텍스트에 따라 사용 가능한 필드와 문서를 표시해야 합니다.

여기서 일함 +space를 구성했기 때문에 공백 inoremap <silent><expr> <c-space> coc#refresh(). 아직 해보지 않았다면 다음을 참조하세요. coc.nvim 읽어보기 예시 구성은 다음과 같습니다.

Kubernetes API 버전 선택

이 글을 쓰는 시점에서 yaml-언어-server는 Kubernetes 1.14.0 스키마와 함께 제공됩니다. 스키마를 동적으로 선택하는 방법을 찾지 못해 열었습니다. 해당 GitHub 문제. 다행스럽게도 언어 서버는 TypeScript로 작성되었기 때문에 수동으로 버전을 변경하는 것이 매우 쉽습니다. 이렇게하려면 파일을 찾으십시오. server.ts.

컴퓨터에서 이를 감지하려면 vim으로 YAML 파일을 열고 다음으로 프로세스를 찾으세요. 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의 다이어그램에는 시작프로브:

개요

이번 기회가 나만큼 당신을 기쁘게 해주기를 바랍니다. 행복한 YAMLing! 기사에 언급된 유틸리티를 더 잘 이해하려면 다음 리포지토리를 확인하세요.

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

번역가의 추신

그리고 거기에있다. 비쿠베, vim-kubernetes и vimkubectl.

블로그에서도 읽어보세요.

• «Kubernetes용 kubebox 및 기타 셸";
• «kubectl을 통해 Kubernetes 작업을 위한 콘솔 도우미".

출처 : habr.com