docs/doc/source/index.rst

4.5 KiB
Executable File

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 is StarlingX R9.0.

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 </contributor/index> for more information.

Introduction

To get started fast with StarlingX, try the Virtual All-in-one Simplex Installation <virtual-aio-simplex>, which requires a minimum of hardware and configuration.

Learn more about StarlingX:

introduction/index-intro-27197f27ad41

Deployment configurations

deploy/index-deploy-da06a98b83b1

Planning

planning/index-planning-332af0718d15

Installation guides

deploy_install_guides/index-install-e083ca818006

Security

security/index-security-84d0d8aa401b

System configuration

system_configuration/index-sysconf-d511820651f0

Data networks

datanet/index-datanet-e316bf6c2f6a

Node management

node_management/index-node-mgmt-cd0f9d8eaee6

Storage

storage/index-storage-6cd708f1ada9

Fault management

fault-mgmt/index-fault-98d5f50a9b8c

Backup and restore

backup/index-backup-1b466179efc3

Updates

updates/index-updates-e3b970bb69ce

KubeVirt

kube-virt/index-kubevirt-f1bfd2a21152

Admin tasks

admintasks/index-admintasks-768a6e9aaeff

User tasks

usertasks/index-usertasks-b18b379ab832

Guest integration

guest_integration/index-guest-ef8c9a20bf6c

Reference

api-ref/index cli_ref/index

Distributed Cloud

dist_cloud/index-dist-cloud-f5dbeb16b976

Sample Application Deployments

sample_apps/index-sample-apps-15fce86ad4bf

Deprecated guides

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

archive/index-documentation-archive-900988dce206

configuration/index

operations/index

General information

contributor/index releasenotes/index developer_resources/index Project Specifications <https://docs.starlingx.io/specs/>

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.