genifest

README

genifest

⚠️ Alpha Software: This is alpha software under active development. APIs and configuration formats may change without notice.

Genifest is a Kubernetes manifest generation tool that creates deployment manifests from templates for GitOps workflows. It processes configuration files to generate Kubernetes resources with dynamic value substitution, designed for use with GitOps continuous deployment processes like ArgoCD.

How It Works

Genifest uses a metadata-driven approach to discover and process YAML configuration files. It applies dynamic changes to Kubernetes manifests and related configuration files based on configurable rules, allowing you to maintain a single set of manifests that evolve over time. This is useful for:

• Generating environment-specific deployments
• Embed secrets
• Incrementing image tags according to business rules
• Managing variations in configuration files

This is all done without templating and aiming at idempotency so there is a single source of truth.

Core Concepts

• Configuration Discovery: Starts with a root genifest.yaml file and discovers additional configurations through metadata-defined paths
• Dynamic Value Generation: Uses ValueFrom expressions to generate values from functions, templates, scripts, files, and more
• Tag-Based Filtering: Apply different sets of changes based on tags (based on environment, e.g., production, staging, development, or change type, e.g., secrets, config, image-version, depending your needs)

Configuration Structure

The system uses a hierarchical configuration approach:

1. Root Configuration: A genifest.yaml file in your project root defines metadata paths and global settings
2. Distributed Configurations: Additional genifest.yaml files in subdirectories provide scoped configurations
3. Automatic Discovery: Directories without explicit configurations get synthetic configs containing all YAML files

Recommended Usage Pattern

For optimal organization and maintainability, use multiple genifest.yaml files throughout your project to keep changes close to the YAML files being managed:

project-root/
├── genifest.yaml                 # Root configuration
├── k8s/
│   ├── app1/
│   │   ├── genifest.yaml        # App1-specific changes
│   │   ├── deployment.yaml
│   │   └── service.yaml
│   └── app2/
│       ├── genifest.yaml        # App2-specific changes  
│       ├── deployment.yaml
│       └── configmap.yaml
├── scripts/
│   └── build-image.sh
├── files/
│   └── app1/                   # App1-specific files
        └── config-file.yaml

Primary Use Case

Genifest is designed for managing YAML files that are directly deployed via GitOps CD processes such as ArgoCD. In this workflow:

1. Developers define base Kubernetes manifests
2. Genifest generates environment-specific variations
3. GitOps tools detect changes and deploy automatically
4. No manual kubectl or deployment steps required

While this is the primary use case, genifest can be adapted for other YAML processing workflows where dynamic value substitution is needed.

Key Selector Syntax

Genifest uses yq-style path expressions for the keySelector field to specify which parts of YAML documents to modify. This syntax is a subset of the expression syntax used by tools like yq and jq.

Supported Syntax

Field Access:

keySelector: ".metadata.name"          # Access nested fields
keySelector: ".spec.replicas"          # Navigate object hierarchy

Array Indexing:

keySelector: ".spec.containers[0]"     # First array element
keySelector: ".items[-1]"              # Last array element (negative indexing)

Map Key Access:

keySelector: ".data.config"            # Simple key access
keySelector: ".data.[\"app.yaml\"]"    # Quoted keys (for keys with special characters)
keySelector: ".labels.[\"app.kubernetes.io/name\"]"  # Complex key names

Array Slicing:

keySelector: ".items[1:3]"             # Elements 1 and 2
keySelector: ".items[2:]"              # From element 2 to end
keySelector: ".items[:3]"              # First 3 elements
keySelector: ".items[:]"               # All elements (copy)

Array Iteration and Filtering:

keySelector: ".spec.containers[]"                               # Iterate over all containers
keySelector: ".spec.containers[] | select(.name == \"frontend\")"  # Filter by condition
keySelector: ".spec.containers[] | select(.name == \"frontend\") | .image"  # Pipeline operations

Complex Expressions:

keySelector: ".spec.template.spec.containers[0].image"           # Deep navigation
keySelector: ".metadata.labels.[\"app.kubernetes.io/version\"]"  # Complex key in metadata
keySelector: ".spec.volumes[0].configMap.items[1].key"          # Mixed array/object access
keySelector: ".spec.template.spec.containers[] | select(.name == \"backend\") | .image"  # Full pipeline

Key Features

• Grammar-based parsing: Uses a formal grammar parser for robust expression handling
• Array iteration: Support for iterating over array elements with [] syntax
• Pipeline operations: Chain operations with | for complex expressions
• Filtering functions: Built-in select() function for conditional filtering
• Comparison operators: Support for == and != in filter conditions
• Negative indexing: Array access with negative indices (e.g., [-1] for last element)
• Quoted keys: Supports both single and double quotes for keys containing special characters
• Path scoping: Changes only apply to files within their configuration directory

