Skip to content

Commit

Permalink
readme updates with new logo
Browse files Browse the repository at this point in the history
  • Loading branch information
drmorr0 committed Oct 29, 2024
1 parent 7695a09 commit a04da02
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
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=150 style="float: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.

0 comments on commit a04da02

Please sign in to comment.