-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4 from kurtosis-tech/gyani/readme-rewrite
- Loading branch information
Showing
1 changed file
with
56 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,62 @@ | ||
| [<img src="https://img.shields.io/badge/dockerhub-images-important.svg?logo=docker">](https://hub.docker.com/u/kurtosistech) | ||
| [](https://hub.docker.com/u/kurtosistech) | ||
|
|
||
| # Kardinal | ||
|
|
||
| ## Developing instructions | ||
|  | ||
|
|
||
| Kardinal is a 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 <service-name> <dev-image-tag> | ||
| ``` | ||
|
|
||
| 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. | ||
|
|
||
| ## Join the Beta Program | ||
|
|
||
| Our beta program for a select group of developers is coming soon! Be among the first to experience the future of software development: | ||
|
|
||
| - Email us at: [[email protected]](mailto:[email protected]) to learn more about joining the beta | ||
| - Get early access to Kardinal | ||
| - Provide valuable feedback to shape the future of the product | ||
|
|
||
| ## Try the Kardinal Playground | ||
|
|
||
| Can't wait to get started? Check out our proof of concept: | ||
|
|
||
| - Visit the [Kardinal playground](https://github.com/kurtosis-tech/kardinal-playground/) | ||
| - Experience a simple demonstration of how Kardinal can enhance your development workflow | ||
| - Get a taste of developing directly in production, risk-free | ||
|
|
||
| ## Get Support | ||
|
|
||
| Have questions or need assistance? We're here to help: | ||
|
|
||
| - Email us at: [[email protected]](mailto:[email protected]) | ||
| - Check out our documentation: [https://kardinal.dev/docs](https://kardinal.dev/docs) | ||
|
|
||
| --- | ||
|
|
||
| ## Development instructions | ||
|
|
||
| 1. Enter the dev shell and start the local cluster: | ||
|
|
||
|
|
||