Jump to: navigation, search

Difference between revisions of "StarlingX"

(Code)
(Meetings)
(28 intermediate revisions by 7 users not shown)
Line 18: Line 18:
  
 
== Releases ==
 
== Releases ==
The first StarlingX release will be stx.2018.10 and will be available in late October.
+
The first StarlingX release is stx.2018.10 and it is available now!
 
* How to get the code (placeholder)
 
* How to get the code (placeholder)
* [[StarlingX/stx.2018.10 Release Notes|stx.2018.10 Release Notes]]
+
* You can find a pre-build image for the October 2018 release [http://mirror.starlingx.cengn.ca/mirror/starlingx/centos/2018.10/20181110/outputs/iso/ here]
 +
* [http://mirror.starlingx.cengn.ca/mirror/starlingx/master/centos/ Latest builds]
 +
* [https://docs.starlingx.io/releasenotes/index.html StarlingX Release Notes (stx.2018.10)]
  
 
== Documentation ==
 
== Documentation ==
These three documents will help get you started building, installing, and validating your installation of StarlingX:
+
These two documents will help get you started building, installing, and validating your installation of StarlingX:
* [[StarlingX/Developer Guide|Developer Guide]]
+
* [https://docs.starlingx.io/developer_guide/index.html StarlingX Developer Guide]
* [[StarlingX/Installation Guide|Installation Guide Virtual Environment]]
+
* [https://docs.starlingx.io/installation_guide/index.html StarlingX Installation Guide]
* [[StarlingX/Testing Guide|Testing Guide]]
 
  
 
== Code ==
 
== Code ==
 
The StarlingX project uses Gerrit as its web-based code change management and review tool.
 
The StarlingX project uses Gerrit as its web-based code change management and review tool.
* [https://git.starlingx.io/cgit Gerrit repositories] maintain the StarlingX code, build instructions are in the [[StarlingX/Developer Guide]]
+
* [https://git.starlingx.io/cgit Gerrit repositories] maintain the StarlingX code, build instructions are in the [https://docs.starlingx.io/developer_guide/index.html StarlingX Developer Guide]
 
* [https://review.openstack.org/#/admin/projects/?filter=stx StarlingX Gerrit Projects] and [https://review.openstack.org/#/q/status:open+AND+project:%255Eopenstack/stx-%2540 Open StarlingX project reviews]
 
* [https://review.openstack.org/#/admin/projects/?filter=stx StarlingX Gerrit Projects] and [https://review.openstack.org/#/q/status:open+AND+project:%255Eopenstack/stx-%2540 Open StarlingX project reviews]
* [https://review.openstack.org/#/dashboard/?foreach=(project:openstack/stx-clients%20OR%20project:openstack/stx-config%20OR%20project:openstack/stx-fault%20OR%20project:openstack/stx-gplv2%20OR%20project:openstack/stx-gplv3%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-tis-repo%20OR%20project:openstack/stx-tools%20OR%20project:openstack/stx-update%20OR%20project:openstack/stx-upstream%20OR%20project:openstack/stx-utils)%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=(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-fault+OR+project%3Aopenstack%2Fstx-gplv2+OR+project%3Aopenstack%2Fstx-gplv3+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-tis-repo+OR+project%3Aopenstack%2Fstx-tools+OR+project%3Aopenstack%2Fstx-update+OR+project%3Aopenstack%2Fstx-upstream+OR+project%3Aopenstack%2Fstx-utils%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]
+
* [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]
  
 
* [[StarlingX/CodeSubmissionGuidelines|Code Submission Guidelines]]
 
* [[StarlingX/CodeSubmissionGuidelines|Code Submission Guidelines]]
 +
* [https://docs.starlingx.io/contributor/api_contribute_guide.html StarlingX API Contributor Guide]
  
 
== Planning & Process ==
 
== Planning & Process ==
Line 78: Line 80:
 
== Governance ==
 
== Governance ==
  
A very preliminary Governance document can be found [https://etherpad.openstack.org/p/stx-governance here].  It contains lot of feedback from various reviewers of the early drafts.
+
You can find more information about StarlingX governance and the TSC charter on the [https://docs.starlingx.io/governance/index.html governance section] of the documentation website.
  
A more polished version of the same document can be found [[Starlingx/Initial Governance|on this page.]]
+
For early versions and evolution of the documents see [https://etherpad.openstack.org/p/stx-governance here] and [[Starlingx/Initial Governance|on this wiki page.]]
  
 
|style="vertical-align:top; width:50%;" |
 
|style="vertical-align:top; width:50%;" |
Line 95: Line 97:
  
 
== Meetings ==
 
== Meetings ==
 +
 +
All StarlingX meetings are cancelled for the weeks of Dec 24-28th and Dec 31-Jan 4th due to the holidays.
 +
We will resume our usual meeting schedule starting Jan 7th.
  
 
=== Weekly calls ===
 
=== Weekly calls ===
  
The list of meetings and dial-in information can be found [[Starlingx/Meetings|on this page.]]
+
* The list of meetings and dial-in information can be found [[Starlingx/Meetings|on this page.]]
 +
* We are holding a community meetup in January 2019.  The agenda and meeting notes [https://etherpad.openstack.org/p/stx-chandler-meetup can be found here]
  
 
=== PTG Meetings ===
 
=== PTG Meetings ===
  
We are preparing for the Denver OpenStack PTG meeting.  Draft agenda items can be found here:
+
Here are the agendas and notes for our PTG meetings:
 
* [https://etherpad.openstack.org/p/stx-PTG-agenda StarlingX Denver PTG Agenda]
 
* [https://etherpad.openstack.org/p/stx-PTG-agenda StarlingX Denver PTG Agenda]
  
Line 149: Line 155:
 
| [[StarlingX/Pyton2|Python2 to Python3 Transition]]|| [[StarlingX/Zull|Zuul Enablement and Coverage]]
 
| [[StarlingX/Pyton2|Python2 to Python3 Transition]]|| [[StarlingX/Zull|Zuul Enablement and Coverage]]
 
|-
 
|-
| [[StarlingX/Devstack|Devstack Integration]] ||
+
| [[StarlingX/Devstack|Devstack Integration]] ||  
 
|}
 
|}
 
ToDo:  
 
ToDo:  
* Add a vendor project for Intel platform specific features e.g. FPGA access in guests, GPU support in guests, Intel SGX and EPID support and NEV SDK integration
 
 
* Create a Project Map graphic that captures all of this in a graphical way, similar to (or an extension of) the OpenStack project map.
 
* Create a Project Map graphic that captures all of this in a graphical way, similar to (or an extension of) the OpenStack project map.
  

Revision as of 18:25, 12 December 2018

Welcome to the StarlingX Project

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 <insert link 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.


Releases

The first StarlingX release is stx.2018.10 and it is available now!

Documentation

These two documents will help get you started building, installing, and validating your installation of StarlingX:

Code

The StarlingX project uses Gerrit as its web-based code change management and review tool.

Planning & 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 description. 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 (of any kind), please mark it with the tag "stx.new" so we can find it, review it and assign it to the right team and a release.

We are using Launchpad for tracking bugs. Link to the StarlingX Launchpad 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 assigned to the stx.2018.10 release, use this query
  • To find all active bugs assigned to the stx.2018.10 release in launchpad, use this query.
  • [Temporary] To find all active bugs in story board, use: this query
  • Queries for the Sub-projects are defined on each Sub-project's page


Optional: You can also use Prefixes to search for Stories, but we consider Prefixes optional so these searches might not show the same results as searching for Tags.

  • Sample Prefix queries:
    • To find all Stories with the [Features] prefix use: this query
    • To find all Stories with the [Build] prefix use: this query

References

OpenStack Documentation

These are references to general OpenStack material:

Governance

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

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

Culture

We are proud to be an OpenStack Foundation project!

Meetings

All StarlingX meetings are cancelled for the weeks of Dec 24-28th and Dec 31-Jan 4th due to the holidays. We will resume our usual meeting schedule starting Jan 7th.

Weekly calls

  • The list of meetings and dial-in information can be found on this page.
  • We are holding a community meetup in January 2019. The agenda and meeting notes can be found here

PTG Meetings

Here are the agendas and notes for our PTG meetings:

Status and Planning

This section is under construction.

Overall project planning pages

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:

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

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 our progress in a shared Google document. Please send an email to BruceJ @ Intel with your gmail.com email address for access to the document.