Skip to content

KubeStellar User Guide#

This user guide is an ongoing project. If you find errors, please point them out in our Slack channel or open an issue in our github repository!

Basics of KubeStellar Usage#

KubeStellar operates with a multiple-cluster architecture:

  • One for the KubeStellar core components
  • One or more Workload Execution Clusters (WECs) to which the core deploys workloads

General Flow of Initial Setup#

The general flow for setting up and using KubeStellar is in 3 steps:

  1. Set Up the KubeStellar core components
  2. Set Up and Register the Workload Execution Clusters
  3. Define workloads and the bindings between workloads and the WECs This will deploy the workloads to the WECs

After Deployment of Workloads#

Once workload(s) are deployed, KubeStellar lets you

  • Confirm/monitor status of workload(s)
  • Modify workloads as necessary (update, delete, or redeploy workloads) on WECs by redefining the workloads and/or bindings.

Getting Started: Try the "Common Setup"#

Given the multitude of infrastructure configurations possible, the details of any particular installation can obviously vary.

We have developed a common setup for our examples which you may find a useful starting point. You can use a helm chart to automate the process of setting up the core components, or you may work through the steps individually to more completely customize the installation.