Installation Guides

Installation and deployment guides for StarlingX are release-specific. Each guide provides instruction on a specific StarlingX configuration (e.g. All-in-one Simplex).

Upcoming release

The next release will be R9.0. Use the installation procedures in the Installation Guide

Current release

R8.0 is the current release of StarlingX.

Use the R8 Installation Guide

R6.0 release

• StarlingX R6.0 Installation
  • Install StarlingX Kubernetes in a virtual environment
    • Virtual All-in-one Simplex Installation R6.0
      • Overview
      • Installation
        • Prepare Host and Environment
          • Physical host requirements and setup
            • Hardware requirements
            • Software requirements
            • Host setup
          • Prepare virtual environment and servers
        • Install StarlingX Kubernetes on Virtual AIO-SX
          • Install software on controller-0
          • Bootstrap system on controller-0
          • Configure controller-0
            • Optionally, initialize a Ceph-based Persistent Storage Backend
            • OpenStack-specific host configuration
          • Unlock controller-0
          • Optionally, finish configuration of Ceph-based Persistent Storage Backend
          • Next steps
    • Virtual All-in-one Duplex Installation R6.0
      • Overview
      • Installation
        • Prepare Host and Environment
          • Physical host requirements and setup
            • Hardware requirements
            • Software requirements
            • Host setup
          • Prepare virtual environment and servers
        • Install StarlingX Kubernetes on Virtual AIO-DX
          • Install software on controller-0
          • Bootstrap system on controller-0
          • Configure controller-0
            • Optionally, initialize a Ceph-based Persistent Storage Backend
            • OpenStack-specific host configuration
          • Unlock controller-0
          • Install software on controller-1 node
          • Configure controller-1
            • Optionally, configure host-specific details for Ceph-based Persistent Storage Backend
            • OpenStack-specific host configuration
          • Unlock controller-1
          • Optionally, finish configuration of Ceph-based Persistent Storage Backend
          • Next steps
    • Virtual Standard with Controller Storage Installation R6.0
      • Overview
      • Installation
        • Prepare Host and Environment
          • Physical host requirements and setup
            • Hardware requirements
            • Software requirements
            • Host setup
          • Prepare virtual environment and servers
        • Install StarlingX Kubernetes on Virtual Standard with Controller Storage
          • Install software on controller-0
          • Bootstrap system on controller-0
          • Configure controller-0
            • OpenStack-specific host configuration
          • Unlock controller-0
          • Install software on controller-1 and worker nodes
          • Configure controller-1
            • OpenStack-specific host configuration
          • Unlock controller-1
          • Configure worker nodes
            • OpenStack-specific host configuration
          • Unlock worker nodes
          • Add Ceph OSDs to controllers
          • Next steps
    • Virtual Standard with Dedicated Storage Installation R6.0
      • Overview
      • Installation
        • Prepare Host and Environment
          • Physical host requirements and setup
            • Hardware requirements
            • Software requirements
            • Host setup
          • Prepare virtual environment and servers
        • Install StarlingX Kubernetes on Virtual Standard with Dedicated Storage
          • Install software on controller-0
          • Bootstrap system on controller-0
          • Configure controller-0
            • OpenStack-specific host configuration
          • Unlock controller-0
          • Install software on controller-1, storage nodes, and worker nodes
          • Configure controller-1
            • OpenStack-specific host configuration
          • Unlock controller-1
          • Configure storage nodes
          • Unlock storage nodes
          • Configure worker nodes
            • OpenStack-specific host configuration
          • Unlock worker nodes
          • Next steps
    • Virtual Standard with Rook Storage Installation R6.0
      • Overview
      • Installation
        • Prepare Host and Environment
          • Physical host requirements and setup
            • Hardware requirements
            • Software requirements
            • Host setup
          • Prepare virtual environment and servers
        • Install StarlingX Kubernetes on Virtual Standard with Rook Storage
          • Install software on controller-0
          • Bootstrap system on controller-0
          • Configure controller-0
            • OpenStack-specific host configuration
            • Rook-specific host configuration
          • Unlock controller-0
          • Install software on controller-1 and worker nodes
          • Configure controller-1
            • OpenStack-specific host configuration
            • Rook-specific host configuration
          • Unlock controller-1
          • Configure storage nodes
          • Unlock storage nodes
          • Configure worker nodes
            • OpenStack-specific host configuration
          • Unlock worker nodes
          • Install Rook application manifest and helm-charts
          • Next steps
  • Install StarlingX Kubernetes on bare metal
    • Overview
    • Installation
      • Hardware Requirements
        • Minimum hardware requirements
        • Prepare bare metal servers
      • Install Kubernetes Platform on All-in-one Simplex
        • Create a bootable USB
        • Install software on controller-0
        • Bootstrap system on controller-0
        • Configure controller-0
          • OpenStack-specific host configuration
          • Optionally Configure PCI-SRIOV Interfaces
          • If required, initialize a Ceph-based Persistent Storage Backend
        • Unlock controller-0
        • If using Rook container-based Ceph, finish configuring the ceph-rook Persistent Storage Backend
        • Next steps
    • Overview
    • Installation
      • Hardware Requirements
        • Minimum hardware requirements
        • Prepare bare metal servers
      • Install Kubernetes Platform on All-in-one Duplex
        • Create a bootable USB
        • Install software on controller-0
        • Bootstrap system on controller-0
        • Configure controller-0
          • OpenStack-specific host configuration
          • Optionally Configure PCI-SRIOV Interfaces
          • If required, initialize a Ceph-based Persistent Storage Backend
        • Unlock controller-0
        • Install software on controller-1 node
        • Configure controller-1
          • OpenStack-specific host configuration
          • Optionally Configure PCI-SRIOV Interfaces
          • If configuring a Ceph-based Persistent Storage Backend, configure host-specific details
        • Unlock controller-1
        • If using Rook container-based Ceph, finish configuring the ceph-rook Persistent Storage Backend
        • Next steps
      • Extend Capacity with Worker Nodes
        • Install software on worker nodes
        • Configure worker nodes
          • OpenStack-specific host configuration
          • Optionally Configure PCI-SRIOV Interfaces
        • Unlock worker nodes
    • Overview
    • Installation
      • Hardware Requirements
        • Minimum hardware requirements
        • Prepare bare metal servers
      • Install Kubernetes Platform on Standard with Controller Storage
        • Create bootable USB
        • Install software on controller-0
        • Bootstrap system on controller-0
        • Configure controller-0
          • OpenStack-specific host configuration
        • Unlock controller-0
        • Install software on controller-1 and worker nodes
        • Configure controller-1
          • OpenStack-specific host configuration
        • Unlock controller-1
        • Configure worker nodes
          • OpenStack-specific host configuration
          • Optionally Configure PCI-SRIOV Interfaces
        • Unlock worker nodes
        • If configuring Ceph Storage Backend, Add Ceph OSDs to controllers
        • Next steps
    • Bare metal Standard with Dedicated Storage Installation R6.0
      • Overview
      • Installation
        • Hardware Requirements
          • Minimum hardware requirements
          • Prepare bare metal servers
        • Install Kubernetes Platform on Standard with Dedicated Storage
          • Create bootable USB
          • Install software on controller-0
          • Bootstrap system on controller-0
          • Configure controller-0
            • OpenStack-specific host configuration
          • Unlock controller-0
          • Install software on controller-1, storage nodes, and worker nodes
          • Configure controller-1
            • OpenStack-specific host configuration
          • Unlock controller-1
          • Configure storage nodes
          • Unlock storage nodes
          • Configure worker nodes
            • OpenStack-specific host configuration
            • Optionally Configure PCI-SRIOV Interfaces
          • Unlock worker nodes
          • Next steps
    • Bare metal Standard with Ironic R6.0
      • Overview
      • Installation
        • Hardware Requirements
          • Minimum hardware requirements
          • BMC configuration of Ironic node(s)
        • Install Ironic on StarlingX R6.0
          • Enable Ironic service
            • Download Ironic deployment image
            • Configure Ironic network on deployed standard StarlingX
            • Generate user Helm overrides
            • Apply OpenStack application
          • Start an Ironic node
            • Create Glance images
            • Create an Ironic node
          • Deploy an instance on Ironic node
    • Bare metal Standard with Rook Storage Installation R6.0
      • Overview
      • Installation
        • Hardware Requirements
          • Minimum hardware requirements
          • Prepare bare metal servers
        • Install StarlingX Kubernetes on Bare Metal Standard with Rook Storage
          • Create bootable USB
          • Install software on controller-0
          • Bootstrap system on controller-0
          • Configure controller-0
            • OpenStack-specific host configuration
            • Rook-specific host configuration
          • Unlock controller-0
          • Install software on controller-1 and worker nodes
          • Configure controller-1
            • OpenStack-specific host configuration
            • Rook-specific host configuration
          • Unlock controller-1
          • Configure worker nodes
            • OpenStack-specific host configuration
          • Unlock worker nodes
          • Configure storage nodes
          • Unlock storage nodes
          • Install Rook application manifest and helm-charts
          • Next steps
    • Appendixes
      • Use a private Docker registry
        • Bootstrapping from a Private Docker Registry
      • Set up a Simple DNS Server in Lab
        • Set up a Simple DNS Server in the Lab
      • Install controller-0 from a PXE boot server
        • Configure a PXE Boot Server
        • Access PXE Boot Server Files for a Custom Configuration
      • Add and reinstall a host
        • Add Hosts Using the Command Line
        • Delete Hosts Using the Command Line
        • Add hosts in bulk
          • Add Hosts in Bulk
          • Bulk Host XML File Format
        • Reinstall a system or a host
          • Reinstall a System or a Host
          • Reinstall a System Using an Exported Host Configuration File
          • Export Host Configurations
  • Install StarlingX Distributed Cloud on bare metal
    • Distributed Cloud Installation R6.0
      • Overview
      • Distributed cloud architecture
      • Network requirements
      • Install and provision the central cloud
      • Install a subcloud
  • Access Kubernetes
    • Access StarlingX Kubernetes R6.0
      • Local CLIs
        • StarlingX system and host management commands
        • StarlingX fault management commands
        • Kubernetes commands
      • Remote CLIs
      • GUI
        • StarlingX Horizon GUI
        • Kubernetes dashboard
      • REST APIs
  • Access StarlingX OpenStack
    • StarlingX OpenStack
      • Install StarlingX OpenStack
        • Install application manifest and helm-charts
        • Next steps
      • Access StarlingX OpenStack
        • Local CLI
          • OpenStack CLI commands
        • Configure Helm endpoint domain
        • Configure HTTPS Certificate
        • Remote CLI
        • GUI
        • REST APIs
          • Public endpoints
          • Get a token
          • List Nova flavors
      • Uninstall OpenStack
        • Remove all OpenStack resources
        • Bring down OpenStack services
        • Delete OpenStack application definition
      • Hybrid Cluster
        • Hybrid Cluster
          • Limitations
        • Convert Worker Nodes

Supported releases

To access other supported releases, use the VERSION menu above.

Archived releases

To view the archived installation guides, see Installation guides for R5.0 and older releases.