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 R4.0.

• See the Release Notes.

• Download the R4.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.

Get started

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:

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

Planning

• Planning
  • Kubernetes
  • OpenStack

Deployment guides

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

Installation guides

• Installation Guides
  • Supported release (R4.0)
  • Upcoming release (latest)
  • Archived releases

Configuration

• Configuration
  • General Configuration
  • Kubernetes Configuration
  • OpenStack Configuration

Data Network Configuration and Management Guides

• Data Networks
  • Kubernetes
  • OpenStack

Node Management

• Node Management
  • Kubernetes
  • OpenStack

Security

• Security
  • Kubernetes
  • OpenStack

System Configuration

• System Configuration
  • StarlingX Kubernetes
  • StarlingX OpenStack

Fault Management

• Fault Management
  • StarlingX Kubernetes
  • StarlingX OpenStack

Admin Tasks

• Administrator Tasks
  • StarlingX Kubernetes
  • Application management
  • Local Docker registry
  • Optimize application performance
  • CPU Manager for Kubernetes

User Tasks

• User Tasks
  • Kubernetes
  • OpenStack

VNF Integration

• OpenStack VNF Integration
  • Overview of VNF Integration
  • Bootstrap Data
  • Accelerated Virtual Interfaces

Storage

• Storage
  • Kubernetes
  • OpenStack

Operation guides

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

Backup and restore

• Backup and Restore
  • Kubernetes
  • OpenStack

Container integration

• Container Integration
  • PTP Notification

Distributed Cloud

• Distributed Cloud
  • Introduction
  • Installation
  • Operation
  • Appendix

Updates

• Updates
  • Openstack

Reference

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

General information

• Contributor Guides
• Release Notes
• Developer Resources

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.