Differences from yq/jq

This implementation supports a subset of yq/jq syntax, focusing on the most common path operations:

✅ Supported:

• Field access (.field, .nested.field)
• Array indexing ([0], [-1])
• Array slicing ([1:3], [2:], [:3])
• Array iteration ([])
• Quoted key access (["key.with.dots"], ['key-with-dashes'])
• Pipeline operations (|)
• Filtering with select() function
• Comparison operators (==, !=)
• Complex pipeline expressions (.containers[] | select(.name == "frontend") | .image)

❌ Not Supported:

• Advanced filtering functions (map(), has(), contains(), etc.)
• Arithmetic operations (+, -, *, /)
• String manipulation functions (split(), join(), length())
• Conditional expressions (if-then-else)
• Recursive descent (..)
• Variable assignment
• Step slicing ([start:end:step])

Value Generation System

Genifest provides multiple ways to generate dynamic values:

DefaultValue

Returns literal string values:

valueFrom:
  default:
    value: "literal-string"

ArgumentRef

References variables from the current evaluation context:

valueFrom:
  argRef:
    name: "variable-name"

BasicTemplate

Template strings with ${variable} substitution:

valueFrom:
  template:
    string: "Hello ${name}!"
    variables:
      - name: "name"
        valueFrom:
          default:
            value: "World"

FunctionCall

Calls named functions with arguments:

valueFrom:
  call:
    function: "get-replicas"
    args:
      - name: "environment"
        valueFrom:
          default:
            value: "production"

ScriptExec

Executes scripts from the scripts directory:

valueFrom:
  script:
    exec: "build-image.sh"
    args:
      - name: "tag"
        valueFrom:
          default:
            value: "latest"
    env:
      - name: "BUILD_ENV"
        valueFrom:
          default:
            value: "production"

FileInclusion

Includes content from files in the files directory:

valueFrom:
  file:
    app: "myapp"  # optional subdirectory
    source: "config.yaml"

CallPipeline

Chains multiple operations together:

valueFrom:
  pipeline:
    - valueFrom:
        default:
          value: "initial"
      output: "step1"
    - valueFrom:
        template:
          string: "${step1}-processed"
          variables:
            - name: "step1"
              valueFrom:
                argRef:
                  name: "step1"

Security and Safety

• All script execution uses the configured CloudHome as working directory
• File inclusion is restricted to the configured files directory
• Path traversal is prevented through path validation
• Environment variables are isolated for script execution

Installation

To install the tool, run the following command:

curl -L https://raw.githubusercontent.com/zostay/genifest/master/tools/install.sh | sh

Or to install from source, you'll need go 1.22 installed:

go install github.com/zostay/genifest/cmd/genifest@latest

Usage

Genifest provides several subcommands for different operations. All commands can optionally specify a directory argument to operate from a location other than the current working directory.

Core Commands

# Apply all changes (run from directory containing genifest.yaml)
genifest run

# Apply only production changes  
genifest run --include-tags production

# Apply all except staging changes
genifest run --exclude-tags staging

# Apply changes from a different directory
genifest run path/to/project

# Show version information
genifest version

# List all available tags in configuration
genifest tags

# Validate configuration without applying changes
genifest validate

# Display merged configuration 
genifest config

Enhanced Output

The run command provides detailed progress reporting:

• Shows total change definitions found and how many will be processed
• Reports each change with full context: file -> document[index] -> key: old → new
• Distinguishes between changes applied vs actual modifications made
• Summarizes final results with file modification counts

Tag Filtering

• No flags: All changes applied (tagged and untagged)
• Include only: Only changes matching include patterns
• Exclude only: All changes except those matching exclude patterns
• Both flags: Changes matching include but not exclude patterns
• Glob patterns supported: prod*, test-*, etc.

Contributing

We welcome contributions! To get started:

Development Setup

1. Clone the repository:

   git clone https://github.com/zostay/genifest.git
   cd genifest
   

2. Install dependencies:

   go mod download
   

3. Run tests:

   go test ./...
   

4. Build locally:

   go build -o genifest ./cmd/genifest
   

5. Run linting:

   golangci-lint run --timeout=5m
   

Development Workflow

1. Fork the repository on GitHub
2. Create a feature branch from master
3. Make your changes with tests
4. Ensure all tests pass and linting is clean
5. Submit a pull request with a clear description

Testing

The project includes comprehensive tests covering:

• Individual ValueFrom evaluator functionality
• Error handling and edge cases
• Integration with real configuration files (guestbook example)
• Context immutability and variable scoping
• Script execution with different argument and environment configurations

LICENSE

Copyright © 2025 Qubling LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.