README
¶
werf is a CNCF Sandbox CLI tool to implement full-cycle CI/CD to Kubernetes easily. werf integrates into your CI system and leverages familiar and reliable technologies, such as Git, Dockerfile, Helm, and Buildah.
What makes werf special:
- Complete application lifecycle management: build and publish container images, test, deploy an application to Kubernetes, distribute release artifacts and clean up the container registry.
- Ease of use: use Dockerfiles and Helm chart for configuration and let werf handle all the rest.
- Advanced features: automatic build caching and content-based tagging, enhanced resource tracking and extra capabilities in Helm, a unique container registry cleanup approach, and more.
- Gluing common technologies: Git, Buildah, Helm, Kubernetes, and your CI system of choice.
- Production-ready: werf has been used in production since 2017; thousands of projects rely on it to build & deploy various apps.
Installation
The Getting Started guide helps set up and use werf both locally and in your CI system.
Documentation
Detailed usage and reference for werf are available in documentation in multiple languages.
Developers can get all the necessary knowledge about application delivery in Kubernetes (including basic understanding of K8s primitives) in the werf guides. They provide ready-to-use examples for popular frameworks, including Node.js (JavaScript), Spring Boot (Java), Django (Python), Rails (Ruby), and Laravel (PHP).
Community & support
Please feel free to reach developers/maintainers and users via GitHub Discussions for any questions regarding werf. You're also welcome on Stack Overflow: when you tag a question with werf, our team is notified and comes to help you.
Your issues are processed carefully if posted to issues at GitHub.
For questions that may require a more detailed and prompt discussion, you can use:
- #werf channel in the CNCF’s Slack workspace;
- werf_io Telegram chat. (There is a Russian-speaking Telegram chat werf_ru as well.)
Follow @werf_io to stay informed about all important project's news, new articles, etc.
Contributing
This contributing guide outlines the process to help get your contribution accepted.
License
Apache License 2.0, see LICENSE.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
buildah-test
command
|
|
|
embed-stapel
command
|
|
|
werf
command
|
|
|
pkg
|
|
|
config
Package config is a generated GoMock package.
|
Package config is a generated GoMock package. |
|
git_repo/gitdata
Package gitdata manages garbage collection of werf's host-local git data under $WERF_HOME/local_cache.
|
Package gitdata manages garbage collection of werf's host-local git data under $WERF_HOME/local_cache. |
|
playground
|
|
|
native_rootless_buildah
command
|
|
|
Package schemas holds the JSON Schemas of werf configuration files.
|
Package schemas holds the JSON Schemas of werf configuration files. |
|
test
|
|
|
mock
Package mock is a generated GoMock package.
|
Package mock is a generated GoMock package. |
|
pkg/fakedockerd
Package fakedockerd provides a minimal in-process Docker Engine API stub for tests that must exercise real werf code paths without touching a shared Docker daemon.
|
Package fakedockerd provides a minimal in-process Docker Engine API stub for tests that must exercise real werf code paths without touching a shared Docker daemon. |