Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Sunsetting #285

Merged
merged 4 commits into from
Oct 21, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 2 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

# Kardinal

## Disclaimer: This project is no longer maintained

## What is Kardinal?

Kardinal is an open-source framework for creating extremely lightweight ephemeral development environments within a shared Kubernetes cluster. Between dev environments, Kardinal shares every microservice or database that can be feasibly be shared, optimizing for cloud costs and fast spin-up/tear-down. To see how much you would save using Kardinal for your particular architecture, check out the [cost saving calculator](https://kardinal.dev/calculator).
Expand All @@ -20,12 +22,6 @@ In Kardinal, an environment is called a "[flow](https://kardinal.dev/docs/concep
- **Cost Savings**: Kardinal can help you save big by avoiding unnecessary resource duplication. It’s a game-changer for teams looking to cut costs. Check out [this calculator](https://kardinal.dev/calculator) to run your own calculations.
- **Open Source**: Kardinal is open source, so use it however fits best within your workflows

### Want a demo?

Sign-up for a free demo of Kardinal below 👇

[![Get a demo](https://img.shields.io/badge/Get_a_demo-FC7444?style=for-the-badge)](https://calendly.com/d/cqhd-tgj-vmc/45-minute-meeting?month=2024-09)

## Installation

### **Step 1: Install Kardinal**
Expand All @@ -50,16 +46,6 @@ kardinal manager deploy kloud-kardinal-kontrol

Once installed check out our docs on [creating your first flow](https://kardinal.dev/docs/getting-started/own-app).

## Try it out in a Playground

We have a playground that runs in Github Codespaces so you can try Kardinal right now without installing anything. Click below to open a Codespace with the playground. The default settings for the Codespace will work just fine.

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=818205437&skip_quickstart=true&machine=standardLinux32gb&devcontainer_path=.devcontainer%2Fdevcontainer.json)

> [!WARNING]
> Please keep in mind that Kardinal is still under active development
> and therefore full backward compatibility is not guaranteed before reaching v1.0.0.

## Quick start with a demo application

### Step 1: Deploy the demo app
Expand Down
11 changes: 10 additions & 1 deletion scripts/install_cli.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,25 @@ set -e

# Install Kardinal CLI - supports bash, zsh, fish and assumes you have curl procps installed

# Function to tell the user this project is no longer active
not_active() {
echo "The Kardinal project is no longer active"
exit 1
}

# Function to handle errors
handle_error() {
echo "Ops! Failed to setup integration with your shell. Please add the following lines to
echo "Oops! Failed to setup integration with your shell. Please add the following lines to
your shell configuration manually (changes may not be persistent)
export PATH=\$PATH:$BIN_FOLDER
source <($BIN_FOLDER/$BINARY_NAME completion $PARENT_SHELL)"
exit 1
}

# Rest of your script goes here

not_active

REPO="kurtosis-tech/kardinal"
BINARY_NAME="kardinal"
OS=$(uname -s | tr '[:upper:]' '[:lower:]')
Expand Down
Loading