Quick Installation Guide

Get KubeStellar up and running quickly with this streamlined installation guide. Follow the prerequisites and installation steps below.

Prerequisites

Install the required tools based on your use case

Core Prerequisites

Essential tools for using KubeStellar

Docker

v20.0.0+

Container runtime platform

Install:

bash
curl -fsSL https://get.docker.com -o get-docker.sh && sudo sh get-docker.sh

Verify:

bash
docker version --format "{{.Client.Version}}"

kubectl

v1.27.0+

Kubernetes command-line tool

Install:

bash
curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl" && chmod +x kubectl && sudo mv kubectl /usr/local/bin/

Verify:

bash
kubectl version --client

KubeFlex

v0.8.0+

Core component for multi-cluster management

Install:

bash
bash <(curl -s https://raw.githubusercontent.com/kubestellar/kubeflex/main/scripts/install-kubeflex.sh) --ensure-folder /usr/local/bin --strip-bin

Verify:

bash
kflex version

OCM CLI

v0.7.0+

Open Cluster Management command line interface

Install:

bash
bash <(curl -L https://raw.githubusercontent.com/open-cluster-management-io/clusteradm/main/install.sh) 0.10.1

Verify:

bash
clusteradm version

Helm

v3.0.0+

Package manager for Kubernetes

Install:

bash
curl https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | bash

Verify:

bash
helm version

Additional Prerequisites

Additional tools for running KubeStellar examples

kind

v0.20.0+

Kubernetes IN Docker - local Kubernetes cluster

Install:

bash
curl -Lo ./kind https://kind.sigs.k8s.io/dl/v0.20.0/kind-linux-amd64 && chmod +x ./kind && sudo mv ./kind /usr/local/bin/kind

Verify:

bash
kind version

k3d

v5.0.0+

Lightweight wrapper to run k3s in Docker

Install:

bash
curl -s https://raw.githubusercontent.com/k3d-io/k3d/main/install.sh | bash

Verify:

bash
k3d version

Argo CD CLI

v2.8.0+

GitOps continuous delivery tool for Kubernetes

Install:

bash
curl -sSL -o argocd-linux-amd64 https://github.com/argoproj/argo-cd/releases/latest/download/argocd-linux-amd64 && sudo install -m 555 argocd-linux-amd64 /usr/local/bin/argocd && rm argocd-linux-amd64

Verify:

bash
argocd version --client

Build Prerequisites

Tools required for building KubeStellar from source

Make

Latest

Build automation tool

Install:

bash
sudo apt-get update && sudo apt-get install -y build-essential

Verify:

bash
make --version

Go

v1.21.0+

Programming language for building KubeStellar

Install:

bash
curl -fsSL https://golang.org/dl/go1.21.6.linux-amd64.tar.gz | sudo tar -C /usr/local -xzf - && echo "export PATH=$PATH:/usr/local/go/bin" >> ~/.bashrc

Verify:

bash
go version

ko

v0.14.0+

Container image builder for Go applications

Install:

bash
go install github.com/google/ko@latest

Verify:

bash
ko version
View Detailed Installation Guides

Automated Check of Prerequisites

Use this script to automatically verify your system has all required tools

Run Prerequisites Check:

bash
curl -fsSL https://raw.githubusercontent.com/kubestellar/kubestellar/refs/heads/main/scripts/check_pre_req.sh | bash

About the Prerequisites Check Script

  • Self-contained script suitable for "curl-to-bash" usage
  • Checks for prerequisite presence in your $PATH using the which command
  • Provides version and path information for present prerequisites
  • Shows installation information for missing prerequisites

For Specific Releases

To check prerequisites for a particular KubeStellar release, use the script from that specific release instead of the main branch.

Tip: Run this check before proceeding with the installation to ensure your system is properly configured.

KubeStellar Installation

Choose your platform and run the installation script

Choose Your Platform:

Installation Script for kind:

bash
bash <(curl -s https://raw.githubusercontent.com/kubestellar/kubestellar/refs/tags/v0.27.2/scripts/create-kubestellar-demo-env.sh) --platform kind

Installation Process

  • Creates a local kind cluster
  • Installs KubeStellar core components
  • Sets up multi-cluster management capabilities
  • Configures workload distribution

Next Steps

  • Verify installation: kubectl get namespaces
  • Check KubeStellar status: kflex ctx
  • Explore the documentation for examples and advanced usage

Frequently Asked Questions

Common questions about KubeStellar installation and setup