foundry

README

Foundry

Foundry is a centralized hub for SigNoz installation configurations and deployments: integrations for install. Select yours, configure, and run SigNoz.

Overview

Just as a metalworking foundry turns raw materials into finished products, Foundry forges your deployment from a single configuration and casts SigNoz to fit your environment.

Foundry abstracts away the complexities of the installation process so you can spend time using SigNoz rather than installing it.

Features

• Multi-platform support: Deploy SigNoz using Docker Compose, Systemd (bare metal), or Render for flexible installation across environments.
• Single configuration file: Configure your entire SigNoz stack with one concise file.
• Automatic dependency management: Handles inter-service dependencies
• Tool validation: Verify prerequisites before deployment

Quick start

1. Install foundryctl

curl -fsSL https://signoz.io/foundry.sh | bash

See Getting Started for manual install options and PATH setup.

2. Create a casting

apiVersion: v1alpha1
metadata:
  name: signoz
spec:
  deployment:
    mode: docker
    flavor: compose

3. Deploy

foundryctl cast -f casting.yaml

How it works

  +-------------------------------------------------------------+
  |                       casting.yaml                          |
  |              your single deployment config                  |
  +-----------------------------+-------------------------------+
                                |
                +---------------+---------------+
                |               |               |
                v               v               v
         +-----------+  +-----------+  +----------------+
         |   gauge   |  |   forge   |  |     cast       |
         |-----------|  |-----------|  |----------------|
         | validate  |  | generate  |  | gauge + forge  |
         | prereqs   |  | files     |  | + deploy       |
         +-----------+  +-----+-----+  +-------+--------+
                              |                 |
                              v                 |
         +----------------------------------+   |
         |             pours/               |   |
         |----------------------------------|   |
         |  compose.yaml    manifests/      |   |
         |  values.yaml     configs/        |   |
         |  render.yaml     *.tf.json       |   |
         +-----------------+----------------+   |
                           |                    |
                           +----------+---------+
                                      v
  +-------------------------------------------------------------+
  |                      SigNoz Running                         |
  |-------------------------------------------------------------|
  |  Docker Compose - Swarm - Systemd - Kubernetes - ECS        |
  |  Render - Railway - Coolify                                 |
  +-------------------------------------------------------------+

foundryctl cast runs the full pipeline (gauge + forge + deploy) in one step.

Term	What it means
Casting	Your deployment config. One YAML file describing what you want. Learn more
Moldings	The SigNoz components (ClickHouse, PostgreSQL, OTel Collector, etc.) that Foundry configures for you. Learn more
Pours	The generated output files in pours/. Structure varies by deployment mode. See examples

Examples

Platform	Mode	Flavor	Example
-	docker	compose	docker/compose
-	docker	swarm	docker/swarm
-	kubernetes	helm	kubernetes/helm
-	kubernetes	kustomize	kubernetes/kustomize
-	systemd	binary	systemd/binary
ecs	ec2	terraform	ecs/ec2/terraform
coolify	-	stack	coolify/stack
railway	-	template	railway/template
render	-	blueprint	render/blueprint

CLI reference

foundryctl [command]

Commands:
  gauge       Validate required tools for your deployment mode
  forge       Generate deployment and configuration files
  cast        Full pipeline: gauge + forge + deploy
  gen         Generate example casting files for all modes

Flags:
  -d, --debug          Enable debug logging
  -f, --file string    Casting file path (default "casting.yaml")
  -p, --pours string   Output directory (default "./pours")

# Validate tools
foundryctl gauge -f casting.yaml

# Generate files only
foundryctl forge -f casting.yaml

# Full deploy
foundryctl cast -f casting.yaml

# Generate examples for all deployment modes
foundryctl gen

See CLI Reference for the full command reference with all flags and examples.

What's next

• Getting Started - install and deploy your first SigNoz instance
• Concepts - understand castings, moldings, and patches
• Examples - deployment configurations for all supported platforms
• Reference - CLI commands and casting file spec
• SigNoz documentation - learn more about SigNoz
• SigNoz Slack - community and support

How can I get help?

• Issues: GitHub Issues
• Documentation: SigNoz Docs
• Community: SigNoz Slack

Made with ❤️ for the SigNoz community