StarlingX/Draft new wiki home page
Welcome to the StarlingX Project
This is a work-in-progress draft of a new look for the StarlingX wiki home page. Comments and feedback welcome! Please send them to (bruce dot e dot jones at intel dot com).
StarlingX is a fully integrated Edge Cloud software stack that includes everything that you need to deploy an Edge Cloud on one server, two servers, or up to 100 servers. It includes a host operating system, storage and networking components, and all of the Cloud Infrastructure needed to run Edge workloads in one easy to install package. All of the software has been tuned and optimized to meet Edge application requirements.
The stack pre-defines several different configurations that are designed to meet a variety of Edge Cloud deployment needs.
The StarlingX project's goal is to make the task of deploying and managing a high performance Edge Cloud as simple as possible.
You can find an overview of the StarlingX project's features here.
We are proud to be an OpenStack Foundation project!
- We support and adhere to the OpenStack community Code of Conduct
- We support and fully embrace the Four Opens
- Email: See http://lists.starlingx.io/ to subscribe to starlingx-announce or starlingx-discuss.
- IRC: #starlingX on freenode. See here for info on IRC account setup.
- Weekly calls: The list of meetings and dial-in information can be found on this page.
Users and Operators
This section of the wiki contains information aimed at users and operators of StarlingX.
The first StarlingX release is stx.1.0 (previously referred to as stx.2018.10) and it is available now. The second StarlingX release is stx.2.0 and is expected to be ready in August of 2019.
|Release||Description||Release Date||Prebuilt Image||Release Notes|
|Stx.1.0||StarlingX 1.0 is an OpenStack Pike platform that can manage application workloads in Virtual Machines or on Bare Metal. It is the most recent stable release of StarlingX.||October 2018||stx.1.0||stx.1.0 Release Notes|
|Stx.2.0||StarlingX 2.0 adds Container support with Kubernetes and runs OpenStack Stein within containers as an optional application. It has not yet been released.||August 2019||Not yet available||Not yet available|
|Stx.3.0||To be defined||November 2019||Not yet available||Not yet available|
|Latest nightly builds||These builds are a preview of our upcoming release and are under active development by the community.||Not applicable||Latest builds||Not applicable|
Documentation on how to use, build and install StarlingX is available on StarlingX documentation page. There is additional documentation available on this wiki:
- StarlingX Developer Guide
- StarlingX Installation Guide
- StarlingX VirtualBox Configuration Guide
- StarlingX Packet.com iPXE Installation
Features that are unique to a specific hardware platform are described here.
New Contributor Info
Your contribution is welcome - check the list of "help wanted" bugs which is an easy way to get started.
The StarlingX project uses Gerrit as its web-based code change management and review tool. The following links and queries are helpful for finding out what reviews are active in the project:
- Gerrit repositories maintain the StarlingX code, build instructions are in the StarlingX Developer Guide
- StarlingX Gerrit Projects and Open StarlingX project reviews
- StarlingX Gerrit Review Dashboard
- StarlingX Gerrit Review Dashboard by Status
We have a number of community calls each week. All calls are open for anyone to join. We try to schedule them in a time slot that works for Asia, US/Canada and Europe, which means they are usually in the morning US time.
- The list of meetings and dial-in information can be found on this page. New contributors should join the Wednesday weekly community call.
- We held a community meetup in January 2019. The agenda and meeting notes can be found here. A blog with pictures and a description of the meetup is here.
Here are the agendas and notes for our PTG meetings:
- StarlingX Denver 2018 PTG Agenda
- add link here to the Berlin PTG meeting minutes
- StarlingX Denver 2019 PTG Agenda and Notes
Planning & Process
- StarlingX Release Planning
- StarlingX Feature Development Process (needs update)
- StarlingX Defect Handling Process
Story and Bug Tracking
We are using the OpenStack Storyboard tool for tracking feature development activities. Each new Story should be marked with one or more Tags, and can optionally include one or more Prefixes in the title. See Tags and Prefixes for a description of how we use them.
The StarlingX Storyboard project group is here.
- To find newly created stories, use: this query
- To find stories with no sub-project tags, use this worklist
- To find all active stories, use this query
- To find all active stories for stx.2.0, use this query
- To find all active bugs for stx.2.0 in launchpad, use this query.
- Queries for the Sub-projects are defined on each Sub-project's page
StarlingX is both a development project and an integration project that combines new services with many other open source projects into an overall Edge Cloud software stack. We've broken the overall project into a set of separate projects to help keep things manageable. Notes from the F2F discussion on how to organize sub-teams are here
StarlingX main projects
Information on the main StarlingX development projects can be found on the wiki pages below:
|Config project||Fault project||HA project||GUI project|
|Metal project||NFV project||Update project||Distributed Cloud project|
StarlingX supporting projects
In addition to the main StarlingX development projects there are also additional projects to help us develop, maintain, document, build and release the overall StarlingX software stack.
|Docs and Infra project||Build project||Distro - OpenStack project||Distro - Non-OpenStack project|
|Test project||Security project||Containers project||Networking project|
|Releases project||MultiOS project|
StarlingX cross-project initiatives
There are several initiatives we are implementing that cross project boundaries:
|Python2 to Python3 Transition||Zuul Enablement and Coverage|
|Devstack Integration||StarlingX In-a-box|
- Create a Project Map graphic that captures all of this in a graphical way, similar to (or an extension of) the OpenStack project map.
These are references to general OpenStack material:
- Developer's Guide
- Project Creator's Guide
- The Contributors Guide (the older wiki page)
- Project Testing Interface
You can find more information about StarlingX governance and the TSC charter on the governance section of the documentation website.