Jump to: navigation, search

Difference between revisions of "StarlingX"

(Sub-projects)
(Developer Resources)
 
(148 intermediate revisions by 22 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 starlingx-discuss mailing list or IRC - we're here to help!
 
</center>
 
</center>
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.
+
----
 +
 
 +
<!-- 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]
  
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 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]
  
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="vertical-align:top; width:25%;" |
 +
<!-- 1st table 3rd column contents -->
 +
===== Communicate =====
 
----
 
----
<!-- the rest of the page is a two-column table -->
+
* [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 =====
 +
----
 +
* [https://docs.openstack.org/infra/manual/developers.html Openstack Developer Guide]
 +
* [https://drive.google.com/drive/folders/1AvUCq3ojuhNZV6XE8YdRhp9PVxixRIeE Detailed Training Materials]
 +
* [[StarlingX/StarlingX VirtualBox Configuration Guide | VirtualBox Guide]]
 +
* [[StarlingX/StarlingX Packet.com iPXE Installation | StarlingX Packet.com  iPXE]]
 +
* [https://docs.starlingx.io/developer_resources/code-submission-guide.html 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://drive.google.com/drive/folders/1AvUCq3ojuhNZV6XE8YdRhp9PVxixRIeE StarlingX Reference Material]
 +
* [https://wiki.openstack.org/wiki/StarlingX/Defect_Handling_Process#Key_StarlingX_Bug_Queries StarlingX Bug Queries]
 +
* [https://bugs.launchpad.net/starlingx/+bugs?field.tag=stx.helpwanted "Help wanted" bugs]
 +
|}
 
{| style="border-collapse: separate; border-spacing: 25px;"
 
{| style="border-collapse: separate; border-spacing: 25px;"
|style="vertical-align:top; width:50%;" |
+
|style="vertical-align:top; width:25%;" |
<!-- left column contents -->
+
<!-- 2nd table 1st column contents -->
== Documentation ==
 
  
These three documents will help get you started building, installing, and validating your installation of StarlingX:
+
===== User resources  =====
* [[StarlingX/Developer Guide|Developer Guide]]
+
----
* [[StarlingX/Installation Guide|Installation Guide]]
+
* [https://docs.starlingx.io/deploy_install_guides/index.html Installation and Deployment Guides]
* [[StarlingX/Validation Guide|Validation Guide]]
+
* [[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]
 +
* [https://wiki.openstack.org/wiki/StarlingX/Tips_Tricks_Debugging_Techniques Tips, Tricks and Debugging Techniques]
 +
* [https://wiki.openstack.org/wiki/StarlingX/Features_Around_Kubernetes Features Around STX Kubernetes ]
  
== Code ==
 
The StarlingX project uses Gerrit as its web-based code change management and review tool.
 
* [https://git.openstack.org/cgit/openstack/stx Gerrit repositories] maintain the StarlingX code, build instructions are in the [[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/#/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]
 
  
== Story and Bug Tracking ==
+
|style="vertical-align:top; width:25%;" |
We are using the OpenStack Storyboard tool for tracking all 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 [[StarlingX/Tags and Prefixes|Tags and Prefixes]] for a description of how we use them. 
+
<!-- 2nd table 2nd column contents -->
  
'''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.
+
===== Code =====
 +
----
 +
* [https://opendev.org/starlingx Source code repositories]
 +
* [https://review.opendev.org/#/q/status:open+AND+project:%255Estarlingx/%2540 Active code reviews]
  
The StarlingX Storyboard project group is [https://storyboard.openstack.org/#!/project_group/86 here].
+
|style="vertical-align:top; width:25%;" |
 +
<!-- 2nd table 3rd column contents -->
  
Sample queries:
+
===== Governance =====
* To find the newly created stories use: [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&tags=stx.new this query]
+
----
* To find all of the active bugs use: [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&tags=stx.bug this query]
+
* [https://docs.starlingx.io/governance/index.html Governance documents]
* To find all of the active bugs assigned to the stx.2018.08 release use [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&tags=stx.bug&tags=stx.2018.08 this query]
+
* [https://docs.starlingx.io/election/ Election documents and results]
* To find all of the active bugs assigned to the stx.2018.11 release use [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&tags=stx.bug&tags=stx.2018.11 this query]
+
* [https://etherpad.openstack.org/p/stx-governance Archive: Draft governance etherpad]
 +
* [[Starlingx/Initial Governance|Archive: Draft governance wiki]]
 +
|style="vertical-align:top; width:25%;" |
 +
<!-- 2nd table 4th column contents -->
 +
===== Meetups & PTGs =====
 +
----
 +
* [https://etherpad.openstack.org/p/stx-PTG-agenda StarlingX Denver 2018 PTG Agenda]
 +
* [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/starlingX-winter-2020-meetup March 2020 meetup etherpad]
 +
* [https://etherpad.opendev.org/p/stx-virtual-PTG-June June 2020 PTG etherpad]
 +
* [https://etherpad.opendev.org/p/stx-ptg-planning-october-2020 October 2020 PTG etherpad]
 +
|}
 +
<!-- 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 -->
  
Queries for the Sub-projects will be defined on each Sub-project's page
+
===== Planning & Processes =====
 +
----
 +
* [[StarlingX/Release_Plan|StarlingX Release Planning]]
 +
* [https://docs.starlingx.io/contributor/development_process.html Development 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 -->
  
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.
+
===== Useful queries =====
* Sample Prefix queries:
+
----
** To find all Stories with the [Features] prefix use: [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&q=Feature this query]
+
* [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86 All active stories]
** To find all Stories with the [Bug] prefix use: [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&q=Bug this query]
+
* [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&tags=stx.4.0 All active stories for StarlingX 4.0]
 +
* [https://bugs.launchpad.net/starlingx/+bugs?field.tag=stx.4.0 All open bugs for StarlingX 4.0].
 +
* [https://review.opendev.org/#/dashboard/?title=StarlingX+Review+Inbox&foreach=%28%0Aproject%3Astarlingx%2Fansible%2Dplaybooks+OR%0Aproject%3Astarlingx%2Fclients+OR%0Aproject%3Astarlingx%2Fcompile+OR%0Aproject%3Astarlingx%2Fconfig+OR%0Aproject%3Astarlingx%2Fconfig%2Dfiles+OR%0Aproject%3Astarlingx%2Fcontainers+OR%0Aproject%3Astarlingx%2Fdistcloud+OR%0Aproject%3Astarlingx%2Fdistcloud%2Dclient+OR%0Aproject%3Astarlingx%2Fdocs+OR%0Aproject%3Astarlingx%2Felection+OR%0Aproject%3Astarlingx%2Ffault+OR%0Aproject%3Astarlingx%2Fgovernance+OR%0Aproject%3Astarlingx%2Fgui+OR%0Aproject%3Astarlingx%2Fha+OR%0Aproject%3Astarlingx%2Fhelm%2Dcharts+OR%0Aproject%3Astarlingx%2Finteg+OR%0Aproject%3Astarlingx%2Fmanifest+OR%0Aproject%3Astarlingx%2Fmetal+OR%0Aproject%3Astarlingx%2Fmonitor%2Darmada%2Dapp+OR%0Aproject%3Astarlingx%2Fmonitoring+OR%0Aproject%3Astarlingx%2Fnfv+OR%0Aproject%3Astarlingx%2Fopenstack%2Darmada%2Dapp+OR%0Aproject%3Astarlingx%2Fplatform%2Darmada%2Dapp+OR%0Aproject%3Astarlingx%2Froot+OR%0Aproject%3Astarlingx%2Fspecs+OR%0Aproject%3Astarlingx%2Fstx%2Dpuppet+OR%0Aproject%3Astarlingx%2Ftest+OR%0Aproject%3Astarlingx%2Ftools+OR%0Aproject%3Astarlingx%2Fupdate+OR%0Aproject%3Astarlingx%2Fupstream+OR%0Aproject%3Astarlingx%2Futilities+OR%0Aproject%3Astarlingx%2Fzuul%2Djobs%0A%29%0Astatus%3Aopen%0ANOT+owner%3Aself%0ANOT+label%3AWorkflow%3C%3D%2D1%0Alabel%3AVerified%3E%3D1%2Czuul%0ANOT+reviewedby%3Aself&Needs+final+%2B2=label%3ACode%2DReview%3E%3D2+limit%3A50+NOT+label%3ACode%2DReview%3C%3D%2D1%2Cself&Passed+Zuul%2C+No+Negative+Feedback+%28Small+Fixes%29=NOT+label%3ACode%2DReview%3E%3D2+NOT+label%3ACode%2DReview%3C%3D%2D1%2Cstarlingx%2Dcore+delta%3A%3C%3D10&Passed+Zuul%2C+No+Negative+Feedback=NOT+label%3ACode%2DReview%3E%3D2+NOT+label%3ACode%2DReview%3C%3D%2D1%2Cstarlingx%2Dcore+delta%3A%3E10&Needs+Feedback+%28Changes+older+than+5+days+that+have+not+been+reviewed+by+anyone%29=NOT+label%3ACode%2DReview%3C%3D%2D1+NOT+label%3ACode%2DReview%3E%3D1+age%3A5d&You+are+a+reviewer%2C+but+haven%27t+voted+in+the+current+revision=NOT+label%3ACode%2DReview%3C%3D%2D1%2Cself+NOT+label%3ACode%2DReview%3E%3D1%2Cself+reviewer%3Aself&Wayward+Changes+%28Changes+with+no+code+review+in+the+last+2days%29=NOT+is%3Areviewed+age%3A2d Gerrit Review Dashboard]
 +
* [https://review.opendev.org/#/dashboard/?title=StarlingX+TSC+Overview&foreach=%28%0Aproject%3Astarlingx%2Fgovernance+OR%0Aproject%3Astarlingx%2Fspecs%0A%29%0Astatus%3Aopen%0ANOT+label%3AWorkflow%3C%3D%2D1%0Alabel%3AVerified%3E%3D1%2Czuul%0ANOT+reviewedby%3Aself&Needs+Feedback+%28Changes+older+than+5+days+that+have+not+been+reviewed+by+anyone%29=NOT+label%3ACode%2DReview%3C%3D%2D1+NOT+label%3ACode%2DReview%3E%3D1+age%3A5d+branch%3Amaster&You+are+a+reviewer%2C+but+haven%27t+voted+in+the+current+revision=NOT+label%3ACode%2DReview%3C%3D%2D1%2Cself+NOT+label%3ACode%2DReview%3E%3D1%2Cself+reviewer%3Aself&Needs+final+%2B2=label%3ACode%2DReview%3E%3D2+limit%3A50+NOT+reviewedby%3Aself+NOT+label%3Aworkflow%3E%3D1&Passed+Zuul%2C+No+Negative+Feedback=NOT+label%3ACode%2DReview%3E%3D2+NOT+label%3ACode%2DReview%3C%3D%2D1+limit%3A50+branch%3Amaster&Wayward+Changes+%28Changes+with+no+code+review+in+the+last+2+days%29=NOT+label%3ACode%2DReview%3C%3D%2D1+NOT+label%3ACode%2DReview%3E%3D1+age%3A2d+branch%3Amaster TSC Review Dashboard]
  
== References ==
+
|style="vertical-align:top; width:25%;" |
 +
<!-- 3rd table 3rd column contents -->
  
* [https://etherpad.openstack.org/p/stx-notes The list of repos] and other things
+
===== StarlingX sub-projects =====
 +
----
 +
* [[StarlingX/Build|Build project]]
 +
* [[StarlingX/Config|Config project]]
 +
* [[StarlingX/Containers|Containers project]]
 +
* [[StarlingX/Devstack|Devstack Integration]]
 +
* [[StarlingX/DistCloud|Distributed Cloud project]]
 +
* [[StarlingX/Distro|Distro - Non-OpenStack project]]
 +
* [[StarlingX/DistroOpenStack|Distro - OpenStack project]]
 +
* [[StarlingX/Docs_and_Infra|Docs and Infra project]]
 +
* [[StarlingX/FlockServices|Flock Services project]]
 +
* [[StarlingX/MultiOS|MultiOS project]]
 +
* [[StarlingX/Networking|Networking project]]
 +
* [[StarlingX/Python2|Python2 to Python3 Transition]]
 +
* [[StarlingX/Releases|Releases project]]
 +
* [[StarlingX/Security|Security project]]
 +
* [[StarlingX/stxinabox|StarlingX In-a-box]]
 +
* [[StarlingX/Test|Test project]]
 +
* [[StarlingX/Zull|Zuul Enablement and Coverage]]
 +
* [[StarlingX/Distro/tpm-verify|tpm-verify]]
  
== OpenStack Documentation ==
 
  
These are references to general OpenStack material:
+
|style="vertical-align:top; width:25%;" |
 +
<!-- 1st table 4th column contents -->
  
* [https://docs.openstack.org/infra/manual/developers.html Developer's Guide]
+
===== Special Interest Groups (SIGs) =====
* [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)
+
* [[StarlingX/Packet SIG|Packet SIG]]  
* [https://governance.openstack.org/tc/reference/project-testing-interface.html Project Testing Interface]
+
* [[StarlingX/First Contact SIG|First Contact SIG]]
 +
|}
  
|style="vertical-align:top; width:50%;" |
+
The previous wiki home page can be found [[StarlingX/Archived wiki home page|here]]
<!-- 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 ===
 
 
 
* We host a weekly call for the project every Wednesday at 7am PDT / 1400 UTC.  All are welcome.
 
* We also host a Core team call every Thursday at 7AM PDT / 1400 UTC.  This is for the Core team but other project participants are welcome to join.
 
 
 
==== Call details ====
 
 
 
* ''' Zoom link: https://zoom.us/j/342730236 '''
 
* ''' Dialing in from phone: '''
 
** Dial(for higher quality, dial a number based on your current location): US: +1 669 900 6833  or +1 646 876 9923
 
** Meeting ID: 342 730 236
 
** International numbers available: https://zoom.us/u/ed95sU7aQ
 
 
 
==== Agenda and meeting minutes ====
 
 
 
The agenda and notes for each call are kept in Etherpads:
 
* [https://etherpad.openstack.org/p/stx-status Weekly Agenda and Notes]
 
* [https://etherpad.openstack.org/p/stx-cores Weekly Core team Agenda and Notes]
 
 
 
Please feel free to add items to the agendas for these meetings.
 
 
 
=== PTG Meetings ===
 
 
 
We are preparing for the Denver OpenStack PTG meeting.  Draft agenda items can be found here:
 
* [https://etherpad.openstack.org/p/stx-PTG-agenda StarlingX Denver PTG Agenda]
 
== Status and Planning ==
 
This section is under construction.
 
=== Overall project planning pages ===
 
* [[StarlingX/Project Priorities|Project Priorities]]
 
* [[StarlingX/Release Plan|Release Plan]]
 
* [https://etherpad.openstack.org/p/stx-planning StarlingX Planning Etherpad] (contains sub-projects and Worklists)
 
* [[StarlingX/Project Plans|Project Plans]]
 
 
 
=== Sub-projects ===
 
To keep things manageable, we are splitting the overall project into sub-projects. The list of sub-projects is below with links to their sub-project home pages.
 
 
 
* [[StarlingX/Docs_and_Infra|Documentation and Infrastructure]]
 
* [[StarlingX/Releases|Releases]]
 
* [[StarlingX/Distro|Distro support]]
 
** TBD: Should updating to CentOS 7.5 and updating qemy/libvirt be tracked in the Distro project or in their own projects?
 
* New Features (Including networking) Task & Story list is at https://ethercalc.openstack.org/sedtamo5yauh
 
* Upstream patch submission for other (non-Openstack) projects (ToDo:  split up into sub-sub projects) https://storyboard.openstack.org/#!/worklist/358
 
* Validation - high level tasks https://ethercalc.openstack.org/50vke3z9qta3
 
* [[StarlingX/Security|Security]] - Task & Story list is at https://ethercalc.openstack.org/fo49gw7kt2ee
 
* Container support includinng OVS DPDK integration - TBD
 
* Python2 transition
 
* Zuul enablement and coverage
 
* Devstack integration
 
 
 
== 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.
 
 
 
TODO: Add a link to our Dashboard showing the status of upstream submissions
 
|}
 

Latest revision as of 16:54, 21 October 2020

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 starlingx-discuss 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