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

readme updates with new logo #150

Merged
merged 1 commit into from
Oct 29, 2024
Merged
Show file tree
Hide file tree
Changes from all 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
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ template: docs.html

![build status](https://github.com/acrlabs/simkube/actions/workflows/verify.yml/badge.svg)

# simkube
<img src="docs/images/logo_with_name.png" width=400 /><img src="docs/images/mascot-2024.png" height=200 align="right"/>

A collection of tools for simulating Kubernetes scheduling and autoscaling behaviour
A record-and-replay simulation environment for the Kubernetes control plane based on [KWOK](https://kwok.sigs.k8s.io).

## Overview

Expand All @@ -22,14 +22,6 @@ This package provides the following components:
- `sk-tracer`: a watcher for Kubernetes pod creation and deletion events, saves these events in a replayable trace
format.

### Architecture Diagram

![architecture diagram of SimKube](docs/images/sk-overview.png)

### Demo

[![Watch the video](https://img.youtube.com/vi/Q1XpH1H4It8/hqdefault.jpg)](https://www.youtube.com/watch?v=Q1XpH1H4It8)

## Installation

1. To install `sk-tracer` in your prod cluster: `kubectl apply -k k8s/kustomize/prod`
Expand All @@ -47,6 +39,14 @@ Computing's website. Here are some quick links to select topics:
- [Component Reference](http://appliedcomputing.io/simkube/docs/components/skctl/)
- [Developing SimKube](http://appliedcomputing.io/simkube/docs/dev/contributing/)

### Architecture Diagram

![architecture diagram of SimKube](docs/images/sk-overview.png)

### Demo

[![Watch the video](https://img.youtube.com/vi/Q1XpH1H4It8/hqdefault.jpg)](https://www.youtube.com/watch?v=Q1XpH1H4It8)

## Community

We have a [channel](https://kubernetes.slack.com/archives/C07LTUB823Z) on the Kubernetes Slack instance! Come chat with
Expand Down
Binary file added docs/images/logo_with_name.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/mascot-2024.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading