vmware-archive / octant

Highly extensible platform for developers to better understand the complexity of Kubernetes clusters.

https://octant.dev

Apache License 2.0

6.28k stars 480 forks source link

Object aware YAML editor #520

Open wwitzel3 opened 4 years ago

wwitzel3 commented 4 years ago

Replace Octant's YAML viewer with an object aware YAML editor

Goal

Replace Octant's YAML viewer with an object are aware YAML editor
Editor will be aware of OpenAPI schemas provided by the cluster's API in the current context
Additional OpenAPI schemas can be provided by the user

Non-goals

There will be no wizard-like functionality for creating new objects

GarySmith commented 4 years ago

How will the editor be aware of the type of object that is being edited, including its fields/types/constraints/relationships? Will this metadata be contained in a json schema?

One important feature for this YAML editor is to be general enough to edit YAML that is stored on the file system, and not just YAML representations of objects obtained from the kubernetes api. There would need to be similar metadata support so that external object could also be constrained and validated.

bryanl commented 4 years ago

You can fetch the OpenAPI schema from the Kubernetes cluster and validate it that way.

GarySmith commented 4 years ago

That sounds great for those objects that are in Kubernetes. We also have a need to be able to edit cluster API yaml files in a bootstrapping scenario before Kubernetes is running. Can the OpenAPI schema for these files be provided in some other way than from Kubernetes?

ryanelian commented 4 years ago

One of the major limitations with kubernetes dashboard is the inability to encode/decode base64 when editing secrets.

I wish that octant has secret editor is base64 aware.