README.md

Cluster Gen

Proof of concept Web UI for creating Cluster objects based on SCS Cluster Stacks.

Workflow

• Read cluster stack and clusterclass templates
• Render/populate yaml in live editor with good defaults
• On "Download": perform form validation, create yaml file and open up download prompt (all client-side)

Limitations (to be implemented)

• ClusterClass and Cluster Stack templates are hard-coded and limited to the scs/alpha Cluster Stacks
  • Ideally they should reflect the current state of each specific Cluster Stack (e.g. metal3/kamaji)
  • Possbile solution: Either fetch and parse the ClusterClasses using the GitHub API or use the schema provided by kube-apiserver
• Cluster Stack releases are hard-coded
  • Possible solution: Use GitHub API to get releases

Built with

• Next.js
• Typescript
• pnpm
• Tailwind CSS
• shadcn/ui

Setup

Prerequisites

• pnpm

Develop locally

pnpm i
pnpm dev

Build for production

pnpm build
pnpm start

Docker

docker build -t cluster-gen .
docker run -p 3000:3000 cluster-gen