KubeStellar Documentation

Multi-cluster Configuration Management for Edge, Multi-Cloud, and Hybrid Cloud

Official documentation repository for KubeStellar, a CNCF Sandbox Project enabling seamless multi-cluster configuration management for edge, multi-cloud and hybrid cloud environments.

 

Preview of KubeStellar Docs Website

Visit our website: http://prod.previews.kubestellar.io/en

Website preview for a PR ###: PR-###.previews.kubestellar.io/en

Overview

KubeStellar simplifies Kubernetes operations across distributed infrastructure by providing powerful multi-cluster configuration management capabilities. This repository serves as the canonical source for all KubeStellar documentation, powering the official documentation website at kubestellar.io.

Key Features

• Flexible Binding Policies — Define sophisticated relationships between clusters and Kubernetes resources
• Familiar Tooling — Leverage existing single-cluster tools and workflows for multi-cluster operations
• Enhanced Operations — Improve compliance, resilience, availability, and developer productivity across your infrastructure

Documentation Content

This repository includes comprehensive documentation such as:

• Getting Started Guides — Quick start workflows and installation instructions
• User & Operator Guides — Detailed operational documentation
• Architecture & Technical References — In-depth design specifications
• API Documentation — Complete API reference materials
• Roadmaps & Release Notes — Project planning and version history
• Contribution Guidelines — Resources for contributors and maintainers
• Real-World Examples — Practical use cases and hands-on tutorials

Local Development

This documentation site is built with Next.js, providing a modern, performant documentation experience.

Prerequisites

• Node.js v18.0.0 or higher (Download)
• npm or yarn package manager

Verify your Node.js installation:

node --version

Setup Instructions

1. Clone the repository:

   git clone https://github.com/kubestellar/docs.git
   cd docs

2. Install dependencies:

   npm install
   # or
   yarn install

3. Start the development server:

   npm run dev
   # or
   yarn dev

   The site will be available at http://localhost:3000 with hot-reload enabled for instant feedback.

4. Build for production:

   npm run build
   # or
   yarn build

5. Preview the production build:

   npm start
   # or
   yarn start

Community & Support

We welcome contributions and engagement from the community. Here's how to get involved:

Communication Channels

• Slack: Join #kubestellar-dev in the CNCF Slack Workspace
• Mailing Lists:
  • kubestellar-dev — Development discussions
  • kubestellar-users — User community discussions
• Community Meetings: Subscribe to our community calendar
  • Automatically subscribed via the kubestellar-dev mailing list
• Meeting Recordings: Available on YouTube
• Meeting Notes: View upcoming and past agendas

Additional Resources

• Shared Documents: Access our Google Drive for design docs and collaborative materials
  • Available to kubestellar-dev mailing list members
• Blog: Read our latest updates on Medium
• LinkedIn: Follow #kubestellar for news and updates

Contributing

We welcome contributions of all kinds — from documentation improvements to code contributions. Please review our Contributing Guide to get started.

Areas for Contribution

• Documentation improvements and corrections
• Tutorial and example development
• Translation and localization
• Code contributions to the core project
• Community support and engagement

Contributors

CNCF Sandbox Project

KubeStellar is a Cloud Native Computing Foundation Sandbox project, part of the broader cloud native ecosystem working to make cloud native computing universal and sustainable.

---