uffizzi

uffizzi copied to clipboard

What is Uffizzi?

Uffizzi is a cloud-native REST API for managing lightweight, event-driven test environments on Kubernetes. It provides Development teams with an environments-as-a-service capability, while eliminating the need for Operations teams to configure and manage test infrastructure and tooling.

Use cases

Uffizzi is designed to integrate with any CI/CD platform as a step in your pipeline. Example use cases include rapidly creating PR environments, preview environments, release environments, demo environments, and staging environments.

Why Uffizzi?

• 👩‍💻 Developer-friendly - The Uffizzi API provides a simplified interface to Kubernetes, allowing you to define your application with Docker Compose.

• 🪶 Lightweight - Uffizzi test environments are isolated namespaces within a single cluster. This level of abstraction helps reduce a team's infrastructure footprint and associated overhead.

• 🔁 Event-driven - Designed to integrate with any CI/CD system, Uffizzi environments are created, updated, or deleted via triggering events, such as pull requests or new release tags. Uffizzi generates a secure HTTPS URL for each environment, which is continually refreshed in response to new events.

• 🧼 Clean - The ephemeral nature of Uffizzi test environments means your team can test new features or release candidates in clean, parallel environments before merging or promoting to production.

Project roadmap

See our high-level project roadmap, including already delivered milestones.

Getting started

The easiest way to get started with Uffizzi is via the managed API service provided by Uffizzi Cloud, as describe in the quickstart guide. This option is free for small teams and is recommended for those who are new to Uffizzi. Alternatively, you can get started creating on-demand test environments on your own cluster by following the self-hosted installation guide.

Documentation

• Main documentation
• Docker Compose for Uffizzi

Community

• Slack channel - Get support or discuss the project
• Subscribe to our newsletter - Receive monthly updates about new features and special events
• Contributing to Uffizzi - Start here if you want to contribute
• FAQ - Frequently Asked Questions
• Code of Conduct - Let's keep it professional
• Engineering Blog - Lessons learned and best practices from Uffizzi maintainers
• Give us a star ⭐️ - If you are using Uffizzi or just think it's an interesting project, star this repo! This helps others find out about our project.

License

This library is licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0

Security

If you discover a security related issues, please do not create a public github issue. Notify the Uffizzi team privately by sending an email to [email protected].