Home - magicalbob/vagrant_kubernetes GitHub Wiki

Welcome to the Vagrant Kubernetes Wiki!

Welcome to the Vagrant Kubernetes project wiki! This project is designed to help you set up a Kubernetes cluster using Vagrant and Kubespray, providing a powerful environment for container orchestration and management.

Project Overview

The Vagrant Kubernetes project allows you to easily create a cluster of Vagrant virtual machines that run Kubernetes. By leveraging Kubespray, this project automates the installation and configuration process, making it simple and efficient.

Key Features

Getting Started

To get your cluster up and running, follow these key steps:

  1. Clone the Repository: Start by cloning this repository to your local machine.

    git clone https://github.com/magicalbob/vagrant_kubernetes.git
    cd vagrant_kubernetes
    
  2. Install Dependencies: Ensure you have Vagrant and VirtualBox or Parallels installed.

  3. Configure Parameters: Modify the config.json file to suit your needs, such as specifying the Kubernetes version or the number of control/worker nodes. Sample config.json:

{
  "kube_version": "v1.30.5",
  "control_nodes": 1,
  "worker_nodes": 1,
  "ram_size": 2048,
  "cpu_count" : 2,
  "pub_net": "192.168.56",
  "node_name": "knode",
  "kubespray_version": "v2.26.0"
}
  1. Run the Setup Script: Execute the setup script to create and provision your cluster:

    # create cluster
    ./run_vagrant_kubernetes.sh UP_ONLY
    # provision cluster
    ./run_vagrant_kubernetes.sh SKIP_UP
    
  2. Access Your Cluster: Once the setup is complete, SSH into your control node:

    vagrant ssh node1
    
  3. Destroy the Cluster: When you're done, you can easily destroy the environment:

    vagrant destroy -f
    

Documentation and Commands

Refer to the main documentation found in the README.md file for detailed descriptions of available commands and features, including backup and recovery utilities, as well as advanced usage instructions.

Troubleshooting

If you encounter issues, please check the troubleshooting section in the README or consult the Kubespray documentation for common deployment errors and solutions.

Contributions

We welcome contributions! If you have ideas for improvements or want to report issues, please create an issue or submit a pull request.

Join the Community

Stay updated and connect with other users by participating in our discussions or by following us on GitHub.


Thank you for visiting the Vagrant Kubernetes wiki! We hope you find this tool helpful for your Kubernetes adventures. Happy kube-ing!