StarlingX/Archived wiki home page

Welcome to the StarlingX Project
'''This is an archived version of an older StarlingX wiki page. It's here for historical reasons and to ensure we don't loose any content.'''

See the main StarlingX web site for current information about the project and the StarlingX Documentation site for reference documentation and guides.

StarlingX is a fully featured and high performance Edge Cloud software stack that is based on the Wind River® Titanium Cloud R5 product. Intel and Wind River have jointly open sourced this software and we invite you to download, build, install, and run it.

Wind River Titanium Cloud was originally built on open source components, that were then extended and hardened to meet critical infrastructure requirements, including: high availability, fault management, and performance management. This software provides numerous features and capabilities to enable 24/7 operation of mission critical applications.

You can find an overview of the StarlingX project's features here.

The StarlingX project opens all of these enhancements to the open source community. Please join us as we build the infrastructure stack for Edge Computing.

{| style="border-collapse: separate; border-spacing: 25px;"
 * style="vertical-align:top; width:50%;" |

Releases
The first StarlingX release is stx.1.0 (previously referred to as stx.2018.10) and it is available now!
 * How to get the code (placeholder)
 * You can find a pre-build image for the October 2018 release here
 * StarlingX Release Notes (stx.2018.10)
 * Latest builds
 * The latest builds are a easy way to get started and evaluate StarlingX - these builds are provided for evaluation purposes by the community.

Documentation
These two documents will help get you started building, installing, and validating your installation of StarlingX:
 * StarlingX Developer Guide
 * StarlingX Installation Guide
 * StarlingX VirtualBox Configuration Guide
 * StarlingX Packet.com iPXE Installation

Contributing
Your contribution is welcome - check the list of "help wanted" bugs.

Code
The StarlingX project uses Gerrit as its web-based code change management and review tool.
 * Gerrit repositories maintain the StarlingX code, build instructions are in the StarlingX Developer Guide
 * StarlingX Gerrit Projects and Open StarlingX project reviews
 * [https://review.openstack.org/#/dashboard/?foreach=(project:openstack/stx-clients%20OR%20project:openstack/stx-config%20OR%20project:openstack/stx-distcloud%20OR%20project:openstack/stx-distcloud-client%20OR%20project:openstack/stx-fault%20OR%20project:openstack/stx-gui%20OR%20project:openstack/stx-ha%20OR%20project:openstack/stx-integ%20OR%20project:openstack/stx-manifest%20OR%20project:openstack/stx-metal%20OR%20project:openstack/stx-nfv%20OR%20project:openstack/stx-root%20OR%20project:openstack/stx-tools%20OR%20project:openstack/stx-update%20OR%20project:openstack/stx-upstream)%20status:open%20NOT%20owner:self%20NOT%20label:Workflow%3C=-1%20label:Verified%3E=1,zuul%20NOT%20reviewedby:self&title=StarlingX%20Review%20Inbox&Needs%20final%20%202=label:Code-Review%3E=2%20limit:50%20NOT%20label:Code-Review%3C=-1,self&Passed%20Zuul,%20No%20Negative%20Feedback%20(Small%20Fixes)=NOT%20label:Code-Review%3E=2%20NOT%20label:Code-Review%3C=-1,starlingx-core%20delta:%3C=10&Passed%20Zuul,%20No%20Negative%20Feedback=NOT%20label:Code-Review%3E=2%20NOT%20label:Code-Review%3C=-1,starlingx-core%20delta:%3E10&Needs%20Feedback%20(Changes%20older%20than%205%20days%20that%20have%20not%20been%20reviewed%20by%20anyone)=NOT%20label:Code-Review%3C=-1%20NOT%20label:Code-Review%3E=1%20age:5d&You%20are%20a%20reviewer,%20but%20haven't%20voted%20in%20the%20current%20revision=NOT%20label:Code-Review%3C=-1,self%20NOT%20label:Code-Review%3E=1,self%20reviewer:self&Wayward%20Changes%20(Changes%20with%20no%20code%20review%20in%20the%20last%202days)=NOT%20is:reviewed%20age:2d StarlingX Gerrit Review Dashboard]
 * [https://review.openstack.org/#/dashboard/?foreach=%28project%3Aopenstack%2Fstx-clients+OR+project%3Aopenstack%2Fstx-config+OR+project%3Aopenstack%2Fstx-distcloud+OR+project%3Aopenstack%2Fstx-distcloud-client+OR+project%3Aopenstack%2Fstx-fault+OR+project%3Aopenstack%2Fstx-gui+OR+project%3Aopenstack%2Fstx-ha+OR+project%3Aopenstack%2Fstx-integ+OR+project%3Aopenstack%2Fstx-manifest+OR+project%3Aopenstack%2Fstx-metal+OR+project%3Aopenstack%2Fstx-nfv+OR+project%3Aopenstack%2Fstx-root+OR+project%3Aopenstack%2Fstx-tools+OR+project%3Aopenstack%2Fstx-update+OR+project%3Aopenstack%2Fstx-upstream%29+status%3Aopen+NOT+owner%3Aself+NOT+label%3AWorkflow%3C%3D-1+label%3AVerified%3E%3D1%2Czuul+NOT+reviewedby%3Aself&title=StarlingX+Review+Inbox&Needs+final+%2B2=label%3ACode-Review%3E%3D2+limit%3A50+NOT+label%3ACode-Review%3C%3D-1%2Cself&Passed+Zuul%2C+No+Negative+Feedback+%28Small+Fixes%29=NOT+label%3ACode-Review%3E%3D2+NOT+label%3ACode-Review%3C%3D-1%2Cstarlingx-core+delta%3A%3C%3D10&Passed+Zuul%2C+No+Negative+Feedback=NOT+label%3ACode-Review%3E%3D2+NOT+label%3ACode-Review%3C%3D-1%2Cstarlingx-core+delta%3A%3E10&Needs+Feedback+%28Changes+older+than+5+days+that+have+not+been+reviewed+by+anyone%29=NOT+label%3ACode-Review%3C%3D-1+NOT+label%3ACode-Review%3E%3D1+age%3A5d&You+are+a+reviewer%2C+but+haven't+voted+in+the+current+revision=NOT+label%3ACode-Review%3C%3D-1%2Cself+NOT+label%3ACode-Review%3E%3D1%2Cself+reviewer%3Aself&Wayward+Changes+%28Changes+with+no+code+review+in+the+last+2days%29=NOT+is%3Areviewed+age%3A2d StarlingX Gerrit Review Dashboard by Status]


 * Code Submission Guidelines
 * StarlingX API Contributor Guide

Planning & Process

 * StarlingX Release Planning
 * StarlingX Feature Development Process (in review)
 * StarlingX Defect Handling Process

Story and Bug Tracking
We are using the OpenStack Storyboard tool for tracking feature development activities. Each new Story shall 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. IMPORTANT: If you create a new story, please mark it with the tag "stx.new" so we can find it, review it and assign it to the right team/release.

We are using Launchpad for tracking bugs. IMPORTANT: If you create a new bug, please use the StarlingX Bug Template.

Sample queries:
 * 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

OpenStack Documentation
These are references to general OpenStack material:


 * Developer's Guide
 * Project Creator's Guide
 * The Contributors Guide  (the older wiki page)
 * Project Testing Interface

Governance
You can find more information about StarlingX governance and the TSC charter on the governance section of the documentation website.

For information about the upcoming StarlingX TSC election and the election process itself please see the election document page.

For early versions and evolution of the documents see here and on this wiki page.

Special Interest Groups (SIGs)
There are several SIGs in the StarlingX community:
 * Packet SIG - for community members interested in working with the hardware provided by packet.com
 * First Contact SIG - for community members interested in helping new community members
 * style="vertical-align:top; width:50%;" |

Culture
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
 * Contribution Guidelines
 * The mailing lists are a great place to engage the community at http://lists.starlingx.io/. There are two lists, starlingx-announce and starlingx-discuss.  Please subscribe.
 * We have the #starlingX IRC channel set up on freenode. Refer to https://docs.openstack.org/infra/manual/developers.html regarding how to have your IRC account setup.

Weekly calls

 * The list of meetings and dial-in information can be found on this page.
 * 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.

PTG Meetings
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

Status and Planning
This section is under construction.

Overall project planning pages

 * Project Priorities
 * Release Plan
 * Project Plans

StarlingX Projects
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:

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.

StarlingX cross-project initiatives
There are several initiatives we are implementing that cross project boundaries: ToDo:
 * Create a Project Map graphic that captures all of this in a graphical way, similar to (or an extension of) the OpenStack project map.

Upstream Status
The StarlingX code base contains a number of out-of-tree patches against other open source components. One of our highest priorities is to contribute those changes to their upstream communities.

We are tracking the progress of resolving the OpenStack patches in an shared Google document. If you need write access to the document, please request it through the Google sheet directly.

We are tracking the Non-OpenStack patches in a a different shared Google document. Please send an email to [mailto:bruce.e.jones@intel.com BruceJ @ Intel] with your gmail.com email address for access to the document.

Platform features
Features that are unique to a specific hardware platform are described here.

Draft: BruceJ's re-write of the wiki
Bruce's draft new front page of the wiki: draft new wiki home page

The previous wiki home page can be found here