batch-simulator

README

batch-simulator

batch-simulator is a Golang CLI tool that simulates the lifecycle of Kubernetes API resources, such as Nodes, Pods, etc. using KWOK

References

• Kubernetes
• kind
• KWOK

Architecture

This simulator uses KWOK and Stages API to simulate the lifecycle of Kubernetes API resources, such as Nodes, Pods, etc.

Users define simulation parameters such as number of nodes, number of pods, frequency of pod creation, node creation, requests per iteration... The simulator then starts creating the Kubernetes resources and KWOK handles their lifecycle.

Installation

Run make build to build the binary. By default, the binary will be built in ./bin/sim.

Usage

Refer to docs/ folder for detailed command description or run any command with --help flag.

Example:

$ ./bin/sim --help

This command-line interface (CLI) tool facilitates the simulation of batch scheduling scenarios,
leveraging Kubernetes (k8s) and Kwok technologies.
It's designed for users who need to model and understand various batch processing workflows within a k8s environment.

Usage:
  sim [flags]
  sim [command]

Available Commands:
  check       Check are required components installed & configured
  clean       Clean deletes all resources (nodes, pods...) created by the simulator
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  install     Install required simulator components
  remove      Uninstall simulator components
  run         Run a simulation

Flags:
  -d, --debug     enable debug output
  -h, --help      help for sim
      --no-gui    disable printing graphical elements
  -s, --silent    disable internal logging
  -v, --verbose   enable verbose output

Use "sim [command] --help" for more information about a command.

1. Prepare a Kubernetes cluster (e.g. kind).
2. Run ./bin/sim install to install required simulator components.
3. Run ./bin/sim check to check if required components are installed & configured.
4. Run ./bin/sim run to run a simulation.
5. Run ./bin/sim clean to clean up all resources created by the simulator.

Development

Linting

Lint rules are defined in the .gomodguard.yml file and golangci-lint is used to enforce them.

Run make lint to run the linter or make lint-fix to run the linter and fix lint errors.

Testing

Run make test-unit to run unit tests and make test-integration to run integration tests, or run make test to run all tests.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT