Jump to: navigation, search

Difference between revisions of "StarlingX"

(PTG Meetings)
(Developer Resources)
 
(13 intermediate revisions by 4 users not shown)
Line 2: Line 2:
 
<center>
 
<center>
  
== Welcome to the StarlingX Project ==
+
== Welcome! ==
 +
Welcome to the StarlingX Contributor Community!  We're glad you are here.  Everything you need to get started with StarlingX is available below.  If you have questions or need advice, please reach out to us on the mailing list or IRC - we're here to help!
 
</center>
 
</center>
 +
----
  
''See the [https://www.starlingx.io/ main StarlingX web site] for current information about the project and the [https://docs.starlingx.io/ StarlingX Documentation site] for reference documentation and guides.''
+
<!-- the rest of the page is a series of four-column tables -->
 +
{| style="border-collapse: separate; border-spacing: 25px;"
 +
|style="vertical-align:top; width:25%;" |
 +
<!-- 1st table 1st column contents -->
 +
===== Getting Started =====
 +
----
 +
* [[StarlingX/Releases|Releases]]
 +
* [https://www.starlingx.io/ StarlingX web site]
 +
* [https://docs.starlingx.io/ Documentation]  
 +
* [https://www.starlingx.io/learn/ Learn more]
  
StarlingX is a fully featured and high performance Edge Cloud software stack that is based on the [https://www.windriver.com/products/titanium-cloud/ 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.
+
|style="vertical-align:top; width:25%;" |
 +
<!-- 1st table 2nd column contents -->
 +
===== Culture =====
 +
----
 +
* [https://www.openstack.org/legal/community-code-of-conduct/ Code of Conduct]
 +
* [https://governance.openstack.org/tc/reference/opens.html The Four Opens]
  
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.
+
|style="vertical-align:top; width:25%;" |
 
+
<!-- 1st table 3rd column contents -->
You can find an overview of the StarlingX project's features  [https://www.starlingx.io/learn/ here].
+
===== Communicate =====
 
+
----
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.
+
* [http://lists.starlingx.io/ Email lists]
 +
* IRC: #starlingX@freenode
 +
* [https://docs.openstack.org/infra/manual/developers.html IRC setup]
 +
* [[Starlingx/Meetings|Weekly calls schedule]]
 +
* [https://zoom.us/j/342730236 Weekly calls Zoom]
 +
|style="vertical-align:top; width:25%;" |
 +
<!-- 1st table 4th column contents -->
 +
===== Developer Resources =====
 
----
 
----
<!-- the rest of the page is a two-column table -->
+
* [https://docs.openstack.org/infra/manual/developers.html Developer Guide]
{| style="border-collapse: separate; border-spacing: 25px;"
+
* [[StarlingX/StarlingX VirtualBox Configuration Guide | VirtualBox Guide]]
|style="vertical-align:top; width:50%;" |
+
* [[StarlingX/StarlingX Packet.com iPXE Installation | StarlingX Packet.com  iPXE]]
<!-- left column contents -->
 
 
 
== 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 [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 ==
 
These two documents will help get you started building, installing, and validating your installation of StarlingX:
 
* [https://docs.starlingx.io/contributor/index.html StarlingX Developer Guide]
 
* [https://docs.starlingx.io/installation_guide/index.html StarlingX Installation Guide]
 
* [[StarlingX/StarlingX VirtualBox Configuration Guide | StarlingX VirtualBox Configuration Guide]]
 
* [[StarlingX/StarlingX Packet.com iPXE Installation | StarlingX Packet.com  iPXE Installation]]
 
 
 
== Contributing ==
 
Your contribution is welcome - check the list of [https://bugs.launchpad.net/starlingx/+bugs?field.tag=stx.helpwanted "help wanted" bugs].
 
 
 
== Code ==
 
The StarlingX project uses Gerrit as its web-based code change management and review tool.
 
* [https://opendev.org/starlingx Gerrit repositories] maintain the StarlingX code, build instructions are in the [https://docs.starlingx.io/developer_guide/index.html StarlingX Developer Guide]
 
* [https://review.opendev.org/#/admin/projects/?filter=starlingx StarlingX Gerrit Projects] and [https://review.opendev.org/#/q/status:open+AND+project:%255Estarlingx/%2540 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]
 
 
 
 
* [[StarlingX/CodeSubmissionGuidelines|Code Submission Guidelines]]
 
* [[StarlingX/CodeSubmissionGuidelines|Code Submission Guidelines]]
 +
* [https://docs.starlingx.io/contributor/index.html Contribution guidelines]
 
* [https://docs.starlingx.io/contributor/api_contribute_guide.html StarlingX API Contributor Guide]
 
* [https://docs.starlingx.io/contributor/api_contribute_guide.html StarlingX API Contributor Guide]
 +
* [https://bugs.launchpad.net/starlingx/+bugs?field.tag=stx.helpwanted "Help wanted" bugs]
 +
|}
 +
{| style="border-collapse: separate; border-spacing: 25px;"
 +
|style="vertical-align:top; width:25%;" |
 +
<!-- 2nd table 1st column contents -->
  
== Planning & Process ==
+
===== User resources  =====
* [[StarlingX/Release_Plan|StarlingX Release Planning]]
+
----
* [[StarlingX/Feature Development Process|StarlingX Feature Development Process (in review)]]
+
* [https://docs.starlingx.io/deploy_install_guides/index.html Installation and Deployment Guides]
* [[StarlingX/Defect Handling Process|StarlingX Defect Handling Process]]
+
* [[StarlingX/Platform Features|Hardware platform features]]
 +
* [https://docs.openstack.org/infra/manual/developers.html OpenStack Developer's Guide]
 +
* [https://docs.openstack.org/infra/manual/creators.html OpenStack Project Creator's Guide]
 +
* [https://wiki.openstack.org/wiki/How_To_Contribute OpenStack Contributors Guide]  
 +
* [https://governance.openstack.org/tc/reference/project-testing-interface.html OpenStack Project Testing Interface]
  
== Story and Bug Tracking ==
+
|style="vertical-align:top; width:25%;" |
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 [[StarlingX/Tags and Prefixes|Tags and Prefixes]] for a description of how we use them. 
+
<!-- 2nd table 2nd column contents -->
  
The StarlingX Storyboard project group is [https://storyboard.openstack.org/#!/project_group/86 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.
+
===== Code =====
 +
----
 +
* [https://opendev.org/starlingx Source code repositories]
 +
* [https://review.opendev.org/#/q/status:open+AND+project:%255Estarlingx/%2540 Active code reviews]
  
We are using [https://bugs.launchpad.net/starlingx Launchpad] for tracking bugs. '''IMPORTANT:''' If you create a new bug, please use [[StarlingX/BugTemplate|the StarlingX Bug Template]].
+
|style="vertical-align:top; width:25%;" |
 +
<!-- 2nd table 3rd column contents -->
  
Sample queries:
+
===== Governance =====
* To find newly created stories, use: [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&tags=stx.new this query]
+
----
* To find stories with no sub-project tags, use [https://storyboard.openstack.org/#!/worklist/456 this worklist]
+
* [https://docs.starlingx.io/governance/index.html Governance documents]
* To find all active stories, use [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86 this query]
+
* [https://docs.starlingx.io/election/ Election documents and results]
* To find all active stories for stx.2.0, use  [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&tags=stx.2.0 this query]
+
* [https://etherpad.openstack.org/p/stx-governance Archive: Draft governance etherpad]
* To find all active bugs for stx.2.0 in launchpad, use [https://bugs.launchpad.net/starlingx/+bugs?field.tag=stx.2018.10 this query].
+
* [[Starlingx/Initial Governance|Archive: Draft governance wiki]]
* Queries for the Sub-projects are defined on each Sub-project's page
+
|style="vertical-align:top; width:25%;" |
 
+
<!-- 2nd table 4th column contents -->
== References ==
+
===== Meetups & PTGs =====
 
+
----
* [https://etherpad.openstack.org/p/stx-notes The list of repos] and other things
 
 
 
== OpenStack Documentation ==
 
 
 
These are references to general OpenStack material:
 
 
 
* [https://docs.openstack.org/infra/manual/developers.html Developer's Guide]
 
* [https://docs.openstack.org/infra/manual/creators.html Project Creator's Guide]
 
* [https://wiki.openstack.org/wiki/How_To_Contribute The Contributors Guide]  (the older wiki page)
 
* [https://governance.openstack.org/tc/reference/project-testing-interface.html Project Testing Interface]
 
 
 
== Governance ==
 
 
 
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.
 
 
 
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%;" |
 
<!-- right column contents -->
 
 
 
== Culture ==
 
 
 
We are proud to be an OpenStack Foundation project!
 
* We support and adhere to the [https://www.openstack.org/legal/community-code-of-conduct/ OpenStack community Code of Conduct]
 
* We support and fully embrace the [https://governance.openstack.org/tc/reference/opens.html Four Opens]
 
* [[StarlingX/Contribution Guidelines|Contribution Guidelines]]
 
* The mailing lists are now live 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.
 
 
 
== Meetings ==
 
 
 
=== Weekly calls ===
 
 
 
* The list of meetings and dial-in information can be found [[Starlingx/Meetings|on this page.]]
 
* We held a community meetup in January 2019.  The agenda and meeting notes [https://etherpad.openstack.org/p/stx-chandler-meetup can be found here].  A blog with pictures and a description of the meetup [https://www.starlingx.io/blog/starlingx-meetup-january-2019.html is here].
 
 
 
=== PTG Meetings ===
 
 
 
Here are the agendas and notes for our PTG meetings:
 
 
* [https://etherpad.openstack.org/p/stx-PTG-agenda StarlingX Denver 2018 PTG Agenda]
 
* [https://etherpad.openstack.org/p/stx-PTG-agenda StarlingX Denver 2018 PTG Agenda]
 
* add link here to the Berlin PTG meeting minutes
 
* add link here to the Berlin PTG meeting minutes
 +
* [https://etherpad.openstack.org/p/stx-chandler-meetup Jan 2019 meetup etherpad]
 +
* [https://www.starlingx.io/blog/starlingx-meetup-january-2019.html Jan 2019 meetup blog]
 
* [https://etherpad.openstack.org/p/stx-ptg-agenda StarlingX Denver 2019 PTG Agenda and Notes]
 
* [https://etherpad.openstack.org/p/stx-ptg-agenda StarlingX Denver 2019 PTG Agenda and Notes]
 
== Status and Planning ==
 
This section is under construction.
 
=== Overall project planning pages ===
 
* [[StarlingX/Project Priorities|Project Priorities]]
 
* [[StarlingX/Release Plan|Release Plan]]
 
* [[StarlingX/Project Plans|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 [https://ethercalc.openstack.org/ctjc7vlbphm1 here]
 
==== StarlingX main projects ====
 
Information on the main StarlingX development projects can be found on the wiki pages below:
 
{| class=wikitable
 
|-
 
| [[StarlingX/Config|Config project]]|| [[StarlingX/Fault|Fault project]]
 
|-
 
|  [[StarlingX/HA|HA project]] || [[StarlingX/GUI|GUI project]]
 
|-
 
| [[StarlingX/Metal|Metal project]]|| [[StarlingX/NFV|NFV project]]
 
|-
 
| [[StarlingX/Update|Update project]]|| [[StarlingX/DistCloud|Distributed Cloud project]]
 
 
|}
 
|}
 +
<!-- the rest of the page is a series of four-column tables -->
 +
{| style="border-collapse: separate; border-spacing: 25px;"
 +
|style="vertical-align:top; width:25%;" |
 +
<!-- 3rd table 1st column contents -->
 +
===== Planning & Processes =====
 +
----
 +
* [[StarlingX/Release_Plan|StarlingX Release Planning]]
 +
* [[StarlingX/Feature Development Process|StarlingX Feature Development Process (needs update)]]
 +
* [[StarlingX/Defect Handling Process|StarlingX Defect Handling Process]]
 +
* [[StarlingX/Tags and Prefixes|Tags and Prefixes]] 
 +
* [https://storyboard.openstack.org/#!/project_group/86 Storyboard Group]
 +
|style="vertical-align:top; width:25%;" |
 +
<!-- 3rd table 2nd column contents -->
 +
===== Useful queries =====
 +
----
 +
* [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&tags=stx.new Newly created stories]
 +
* [https://storyboard.openstack.org/#!/worklist/456 Stories with no sub-project tags]
 +
* [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86 All active stories]
 +
* [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&tags=stx.2.0 All active stories for StarlingX 2.0]
 +
* [https://bugs.launchpad.net/starlingx/+bugs?field.tag=stx.2.0 All open bugs for StarlingX 2.0].
  
==== StarlingX supporting projects ====
+
|style="vertical-align:top; width:25%;" |
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.
+
<!-- 3rd table 3rd column contents -->
{| class="wikitable"
+
===== StarlingX sub-projects =====
|-
+
----
| [[StarlingX/Docs_and_Infra|Docs and Infra project]]|| [[StarlingX/Build|Build project]]
+
* [[StarlingX/Config|Config project]]
|-
+
* [[StarlingX/Fault|Fault project]]
| [[StarlingX/DistroOpenStack|Distro - OpenStack project]] ||  [[StarlingX/Distro|Distro - Non-OpenStack project]]
+
* [[StarlingX/HA|HA project]]
|-
+
* [[StarlingX/GUI|GUI project]]
| [[StarlingX/Test|Test project]]||  [[StarlingX/Security|Security project]]
+
* [[StarlingX/Metal|Metal project]]
|-
+
* [[StarlingX/NFV|NFV project]]
| [[StarlingX/Containers|Containers project]]||  [[StarlingX/Networking|Networking project]]
+
* [[StarlingX/Update|Update project]]
|-
+
* [[StarlingX/DistCloud|Distributed Cloud project]]
| [[StarlingX/Releases|Releases project]] || [[StarlingX/MultiOS|MultiOS project]]
+
* [[StarlingX/Docs_and_Infra|Docs and Infra project]]
|}
+
* [[StarlingX/Build|Build project]]
 +
* [[StarlingX/DistroOpenStack|Distro - OpenStack project]]
 +
* [[StarlingX/Distro|Distro - Non-OpenStack project]]
 +
* [[StarlingX/Test|Test project]]
 +
* [[StarlingX/Security|Security project]]
 +
* [[StarlingX/Containers|Containers project]]
 +
* [[StarlingX/Networking|Networking project]]
 +
* [[StarlingX/Releases|Releases project]]
 +
* [[StarlingX/MultiOS|MultiOS project]]
 +
* [[StarlingX/Pyton2|Python2 to Python3 Transition]]
 +
* [[StarlingX/Zull|Zuul Enablement and Coverage]]
 +
* [[StarlingX/Devstack|Devstack Integration]]
 +
* [[StarlingX/stxinabox|StarlingX In-a-box]]
  
==== StarlingX cross-project initiatives ====
+
|style="vertical-align:top; width:25%;" |
There are several initiatives we are implementing that cross project boundaries:
+
<!-- 1st table 4th column contents -->
{| class="wikitable"
+
===== Special Interest Groups (SIGs) =====
|-
+
----
| [[StarlingX/Pyton2|Python2 to Python3 Transition]]|| [[StarlingX/Zull|Zuul Enablement and Coverage]]
+
* [[StarlingX/Packet SIG|Packet SIG]]  
|-
+
* [[StarlingX/First Contact SIG|First Contact SIG]]
| [[StarlingX/Devstack|Devstack Integration]] || [[StarlingX/stxinabox|StarlingX In-a-box]]
 
 
|}
 
|}
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 [https://docs.google.com/spreadsheets/d/1udAtEpQljV2JZVs-525UhWyx-5ePOaSSkKD1CS27ohU/edit?usp=sharing 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 [https://docs.google.com/spreadsheets/d/1nKnkweuxcqvVOoRcpnTYMVUUv1RoAugOWXMjB7VIrfc/edit?usp=sharing 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 [[StarlingX/Platform Features|here]].
+
The previous wiki home page can be found [[StarlingX/Archived wiki home page|here]]

Latest revision as of 15:35, 16 July 2019

Welcome!

Welcome to the StarlingX Contributor Community! We're glad you are here. Everything you need to get started with StarlingX is available below. If you have questions or need advice, please reach out to us on the mailing list or IRC - we're here to help!


Getting Started

Culture

Communicate

Developer Resources

User resources

Code

Governance

Meetups & PTGs

Planning & Processes

Useful queries

StarlingX sub-projects

Special Interest Groups (SIGs)

The previous wiki home page can be found here