kube_cluster 0.3.2 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 143c409d80b81ee281ed0b8a11fcfedc2d1ae76aa15bae26cbf5a6a1e4d820df
-  data.tar.gz: 8866e6cecdca078a5ceb6df8003b3c0433c915bf97ca0b9650e6d0e07a2decd6
+  metadata.gz: 0b71ea6fab00cdb1604ed20b2e243d9a07213354bbfd34a7a7223039a2291cc0
+  data.tar.gz: 5d81264cb2608fc78a24f81fa34117f7a2192a63f20952b7e1bd483aeb59e21c
 SHA512:
-  metadata.gz: 8d35f3da0f04b39e204a4a2df015ce7723537d7cf08f3cecd30d6a2532ec1cb1ce7005ae00173e7549a6223ce7312b67353e3aa20dc4693fbf1f75f66bb0de43
-  data.tar.gz: 497038c1324cff9eab76b0b15e1ab6e6cd91d88526af313db21bca45387b48efb2b35827f5320be8f13465a2b45c8b2a09880c66e36200ea5dccdcc8762d3863
+  metadata.gz: 54bb18e16d86e240ec4b58c62ee223dbf75aaec7c1597a04791111436dbb59b4b49a07f5e726326d1dd3d4cd0cc56b67fd5f631645645f730179074599753397
+  data.tar.gz: 11a41bf7917ed4972ddc00bbda95df024eb76d48d4c806d12bf0ac77f463688376a299f40c9666db3943d86746c7b5316f091853c2f1928e07f7f0858129e382

data/Gemfile

@@ -3,3 +3,6 @@
 source "https://rubygems.org"
 
 gemspec
+
+gem "kube_schema", path: "../schema"
+gem "kube_kubectl", path: "../ctl"

data/Gemfile.lock

@@ -1,8 +1,24 @@
+PATH
+  remote: ../ctl
+  specs:
+    kube_kubectl (2.0.8)
+      debug (~> 1.11)
+      json_schemer (~> 2.5)
+      rubyshell (~> 1.5)
+      shellwords (~> 0.2.2)
+      string_builder (~> 1.2.0)
+
+PATH
+  remote: ../schema
+  specs:
+    kube_schema (1.3.4)
+      json_schemer (~> 2.5.0)
+      rubyshell (~> 1.5.0)
+
 PATH
   remote: .
   specs:
-    kube_cluster (0.3.1)
-      kube_kit (> 0)
+    kube_cluster (0.3.4)
       kube_kubectl (~> 2.0.0)
       kube_schema (~> 1.3.0)
 
@@ -29,16 +45,6 @@ GEM
       hana (~> 1.3)
       regexp_parser (~> 2.0)
       simpleidn (~> 0.2)
-    kube_kit (0.2.0)
-    kube_kubectl (2.0.2)
-      debug (~> 1.11)
-      json_schemer (~> 2.5)
-      rubyshell (~> 1.5)
-      shellwords (~> 0.2.2)
-      string_builder (~> 1.2.0)
-    kube_schema (1.3.1)
-      json_schemer (~> 2.5.0)
-      rubyshell (~> 1.5.0)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     minitest (5.27.0)
@@ -94,6 +100,8 @@ PLATFORMS
 
 DEPENDENCIES
   kube_cluster!
+  kube_kubectl!
+  kube_schema!
   minitest (~> 5.0)
   rake (~> 13.0)
   rubocop (~> 1.21)

data/examples/01-basic-redis-pod/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "falcon", "~> 0.55.3"

data/examples/01-basic-redis-pod/README.md

@@ -0,0 +1,30 @@
+# 01 — Basic Redis Pod
+
+A single Redis pod defined with `Kube::Cluster['Pod']`, demonstrating the resource DSL and block overrides.
+
+## Prerequisites
+
+- Docker (with Compose)
+- `kubectl`
+- `bundle install` (from project root)
+
+## Run
+
+```
+bin/dev
+```
+
+## Verify
+
+```
+kubectl logs my-redis-1
+kubectl exec -it my-redis-1 -- redis-cli ping
+```
+
+## Files
+
+| File | Purpose |
+|---|---|
+| `manifest.rb` | Defines `RedisPod` class and generates YAML |
+| `redis.conf` | Redis config mounted into the pod |
+| `docker-compose.yml` | Local k3s cluster |

