From 2f859de02110828e31cf0096fd384e73a324fd74 Mon Sep 17 00:00:00 2001 From: Laurent Luce Date: Mon, 21 Oct 2024 17:23:55 -0400 Subject: [PATCH] chore: Sunsetting (#285) --- .github/workflows/ci.yml | 62 ---------------------------------------- README.md | 18 ++---------- scripts/install_cli.sh | 11 ++++++- 3 files changed, 12 insertions(+), 79 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 0a7a73f9..7841df07 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -140,65 +140,3 @@ jobs: ln -s $path $binout ls -lah $binout [ -s $binout ] - - test_cli_install: - strategy: - matrix: - shell: [bash, fish, zsh] - runs-on: ubuntu-latest - steps: - - name: git checkout - uses: actions/checkout@v3 - - - name: Install ShellCheck and shells - run: | - sudo apt-get update - sudo apt-get install -y shellcheck fish zsh - - - name: Run ShellCheck - run: shellcheck ./scripts/install_cli.sh - - - name: Run install script with ${{ matrix.shell }} - run: | - if [ "${{ matrix.shell }}" = "fish" ]; then - fish -c 'set -gx SHELL (which fish); cat ./scripts/install_cli.sh | bash' - elif [ "${{ matrix.shell }}" = "zsh" ]; then - zsh -c 'export SHELL=$(which zsh); cat ./scripts/install_cli.sh | bash' - elif [ "${{ matrix.shell }}" = "bash" ]; then - bash -c 'export SHELL=$(which bash); cat ./scripts/install_cli.sh | bash' - else - echo "Unsupported shell: ${{ matrix.shell }}" - exit 1 - fi - - - name: Check if ~/.local/bin exists - run: | - if [ ! -d ~/.local/bin ]; then - echo "~/.local/bin directory was not created" - exit 1 - fi - - - name: Check if config was added - run: | - if [ "${{ matrix.shell }}" = "fish" ]; then - config_file="$HOME/.config/fish/config.fish" - elif [ "${{ matrix.shell }}" = "zsh" ]; then - config_file="$HOME/.zshrc" - else - config_file="$HOME/.bashrc" - fi - if ! grep -q "# Kardinal CLI config" "$config_file"; then - echo "CLI tool configuration was not added to $config_file" - cat "$config_file" - exit 1 - fi - - - name: Verify kardinal command - run: | - if [ "${{ matrix.shell }}" = "fish" ]; then - fish -c 'source ~/.config/fish/config.fish; if kardinal | grep -q "Kardinal CLI"; exit 0; else; exit 1; end' - elif [ "${{ matrix.shell }}" = "zsh" ]; then - zsh -c 'source ~/.zshrc; if kardinal | grep -q "Kardinal CLI"; then exit 0; else exit 1; fi' - else - bash -c 'source ~/.bashrc; if kardinal | grep -q "Kardinal CLI"; then exit 0; else exit 1; fi' - fi diff --git a/README.md b/README.md index b2263424..b5ac03f5 100644 --- a/README.md +++ b/README.md @@ -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). @@ -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** @@ -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 diff --git a/scripts/install_cli.sh b/scripts/install_cli.sh index 23bff480..601c6e8a 100644 --- a/scripts/install_cli.sh +++ b/scripts/install_cli.sh @@ -3,9 +3,15 @@ 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)" @@ -13,6 +19,9 @@ source <($BIN_FOLDER/$BINARY_NAME completion $PARENT_SHELL)" } # Rest of your script goes here + +not_active + REPO="kurtosis-tech/kardinal" BINARY_NAME="kardinal" OS=$(uname -s | tr '[:upper:]' '[:lower:]')