Skip to content

kubestellar/docs

KubeStellar Documentation

KubeStellar Logo

Multi-cluster Configuration Management for Edge, Multi-Cloud, and Hybrid Cloud
Official documentation source for the KubeStellar Website

First Timers Only Broken Links Crawler OpenSSF Best Practices Scorecard ArtifactHub Join Slack


About KubeStellar

KubeStellar is a CNCF Sandbox Project that enables seamless deployment and configuration of Kubernetes objects across multiple clusters — whether you're operating in edge, multi-cloud, or hybrid environments.

Key Capabilities

KubeStellar empowers you to:

  • Define binding policies between clusters and Kubernetes resources
  • Use familiar single-cluster tooling for multi-cluster operations
  • Improve compliance, resilience, availability, and developer productivity

Learn more at the official KubeStellar Website.


About This Repository

This repository powers the KubeStellar Documentation Site, serving as the canonical source for comprehensive project documentation including:

  • User and operator guides
  • Architecture overviews and technical references
  • Roadmaps and release notes
  • Contribution and governance documentation
  • Tutorials and practical examples

Our goal is to deliver well-organized, consistent, and comprehensive documentation that helps both newcomers and experienced contributors succeed with KubeStellar.


Quick Links


Local Development Setup

This documentation site is built with Next.js. Follow these steps to run it locally:

Prerequisites

Ensure you have Node.js v18+ installed:

node --version

Installation & Development

  1. Install dependencies:

    npm install
    # or
    yarn
  2. Start development server:

    npm run dev

    Visit http://localhost:3000 in your browser. The server supports hot-reload for instant feedback.

  3. Build for production:

    npm run build
  4. Preview production build locally:

    npm start

Community & Communication

Join Our Community

Get instant access to our documents and meeting invites at kubestellar.io/joinus

Communication Channels

Meetings & Events

Resources & Collaboration

Follow Us


Contributing

We welcome contributions from everyone! Whether you're fixing a typo, improving documentation, or adding new content, your help makes a meaningful impact.

Get started:

  1. Review our Contributing Guidelines
  2. Join discussions on Slack or mailing lists
  3. Open issues or pull requests for improvements

We especially encourage first-time contributors and provide mentorship for those new to open source.


Project Status & Compliance

CLOMonitor

FOSSA License Scan


Contributors

Contributors


CNCF & Licensing

CNCF Logo

We are a proud Cloud Native Computing Foundation Sandbox Project.


Legal Notice: Kubernetes® and the Kubernetes logo are registered trademarks of The Linux Foundation®.
© 2022–2025 The KubeStellar Authors. All rights reserved.
Licensed under the Apache License 2.0.

About

new home for our documentation and supporting platform

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •