From 83a9de8a7c5dcd1d4322b41ba2c6417f7695228b Mon Sep 17 00:00:00 2001 From: Gyanendra Mishra Date: Thu, 27 Jun 2024 21:26:14 -0800 Subject: [PATCH] update the readme --- README.md | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dddef398..88ffd40a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,36 @@ -[](https://hub.docker.com/u/kurtosistech) +[![Docker Hub](https://img.shields.io/badge/dockerhub-images-important.svg?logo=docker)](https://hub.docker.com/u/kurtosistech) # Kardinal +![Kardi B](https://kardinal.dev/_next/static/media/kardinal-orange.65ea335b.png) + +Kardinal is a revolutionary traffic control and data isolation layer that enables engineers to safely do development and QA work directly in production. Say goodbye to maintaining multiple environments and hello to faster, more efficient development workflows. + +## What is Kardinal? + +Kardinal injects production data and service dependencies into your dev and test workflows safely and securely. Instead of spinning up ephemeral environments with mocked services, fake traffic, and fake data, developers using Kardinal can put their service directly into the production environment to see how it works... without risking the stability of that environment. + +Key features: +- Develop and test directly in production without risk +- Catch bugs that "only appear in prod" faster +- Stop maintaining multiple environments - do it all in production +- Lighter-weight dev workflow: reuse deployed services +- Implement isolated dev sandbox flows with maximum dev-prod parity +- Control data and traffic access throughout the software development lifecycle with maturity gates + +## How it Works + +Kardinal uses traffic flow controls and a data isolation layer to protect production while you're developing. It achieves this by rethinking the idea of isolated "environments" and replacing them with isolated traffic flows within the production environment. + +To use Kardinal, just drop the Kardinal sidecars into your production environment. Then run: + +```bash +# Create a dev flow +kardinal create-dev-flow +``` + +This creates a dev flow for your service with access to all the data, traffic, and services in your production environment, while ensuring complete isolation and safety. + ## Developing instructions 1. Enter the dev shell and start the local cluster: