diff --git a/README.md b/README.md index e7bfb2fa..17d66369 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,9 @@ template: docs.html ![build status](https://github.com/acrlabs/simkube/actions/workflows/verify.yml/badge.svg) -# simkube + -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 @@ -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` @@ -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 diff --git a/docs/images/logo_with_name.png b/docs/images/logo_with_name.png new file mode 100644 index 00000000..ccfc0643 Binary files /dev/null and b/docs/images/logo_with_name.png differ diff --git a/docs/images/mascot-2024.png b/docs/images/mascot-2024.png new file mode 100644 index 00000000..3336b24b Binary files /dev/null and b/docs/images/mascot-2024.png differ