data/examples/01-basic-redis-pod/bin/dev

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+docker compose up -d
+
+kubectl create configmap example-redis-config --from-file=redis.conf --dry-run=client -o yaml | kubectl apply -f -
+
+bundle exec ruby manifest.rb > manifest.yaml
+kubectl apply -f manifest.yaml

data/examples/01-basic-redis-pod/docker-compose.yml

@@ -0,0 +1,14 @@
+services:
+  cluster:
+    image: "rancher/k3s:latest"
+    command: server
+    privileged: true
+    restart: always
+    environment:
+      - K3S_TOKEN=change-me-or-face-the-consequences
+      - K3S_KUBECONFIG_OUTPUT=/output/kubeconfig.yaml
+      - K3S_KUBECONFIG_MODE=666
+    volumes:
+      - .:/output
+    ports:
+      - 6443:6443

data/examples/01-basic-redis-pod/manifest.rb

@@ -3,7 +3,7 @@ require "kube/cluster"
 
 class RedisPod < Kube::Cluster['Pod']
   def initialize(container_name: 'my-redis-container', **options, &block)
-    super(**options) {
+    super {
       spec.containers = [
         {
           name: container_name,

data/examples/01-basic-redis-pod/redis.conf

@@ -0,0 +1,2 @@
+maxmemory 2mb
+maxmemory-policy allkeys-lru

data/examples/02-manifest-with-middleware/Dockerfile

@@ -0,0 +1,19 @@
+FROM ruby:3.4-slim
+
+WORKDIR /app
+
+RUN apt-get update -qq && \
+    apt-get install -y --no-install-recommends \
+    build-essential \
+    libyaml-dev \
+    libssl-dev \
+    pkg-config && \
+    rm -rf /var/lib/apt/lists/*
+
+COPY Gemfile ./
+RUN bundle install
+
+COPY config.ru falcon.rb ./
+
+EXPOSE 3000
+CMD ["bundle", "exec", "falcon", "host"]

data/examples/02-manifest-with-middleware/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "falcon", "~> 0.55.3"

data/examples/02-manifest-with-middleware/README.md

@@ -0,0 +1,34 @@
+# 02 — Manifest with Middleware
+
+A full app deployment (Deployment, Service, Ingress, ConfigMap, HPA) assembled with `Kube::Cluster::Manifest` and transformed by middleware (Namespace, Labels).
+
+## Prerequisites
+
+- Docker (with Compose)
+- `kubectl`
+- `bundle install` (from project root)
+
+## Run
+
+```
+bin/dev
+```
+
+## Verify
+
+```
+kubectl get pods -n my-app
+kubectl logs -n my-app -l app=my-app
+curl -H "Host: app.example.com" http://localhost
+```
+
+## Files
+
+| File | Purpose |
+|---|---|
+| `manifest.rb` | Assembles resources and applies middleware |
+| `templates/` | Resource classes (Deployment, Service, Ingress, ConfigMap, HPA) |
+| `middleware/` | Namespace and Labels middleware |
+| `config.ru` | Falcon hello-world app |
+| `Dockerfile` | Container image |
+| `docker-compose.yml` | Local k3s cluster + registry |

data/examples/02-manifest-with-middleware/bin/dev

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+docker compose up -d
+
+docker build -t localhost:5000/my-app:latest .
+docker push localhost:5000/my-app:latest
+
+bundle exec ruby manifest.rb > manifest.yaml
+kubectl apply -f manifest.yaml

data/examples/02-manifest-with-middleware/config.ru

@@ -0,0 +1,3 @@
+run do |env|
+  [200, {'Content-Type' => 'text/plain'}, ['Hello, World!']]
+end

data/examples/02-manifest-with-middleware/docker-compose.yml

@@ -0,0 +1,25 @@
+services:
+  registry:
+    image: registry:2
+    ports:
+      - "5000:5000"
+    restart: unless-stopped
+
+  cluster:
+    image: "rancher/k3s:latest"
+    command: server
+    privileged: true
+    restart: always
+    environment:
+      - K3S_TOKEN=change-me-or-face-the-consequences
+      - K3S_KUBECONFIG_OUTPUT=/output/kubeconfig.yaml
+      - K3S_KUBECONFIG_MODE=666
+    volumes:
+      - .:/output
+      - ./registries.yaml:/etc/rancher/k3s/registries.yaml:ro
+    ports:
+      - 6443:6443
+      - 80:80
+      - 443:443
+    depends_on:
+      - registry

data/examples/02-manifest-with-middleware/falcon.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/env falcon-host
+
+require "falcon/environment/rack"
+
+service "rack" do
+  include Falcon::Environment::Rack
+
+  endpoint do
+    Async::HTTP::Endpoint.parse('http://0.0.0.0:3000')
+  end
+end

data/examples/02-manifest-with-middleware/manifest.rb

@@ -3,7 +3,7 @@ require "kube/cluster"
 
 APP_NAME        = "my-app"
 FULLNAME        = "my-app"
-IMAGE           = "my-app:latest"
+IMAGE           = "registry:5000/my-app:latest"
 MATCH_LABELS    = { app: APP_NAME }
 STANDARD_LABELS = { app: APP_NAME, version: "1.0" }
 RESOURCES       = { requests: { cpu: "100m", memory: "128Mi" }, limits: { cpu: "500m", memory: "256Mi" } }

data/examples/02-manifest-with-middleware/registries.yaml

@@ -0,0 +1,4 @@
+mirrors:
+  "registry:5000":
+    endpoint:
+      - "http://registry:5000"

data/examples/03-app-with-database/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "falcon", "~> 0.55.3"

data/examples/04-pod-with-ingress/Dockerfile

@@ -0,0 +1,20 @@
+FROM ruby:3.4-slim
+
+WORKDIR /app
+
+# Install build dependencies and OpenSSL headers
+RUN apt-get update -qq && \
+    apt-get install -y --no-install-recommends \
+    build-essential \
+    libyaml-dev \
+    libssl-dev \
+    pkg-config && \
+    rm -rf /var/lib/apt/lists/*
+
+COPY Gemfile Gemfile.lock ./
+RUN bundle install
+
+COPY . .
+
+EXPOSE 3000
+CMD ["bundle", "exec", "falcon", "host"]

data/examples/04-pod-with-ingress/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+
+gem "metatron", "~> 0.11.3"
+gem "falcon", "~> 0.55.3"
+gem "logger", "~> 1.7"
+
+gem "kube_cluster", "~> 0.3.2"

data/examples/04-pod-with-ingress/README.md

@@ -0,0 +1,42 @@
+# 04 — Pod with Ingress
+
+A hello-world Falcon app deployed as a Pod + Service + Ingress using `PodWithIngress`, a composite `Kube::Cluster::Manifest`.
+
+## Prerequisites
+
+- Docker (with Compose)
+- `kubectl`
+- `bundle install`
+
+## Run
+
+```
+bin/dev
+```
+
+This starts a local k3s cluster with a container registry, builds and pushes the app image, generates the Kubernetes manifest from `manifest.rb`, and applies it.
+
+## Verify
+
+```
+kubectl logs my-app
+curl -H "Host: localhost" http://localhost
+```
+
+## What it does
+
+`manifest.rb` produces three resources from a single `PodWithIngress` declaration:
+
+- **Pod** — runs the Falcon hello-world server on port 3000
+- **Service** — routes traffic to the pod
+- **Ingress** — exposes the service at `http://localhost`
+
+## Files
+
+| File | Purpose |
+|---|---|
+| `manifest.rb` | Generates Kubernetes YAML |
+| `pod_with_ingress.rb` | Composite manifest: Pod + Service + Ingress |
+| `config.ru` | Falcon rack app |
+| `Dockerfile` | Container image |
+| `docker-compose.yml` | Local k3s cluster + registry |

data/examples/04-pod-with-ingress/bin/dev

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+docker compose up -d
+
+docker build -t localhost:5000/myapp:v1 .
+docker push localhost:5000/myapp:v1
+
+kubectl delete pod my-app
+bundle exec ruby manifest.rb > manifest.yaml
+kubectl apply -f manifest.yaml

data/examples/04-pod-with-ingress/config.ru

@@ -0,0 +1,3 @@
+run do |env|
+  [200, {'Content-Type' => 'text/plain'}, ['Hello, World!']]
+end

data/examples/04-pod-with-ingress/docker-compose.yml

@@ -0,0 +1,35 @@
+# to run define K3S_TOKEN, K3S_VERSION is optional, eg:
+#   K3S_TOKEN=${RANDOM}${RANDOM}${RANDOM} docker-compose up
+services:
+  registry:
+    image: registry:2
+    ports:
+      - "5000:5000"
+    restart: unless-stopped
+
+  cluster:
+    image: "rancher/k3s:latest"
+    command: server
+    privileged: true
+    restart: always
+    environment:
+      - K3S_TOKEN=change-me-or-face-the-consequences
+      - K3S_KUBECONFIG_OUTPUT=/output/kubeconfig.yaml
+      - K3S_KUBECONFIG_MODE=666
+    volumes:
+      - .:/output
+      - ./registries.yaml:/etc/rancher/k3s/registries.yaml:ro
+    ports:
+      - 6443:6443  # Kubernetes API Server
+      - 80:80      # Ingress controller port 80
+      - 443:443    # Ingress controller port 443
+    depends_on:
+      - registry
+    #tmpfs:
+    #  - /run
+    #  - /var/run
+    #ulimits:
+    #  nproc: 65535
+    #  nofile:
+    #    soft: 65535
+    #    hard: 65535

data/examples/04-pod-with-ingress/falcon.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/env falcon-host
+
+require "falcon/environment/rack"
+
+service "rack" do
+  include Falcon::Environment::Rack
+
+  endpoint do
+    Async::HTTP::Endpoint.parse('http://0.0.0.0:3000')
+  end
+end

data/examples/04-pod-with-ingress/manifest.rb

@@ -0,0 +1,15 @@
+require "bundler/setup"
+require "kube/cluster"
+
+require_relative "pod_with_ingress"
+
+manifest = Kube::Cluster::Manifest.new(
+  PodWithIngress.new(
+    name: "my-app",
+    image: "registry:5000/myapp:v1",
+    port: 3000,
+    host: "localhost",
+  ),
+)
+
+puts manifest.to_yaml

data/examples/04-pod-with-ingress/pod_with_ingress.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+class PodWithIngress < Kube::Cluster::Manifest
+  def initialize(name:, image:, port:, host:, &block)
+    match_labels = { app: name }
+
+    super(
+      Kube::Cluster["Pod"].new {
+        metadata.name   = name
+        metadata.labels = match_labels
+
+        spec.containers = [
+          {
+            name: name,
+            image: image,
+            imagePullPolicy: "Always",
+            ports: [
+              { name: "http", containerPort: port }
+            ],
+          }
+        ]
+      },
+
+      Kube::Cluster["Service"].new {
+        metadata.name = name
+
+        spec.selector = match_labels
+        spec.ports = [
+          { port: port, targetPort: "http" }
+        ]
+      },
+
+      Kube::Cluster["Ingress"].new {
+        metadata.name = name
+
+        spec.rules = [
+          {
+            host: host,
+            http: {
+              paths: [
+                {
+                  path: "/",
+                  pathType: "Prefix",
+                  backend: {
+                    service: {
+                      name: name,
+                      port: { number: port },
+                    },
+                  },
+                },
+              ],
+            },
+          },
+        ]
+      },
+    )
+
+    instance_exec(&block) if block
+  end
+end

data/examples/04-pod-with-ingress/registries.yaml

@@ -0,0 +1,4 @@
+mirrors:
+  "registry:5000":
+    endpoint:
+      - "http://registry:5000"

data/examples/05-helm-chart-to-manifest/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "kube_cluster", "~> 0.3.2"

data/examples/05-helm-chart-to-manifest/README.md

@@ -0,0 +1,44 @@
+# 05 — Helm Chart to Manifest
+
+Fetches a Helm chart from a repository, renders it with custom values, and converts the output into typed Ruby `Kube::Schema::Resource` objects.
+
+No running cluster is required — `helm template` renders everything locally.
+
+## Prerequisites
+
+- `helm` CLI installed
+- `bundle install`
+
+## Run
+
+```
+bin/dev
+```
+
+## What it does
+
+`manifest.rb` demonstrates the full Helm → Ruby pipeline:
+
+1. **Registers a Helm repo** — `Kube::Helm::Repo.new("bitnami", url: "...")`
+2. **Gets a chart reference** — `repo.chart("nginx", version: "18.1.0")`
+3. **Inspects default values** — `chart.show_values` returns a Ruby hash
+4. **Renders with custom values** — `chart.template(release:, namespace:, values:)` returns a `Kube::Schema::Manifest`
+5. **Iterates typed resources** — each item is a real `Resource` with `.kind`, `.metadata.name`, `.spec.replicas`, etc.
+6. **Applies middleware** — the rendered resources pass through the same middleware stack as hand-written resources
+7. **Writes YAML** — `manifest.write("manifest.yaml")`
+
+## OCI Registry Example
+
+For OCI-based registries, no `repo.add` is needed:
+
+```ruby
+repo = Kube::Helm::Repo.new("ghcr", url: "oci://ghcr.io/my-org/charts")
+chart = repo.chart("my-app", version: "1.0.0")
+manifest = chart.template(release: "my-app", namespace: "production")
+```
+
+## Files
+
+| File | Purpose |
+|---|---|
+| `manifest.rb` | Fetches chart, renders with values, outputs YAML |

data/examples/05-helm-chart-to-manifest/bin/dev

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+docker compose up -d
+
+bundle exec ruby manifest.rb
+kubectl apply -f manifest.yaml

data/examples/05-helm-chart-to-manifest/docker-compose.yml

@@ -0,0 +1,16 @@
+services:
+  cluster:
+    image: "rancher/k3s:latest"
+    command: server
+    privileged: true
+    restart: always
+    environment:
+      - K3S_TOKEN=change-me-or-face-the-consequences
+      - K3S_KUBECONFIG_OUTPUT=/output/kubeconfig.yaml
+      - K3S_KUBECONFIG_MODE=666
+    volumes:
+      - .:/output
+    ports:
+      - 6443:6443
+      - 80:80
+      - 443:443

data/examples/05-helm-chart-to-manifest/manifest.rb

@@ -0,0 +1,18 @@
+require "bundler/setup"
+require "kube/cluster"
+
+# Helm Chart → Manifest
+#
+# Fetches the Bitnami nginx chart, renders it with values,
+# and writes the result as YAML.
+
+manifest =
+  Kube::Helm::Repo
+    .new("bitnami", url: "https://charts.bitnami.com/bitnami")
+    .fetch("nginx", version: "18.1.0")
+    .apply_values({
+      "replicaCount" => 3,
+      "service"      => { "type" => "ClusterIP" },
+    })
+
+puts manifest.to_yaml

data/examples/06-nginx-with-cert-manager/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "kube_cluster", "~> 0.3.2"

data/examples/06-nginx-with-cert-manager/README.md

@@ -0,0 +1,57 @@
+# 06 — Nginx with cert-manager
+
+Deploys a stock **nginx** Deployment (configured via ConfigMap) with a self-signed TLS certificate from **cert-manager**. Uses k3s's built-in Traefik as the ingress controller.
+
+## Architecture
+
+```
+Internet
+  │
+  ▼
+┌─────────────────────────────────────┐
+│  Traefik (k3s built-in)             │  ← terminates TLS
+└──────────────┬──────────────────────┘
+               │
+               ▼
+┌─────────────────────────────────────┐
+│  Ingress → Service → Deployment    │  ← nginx:1.27-alpine
+│  nginx-app namespace                │
+└─────────────────────────────────────┘
+               │
+               ▼
+┌─────────────────────────────────────┐
+│  cert-manager (Helm)                │  ← provisions self-signed cert
+│  ClusterIssuer (selfsigned)         │
+└─────────────────────────────────────┘
+```
+
+## Prerequisites
+
+- Docker (with Compose)
+- `helm` CLI installed
+- `kubectl`
+- `bundle install`
+
+## Run
+
+```
+bin/dev
+```
+
+## Verify
+
+```
+kubectl get pods -n nginx-app
+kubectl get ingress -n nginx-app
+kubectl get certificate -n nginx-app
+curl -H "Host: app.example.com" http://localhost
+```
+
+## Files
+
+| File | Purpose |
+|---|---|
+| `manifest.rb` | Assembles cert-manager chart + application resources |
+| `nginx_app.rb` | `NginxApp` — Namespace + ConfigMap + Deployment + Service + Ingress |
+| `self_signed_issuer.rb` | `SelfSignedIssuer` — self-signed ClusterIssuer |
+| `docker-compose.yml` | Local k3s cluster |