Kubernetes Spec Explorer

Dev tools

api reference explorer

SHOW HN2024

Kubernetes Spec Explorer

I built an interactive explorer for Kubernetes resources spec A few things included: - Tree view with…

kubespec.dev

#kubernetes spec#kubernetes api reference#k8s schema#kubernetes version diff

216points
30comments
#358of 3,515 in 2024
Top 11%of 2024 by points

How HN took it

LovedMost comments that take a side are positive

13 positive, 6 neutral or asking, 0 mixed, 1 critical, out of 20 comments about the project. Thread score +0.55.

Docs: 7 for, 0 againstDesign: 3 for, 1 against

The thread, comment by comment

Each row is a top-level comment and its replies, in HN's order. Select a cell to open that comment on HN.

positive neutral or mixed critical about another commenter or something else the maker

What HN said

What people liked

  • Tree view with inline type definitions is easier than official docs

    From 3 comments
    • This is what the official reference docs should look and work like. Well done.
      wpm on HN
    • >Contrast that with Ok, let's contrast. Your link does take a moment to load, and it says the exact same thing about envFrom[].fieldRef.fieldPath as the OP's site does. It takes…
      wpm on HN
    • This is so awesome and at a glance far better than the official documentation. Thank you!
      JohnMakin on HN
  • Version diffs are useful

    From 1 comment
    • I like the version diffs. Perhaps add an "expand all" button to avoid clicking individually on properties to see their descriptions? I usually rely on the official generated docs…
      leg100 on HN
  • Examples and version history in one place

    From 1 comment
    • Official Kubernetes docs are terrible. No versioning (most of the links on the internet are dead). A lot of text with not much exmaples. This one looks nice. Spec with full list…
      fikama on HN

Objections

  • Collapsed leaf nodes break command-f and deep linking

    From 1 comment
    • I gravely disagree because having to click to open the description in the leaf nodes makes command-f not work. I would link to an example but it doesn't support permalinks and…
      mdaniel on HN
  • Field order differs from official docs

    From 2 comments
    • Why order of fields is different? Example: https://kubespec.dev/apps/v1/Deployment https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/deployment-v1/ ```…
      vbezhenar on HN
    • > Not sure where it really comes from, It's almost certainly from the golang struct https://github.com/kubernetes/api/blob/v0.32.0/apps/v1/types.go#L376 or its more succinct…
      mdaniel on HN

Requests

  • Support for CRDs

    From 2 comments
    • Very nice! Adding support for CRDs would be very nice. Maybe look up popular CNCF projects and find their official helm charts, that contain the CRDs?
      robinhoodexe on HN
    • I think the next closest thing for CRDs is this: https://doc.crds.dev
      jzelinskie on HN
  • Expand all button

    From 1 comment
    • I like the version diffs. Perhaps add an "expand all" button to avoid clicking individually on properties to see their descriptions? I usually rely on the official generated docs…
      leg100 on HN
  • Colon after keys for copy-paste into editors

    From 1 comment
    • This is really nice! The context switching that comes from using the [official k8s…
      abuckenheimer on HN
  • Paste an existing manifest to analyze

    From 1 comment
    • It would be great if you could paste in an existing k8s file to analyze as well. Would help for onboarding/modifying existing templates you haven't worked on in awhile, etc.
      elliot07 on HN
  • kubectl explain plugin integration

    From 1 comment
    • Very nice, would love to see a kubectl explain type plugin to integrate with this somehow.
      JeffMcCune on HN

Questions

  • Why Kubernetes is complex compared to EC2 and EBS

    From 1 comment
    • A naive question: why does k8s require more documentation and understanding than using EC2 + EBS, if I don't have to consider cost. To set up my infrastructure, I launch clusters…
      hintymad on HN

Alternatives named

  • Official Kubernetes API reference docs

    From 2 comments
    • I find this hard-to-find official documentation so much easier to read: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/ In my opinion, it comes with better…
      Xeago on HN
    • I like the version diffs. Perhaps add an "expand all" button to avoid clicking individually on properties to see their descriptions? I usually rely on the official generated docs…
      leg100 on HN
  • kubectl explain

    From 1 comment
    • Please note that kubectl also contains something similar: e.g. kubectl explain deployment.spec
      joushx on HN
  • doc.crds.dev

    From 1 comment
    • I think the next closest thing for CRDs is this: https://doc.crds.dev
      jzelinskie on HN
  • kubectl-explore CLI

    From 1 comment
    • This CLI should solve similar issues! https://github.com/keisku/kubectl-explore
      keisku on HN

Category, keywords, summaries and labels on this page were made by AI (Thread Reader v2) and not checked by hand. Each point links to the comments it came from.

Add a badge to your READMEShown on HackerShow
[![Shown on HackerShow](https://hackershow.org/badge.svg)](https://hackershow.org/show/42399701)