Kubernetes YAML Generator & Linter

Overview

The Kubernetes YAML Generator & Linter is a powerful, dual-mode tool designed to streamline the creation and validation of Kubernetes configuration files. Whether you are a seasoned DevOps engineer or a developer new to cloud-native applications, this tool helps you produce accurate, best-practice-compliant YAML manifests with ease.

Key Features

Generator Mode

• Form-Based Creation: Interactively build Kubernetes resources using intuitive forms. No need to memorize complex YAML syntax.
• Resource Support: Generate configurations for common Kubernetes objects:
  • Deployment
  • Service
  • Pod
  • ConfigMap
  • Secret
• Dynamic Fields: Easily manage complex structures like container lists, environment variables, ports, and labels with dynamic editors.
• Live YAML Output: See the generated YAML manifest update in real-time as you fill out the forms.
• Best-Practice Defaults: Forms are pre-filled with sensible defaults (e.g., replica count, default namespace) to get you started quickly.
• Intelligent Linking: The tool can pre-fill selectors for a Service based on the labels of a Deployment you just configured.

Linter Mode

• Instant Validation: Paste your existing Kubernetes YAML and get immediate feedback on its validity.
• YAML Syntax Checking: Catches fundamental syntax errors like incorrect indentation, missing colons, and invalid structures using js-yaml.
• Kubernetes Schema Validation:
  • Ensures the presence of required fields like apiVersion, kind, and metadata.
  • Validates the basic structure of common resources.
• Best Practice Warnings: The linter goes beyond syntax to provide valuable suggestions:
  • Warns against using the :latest image tag.
  • Flags containers missing resource requests or limits.
  • Highlights missing livenessProbe or readinessProbe for improved application reliability.
  • Detects potential mismatches between a Service selector and Deployment labels.
• Clear Feedback: Errors and warnings are presented in a clear, organized list, making it easy to identify and fix issues.

How to Use

Generate a Kubernetes Deployment and Service

1. Select Generate Mode: Ensure the "Generate" tab is active.
2. Choose Resource Type: Select Deployment from the resource type dropdown.
3. Fill in the Form:
   • Provide a metadata.name for your deployment (e.g., my-app-deployment).
   • Add container details: specify a name (e.g., my-app-container) and an image (e.g., nginx:1.21). Avoid using the :latest tag.
   • Configure ports, environment variables, and resource limits as needed.
4. Observe Live Output: The YAML manifest will appear in the right-hand panel, updating as you type.
5. Generate a Service:
   • Switch the resource type to Service.
   • Provide a metadata.name (e.g., my-app-service).
   • The spec.selector field will automatically be populated with the labels from your deployment.
   • Configure the service ports, ensuring the targetPort matches the containerPort from your deployment.
6. Copy or Download: Once you're satisfied, use the "Copy to Clipboard" or "Download YAML" buttons.

Lint an Existing YAML File

1. Select Lint Mode: Switch to the "Lint" tab.
2. Input YAML: Paste your Kubernetes YAML content into the input area on the left. You can also upload a .yaml file.
3. Review Results:
   • The YAML will be instantly parsed and validated.
   • Any syntax errors or best-practice warnings will appear in the results panel below the YAML input.
   • Each issue will have a severity (Error/Warning), a descriptive message, and context to help you locate the problem.
4. Correct and Re-lint: Edit the YAML directly in the input area. The linter will re-validate as you type, providing live feedback until all issues are resolved.