Welcome to the StarlingX Documentation

StarlingX is a fully integrated edge cloud software stack that provides everything needed to deploy an edge cloud on one, two, or up to 100 servers.

The most recent supported release of StarlingX is StarlingX R5.0.

• See the Release Notes.

• Download the R5.0 StarlingX ISO image from the CENGN StarlingX mirror.

For more information about the StarlingX project, refer to the StarlingX wiki.

Note

Community contributions to the documentation are welcome! If you see an empty topic and want to contribute, refer to the linked story in the topic for details.

See our Contributor guide for more information.

Introduction

To get started fast with StarlingX, try the Virtual All-in-one Simplex installation, which requires a minimum of hardware and configuration.

Learn more about StarlingX:

• Introduction
  • Functional Overview
  • Deployment Configurations Overview
  • Deployment Options
  • Basic Terminology
  • Consuming StarlingX
  • StarlingX Project Overview (PDF)
  • Projects

Deployment configurations

• Deployment Configurations
  • Deployment Options
  • Common Components
  • All-in-one (AIO) Simplex Configuration
  • All-in-one (AIO) Duplex Configuration
  • Standard Configuration with Controller Storage
  • Standard Configuration with Dedicated Storage
  • Worker Function Performance Profiles
  • Deploy Edgeworker Nodes

Planning

• Planning
  • Kubernetes
  • OpenStack

Installation guides

• Installation Guides
  • Upcoming release (latest)
  • Supported release
  • Archived releases

Security

• Security
  • Kubernetes
  • OpenStack

System configuration

• System Configuration
  • StarlingX Kubernetes
  • StarlingX OpenStack

Data networks

• Data Networks
  • Kubernetes
  • OpenStack

Node management

• Node Management
  • Kubernetes
  • OpenStack

Storage

• Storage
  • Kubernetes
  • OpenStack

Fault management

• Fault Management
  • StarlingX Kubernetes
  • StarlingX OpenStack

Backup and restore

• Backup and Restore
  • Kubernetes
  • OpenStack

Updates

• Updates and Upgrades
  • Kubernetes
  • Openstack

Admin tasks

• Admin Tasks
  • Kubernetes
  • StarlingX OpenStack

User tasks

• User Tasks
  • Kubernetes

Guest integration

• Guest Integration
  • Kubernetes container integration
  • OpenStack VNF integration

Reference

• REST API Reference
• CLI Reference
  • dcmanager
  • fm
  • sw-manager
  • system

Distributed Cloud

• Distributed Cloud
  • Introduction
  • Installation
  • Operation
  • Manage Subcloud Groups
  • Update (Patch) management
  • FPGA device image update management
  • Kubernetes Version Upgrade Distributed Cloud Orchestration
  • Upgrade management
  • Appendix

Deprecated guides

The guides listed here have been replaced by new guides that provide more details.

Configuration

• Configuration
  • General Configuration
  • Kubernetes Configuration
  • OpenStack Configuration

Operation guides

• Operation Guides
  • General Operation
  • Kubernetes Operation
  • OpenStack Operation

General information

• Contributor Guides
• Release Notes
• Developer Resources
• Project Specifications

Governance

StarlingX is a top-level OpenStack Foundation pilot project that is governed by two separate bodies: The OpenStack Foundation Board of Directors and the StarlingX Technical Steering Committee.

See StarlingX Governance for additional information about StarlingX project governance.