Skip to content

acrlabs/simkube

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

b06c2dd · Dec 17, 2024
Sep 2, 2023
Dec 17, 2024
Oct 25, 2024
Oct 29, 2024
Nov 17, 2024
Oct 4, 2024
Nov 20, 2024
Nov 17, 2024
Nov 30, 2024
Nov 22, 2024
Nov 22, 2024
Nov 30, 2024
Nov 30, 2024
Nov 17, 2024
Nov 30, 2024
Jun 13, 2024
Oct 27, 2023
Oct 31, 2023
Aug 27, 2023
Oct 25, 2024
Jul 17, 2024
Jun 28, 2024
Nov 20, 2024
Aug 22, 2023
Nov 22, 2024
Nov 30, 2024
Nov 2, 2023
Nov 19, 2024
Nov 10, 2024
Nov 19, 2024

Repository files navigation

build status

A record-and-replay simulation environment for the Kubernetes control plane based on KWOK.

Overview

This package provides the following components:

  • skctl: a CLI utility for interacting with various other SimKube components
  • sk-ctrl: a Kubernetes Controller that watches for Simulation custom resources and runs a simulation based on the provided trace file.
  • sk-driver: the actual runner for a specific simulation, created as a Kubernetes Job by sk-ctrl
  • sk-tracer: a watcher for Kubernetes pod creation and deletion events, saves these events in a replayable trace format.

Installation

  1. To install sk-tracer in your prod cluster: kubectl apply -k k8s/kustomize/prod
  2. To install sk-ctrl in your simulation cluster: kubectl apply -k k8s/kustomize/sim
  3. To install skctl on your dev machine: cargo install skctl

Documentation

Full documentation for SimKube is available on Applied Computing's website. Here are some quick links to select topics:

Architecture Diagram

architecture diagram of SimKube

Community

We have a channel on the Kubernetes Slack instance! Come chat with us there. (You can sign up for the Kubernetes Slack instance for free)

Contributing

We welcome any and all contributions to the SimKube project! Please open a pull request.

If you have a feature request, please start a discussion. Members of the SimKube team will determine whether the feature should become planned work and how it will be prioritized.

If you've found a bug or are working on a planned improvement, please open an issue!

Code of Conduct

Applied Computing Research Labs has a strict code of conduct we expect all contributors to adhere to. Please read the full text so that you understand the expectations upon you as a contributor.

Copyright and Licensing

SimKube is licensed under the MIT License. Contributors to this project agree that they own the copyrights to all contributed material, and agree to license your contributions under the same terms. This is "inbound=outbound", and is the GitHub default.

Warning

Due to the uncertain nature of copyright and IP law, this repository does not accept contributions that have been all or partially generated with GitHub Copilot or other LLM-based code generation tools. Please disable any such tools before authoring changes to this project.

Related Reading