Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dcermak/vscode-rke-cluster-config

VSCode extension to for RKE cluster configuration
https://github.com/dcermak/vscode-rke-cluster-config

kubernetes rancher rke vscode vscode-extension yaml

Last synced: about 2 months ago
JSON representation

VSCode extension to for RKE cluster configuration

Awesome Lists containing this project

README 

        
# VSCode extension for RKE Cluster Configuration files



[![Visual Studio Marketplace](https://img.shields.io/visual-studio-marketplace/v/dancermak.vscode-rke-cluster-config)](https://marketplace.visualstudio.com/items?itemName=dancermak.vscode-rke-cluster-config)

[![Open VSX Marketplace](https://img.shields.io/open-vsx/v/dancermak/vscode-rke-cluster-config)](https://open-vsx.org/extension/dancermak/vscode-rke-cluster-config)

[![extension build](https://img.shields.io/github/workflow/status/dcermak/vscode-rke-cluster-config/extension?label=extension%20build)](https://github.com/dcermak/vscode-rke-cluster-config/actions/workflows/extension.yml)

[![schema check](https://img.shields.io/github/workflow/status/dcermak/vscode-rke-cluster-config/schema?label=schema%20check)](https://github.com/dcermak/vscode-rke-cluster-config/actions/workflows/schema.yml)

[![go tests](https://img.shields.io/github/workflow/status/dcermak/vscode-rke-cluster-config/go?label=go%20test)](https://github.com/dcermak/vscode-rke-cluster-config/actions/workflows/go.yml)

[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://github.com/dcermak/vscode-rke-cluster-config/blob/main/LICENSE)

[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)



# VSCode extension for RKE cluster configuration



Ever needed to make quick edit in RKE's `cluster.yaml` configuration file, but

didn't rember the exact name of a key? Or what that other parameter five lines

below meant? And preferably check beforehands whether the configuration file is

valid instead of testing it in production?



Now you can get all of that from within Visual Studio Code using this extension!



## Features



The extension builds upon the

[YAML](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml)

plugin for VSCode and adds the following capabilities:



- Autocompletion of Configuration keys and values:



![autocomplete](media/autocomplete.gif)



- The configuration file is automatically checked against the schema and errors

  are highlighted:



![linting_error](media/linting_error.png)



- Hovering over a a key in the configuration file will show the documentation of

  that option (if available):



![doc_on_hover](media/doc_on_hover.png)



- You can use

  [Breadcrumbs](https://code.visualstudio.com/Docs/editor/editingevolved#_breadcrumbs)

  to quickly jump through the configuration file (these are provided by the

  [YAML](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml)

  extension):



![breadcrumbs](media/breadcrumbs.png)



And the best part? If you are already using the

[YAML](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml)

plugin, then you don't have to anything to get these features! VSCode will

provide you with all of the above as long as your configuration file is called

`cluster.yml` or `cluster.yaml`.



## Development



Requirements:



- go

- nodejs and yarn



The schema is generated using the

[alecthomas/jsonschema](https://github.com/alecthomas/jsonschema) module from

the structs in

[rancher/rke/blob/master/types/rke_types.go](https://github.com/rancher/rke/blob/master/types/rke_types.go).

This is performed by `dump_cluster_config_schema.go` with some additional post

processing steps performed in `process-schema` (the `$schema` key is removed,

because the validator fails to handle it and the extracted documentation is

added as the description field) via `yarn run schema`.