Skip to content

Striveworks/stampede

Repository files navigation

Striveworks MIT License


Logo

Stampede

Bootstrap kubernetes clusters
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact

About The Project

Stampede is meant to make bootstrapping kubernetes clusters seamless. It uses a simple election protocol to elect a leader and then followers will follow. The leader bootstraps the cluster and deals out join tokens to any followers. All communication is handled via a specified multicast channel.

This project is inspired by Chic-fil-A's Highlander

Built With

Supported Kubernetes distributions

  • MicroK8s
  • Kubeadm
  • K3s
  • RKE

Getting Started

This can be run on any Ubuntu distribution. The install script will create systemd service and run it. Optionally, there is a Vagrant setup that can be used to spin up 3 VMs and bootstrap them into a kubernetes cluster.

Prerequisites

Currently, this project only offers support for Ubuntu distributions

Installation

  1. make install-microk8s or make install-kubeadm

Testing

  1. make test

Generating documentation

  1. make docs

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Striveworks