otto-de / traefik-config-validator

Validator for your Traefik Proxy (https://doc.traefik.io/traefik/) configuration

Traefik Config Validator

traefik-config-validator is a CLI tool to (syntactically) validate your Traefik configuration files to ensure bad configurations are being captured before hitting your production system or during development. It can be used either as a developer tool on your machine or in CI/CD pipelines and has been used in production at OTTO.

It will be validated against the following JSON schemas hosted on schemastore:

• https://github.com/SchemaStore/schemastore/blob/master/src/schemas/json/traefik-v2.json
• https://github.com/SchemaStore/schemastore/blob/master/src/schemas/json/traefik-v2-file-provider.json

Features

• Validate Traefik configuration (traefik.yml)
• Validate Traefik file provider configuration

Known Limitations

• Currently, only YAML configuration is supported while Traefik supports TOML, JSON, environment variables and the CLI for configuration
• Cannot recursively scan files for file provided configurations

Installation

go get github.com/otto-de/traefik-config-validator

or via Docker

docker pull ghcr.io/otto-de/traefik-config-validator:latest

Usage

traefik-config-validator -cfg <traefik.yml> -cfgdir <static-file-provider-root>

Developer Guide

All steps in development can be performed either through the CI/CD pipeline with GitHub Actions or locally. See below for instructions on how to do it.

Setting Up

We use pre-commit for validating commits before pushing them. In addition, you will need go installed and (optionally) Docker for build an image.

Building

Build via make build to build via golang build tools or docker build --build-arg VERSION=<myversion> to build via Docker.

Testing

Currently, we are lacking good unit tests. Feel free to add them!

Linting

Run make lint to lint the Golang code.

Releasing

We use Semantic Versioning. Each git tag should be named according to v{major}.{minor}.{patch}.

Contributing

If you'd like to contribute to the project, refer to the contributing documentation.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

Credits

The gopher's logo of Traefik is licensed under the Creative Commons 3.0 Attributions license (see traefik/traefik).

traefik-config-validator's Issues

[FEATURE] TOML Support

Is there an existing issue for this?

• I have searched the existing issues

Feature description

I know that the TOML does not supported for now.
But I hope it will be done in future. Just want to leave this feature request to track the state.

Anything else?

No response

[BUG] go install does not work

Is there an existing issue for this?

• I have searched the existing issues

Current Behavior

When trying to install the CLI via go install github.com/otto-de/traefik-config-validator, I receive the following error message

go install: github.com/otto-de/[email protected]: module github.com/otto-de/[email protected] found, but does not contain package github.com/otto-de/traefik-config-validator

Expected Behavior

go install ... works

Steps To Reproduce

1. go install github.com/otto-de/[email protected]

Anything else?

No response

Release 1.0.0

Is there an existing issue for this?

• I have searched the existing issues

Feature description

Finally, release the initial stable version after the tool is in production for roughly 6 months at OTTO.

To Dos

• Release v1.0.0
• Add Changelog
• Write Blog Post at OTTO Dev Blog

[FEATURE] Validation of dynamic config using Go templates

Is there an existing issue for this?

• I have searched the existing issues

Feature description

Traefik dynamic configuration using the File provider supports Go Templating. My sense is that this tool does not currently support validating dynamic configuration that uses template syntax.

Assuming this is correct, perhaps this should be called out in the docs?

Not sure what kind of lift this would take, but just wanted to call it out for discussion. I use go templating in my traefik config, and would definitely like to be able to validate these files before I commit or deploy them. However, I could also see this be more appropriately built into traefik itself, similar to how the apachectl configtest command works with Apache.

Anything else?

No response